Documentation
¶
Overview ¶
Package codeguruprofiler provides the client and types for making API requests to Amazon CodeGuru Profiler.
This section provides documentation for the Amazon CodeGuru Profiler API operations.
<p>Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks. </p> <p>Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. </p> <note> <p>Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html">What is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>. </p>
See https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18 for more information on this service.
See codeguruprofiler package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/codeguruprofiler/
Using the Client ¶
To use Amazon CodeGuru Profiler with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon CodeGuru Profiler client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codeguruprofiler/#New
Index ¶
- Constants
- type ActionGroup
- type AddNotificationChannelsInput
- type AddNotificationChannelsOutput
- type AddNotificationChannelsRequest
- type AddNotificationChannelsResponse
- type AgentConfiguration
- type AgentOrchestrationConfig
- type AgentParameterField
- type AggregatedProfileTime
- type AggregationPeriod
- type Anomaly
- type AnomalyInstance
- type BatchGetFrameMetricDataInput
- type BatchGetFrameMetricDataOutput
- type BatchGetFrameMetricDataRequest
- type BatchGetFrameMetricDataResponse
- type Channel
- type Client
- func (c *Client) AddNotificationChannelsRequest(input *AddNotificationChannelsInput) AddNotificationChannelsRequest
- func (c *Client) BatchGetFrameMetricDataRequest(input *BatchGetFrameMetricDataInput) BatchGetFrameMetricDataRequest
- func (c *Client) ConfigureAgentRequest(input *ConfigureAgentInput) ConfigureAgentRequest
- func (c *Client) CreateProfilingGroupRequest(input *CreateProfilingGroupInput) CreateProfilingGroupRequest
- func (c *Client) DeleteProfilingGroupRequest(input *DeleteProfilingGroupInput) DeleteProfilingGroupRequest
- func (c *Client) DescribeProfilingGroupRequest(input *DescribeProfilingGroupInput) DescribeProfilingGroupRequest
- func (c *Client) GetFindingsReportAccountSummaryRequest(input *GetFindingsReportAccountSummaryInput) GetFindingsReportAccountSummaryRequest
- func (c *Client) GetNotificationConfigurationRequest(input *GetNotificationConfigurationInput) GetNotificationConfigurationRequest
- func (c *Client) GetPolicyRequest(input *GetPolicyInput) GetPolicyRequest
- func (c *Client) GetProfileRequest(input *GetProfileInput) GetProfileRequest
- func (c *Client) GetRecommendationsRequest(input *GetRecommendationsInput) GetRecommendationsRequest
- func (c *Client) ListFindingsReportsRequest(input *ListFindingsReportsInput) ListFindingsReportsRequest
- func (c *Client) ListProfileTimesRequest(input *ListProfileTimesInput) ListProfileTimesRequest
- func (c *Client) ListProfilingGroupsRequest(input *ListProfilingGroupsInput) ListProfilingGroupsRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) PostAgentProfileRequest(input *PostAgentProfileInput) PostAgentProfileRequest
- func (c *Client) PutPermissionRequest(input *PutPermissionInput) PutPermissionRequest
- func (c *Client) RemoveNotificationChannelRequest(input *RemoveNotificationChannelInput) RemoveNotificationChannelRequest
- func (c *Client) RemovePermissionRequest(input *RemovePermissionInput) RemovePermissionRequest
- func (c *Client) SubmitFeedbackRequest(input *SubmitFeedbackInput) SubmitFeedbackRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- func (c *Client) UpdateProfilingGroupRequest(input *UpdateProfilingGroupInput) UpdateProfilingGroupRequest
- type ComputePlatform
- type ConfigureAgentInput
- type ConfigureAgentOutput
- type ConfigureAgentRequest
- type ConfigureAgentResponse
- type CreateProfilingGroupInput
- type CreateProfilingGroupOutput
- type CreateProfilingGroupRequest
- type CreateProfilingGroupResponse
- type DeleteProfilingGroupInput
- type DeleteProfilingGroupOutput
- type DeleteProfilingGroupRequest
- type DeleteProfilingGroupResponse
- type DescribeProfilingGroupInput
- type DescribeProfilingGroupOutput
- type DescribeProfilingGroupRequest
- type DescribeProfilingGroupResponse
- type EventPublisher
- type FeedbackType
- type FindingsReportSummary
- type FrameMetric
- type FrameMetricDatum
- type GetFindingsReportAccountSummaryInput
- type GetFindingsReportAccountSummaryOutput
- type GetFindingsReportAccountSummaryPaginator
- type GetFindingsReportAccountSummaryRequest
- type GetFindingsReportAccountSummaryResponse
- type GetNotificationConfigurationInput
- type GetNotificationConfigurationOutput
- type GetNotificationConfigurationRequest
- type GetNotificationConfigurationResponse
- type GetPolicyInput
- type GetPolicyOutput
- type GetPolicyRequest
- type GetPolicyResponse
- type GetProfileInput
- type GetProfileOutput
- type GetProfileRequest
- type GetProfileResponse
- type GetRecommendationsInput
- type GetRecommendationsOutput
- type GetRecommendationsRequest
- type GetRecommendationsResponse
- type ListFindingsReportsInput
- type ListFindingsReportsOutput
- type ListFindingsReportsPaginator
- type ListFindingsReportsRequest
- type ListFindingsReportsResponse
- type ListProfileTimesInput
- type ListProfileTimesOutput
- type ListProfileTimesPaginator
- type ListProfileTimesRequest
- type ListProfileTimesResponse
- type ListProfilingGroupsInput
- type ListProfilingGroupsOutput
- type ListProfilingGroupsPaginator
- type ListProfilingGroupsRequest
- type ListProfilingGroupsResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type Match
- type MetadataField
- type Metric
- type MetricType
- type NotificationConfiguration
- type OrderBy
- type Pattern
- type PostAgentProfileInput
- type PostAgentProfileOutput
- type PostAgentProfileRequest
- type PostAgentProfileResponse
- type ProfileTime
- type ProfilingGroupDescription
- type ProfilingStatus
- type PutPermissionInput
- type PutPermissionOutput
- type PutPermissionRequest
- type PutPermissionResponse
- type Recommendation
- type RemoveNotificationChannelInput
- type RemoveNotificationChannelOutput
- type RemoveNotificationChannelRequest
- type RemoveNotificationChannelResponse
- type RemovePermissionInput
- type RemovePermissionOutput
- type RemovePermissionRequest
- type RemovePermissionResponse
- type SubmitFeedbackInput
- type SubmitFeedbackOutput
- type SubmitFeedbackRequest
- type SubmitFeedbackResponse
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type TimestampStructure
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- type UpdateProfilingGroupInput
- type UpdateProfilingGroupOutput
- type UpdateProfilingGroupRequest
- type UpdateProfilingGroupResponse
- type UserFeedback
Constants ¶
const ( ServiceName = "Amazon CodeGuru Profiler" // Service's name ServiceID = "CodeGuruProfiler" // Service's identifier EndpointsID = "codeguru-profiler" // Service's Endpoint identifier )
const ( // ErrCodeConflictException for service response error code // "ConflictException". // // The requested operation would cause a conflict with the current state of // a service resource associated with the request. Resolve the conflict before // retrying this request. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // The server encountered an internal error and is unable to complete the request. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The resource specified in the request does not exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // You have exceeded your service quota. To perform the requested action, remove // some of the relevant resources, or use Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html) // to request a service quota increase. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // The request was denied due to request throttling. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // // The parameter is not valid. ErrCodeValidationException = "ValidationException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActionGroup ¶ added in v0.21.0
type ActionGroup string
const (
ActionGroupAgentPermissions ActionGroup = "agentPermissions"
)
Enum values for ActionGroup
func (ActionGroup) MarshalValue ¶ added in v0.21.0
func (enum ActionGroup) MarshalValue() (string, error)
func (ActionGroup) MarshalValueBuf ¶ added in v0.21.0
func (enum ActionGroup) MarshalValueBuf(b []byte) ([]byte, error)
type AddNotificationChannelsInput ¶ added in v0.24.0
type AddNotificationChannelsInput struct { // One or 2 channels to report to when anomalies are detected. // // Channels is a required field Channels []Channel `locationName:"channels" min:"1" type:"list" required:"true"` // The name of the profiling group that we are setting up notifications for. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the AddNotificationChannelsRequest.
func (AddNotificationChannelsInput) MarshalFields ¶ added in v0.24.0
func (s AddNotificationChannelsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AddNotificationChannelsInput) String ¶ added in v0.24.0
func (s AddNotificationChannelsInput) String() string
String returns the string representation
func (*AddNotificationChannelsInput) Validate ¶ added in v0.24.0
func (s *AddNotificationChannelsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddNotificationChannelsOutput ¶ added in v0.24.0
type AddNotificationChannelsOutput struct { // The new notification configuration for this profiling group. NotificationConfiguration *NotificationConfiguration `locationName:"notificationConfiguration" type:"structure"` // contains filtered or unexported fields }
The structure representing the AddNotificationChannelsResponse.
func (AddNotificationChannelsOutput) MarshalFields ¶ added in v0.24.0
func (s AddNotificationChannelsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AddNotificationChannelsOutput) String ¶ added in v0.24.0
func (s AddNotificationChannelsOutput) String() string
String returns the string representation
type AddNotificationChannelsRequest ¶ added in v0.24.0
type AddNotificationChannelsRequest struct { *aws.Request Input *AddNotificationChannelsInput Copy func(*AddNotificationChannelsInput) AddNotificationChannelsRequest }
AddNotificationChannelsRequest is the request type for the AddNotificationChannels API operation.
func (AddNotificationChannelsRequest) Send ¶ added in v0.24.0
func (r AddNotificationChannelsRequest) Send(ctx context.Context) (*AddNotificationChannelsResponse, error)
Send marshals and sends the AddNotificationChannels API request.
type AddNotificationChannelsResponse ¶ added in v0.24.0
type AddNotificationChannelsResponse struct { *AddNotificationChannelsOutput // contains filtered or unexported fields }
AddNotificationChannelsResponse is the response type for the AddNotificationChannels API operation.
func (*AddNotificationChannelsResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *AddNotificationChannelsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddNotificationChannels request.
type AgentConfiguration ¶
type AgentConfiguration struct { // Parameters used by the profiler. The valid parameters are: // // * MaxStackDepth - The maximum depth of the stacks in the code that is // represented in the profile. For example, if CodeGuru Profiler finds a // method A, which calls method B, which calls method C, which calls method // D, then the depth is 4. If the maxDepth is set to 2, then the profiler // evaluates A and B. // // * MemoryUsageLimitPercent - The percentage of memory that is used by the // profiler. // // * MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds // between sending reports. // // * ReportingIntervalInMilliseconds - The reporting interval in milliseconds // used to report profiles. // // * SamplingIntervalInMilliseconds - The sampling interval in milliseconds // that is used to profile samples. AgentParameters map[string]string `locationName:"agentParameters" type:"map"` // How long a profiling agent should send profiling data using ConfigureAgent // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html). // For example, if this is set to 300, the profiling agent calls ConfigureAgent // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) // every 5 minutes to submit the profiled data collected during that period. // // PeriodInSeconds is a required field PeriodInSeconds *int64 `locationName:"periodInSeconds" type:"integer" required:"true"` // A Boolean that specifies whether the profiling agent collects profiling data // or not. Set to true to enable profiling. // // ShouldProfile is a required field ShouldProfile *bool `locationName:"shouldProfile" type:"boolean" required:"true"` // contains filtered or unexported fields }
The response of ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) that specifies if an agent profiles or not and for how long to return profiling data.
func (AgentConfiguration) MarshalFields ¶
func (s AgentConfiguration) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AgentConfiguration) String ¶
func (s AgentConfiguration) String() string
String returns the string representation
type AgentOrchestrationConfig ¶
type AgentOrchestrationConfig struct { // A Boolean that specifies whether the profiling agent collects profiling data // or not. Set to true to enable profiling. // // ProfilingEnabled is a required field ProfilingEnabled *bool `locationName:"profilingEnabled" type:"boolean" required:"true"` // contains filtered or unexported fields }
Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html) to enable or disable profiling for a profiling group.
func (AgentOrchestrationConfig) MarshalFields ¶
func (s AgentOrchestrationConfig) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AgentOrchestrationConfig) String ¶
func (s AgentOrchestrationConfig) String() string
String returns the string representation
func (*AgentOrchestrationConfig) Validate ¶
func (s *AgentOrchestrationConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AgentParameterField ¶ added in v0.24.0
type AgentParameterField string
const ( AgentParameterFieldMaxStackDepth AgentParameterField = "MaxStackDepth" AgentParameterFieldMemoryUsageLimitPercent AgentParameterField = "MemoryUsageLimitPercent" AgentParameterFieldMinimumTimeForReportingInMilliseconds AgentParameterField = "MinimumTimeForReportingInMilliseconds" AgentParameterFieldReportingIntervalInMilliseconds AgentParameterField = "ReportingIntervalInMilliseconds" AgentParameterFieldSamplingIntervalInMilliseconds AgentParameterField = "SamplingIntervalInMilliseconds" )
Enum values for AgentParameterField
func (AgentParameterField) MarshalValue ¶ added in v0.24.0
func (enum AgentParameterField) MarshalValue() (string, error)
func (AgentParameterField) MarshalValueBuf ¶ added in v0.24.0
func (enum AgentParameterField) MarshalValueBuf(b []byte) ([]byte, error)
type AggregatedProfileTime ¶
type AggregatedProfileTime struct { // The aggregation period. This indicates the period during which an aggregation // profile collects posted agent profiles for a profiling group. Use one of // three valid durations that are specified using the ISO 8601 format. // // * P1D — 1 day // // * PT1H — 1 hour // // * PT5M — 5 minutes Period AggregationPeriod `locationName:"period" type:"string" enum:"true"` // The time that aggregation of posted agent profiles for a profiling group // starts. The aggregation profile contains profiles posted by the agent starting // at this time for an aggregation period specified by the period property of // the AggregatedProfileTime object. // // Specify start using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. Start *time.Time `locationName:"start" type:"timestamp" timestampFormat:"iso8601"` // contains filtered or unexported fields }
Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an aggregation period. There are three possible aggregation periods (1 day, 1 hour, or 5 minutes).
func (AggregatedProfileTime) MarshalFields ¶
func (s AggregatedProfileTime) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AggregatedProfileTime) String ¶
func (s AggregatedProfileTime) String() string
String returns the string representation
type AggregationPeriod ¶
type AggregationPeriod string
const ( AggregationPeriodP1d AggregationPeriod = "P1D" AggregationPeriodPt1h AggregationPeriod = "PT1H" AggregationPeriodPt5m AggregationPeriod = "PT5M" )
Enum values for AggregationPeriod
func (AggregationPeriod) MarshalValue ¶
func (enum AggregationPeriod) MarshalValue() (string, error)
func (AggregationPeriod) MarshalValueBuf ¶
func (enum AggregationPeriod) MarshalValueBuf(b []byte) ([]byte, error)
type Anomaly ¶ added in v0.24.0
type Anomaly struct { // A list of the instances of the detected anomalies during the requested period. // // Instances is a required field Instances []AnomalyInstance `locationName:"instances" type:"list" required:"true"` // Details about the metric that the analysis used when it detected the anomaly. // The metric includes the name of the frame that was analyzed with the type // and thread states used to derive the metric value for that frame. // // Metric is a required field Metric *Metric `locationName:"metric" type:"structure" required:"true"` // The reason for which metric was flagged as anomalous. // // Reason is a required field Reason *string `locationName:"reason" type:"string" required:"true"` // contains filtered or unexported fields }
Details about an anomaly in a specific metric of application profile. The anomaly is detected using analysis of the metric data over a period of time.
func (Anomaly) MarshalFields ¶ added in v0.24.0
func (s Anomaly) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type AnomalyInstance ¶ added in v0.24.0
type AnomalyInstance struct { // The end time of the period during which the metric is flagged as anomalous. // This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` // The universally unique identifier (UUID) of an instance of an anomaly in // a metric. // // Id is a required field Id *string `locationName:"id" type:"string" required:"true"` // The start time of the period during which the metric is flagged as anomalous. // This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // Feedback type on a specific instance of anomaly submitted by the user. UserFeedback *UserFeedback `locationName:"userFeedback" type:"structure"` // contains filtered or unexported fields }
The specific duration in which the metric is flagged as anomalous.
func (AnomalyInstance) MarshalFields ¶ added in v0.24.0
func (s AnomalyInstance) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (AnomalyInstance) String ¶ added in v0.24.0
func (s AnomalyInstance) String() string
String returns the string representation
type BatchGetFrameMetricDataInput ¶ added in v0.24.0
type BatchGetFrameMetricDataInput struct { // The end time of the time period for the returned time series values. This // is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` // The details of the metrics that are used to request a time series of values. // The metric includes the name of the frame, the aggregation type to calculate // the metric value for the frame, and the thread states to use to get the count // for the metric value of the frame. FrameMetrics []FrameMetric `locationName:"frameMetrics" type:"list"` // The duration of the frame metrics used to return the time series values. // Specify using the ISO 8601 format. The maximum period duration is one day // (PT24H or P1D). Period *string `location:"querystring" locationName:"period" min:"1" type:"string"` // The name of the profiling group associated with the the frame metrics used // to return the time series values. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The start time of the time period for the frame metrics used to return the // time series values. This is specified using the ISO 8601 format. For example, // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 // PM UTC. StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` // The requested resolution of time steps for the returned time series of values. // If the requested target resolution is not available due to data not being // retained we provide a best effort result by falling back to the most granular // available resolution after the target resolution. There are 3 valid values. // // * P1D — 1 day // // * PT1H — 1 hour // // * PT5M — 5 minutes TargetResolution AggregationPeriod `location:"querystring" locationName:"targetResolution" type:"string" enum:"true"` // contains filtered or unexported fields }
The structure representing the BatchGetFrameMetricDataRequest.
func (BatchGetFrameMetricDataInput) MarshalFields ¶ added in v0.24.0
func (s BatchGetFrameMetricDataInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BatchGetFrameMetricDataInput) String ¶ added in v0.24.0
func (s BatchGetFrameMetricDataInput) String() string
String returns the string representation
func (*BatchGetFrameMetricDataInput) Validate ¶ added in v0.24.0
func (s *BatchGetFrameMetricDataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetFrameMetricDataOutput ¶ added in v0.24.0
type BatchGetFrameMetricDataOutput struct { // The end time of the time period for the returned time series values. This // is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // EndTime is a required field EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // List of instances, or time steps, in the time series. For example, if the // period is one day (PT24H)), and the resolution is five minutes (PT5M), then // there are 288 endTimes in the list that are each five minutes appart. // // EndTimes is a required field EndTimes []TimestampStructure `locationName:"endTimes" type:"list" required:"true"` // Details of the metrics to request a time series of values. The metric includes // the name of the frame, the aggregation type to calculate the metric value // for the frame, and the thread states to use to get the count for the metric // value of the frame. // // FrameMetricData is a required field FrameMetricData []FrameMetricDatum `locationName:"frameMetricData" type:"list" required:"true"` // Resolution or granularity of the profile data used to generate the time series. // This is the value used to jump through time steps in a time series. There // are 3 valid values. // // * P1D — 1 day // // * PT1H — 1 hour // // * PT5M — 5 minutes // // Resolution is a required field Resolution AggregationPeriod `locationName:"resolution" type:"string" required:"true" enum:"true"` // The start time of the time period for the returned time series values. This // is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // List of instances which remained unprocessed. This will create a missing // time step in the list of end times. // // UnprocessedEndTimes is a required field UnprocessedEndTimes map[string][]TimestampStructure `locationName:"unprocessedEndTimes" type:"map" required:"true"` // contains filtered or unexported fields }
The structure representing the BatchGetFrameMetricDataResponse.
func (BatchGetFrameMetricDataOutput) MarshalFields ¶ added in v0.24.0
func (s BatchGetFrameMetricDataOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (BatchGetFrameMetricDataOutput) String ¶ added in v0.24.0
func (s BatchGetFrameMetricDataOutput) String() string
String returns the string representation
type BatchGetFrameMetricDataRequest ¶ added in v0.24.0
type BatchGetFrameMetricDataRequest struct { *aws.Request Input *BatchGetFrameMetricDataInput Copy func(*BatchGetFrameMetricDataInput) BatchGetFrameMetricDataRequest }
BatchGetFrameMetricDataRequest is the request type for the BatchGetFrameMetricData API operation.
func (BatchGetFrameMetricDataRequest) Send ¶ added in v0.24.0
func (r BatchGetFrameMetricDataRequest) Send(ctx context.Context) (*BatchGetFrameMetricDataResponse, error)
Send marshals and sends the BatchGetFrameMetricData API request.
type BatchGetFrameMetricDataResponse ¶ added in v0.24.0
type BatchGetFrameMetricDataResponse struct { *BatchGetFrameMetricDataOutput // contains filtered or unexported fields }
BatchGetFrameMetricDataResponse is the response type for the BatchGetFrameMetricData API operation.
func (*BatchGetFrameMetricDataResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *BatchGetFrameMetricDataResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the BatchGetFrameMetricData request.
type Channel ¶ added in v0.24.0
type Channel struct { // List of publishers for different type of events that may be detected in an // application from the profile. Anomaly detection is the only event publisher // in Profiler. // // EventPublishers is a required field EventPublishers []EventPublisher `locationName:"eventPublishers" min:"1" type:"list" required:"true"` // Unique identifier for each Channel in the notification configuration of a // Profiling Group. A random UUID for channelId is used when adding a channel // to the notification configuration if not specified in the request. Id *string `locationName:"id" type:"string"` // Unique arn of the resource to be used for notifications. We support a valid // SNS topic arn as a channel uri. // // Uri is a required field Uri *string `locationName:"uri" type:"string" required:"true"` // contains filtered or unexported fields }
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
func (Channel) MarshalFields ¶ added in v0.24.0
func (s Channel) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type Client ¶
Client provides the API operation methods for making requests to Amazon CodeGuru Profiler. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := codeguruprofiler.New(myConfig)
func (*Client) AddNotificationChannelsRequest ¶ added in v0.24.0
func (c *Client) AddNotificationChannelsRequest(input *AddNotificationChannelsInput) AddNotificationChannelsRequest
AddNotificationChannelsRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Add up to 2 anomaly notifications channels for a profiling group.
// Example sending a request using AddNotificationChannelsRequest. req := client.AddNotificationChannelsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/AddNotificationChannels
func (*Client) BatchGetFrameMetricDataRequest ¶ added in v0.24.0
func (c *Client) BatchGetFrameMetricDataRequest(input *BatchGetFrameMetricDataInput) BatchGetFrameMetricDataRequest
BatchGetFrameMetricDataRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns the time series of values for a requested list of frame metrics from a time period.
// Example sending a request using BatchGetFrameMetricDataRequest. req := client.BatchGetFrameMetricDataRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/BatchGetFrameMetricData
func (*Client) ConfigureAgentRequest ¶
func (c *Client) ConfigureAgentRequest(input *ConfigureAgentInput) ConfigureAgentRequest
ConfigureAgentRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell and agent whether to profile or not and for how long to return profiling data.
// Example sending a request using ConfigureAgentRequest. req := client.ConfigureAgentRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ConfigureAgent
func (*Client) CreateProfilingGroupRequest ¶
func (c *Client) CreateProfilingGroupRequest(input *CreateProfilingGroupInput) CreateProfilingGroupRequest
CreateProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Creates a profiling group.
// Example sending a request using CreateProfilingGroupRequest. req := client.CreateProfilingGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/CreateProfilingGroup
func (*Client) DeleteProfilingGroupRequest ¶
func (c *Client) DeleteProfilingGroupRequest(input *DeleteProfilingGroupInput) DeleteProfilingGroupRequest
DeleteProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Deletes a profiling group.
// Example sending a request using DeleteProfilingGroupRequest. req := client.DeleteProfilingGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DeleteProfilingGroup
func (*Client) DescribeProfilingGroupRequest ¶
func (c *Client) DescribeProfilingGroupRequest(input *DescribeProfilingGroupInput) DescribeProfilingGroupRequest
DescribeProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns a ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) object that contains information about the requested profiling group.
// Example sending a request using DescribeProfilingGroupRequest. req := client.DescribeProfilingGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DescribeProfilingGroup
func (*Client) GetFindingsReportAccountSummaryRequest ¶ added in v0.24.0
func (c *Client) GetFindingsReportAccountSummaryRequest(input *GetFindingsReportAccountSummaryInput) GetFindingsReportAccountSummaryRequest
GetFindingsReportAccountSummaryRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns a list of FindingsReportSummary (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html) objects that contain analysis results for all profiling groups in your AWS account.
// Example sending a request using GetFindingsReportAccountSummaryRequest. req := client.GetFindingsReportAccountSummaryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetFindingsReportAccountSummary
func (*Client) GetNotificationConfigurationRequest ¶ added in v0.24.0
func (c *Client) GetNotificationConfigurationRequest(input *GetNotificationConfigurationInput) GetNotificationConfigurationRequest
GetNotificationConfigurationRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Get the current configuration for anomaly notifications for a profiling group.
// Example sending a request using GetNotificationConfigurationRequest. req := client.GetNotificationConfigurationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetNotificationConfiguration
func (*Client) GetPolicyRequest ¶ added in v0.21.0
func (c *Client) GetPolicyRequest(input *GetPolicyInput) GetPolicyRequest
GetPolicyRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns the JSON-formatted resource-based policy on a profiling group.
// Example sending a request using GetPolicyRequest. req := client.GetPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetPolicy
func (*Client) GetProfileRequest ¶
func (c *Client) GetProfileRequest(input *GetProfileInput) GetProfileRequest
GetProfileRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles.
<note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol> // Example sending a request using GetProfileRequest. req := client.GetProfileRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetProfile
func (*Client) GetRecommendationsRequest ¶ added in v0.24.0
func (c *Client) GetRecommendationsRequest(input *GetRecommendationsInput) GetRecommendationsRequest
GetRecommendationsRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns a list of Recommendation (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html) objects that contain recommendations for a profiling group for a given time period. A list of Anomaly (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html) objects that contains details about anomalies detected in the profiling group for the same time period is also returned.
// Example sending a request using GetRecommendationsRequest. req := client.GetRecommendationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetRecommendations
func (*Client) ListFindingsReportsRequest ¶ added in v0.24.0
func (c *Client) ListFindingsReportsRequest(input *ListFindingsReportsInput) ListFindingsReportsRequest
ListFindingsReportsRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
List the available reports for a given profiling group and time range.
// Example sending a request using ListFindingsReportsRequest. req := client.ListFindingsReportsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListFindingsReports
func (*Client) ListProfileTimesRequest ¶
func (c *Client) ListProfileTimesRequest(input *ListProfileTimesInput) ListProfileTimesRequest
ListProfileTimesRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
// Example sending a request using ListProfileTimesRequest. req := client.ListProfileTimesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfileTimes
func (*Client) ListProfilingGroupsRequest ¶
func (c *Client) ListProfilingGroupsRequest(input *ListProfilingGroupsInput) ListProfilingGroupsRequest
ListProfilingGroupsRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) objects.
// Example sending a request using ListProfilingGroupsRequest. req := client.ListProfilingGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfilingGroups
func (*Client) ListTagsForResourceRequest ¶ added in v0.24.0
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Returns a list of the tags that are assigned to a specified resource.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListTagsForResource
func (*Client) PostAgentProfileRequest ¶
func (c *Client) PostAgentProfileRequest(input *PostAgentProfileInput) PostAgentProfileRequest
PostAgentProfileRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_GetProfile.html).
// Example sending a request using PostAgentProfileRequest. req := client.PostAgentProfileRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/PostAgentProfile
func (*Client) PutPermissionRequest ¶ added in v0.21.0
func (c *Client) PutPermissionRequest(input *PutPermissionInput) PutPermissionRequest
PutPermissionRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter.
<p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p> // Example sending a request using PutPermissionRequest. req := client.PutPermissionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/PutPermission
func (*Client) RemoveNotificationChannelRequest ¶ added in v0.24.0
func (c *Client) RemoveNotificationChannelRequest(input *RemoveNotificationChannelInput) RemoveNotificationChannelRequest
RemoveNotificationChannelRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Remove one anomaly notifications channel for a profiling group.
// Example sending a request using RemoveNotificationChannelRequest. req := client.RemoveNotificationChannelRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/RemoveNotificationChannel
func (*Client) RemovePermissionRequest ¶ added in v0.21.0
func (c *Client) RemovePermissionRequest(input *RemovePermissionInput) RemovePermissionRequest
RemovePermissionRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler (https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the Amazon CodeGuru Profiler User Guide, ConfigureAgent (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and PostAgentProfile (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html).
// Example sending a request using RemovePermissionRequest. req := client.RemovePermissionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/RemovePermission
func (*Client) SubmitFeedbackRequest ¶ added in v0.24.0
func (c *Client) SubmitFeedbackRequest(input *SubmitFeedbackInput) SubmitFeedbackRequest
SubmitFeedbackRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
// Example sending a request using SubmitFeedbackRequest. req := client.SubmitFeedbackRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/SubmitFeedback
func (*Client) TagResourceRequest ¶ added in v0.24.0
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Use to assign one or more tags to a resource.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/TagResource
func (*Client) UntagResourceRequest ¶ added in v0.24.0
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Use to remove one or more tags from a resource.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/UntagResource
func (*Client) UpdateProfilingGroupRequest ¶
func (c *Client) UpdateProfilingGroupRequest(input *UpdateProfilingGroupInput) UpdateProfilingGroupRequest
UpdateProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.
Updates a profiling group.
// Example sending a request using UpdateProfilingGroupRequest. req := client.UpdateProfilingGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/UpdateProfilingGroup
type ComputePlatform ¶ added in v0.24.0
type ComputePlatform string
const ( ComputePlatformAwslambda ComputePlatform = "AWSLambda" ComputePlatformDefault ComputePlatform = "Default" )
Enum values for ComputePlatform
func (ComputePlatform) MarshalValue ¶ added in v0.24.0
func (enum ComputePlatform) MarshalValue() (string, error)
func (ComputePlatform) MarshalValueBuf ¶ added in v0.24.0
func (enum ComputePlatform) MarshalValueBuf(b []byte) ([]byte, error)
type ConfigureAgentInput ¶
type ConfigureAgentInput struct { // A universally unique identifier (UUID) for a profiling instance. For example, // if the profiling instance is an Amazon EC2 instance, it is the instance ID. // If it is an AWS Fargate container, it is the container's task ID. FleetInstanceId *string `locationName:"fleetInstanceId" min:"1" type:"string"` // Metadata captured about the compute platform the agent is running on. It // includes information about sampling and reporting. The valid fields are: // // * COMPUTE_PLATFORM - The compute platform on which the agent is running // // * AGENT_ID - The ID for an agent instance. // // * AWS_REQUEST_ID - The AWS request ID of a Lambda invocation. // // * EXECUTION_ENVIRONMENT - The execution environment a Lambda function // is running on. // // * LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to // invoke a Lambda function. // // * LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function. // // * LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before // execution of a Lambda function times out. // // * LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds // between two invocations of a Lambda function. // // * LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds // for the previous Lambda invocation. Metadata map[string]string `locationName:"metadata" type:"map"` // The name of the profiling group for which the configured agent is collecting // profiling data. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the configureAgentRequest.
func (ConfigureAgentInput) MarshalFields ¶
func (s ConfigureAgentInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ConfigureAgentInput) String ¶
func (s ConfigureAgentInput) String() string
String returns the string representation
func (*ConfigureAgentInput) Validate ¶
func (s *ConfigureAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConfigureAgentOutput ¶
type ConfigureAgentOutput struct { // An AgentConfiguration (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html) // object that specifies if an agent profiles or not and for how long to return // profiling data. // // Configuration is a required field Configuration *AgentConfiguration `locationName:"configuration" type:"structure" required:"true"` // contains filtered or unexported fields }
The structure representing the configureAgentResponse.
func (ConfigureAgentOutput) MarshalFields ¶
func (s ConfigureAgentOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ConfigureAgentOutput) String ¶
func (s ConfigureAgentOutput) String() string
String returns the string representation
type ConfigureAgentRequest ¶
type ConfigureAgentRequest struct { *aws.Request Input *ConfigureAgentInput Copy func(*ConfigureAgentInput) ConfigureAgentRequest }
ConfigureAgentRequest is the request type for the ConfigureAgent API operation.
func (ConfigureAgentRequest) Send ¶
func (r ConfigureAgentRequest) Send(ctx context.Context) (*ConfigureAgentResponse, error)
Send marshals and sends the ConfigureAgent API request.
type ConfigureAgentResponse ¶
type ConfigureAgentResponse struct { *ConfigureAgentOutput // contains filtered or unexported fields }
ConfigureAgentResponse is the response type for the ConfigureAgent API operation.
func (*ConfigureAgentResponse) SDKResponseMetdata ¶
func (r *ConfigureAgentResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ConfigureAgent request.
type CreateProfilingGroupInput ¶
type CreateProfilingGroupInput struct { // Specifies whether profiling is enabled or disabled for the created profiling // group. AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure"` // Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to // prevent the accidental creation of duplicate profiling groups if there are // failures and retries. // // ClientToken is a required field ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" required:"true" idempotencyToken:"true"` // The compute platform of the profiling group. Use AWSLambda if your application // runs on AWS Lambda. Use Default if your application runs on a compute platform // that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, // or a different platform. If not specified, Default is used. ComputePlatform ComputePlatform `locationName:"computePlatform" type:"string" enum:"true"` // The name of the profiling group to create. // // ProfilingGroupName is a required field ProfilingGroupName *string `locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // A list of tags to add to the created profiling group. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
The structure representing the createProfiliingGroupRequest.
func (CreateProfilingGroupInput) MarshalFields ¶
func (s CreateProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateProfilingGroupInput) String ¶
func (s CreateProfilingGroupInput) String() string
String returns the string representation
func (*CreateProfilingGroupInput) Validate ¶
func (s *CreateProfilingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateProfilingGroupOutput ¶
type CreateProfilingGroupOutput struct { // The returned ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // object that contains information about the created profiling group. // // ProfilingGroup is a required field ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"` // contains filtered or unexported fields }
The structure representing the createProfilingGroupResponse.
func (CreateProfilingGroupOutput) MarshalFields ¶
func (s CreateProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateProfilingGroupOutput) String ¶
func (s CreateProfilingGroupOutput) String() string
String returns the string representation
type CreateProfilingGroupRequest ¶
type CreateProfilingGroupRequest struct { *aws.Request Input *CreateProfilingGroupInput Copy func(*CreateProfilingGroupInput) CreateProfilingGroupRequest }
CreateProfilingGroupRequest is the request type for the CreateProfilingGroup API operation.
func (CreateProfilingGroupRequest) Send ¶
func (r CreateProfilingGroupRequest) Send(ctx context.Context) (*CreateProfilingGroupResponse, error)
Send marshals and sends the CreateProfilingGroup API request.
type CreateProfilingGroupResponse ¶
type CreateProfilingGroupResponse struct { *CreateProfilingGroupOutput // contains filtered or unexported fields }
CreateProfilingGroupResponse is the response type for the CreateProfilingGroup API operation.
func (*CreateProfilingGroupResponse) SDKResponseMetdata ¶
func (r *CreateProfilingGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateProfilingGroup request.
type DeleteProfilingGroupInput ¶
type DeleteProfilingGroupInput struct { // The name of the profiling group to delete. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the deleteProfilingGroupRequest.
func (DeleteProfilingGroupInput) MarshalFields ¶
func (s DeleteProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteProfilingGroupInput) String ¶
func (s DeleteProfilingGroupInput) String() string
String returns the string representation
func (*DeleteProfilingGroupInput) Validate ¶
func (s *DeleteProfilingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteProfilingGroupOutput ¶
type DeleteProfilingGroupOutput struct {
// contains filtered or unexported fields
}
The structure representing the deleteProfilingGroupResponse.
func (DeleteProfilingGroupOutput) MarshalFields ¶
func (s DeleteProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteProfilingGroupOutput) String ¶
func (s DeleteProfilingGroupOutput) String() string
String returns the string representation
type DeleteProfilingGroupRequest ¶
type DeleteProfilingGroupRequest struct { *aws.Request Input *DeleteProfilingGroupInput Copy func(*DeleteProfilingGroupInput) DeleteProfilingGroupRequest }
DeleteProfilingGroupRequest is the request type for the DeleteProfilingGroup API operation.
func (DeleteProfilingGroupRequest) Send ¶
func (r DeleteProfilingGroupRequest) Send(ctx context.Context) (*DeleteProfilingGroupResponse, error)
Send marshals and sends the DeleteProfilingGroup API request.
type DeleteProfilingGroupResponse ¶
type DeleteProfilingGroupResponse struct { *DeleteProfilingGroupOutput // contains filtered or unexported fields }
DeleteProfilingGroupResponse is the response type for the DeleteProfilingGroup API operation.
func (*DeleteProfilingGroupResponse) SDKResponseMetdata ¶
func (r *DeleteProfilingGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteProfilingGroup request.
type DescribeProfilingGroupInput ¶
type DescribeProfilingGroupInput struct { // The name of the profiling group to get information about. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the describeProfilingGroupRequest.
func (DescribeProfilingGroupInput) MarshalFields ¶
func (s DescribeProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeProfilingGroupInput) String ¶
func (s DescribeProfilingGroupInput) String() string
String returns the string representation
func (*DescribeProfilingGroupInput) Validate ¶
func (s *DescribeProfilingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeProfilingGroupOutput ¶
type DescribeProfilingGroupOutput struct { // The returned ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // object that contains information about the requested profiling group. // // ProfilingGroup is a required field ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"` // contains filtered or unexported fields }
The structure representing the describeProfilingGroupResponse.
func (DescribeProfilingGroupOutput) MarshalFields ¶
func (s DescribeProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeProfilingGroupOutput) String ¶
func (s DescribeProfilingGroupOutput) String() string
String returns the string representation
type DescribeProfilingGroupRequest ¶
type DescribeProfilingGroupRequest struct { *aws.Request Input *DescribeProfilingGroupInput Copy func(*DescribeProfilingGroupInput) DescribeProfilingGroupRequest }
DescribeProfilingGroupRequest is the request type for the DescribeProfilingGroup API operation.
func (DescribeProfilingGroupRequest) Send ¶
func (r DescribeProfilingGroupRequest) Send(ctx context.Context) (*DescribeProfilingGroupResponse, error)
Send marshals and sends the DescribeProfilingGroup API request.
type DescribeProfilingGroupResponse ¶
type DescribeProfilingGroupResponse struct { *DescribeProfilingGroupOutput // contains filtered or unexported fields }
DescribeProfilingGroupResponse is the response type for the DescribeProfilingGroup API operation.
func (*DescribeProfilingGroupResponse) SDKResponseMetdata ¶
func (r *DescribeProfilingGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeProfilingGroup request.
type EventPublisher ¶ added in v0.24.0
type EventPublisher string
const (
EventPublisherAnomalyDetection EventPublisher = "AnomalyDetection"
)
Enum values for EventPublisher
func (EventPublisher) MarshalValue ¶ added in v0.24.0
func (enum EventPublisher) MarshalValue() (string, error)
func (EventPublisher) MarshalValueBuf ¶ added in v0.24.0
func (enum EventPublisher) MarshalValueBuf(b []byte) ([]byte, error)
type FeedbackType ¶ added in v0.24.0
type FeedbackType string
const ( FeedbackTypeNegative FeedbackType = "Negative" FeedbackTypePositive FeedbackType = "Positive" )
Enum values for FeedbackType
func (FeedbackType) MarshalValue ¶ added in v0.24.0
func (enum FeedbackType) MarshalValue() (string, error)
func (FeedbackType) MarshalValueBuf ¶ added in v0.24.0
func (enum FeedbackType) MarshalValueBuf(b []byte) ([]byte, error)
type FindingsReportSummary ¶ added in v0.24.0
type FindingsReportSummary struct { // The universally unique identifier (UUID) of the recommendation report. Id *string `locationName:"id" type:"string"` // The end time of the period during which the metric is flagged as anomalous. // This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. ProfileEndTime *time.Time `locationName:"profileEndTime" type:"timestamp" timestampFormat:"iso8601"` // The start time of the profile the analysis data is about. This is specified // using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents // 1 millisecond past June 1, 2020 1:15:02 PM UTC. ProfileStartTime *time.Time `locationName:"profileStartTime" type:"timestamp" timestampFormat:"iso8601"` // The name of the profiling group that is associated with the analysis data. ProfilingGroupName *string `locationName:"profilingGroupName" type:"string"` // The total number of different recommendations that were found by the analysis. TotalNumberOfFindings *int64 `locationName:"totalNumberOfFindings" type:"integer"` // contains filtered or unexported fields }
Information about potential recommendations that might be created from the analysis of profiling data.
func (FindingsReportSummary) MarshalFields ¶ added in v0.24.0
func (s FindingsReportSummary) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FindingsReportSummary) String ¶ added in v0.24.0
func (s FindingsReportSummary) String() string
String returns the string representation
type FrameMetric ¶ added in v0.24.0
type FrameMetric struct { // Name of the method common across the multiple occurrences of a frame in an // application profile. // // FrameName is a required field FrameName *string `locationName:"frameName" type:"string" required:"true"` // List of application runtime thread states used to get the counts for a frame // a derive a metric value. // // ThreadStates is a required field ThreadStates []string `locationName:"threadStates" type:"list" required:"true"` // A type of aggregation that specifies how a metric for a frame is analyzed. // The supported value AggregatedRelativeTotalTime is an aggregation of the // metric value for one frame that is calculated across the occurrences of all // frames in a profile. // // Type is a required field Type MetricType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
func (FrameMetric) MarshalFields ¶ added in v0.24.0
func (s FrameMetric) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FrameMetric) String ¶ added in v0.24.0
func (s FrameMetric) String() string
String returns the string representation
func (*FrameMetric) Validate ¶ added in v0.24.0
func (s *FrameMetric) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type FrameMetricDatum ¶ added in v0.24.0
type FrameMetricDatum struct { // The frame name, metric type, and thread states. These are used to derive // the value of the metric for the frame. // // FrameMetric is a required field FrameMetric *FrameMetric `locationName:"frameMetric" type:"structure" required:"true"` // A list of values that are associated with a frame metric. // // Values is a required field Values []float64 `locationName:"values" type:"list" required:"true"` // contains filtered or unexported fields }
Information about a frame metric and its values.
func (FrameMetricDatum) MarshalFields ¶ added in v0.24.0
func (s FrameMetricDatum) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (FrameMetricDatum) String ¶ added in v0.24.0
func (s FrameMetricDatum) String() string
String returns the string representation
type GetFindingsReportAccountSummaryInput ¶ added in v0.24.0
type GetFindingsReportAccountSummaryInput struct { // A Boolean value indicating whether to only return reports from daily profiles. // If set to True, only analysis data from daily profiles is returned. If set // to False, analysis data is returned from smaller time windows (for example, // one hour). DailyReportsOnly *bool `location:"querystring" locationName:"dailyReportsOnly" type:"boolean"` // The maximum number of results returned by GetFindingsReportAccountSummary // in paginated output. When this parameter is used, GetFindingsReportAccountSummary // only returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another GetFindingsReportAccountSummary request with the returned nextToken // value. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The nextToken value returned from a previous paginated GetFindingsReportAccountSummary // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
The structure representing the GetFindingsReportAccountSummaryRequest.
func (GetFindingsReportAccountSummaryInput) MarshalFields ¶ added in v0.24.0
func (s GetFindingsReportAccountSummaryInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetFindingsReportAccountSummaryInput) String ¶ added in v0.24.0
func (s GetFindingsReportAccountSummaryInput) String() string
String returns the string representation
func (*GetFindingsReportAccountSummaryInput) Validate ¶ added in v0.24.0
func (s *GetFindingsReportAccountSummaryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetFindingsReportAccountSummaryOutput ¶ added in v0.24.0
type GetFindingsReportAccountSummaryOutput struct { // The nextToken value to include in a future GetFindingsReportAccountSummary // request. When the results of a GetFindingsReportAccountSummary request exceed // maxResults, this value can be used to retrieve the next page of results. // This value is null when there are no more results to return. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The return list of FindingsReportSummary (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html) // objects taht contain summaries of analysis results for all profiling groups // in your AWS account. // // ReportSummaries is a required field ReportSummaries []FindingsReportSummary `locationName:"reportSummaries" type:"list" required:"true"` // contains filtered or unexported fields }
The structure representing the GetFindingsReportAccountSummaryResponse.
func (GetFindingsReportAccountSummaryOutput) MarshalFields ¶ added in v0.24.0
func (s GetFindingsReportAccountSummaryOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetFindingsReportAccountSummaryOutput) String ¶ added in v0.24.0
func (s GetFindingsReportAccountSummaryOutput) String() string
String returns the string representation
type GetFindingsReportAccountSummaryPaginator ¶ added in v0.24.0
GetFindingsReportAccountSummaryPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewGetFindingsReportAccountSummaryPaginator ¶ added in v0.24.0
func NewGetFindingsReportAccountSummaryPaginator(req GetFindingsReportAccountSummaryRequest) GetFindingsReportAccountSummaryPaginator
NewGetFindingsReportAccountSummaryRequestPaginator returns a paginator for GetFindingsReportAccountSummary. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.GetFindingsReportAccountSummaryRequest(input) p := codeguruprofiler.NewGetFindingsReportAccountSummaryRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*GetFindingsReportAccountSummaryPaginator) CurrentPage ¶ added in v0.24.0
func (p *GetFindingsReportAccountSummaryPaginator) CurrentPage() *GetFindingsReportAccountSummaryOutput
type GetFindingsReportAccountSummaryRequest ¶ added in v0.24.0
type GetFindingsReportAccountSummaryRequest struct { *aws.Request Input *GetFindingsReportAccountSummaryInput Copy func(*GetFindingsReportAccountSummaryInput) GetFindingsReportAccountSummaryRequest }
GetFindingsReportAccountSummaryRequest is the request type for the GetFindingsReportAccountSummary API operation.
func (GetFindingsReportAccountSummaryRequest) Send ¶ added in v0.24.0
func (r GetFindingsReportAccountSummaryRequest) Send(ctx context.Context) (*GetFindingsReportAccountSummaryResponse, error)
Send marshals and sends the GetFindingsReportAccountSummary API request.
type GetFindingsReportAccountSummaryResponse ¶ added in v0.24.0
type GetFindingsReportAccountSummaryResponse struct { *GetFindingsReportAccountSummaryOutput // contains filtered or unexported fields }
GetFindingsReportAccountSummaryResponse is the response type for the GetFindingsReportAccountSummary API operation.
func (*GetFindingsReportAccountSummaryResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *GetFindingsReportAccountSummaryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetFindingsReportAccountSummary request.
type GetNotificationConfigurationInput ¶ added in v0.24.0
type GetNotificationConfigurationInput struct { // The name of the profiling group we want to get the notification configuration // for. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the GetNotificationConfigurationRequest.
func (GetNotificationConfigurationInput) MarshalFields ¶ added in v0.24.0
func (s GetNotificationConfigurationInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetNotificationConfigurationInput) String ¶ added in v0.24.0
func (s GetNotificationConfigurationInput) String() string
String returns the string representation
func (*GetNotificationConfigurationInput) Validate ¶ added in v0.24.0
func (s *GetNotificationConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetNotificationConfigurationOutput ¶ added in v0.24.0
type GetNotificationConfigurationOutput struct { // The current notification configuration for this profiling group. // // NotificationConfiguration is a required field NotificationConfiguration *NotificationConfiguration `locationName:"notificationConfiguration" type:"structure" required:"true"` // contains filtered or unexported fields }
The structure representing the GetNotificationConfigurationResponse.
func (GetNotificationConfigurationOutput) MarshalFields ¶ added in v0.24.0
func (s GetNotificationConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetNotificationConfigurationOutput) String ¶ added in v0.24.0
func (s GetNotificationConfigurationOutput) String() string
String returns the string representation
type GetNotificationConfigurationRequest ¶ added in v0.24.0
type GetNotificationConfigurationRequest struct { *aws.Request Input *GetNotificationConfigurationInput Copy func(*GetNotificationConfigurationInput) GetNotificationConfigurationRequest }
GetNotificationConfigurationRequest is the request type for the GetNotificationConfiguration API operation.
func (GetNotificationConfigurationRequest) Send ¶ added in v0.24.0
func (r GetNotificationConfigurationRequest) Send(ctx context.Context) (*GetNotificationConfigurationResponse, error)
Send marshals and sends the GetNotificationConfiguration API request.
type GetNotificationConfigurationResponse ¶ added in v0.24.0
type GetNotificationConfigurationResponse struct { *GetNotificationConfigurationOutput // contains filtered or unexported fields }
GetNotificationConfigurationResponse is the response type for the GetNotificationConfiguration API operation.
func (*GetNotificationConfigurationResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *GetNotificationConfigurationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetNotificationConfiguration request.
type GetPolicyInput ¶ added in v0.21.0
type GetPolicyInput struct { // The name of the profiling group. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the getPolicyRequest.
func (GetPolicyInput) MarshalFields ¶ added in v0.21.0
func (s GetPolicyInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetPolicyInput) String ¶ added in v0.21.0
func (s GetPolicyInput) String() string
String returns the string representation
func (*GetPolicyInput) Validate ¶ added in v0.21.0
func (s *GetPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPolicyOutput ¶ added in v0.21.0
type GetPolicyOutput struct { // The JSON-formatted resource-based policy attached to the ProfilingGroup. // // Policy is a required field Policy *string `locationName:"policy" type:"string" required:"true"` // A unique identifier for the current revision of the returned policy. // // RevisionId is a required field RevisionId *string `locationName:"revisionId" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the getPolicyResponse.
func (GetPolicyOutput) MarshalFields ¶ added in v0.21.0
func (s GetPolicyOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetPolicyOutput) String ¶ added in v0.21.0
func (s GetPolicyOutput) String() string
String returns the string representation
type GetPolicyRequest ¶ added in v0.21.0
type GetPolicyRequest struct { *aws.Request Input *GetPolicyInput Copy func(*GetPolicyInput) GetPolicyRequest }
GetPolicyRequest is the request type for the GetPolicy API operation.
func (GetPolicyRequest) Send ¶ added in v0.21.0
func (r GetPolicyRequest) Send(ctx context.Context) (*GetPolicyResponse, error)
Send marshals and sends the GetPolicy API request.
type GetPolicyResponse ¶ added in v0.21.0
type GetPolicyResponse struct { *GetPolicyOutput // contains filtered or unexported fields }
GetPolicyResponse is the response type for the GetPolicy API operation.
func (*GetPolicyResponse) SDKResponseMetdata ¶ added in v0.21.0
func (r *GetPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetPolicy request.
type GetProfileInput ¶
type GetProfileInput struct { // The format of the returned profiling data. The format maps to the Accept // and Content-Type headers of the HTTP request. You can specify one of the // following: or the default . // // <ul> <li> <p> <code>application/json</code> — standard JSON format </p> // </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion // data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon // Ion</a>. </p> </li> </ul> Accept *string `location:"header" locationName:"Accept" type:"string"` // The end time of the requested profile. Specify using the ISO 8601 format. // For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June // 1, 2020 1:15:02 PM UTC. // // If you specify endTime, then you must also specify period or startTime, but // not both. EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` // The maximum depth of the stacks in the code that is represented in the aggregated // profile. For example, if CodeGuru Profiler finds a method A, which calls // method B, which calls method C, which calls method D, then the depth is 4. // If the maxDepth is set to 2, then the aggregated profile contains representations // of methods A and B. MaxDepth *int64 `location:"querystring" locationName:"maxDepth" min:"1" type:"integer"` // Used with startTime or endTime to specify the time range for the returned // aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S. // // <p> To get the latest aggregated profile, specify only <code>period</code>. // </p> Period *string `location:"querystring" locationName:"period" min:"1" type:"string"` // The name of the profiling group to get. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The start time of the profile to get. Specify using the ISO 8601 format. // For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June // 1, 2020 1:15:02 PM UTC. // // <p> If you specify <code>startTime</code>, then you must also specify // <code>period</code> or <code>endTime</code>, but not both. </p> StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` // contains filtered or unexported fields }
The structure representing the getProfileRequest.
func (GetProfileInput) MarshalFields ¶
func (s GetProfileInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetProfileInput) String ¶
func (s GetProfileInput) String() string
String returns the string representation
func (*GetProfileInput) Validate ¶
func (s *GetProfileInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetProfileOutput ¶
type GetProfileOutput struct { // The content encoding of the profile. ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"` // The content type of the profile in the payload. It is either application/json // or the default application/x-amzn-ion. // // ContentType is a required field ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"` // Information about the profile. // // Profile is a required field Profile []byte `locationName:"profile" type:"blob" required:"true"` // contains filtered or unexported fields }
The structure representing the getProfileResponse.
func (GetProfileOutput) MarshalFields ¶
func (s GetProfileOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetProfileOutput) String ¶
func (s GetProfileOutput) String() string
String returns the string representation
type GetProfileRequest ¶
type GetProfileRequest struct { *aws.Request Input *GetProfileInput Copy func(*GetProfileInput) GetProfileRequest }
GetProfileRequest is the request type for the GetProfile API operation.
func (GetProfileRequest) Send ¶
func (r GetProfileRequest) Send(ctx context.Context) (*GetProfileResponse, error)
Send marshals and sends the GetProfile API request.
type GetProfileResponse ¶
type GetProfileResponse struct { *GetProfileOutput // contains filtered or unexported fields }
GetProfileResponse is the response type for the GetProfile API operation.
func (*GetProfileResponse) SDKResponseMetdata ¶
func (r *GetProfileResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetProfile request.
type GetRecommendationsInput ¶ added in v0.24.0
type GetRecommendationsInput struct { // The start time of the profile to get analysis data about. You must specify // startTime and endTime. This is specified using the ISO 8601 format. For example, // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 // PM UTC. // // EndTime is a required field EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // The language used to provide analysis. Specify using a string that is one // of the following BCP 47 language codes. // // * de-DE - German, Germany // // * en-GB - English, United Kingdom // // * en-US - English, United States // // * es-ES - Spanish, Spain // // * fr-FR - French, France // // * it-IT - Italian, Italy // // * ja-JP - Japanese, Japan // // * ko-KR - Korean, Republic of Korea // // * pt-BR - Portugese, Brazil // // * zh-CN - Chinese, China // // * zh-TW - Chinese, Taiwan Locale *string `location:"querystring" locationName:"locale" type:"string"` // The name of the profiling group to get analysis data about. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The end time of the profile to get analysis data about. You must specify // startTime and endTime. This is specified using the ISO 8601 format. For example, // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 // PM UTC. // // StartTime is a required field StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
The structure representing the GetRecommendationsRequest.
func (GetRecommendationsInput) MarshalFields ¶ added in v0.24.0
func (s GetRecommendationsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRecommendationsInput) String ¶ added in v0.24.0
func (s GetRecommendationsInput) String() string
String returns the string representation
func (*GetRecommendationsInput) Validate ¶ added in v0.24.0
func (s *GetRecommendationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRecommendationsOutput ¶ added in v0.24.0
type GetRecommendationsOutput struct { // The list of anomalies that the analysis has found for this profile. // // Anomalies is a required field Anomalies []Anomaly `locationName:"anomalies" type:"list" required:"true"` // The end time of the profile the analysis data is about. This is specified // using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents // 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // ProfileEndTime is a required field ProfileEndTime *time.Time `locationName:"profileEndTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // The start time of the profile the analysis data is about. This is specified // using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents // 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // ProfileStartTime is a required field ProfileStartTime *time.Time `locationName:"profileStartTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // The name of the profiling group the analysis data is about. // // ProfilingGroupName is a required field ProfilingGroupName *string `locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The list of recommendations that the analysis found for this profile. // // Recommendations is a required field Recommendations []Recommendation `locationName:"recommendations" type:"list" required:"true"` // contains filtered or unexported fields }
The structure representing the GetRecommendationsResponse.
func (GetRecommendationsOutput) MarshalFields ¶ added in v0.24.0
func (s GetRecommendationsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetRecommendationsOutput) String ¶ added in v0.24.0
func (s GetRecommendationsOutput) String() string
String returns the string representation
type GetRecommendationsRequest ¶ added in v0.24.0
type GetRecommendationsRequest struct { *aws.Request Input *GetRecommendationsInput Copy func(*GetRecommendationsInput) GetRecommendationsRequest }
GetRecommendationsRequest is the request type for the GetRecommendations API operation.
func (GetRecommendationsRequest) Send ¶ added in v0.24.0
func (r GetRecommendationsRequest) Send(ctx context.Context) (*GetRecommendationsResponse, error)
Send marshals and sends the GetRecommendations API request.
type GetRecommendationsResponse ¶ added in v0.24.0
type GetRecommendationsResponse struct { *GetRecommendationsOutput // contains filtered or unexported fields }
GetRecommendationsResponse is the response type for the GetRecommendations API operation.
func (*GetRecommendationsResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *GetRecommendationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetRecommendations request.
type ListFindingsReportsInput ¶ added in v0.24.0
type ListFindingsReportsInput struct { // A Boolean value indicating whether to only return reports from daily profiles. // If set to True, only analysis data from daily profiles is returned. If set // to False, analysis data is returned from smaller time windows (for example, // one hour). DailyReportsOnly *bool `location:"querystring" locationName:"dailyReportsOnly" type:"boolean"` // The end time of the profile to get analysis data about. You must specify // startTime and endTime. This is specified using the ISO 8601 format. For example, // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 // PM UTC. // // EndTime is a required field EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // The maximum number of report results returned by ListFindingsReports in paginated // output. When this parameter is used, ListFindingsReports only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another ListFindingsReports // request with the returned nextToken value. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The nextToken value returned from a previous paginated ListFindingsReportsRequest // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // The name of the profiling group from which to search for analysis data. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The start time of the profile to get analysis data about. You must specify // startTime and endTime. This is specified using the ISO 8601 format. For example, // 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 // PM UTC. // // StartTime is a required field StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
The structure representing the ListFindingsReportsRequest.
func (ListFindingsReportsInput) MarshalFields ¶ added in v0.24.0
func (s ListFindingsReportsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListFindingsReportsInput) String ¶ added in v0.24.0
func (s ListFindingsReportsInput) String() string
String returns the string representation
func (*ListFindingsReportsInput) Validate ¶ added in v0.24.0
func (s *ListFindingsReportsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListFindingsReportsOutput ¶ added in v0.24.0
type ListFindingsReportsOutput struct { // The list of analysis results summaries. // // FindingsReportSummaries is a required field FindingsReportSummaries []FindingsReportSummary `locationName:"findingsReportSummaries" type:"list" required:"true"` // The nextToken value to include in a future ListFindingsReports request. When // the results of a ListFindingsReports request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
The structure representing the ListFindingsReportsResponse.
func (ListFindingsReportsOutput) MarshalFields ¶ added in v0.24.0
func (s ListFindingsReportsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListFindingsReportsOutput) String ¶ added in v0.24.0
func (s ListFindingsReportsOutput) String() string
String returns the string representation
type ListFindingsReportsPaginator ¶ added in v0.24.0
ListFindingsReportsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListFindingsReportsPaginator ¶ added in v0.24.0
func NewListFindingsReportsPaginator(req ListFindingsReportsRequest) ListFindingsReportsPaginator
NewListFindingsReportsRequestPaginator returns a paginator for ListFindingsReports. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListFindingsReportsRequest(input) p := codeguruprofiler.NewListFindingsReportsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListFindingsReportsPaginator) CurrentPage ¶ added in v0.24.0
func (p *ListFindingsReportsPaginator) CurrentPage() *ListFindingsReportsOutput
type ListFindingsReportsRequest ¶ added in v0.24.0
type ListFindingsReportsRequest struct { *aws.Request Input *ListFindingsReportsInput Copy func(*ListFindingsReportsInput) ListFindingsReportsRequest }
ListFindingsReportsRequest is the request type for the ListFindingsReports API operation.
func (ListFindingsReportsRequest) Send ¶ added in v0.24.0
func (r ListFindingsReportsRequest) Send(ctx context.Context) (*ListFindingsReportsResponse, error)
Send marshals and sends the ListFindingsReports API request.
type ListFindingsReportsResponse ¶ added in v0.24.0
type ListFindingsReportsResponse struct { *ListFindingsReportsOutput // contains filtered or unexported fields }
ListFindingsReportsResponse is the response type for the ListFindingsReports API operation.
func (*ListFindingsReportsResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *ListFindingsReportsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListFindingsReports request.
type ListProfileTimesInput ¶
type ListProfileTimesInput struct { // The end time of the time range from which to list the profiles. // // EndTime is a required field EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // The maximum number of profile time results returned by ListProfileTimes in // paginated output. When this parameter is used, ListProfileTimes only returns // maxResults results in a single page with a nextToken response element. The // remaining results of the initial request can be seen by sending another ListProfileTimes // request with the returned nextToken value. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The nextToken value returned from a previous paginated ListProfileTimes request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // The order (ascending or descending by start time of the profile) to use when // listing profiles. Defaults to TIMESTAMP_DESCENDING. OrderBy OrderBy `location:"querystring" locationName:"orderBy" type:"string" enum:"true"` // The aggregation period. This specifies the period during which an aggregation // profile collects posted agent profiles for a profiling group. There are 3 // valid values. // // * P1D — 1 day // // * PT1H — 1 hour // // * PT5M — 5 minutes // // Period is a required field Period AggregationPeriod `location:"querystring" locationName:"period" type:"string" required:"true" enum:"true"` // The name of the profiling group. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The start time of the time range from which to list the profiles. // // StartTime is a required field StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
The structure representing the listProfileTimesRequest.
func (ListProfileTimesInput) MarshalFields ¶
func (s ListProfileTimesInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListProfileTimesInput) String ¶
func (s ListProfileTimesInput) String() string
String returns the string representation
func (*ListProfileTimesInput) Validate ¶
func (s *ListProfileTimesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListProfileTimesOutput ¶
type ListProfileTimesOutput struct { // The nextToken value to include in a future ListProfileTimes request. When // the results of a ListProfileTimes request exceed maxResults, this value can // be used to retrieve the next page of results. This value is null when there // are no more results to return. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // The list of start times of the available profiles for the aggregation period // in the specified time range. // // ProfileTimes is a required field ProfileTimes []ProfileTime `locationName:"profileTimes" type:"list" required:"true"` // contains filtered or unexported fields }
The structure representing the listProfileTimesResponse.
func (ListProfileTimesOutput) MarshalFields ¶
func (s ListProfileTimesOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListProfileTimesOutput) String ¶
func (s ListProfileTimesOutput) String() string
String returns the string representation
type ListProfileTimesPaginator ¶
ListProfileTimesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListProfileTimesPaginator ¶
func NewListProfileTimesPaginator(req ListProfileTimesRequest) ListProfileTimesPaginator
NewListProfileTimesRequestPaginator returns a paginator for ListProfileTimes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListProfileTimesRequest(input) p := codeguruprofiler.NewListProfileTimesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListProfileTimesPaginator) CurrentPage ¶
func (p *ListProfileTimesPaginator) CurrentPage() *ListProfileTimesOutput
type ListProfileTimesRequest ¶
type ListProfileTimesRequest struct { *aws.Request Input *ListProfileTimesInput Copy func(*ListProfileTimesInput) ListProfileTimesRequest }
ListProfileTimesRequest is the request type for the ListProfileTimes API operation.
func (ListProfileTimesRequest) Send ¶
func (r ListProfileTimesRequest) Send(ctx context.Context) (*ListProfileTimesResponse, error)
Send marshals and sends the ListProfileTimes API request.
type ListProfileTimesResponse ¶
type ListProfileTimesResponse struct { *ListProfileTimesOutput // contains filtered or unexported fields }
ListProfileTimesResponse is the response type for the ListProfileTimes API operation.
func (*ListProfileTimesResponse) SDKResponseMetdata ¶
func (r *ListProfileTimesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListProfileTimes request.
type ListProfilingGroupsInput ¶
type ListProfilingGroupsInput struct { // A Boolean value indicating whether to include a description. If true, then // a list of ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects that contain detailed information about profiling groups is returned. // If false, then a list of profiling group names is returned. IncludeDescription *bool `location:"querystring" locationName:"includeDescription" type:"boolean"` // The maximum number of profiling groups results returned by ListProfilingGroups // in paginated output. When this parameter is used, ListProfilingGroups only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListProfilingGroups request with the returned nextToken value. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The nextToken value returned from a previous paginated ListProfilingGroups // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. // // This token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
The structure representing the listProfilingGroupsRequest.
func (ListProfilingGroupsInput) MarshalFields ¶
func (s ListProfilingGroupsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListProfilingGroupsInput) String ¶
func (s ListProfilingGroupsInput) String() string
String returns the string representation
func (*ListProfilingGroupsInput) Validate ¶
func (s *ListProfilingGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListProfilingGroupsOutput ¶
type ListProfilingGroupsOutput struct { // The nextToken value to include in a future ListProfilingGroups request. When // the results of a ListProfilingGroups request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A returned list of profiling group names. A list of the names is returned // only if includeDescription is false, otherwise a list of ProfilingGroupDescription // (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects is returned. // // ProfilingGroupNames is a required field ProfilingGroupNames []string `locationName:"profilingGroupNames" type:"list" required:"true"` // A returned list ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects. A list of ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // objects is returned only if includeDescription is true, otherwise a list // of profiling group names is returned. ProfilingGroups []ProfilingGroupDescription `locationName:"profilingGroups" type:"list"` // contains filtered or unexported fields }
The structure representing the listProfilingGroupsResponse.
func (ListProfilingGroupsOutput) MarshalFields ¶
func (s ListProfilingGroupsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListProfilingGroupsOutput) String ¶
func (s ListProfilingGroupsOutput) String() string
String returns the string representation
type ListProfilingGroupsPaginator ¶
ListProfilingGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListProfilingGroupsPaginator ¶
func NewListProfilingGroupsPaginator(req ListProfilingGroupsRequest) ListProfilingGroupsPaginator
NewListProfilingGroupsRequestPaginator returns a paginator for ListProfilingGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListProfilingGroupsRequest(input) p := codeguruprofiler.NewListProfilingGroupsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListProfilingGroupsPaginator) CurrentPage ¶
func (p *ListProfilingGroupsPaginator) CurrentPage() *ListProfilingGroupsOutput
type ListProfilingGroupsRequest ¶
type ListProfilingGroupsRequest struct { *aws.Request Input *ListProfilingGroupsInput Copy func(*ListProfilingGroupsInput) ListProfilingGroupsRequest }
ListProfilingGroupsRequest is the request type for the ListProfilingGroups API operation.
func (ListProfilingGroupsRequest) Send ¶
func (r ListProfilingGroupsRequest) Send(ctx context.Context) (*ListProfilingGroupsResponse, error)
Send marshals and sends the ListProfilingGroups API request.
type ListProfilingGroupsResponse ¶
type ListProfilingGroupsResponse struct { *ListProfilingGroupsOutput // contains filtered or unexported fields }
ListProfilingGroupsResponse is the response type for the ListProfilingGroups API operation.
func (*ListProfilingGroupsResponse) SDKResponseMetdata ¶
func (r *ListProfilingGroupsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListProfilingGroups request.
type ListTagsForResourceInput ¶ added in v0.24.0
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource that contains the tags to // return. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) MarshalFields ¶ added in v0.24.0
func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceInput) String ¶ added in v0.24.0
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶ added in v0.24.0
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v0.24.0
type ListTagsForResourceOutput struct { // The list of tags assigned to the specified resource. This is the list of // tags returned in the response. Tags map[string]string `locationName:"tags" type:"map"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) MarshalFields ¶ added in v0.24.0
func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListTagsForResourceOutput) String ¶ added in v0.24.0
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶ added in v0.24.0
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶ added in v0.24.0
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶ added in v0.24.0
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource request.
type Match ¶ added in v0.24.0
type Match struct { // The location in the profiling graph that contains a recommendation found // during analysis. FrameAddress *string `locationName:"frameAddress" type:"string"` // The target frame that triggered a match. TargetFramesIndex *int64 `locationName:"targetFramesIndex" type:"integer"` // The value in the profile data that exceeded the recommendation threshold. ThresholdBreachValue *float64 `locationName:"thresholdBreachValue" type:"double"` // contains filtered or unexported fields }
The part of a profile that contains a recommendation found during analysis.
func (Match) MarshalFields ¶ added in v0.24.0
func (s Match) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type MetadataField ¶ added in v0.24.0
type MetadataField string
const ( MetadataFieldAgentId MetadataField = "AgentId" MetadataFieldAwsRequestId MetadataField = "AwsRequestId" MetadataFieldComputePlatform MetadataField = "ComputePlatform" MetadataFieldExecutionEnvironment MetadataField = "ExecutionEnvironment" MetadataFieldLambdaFunctionArn MetadataField = "LambdaFunctionArn" MetadataFieldLambdaMemoryLimitInMb MetadataField = "LambdaMemoryLimitInMB" MetadataFieldLambdaPreviousExecutionTimeInMilliseconds MetadataField = "LambdaPreviousExecutionTimeInMilliseconds" MetadataFieldLambdaRemainingTimeInMilliseconds MetadataField = "LambdaRemainingTimeInMilliseconds" MetadataFieldLambdaTimeGapBetweenInvokesInMilliseconds MetadataField = "LambdaTimeGapBetweenInvokesInMilliseconds" )
Enum values for MetadataField
func (MetadataField) MarshalValue ¶ added in v0.24.0
func (enum MetadataField) MarshalValue() (string, error)
func (MetadataField) MarshalValueBuf ¶ added in v0.24.0
func (enum MetadataField) MarshalValueBuf(b []byte) ([]byte, error)
type Metric ¶ added in v0.24.0
type Metric struct { // The name of the method that appears as a frame in any stack in a profile. // // FrameName is a required field FrameName *string `locationName:"frameName" type:"string" required:"true"` // The list of application runtime thread states that is used to calculate the // metric value for the frame. // // ThreadStates is a required field ThreadStates []string `locationName:"threadStates" type:"list" required:"true"` // A type that specifies how a metric for a frame is analyzed. The supported // value AggregatedRelativeTotalTime is an aggregation of the metric value for // one frame that is calculated across the occurences of all frames in a profile. // // Type is a required field Type MetricType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.
func (Metric) MarshalFields ¶ added in v0.24.0
func (s Metric) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type MetricType ¶ added in v0.24.0
type MetricType string
const (
MetricTypeAggregatedRelativeTotalTime MetricType = "AggregatedRelativeTotalTime"
)
Enum values for MetricType
func (MetricType) MarshalValue ¶ added in v0.24.0
func (enum MetricType) MarshalValue() (string, error)
func (MetricType) MarshalValueBuf ¶ added in v0.24.0
func (enum MetricType) MarshalValueBuf(b []byte) ([]byte, error)
type NotificationConfiguration ¶ added in v0.24.0
type NotificationConfiguration struct { // List of up to two channels to be used for sending notifications for events // detected from the application profile. Channels []Channel `locationName:"channels" min:"1" type:"list"` // contains filtered or unexported fields }
The configuration for notifications stored for each profiling group. This includes up to to two channels and a list of event publishers associated with each channel.
func (NotificationConfiguration) MarshalFields ¶ added in v0.24.0
func (s NotificationConfiguration) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (NotificationConfiguration) String ¶ added in v0.24.0
func (s NotificationConfiguration) String() string
String returns the string representation
type OrderBy ¶
type OrderBy string
const ( OrderByTimestampAscending OrderBy = "TimestampAscending" OrderByTimestampDescending OrderBy = "TimestampDescending" )
Enum values for OrderBy
func (OrderBy) MarshalValue ¶
type Pattern ¶ added in v0.24.0
type Pattern struct { // A list of the different counters used to determine if there is a match. CountersToAggregate []string `locationName:"countersToAggregate" type:"list"` // The description of the recommendation. This explains a potential inefficiency // in a profiled application. Description *string `locationName:"description" type:"string"` // The universally unique identifier (UUID) of this pattern. Id *string `locationName:"id" type:"string"` // The name for this pattern. Name *string `locationName:"name" type:"string"` // A string that contains the steps recommended to address the potential inefficiency. ResolutionSteps *string `locationName:"resolutionSteps" type:"string"` // A list of frame names that were searched during the analysis that generated // a recommendation. TargetFrames [][]string `locationName:"targetFrames" type:"list"` // The percentage of time an application spends in one method that triggers // a recommendation. The percentage of time is the same as the percentage of // the total gathered sample counts during analysis. ThresholdPercent *float64 `locationName:"thresholdPercent" type:"double"` // contains filtered or unexported fields }
A set of rules used to make a recommendation during an analysis.
func (Pattern) MarshalFields ¶ added in v0.24.0
func (s Pattern) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type PostAgentProfileInput ¶
type PostAgentProfileInput struct { // The submitted profiling data. // // AgentProfile is a required field AgentProfile []byte `locationName:"agentProfile" type:"blob" required:"true"` // The format of the submitted profiling data. The format maps to the Accept // and Content-Type headers of the HTTP request. You can specify one of the // following: or the default . // // <ul> <li> <p> <code>application/json</code> — standard JSON format </p> // </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion // data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon // Ion</a>. </p> </li> </ul> // // ContentType is a required field ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"` // Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to // prevent the accidental submission of duplicate profiling data if there are // failures and retries. ProfileToken *string `location:"querystring" locationName:"profileToken" min:"1" type:"string" idempotencyToken:"true"` // The name of the profiling group with the aggregated profile that receives // the submitted profiling data. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the postAgentProfileRequest.
func (PostAgentProfileInput) MarshalFields ¶
func (s PostAgentProfileInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PostAgentProfileInput) String ¶
func (s PostAgentProfileInput) String() string
String returns the string representation
func (*PostAgentProfileInput) Validate ¶
func (s *PostAgentProfileInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PostAgentProfileOutput ¶
type PostAgentProfileOutput struct {
// contains filtered or unexported fields
}
The structure representing the postAgentProfileResponse.
func (PostAgentProfileOutput) MarshalFields ¶
func (s PostAgentProfileOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PostAgentProfileOutput) String ¶
func (s PostAgentProfileOutput) String() string
String returns the string representation
type PostAgentProfileRequest ¶
type PostAgentProfileRequest struct { *aws.Request Input *PostAgentProfileInput Copy func(*PostAgentProfileInput) PostAgentProfileRequest }
PostAgentProfileRequest is the request type for the PostAgentProfile API operation.
func (PostAgentProfileRequest) Send ¶
func (r PostAgentProfileRequest) Send(ctx context.Context) (*PostAgentProfileResponse, error)
Send marshals and sends the PostAgentProfile API request.
type PostAgentProfileResponse ¶
type PostAgentProfileResponse struct { *PostAgentProfileOutput // contains filtered or unexported fields }
PostAgentProfileResponse is the response type for the PostAgentProfile API operation.
func (*PostAgentProfileResponse) SDKResponseMetdata ¶
func (r *PostAgentProfileResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PostAgentProfile request.
type ProfileTime ¶
type ProfileTime struct { // The start time of a profile. It is specified using the ISO 8601 format. For // example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 // 1:15:02 PM UTC. Start *time.Time `locationName:"start" type:"timestamp" timestampFormat:"iso8601"` // contains filtered or unexported fields }
Contains the start time of a profile.
func (ProfileTime) MarshalFields ¶
func (s ProfileTime) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ProfileTime) String ¶
func (s ProfileTime) String() string
String returns the string representation
type ProfilingGroupDescription ¶
type ProfilingGroupDescription struct { // An AgentOrchestrationConfig (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html) // object that indicates if the profiling group is enabled for profiled or not. AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure"` // The Amazon Resource Name (ARN) identifying the profiling group resource. Arn *string `locationName:"arn" type:"string"` // The compute platform of the profiling group. If it is set to AWSLambda, then // the profiled application runs on AWS Lambda. If it is set to Default, then // the profiled application runs on a compute platform that is not AWS Lambda, // such an Amazon EC2 instance, an on-premises server, or a different platform. // The default is Default. ComputePlatform ComputePlatform `locationName:"computePlatform" type:"string" enum:"true"` // The time when the profiling group was created. Specify using the ISO 8601 // format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past // June 1, 2020 1:15:02 PM UTC. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601"` // The name of the profiling group. Name *string `locationName:"name" min:"1" type:"string"` // A ProfilingStatus (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html) // object that includes information about the last time a profile agent pinged // back, the last time a profile was received, and the aggregation period and // start time for the most recent aggregated profile. ProfilingStatus *ProfilingStatus `locationName:"profilingStatus" type:"structure"` // A list of the tags that belong to this profiling group. Tags map[string]string `locationName:"tags" type:"map"` // The date and time when the profiling group was last updated. Specify using // the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond // past June 1, 2020 1:15:02 PM UTC. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601"` // contains filtered or unexported fields }
Contains information about a profiling group.
func (ProfilingGroupDescription) MarshalFields ¶
func (s ProfilingGroupDescription) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ProfilingGroupDescription) String ¶
func (s ProfilingGroupDescription) String() string
String returns the string representation
type ProfilingStatus ¶
type ProfilingStatus struct { // The date and time when the profiling agent most recently pinged back. Specify // using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents // 1 millisecond past June 1, 2020 1:15:02 PM UTC. LatestAgentOrchestratedAt *time.Time `locationName:"latestAgentOrchestratedAt" type:"timestamp" timestampFormat:"iso8601"` // The date and time when the most recent profile was received. Specify using // the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond // past June 1, 2020 1:15:02 PM UTC. LatestAgentProfileReportedAt *time.Time `locationName:"latestAgentProfileReportedAt" type:"timestamp" timestampFormat:"iso8601"` // An AggregatedProfileTime (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html) // object that contains the aggregation period and start time for an aggregated // profile. LatestAggregatedProfile *AggregatedProfileTime `locationName:"latestAggregatedProfile" type:"structure"` // contains filtered or unexported fields }
Profiling status includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.
func (ProfilingStatus) MarshalFields ¶
func (s ProfilingStatus) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ProfilingStatus) String ¶
func (s ProfilingStatus) String() string
String returns the string representation
type PutPermissionInput ¶ added in v0.21.0
type PutPermissionInput struct { // Specifies an action group that contains permissions to add to a profiling // group resource. One action group is supported, agentPermissions, which grants // permission to perform actions required by the profiling agent, ConfigureAgent // and PostAgentProfile permissions. // // ActionGroup is a required field ActionGroup ActionGroup `location:"uri" locationName:"actionGroup" type:"string" required:"true" enum:"true"` // A list ARNs for the roles and users you want to grant access to the profiling // group. Wildcards are not are supported in the ARNs. // // Principals is a required field Principals []string `locationName:"principals" min:"1" type:"list" required:"true"` // The name of the profiling group to grant access to. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // A universally unique identifier (UUID) for the revision of the policy you // are adding to the profiling group. Do not specify this when you add permissions // to a profiling group for the first time. If a policy already exists on the // profiling group, you must specify the revisionId. RevisionId *string `locationName:"revisionId" type:"string"` // contains filtered or unexported fields }
The structure representing the putPermissionRequest.
func (PutPermissionInput) MarshalFields ¶ added in v0.21.0
func (s PutPermissionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutPermissionInput) String ¶ added in v0.21.0
func (s PutPermissionInput) String() string
String returns the string representation
func (*PutPermissionInput) Validate ¶ added in v0.21.0
func (s *PutPermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutPermissionOutput ¶ added in v0.21.0
type PutPermissionOutput struct { // The JSON-formatted resource-based policy on the profiling group that includes // the added permissions. // // Policy is a required field Policy *string `locationName:"policy" type:"string" required:"true"` // A universally unique identifier (UUID) for the revision of the resource-based // policy that includes the added permissions. The JSON-formatted policy is // in the policy element of the response. // // RevisionId is a required field RevisionId *string `locationName:"revisionId" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the putPermissionResponse.
func (PutPermissionOutput) MarshalFields ¶ added in v0.21.0
func (s PutPermissionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (PutPermissionOutput) String ¶ added in v0.21.0
func (s PutPermissionOutput) String() string
String returns the string representation
type PutPermissionRequest ¶ added in v0.21.0
type PutPermissionRequest struct { *aws.Request Input *PutPermissionInput Copy func(*PutPermissionInput) PutPermissionRequest }
PutPermissionRequest is the request type for the PutPermission API operation.
func (PutPermissionRequest) Send ¶ added in v0.21.0
func (r PutPermissionRequest) Send(ctx context.Context) (*PutPermissionResponse, error)
Send marshals and sends the PutPermission API request.
type PutPermissionResponse ¶ added in v0.21.0
type PutPermissionResponse struct { *PutPermissionOutput // contains filtered or unexported fields }
PutPermissionResponse is the response type for the PutPermission API operation.
func (*PutPermissionResponse) SDKResponseMetdata ¶ added in v0.21.0
func (r *PutPermissionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PutPermission request.
type Recommendation ¶ added in v0.24.0
type Recommendation struct { // How many different places in the profile graph triggered a match. // // AllMatchesCount is a required field AllMatchesCount *int64 `locationName:"allMatchesCount" type:"integer" required:"true"` // How much of the total sample count is potentially affected. // // AllMatchesSum is a required field AllMatchesSum *float64 `locationName:"allMatchesSum" type:"double" required:"true"` // End time of the profile that was used by this analysis. This is specified // using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents // 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // EndTime is a required field EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // The pattern that analysis recognized in the profile to make this recommendation. // // Pattern is a required field Pattern *Pattern `locationName:"pattern" type:"structure" required:"true"` // The start time of the profile that was used by this analysis. This is specified // using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents // 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"` // List of the matches with most impact. // // TopMatches is a required field TopMatches []Match `locationName:"topMatches" type:"list" required:"true"` // contains filtered or unexported fields }
A potential improvement that was found from analyzing the profiling data.
func (Recommendation) MarshalFields ¶ added in v0.24.0
func (s Recommendation) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (Recommendation) String ¶ added in v0.24.0
func (s Recommendation) String() string
String returns the string representation
type RemoveNotificationChannelInput ¶ added in v0.24.0
type RemoveNotificationChannelInput struct { // The id of the channel that we want to stop receiving notifications. // // ChannelId is a required field ChannelId *string `location:"uri" locationName:"channelId" type:"string" required:"true"` // The name of the profiling group we want to change notification configuration // for. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the RemoveNotificationChannelRequest.
func (RemoveNotificationChannelInput) MarshalFields ¶ added in v0.24.0
func (s RemoveNotificationChannelInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RemoveNotificationChannelInput) String ¶ added in v0.24.0
func (s RemoveNotificationChannelInput) String() string
String returns the string representation
func (*RemoveNotificationChannelInput) Validate ¶ added in v0.24.0
func (s *RemoveNotificationChannelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveNotificationChannelOutput ¶ added in v0.24.0
type RemoveNotificationChannelOutput struct { // The new notification configuration for this profiling group. NotificationConfiguration *NotificationConfiguration `locationName:"notificationConfiguration" type:"structure"` // contains filtered or unexported fields }
The structure representing the RemoveNotificationChannelResponse.
func (RemoveNotificationChannelOutput) MarshalFields ¶ added in v0.24.0
func (s RemoveNotificationChannelOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RemoveNotificationChannelOutput) String ¶ added in v0.24.0
func (s RemoveNotificationChannelOutput) String() string
String returns the string representation
type RemoveNotificationChannelRequest ¶ added in v0.24.0
type RemoveNotificationChannelRequest struct { *aws.Request Input *RemoveNotificationChannelInput Copy func(*RemoveNotificationChannelInput) RemoveNotificationChannelRequest }
RemoveNotificationChannelRequest is the request type for the RemoveNotificationChannel API operation.
func (RemoveNotificationChannelRequest) Send ¶ added in v0.24.0
func (r RemoveNotificationChannelRequest) Send(ctx context.Context) (*RemoveNotificationChannelResponse, error)
Send marshals and sends the RemoveNotificationChannel API request.
type RemoveNotificationChannelResponse ¶ added in v0.24.0
type RemoveNotificationChannelResponse struct { *RemoveNotificationChannelOutput // contains filtered or unexported fields }
RemoveNotificationChannelResponse is the response type for the RemoveNotificationChannel API operation.
func (*RemoveNotificationChannelResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *RemoveNotificationChannelResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RemoveNotificationChannel request.
type RemovePermissionInput ¶ added in v0.21.0
type RemovePermissionInput struct { // Specifies an action group that contains the permissions to remove from a // profiling group's resource-based policy. One action group is supported, agentPermissions, // which grants ConfigureAgent and PostAgentProfile permissions. // // ActionGroup is a required field ActionGroup ActionGroup `location:"uri" locationName:"actionGroup" type:"string" required:"true" enum:"true"` // The name of the profiling group. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // A universally unique identifier (UUID) for the revision of the resource-based // policy from which you want to remove permissions. // // RevisionId is a required field RevisionId *string `location:"querystring" locationName:"revisionId" type:"string" required:"true"` // contains filtered or unexported fields }
func (RemovePermissionInput) MarshalFields ¶ added in v0.21.0
func (s RemovePermissionInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RemovePermissionInput) String ¶ added in v0.21.0
func (s RemovePermissionInput) String() string
String returns the string representation
func (*RemovePermissionInput) Validate ¶ added in v0.21.0
func (s *RemovePermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemovePermissionOutput ¶ added in v0.21.0
type RemovePermissionOutput struct { // The JSON-formatted resource-based policy on the profiling group after the // specified permissions were removed. // // Policy is a required field Policy *string `locationName:"policy" type:"string" required:"true"` // A universally unique identifier (UUID) for the revision of the resource-based // policy after the specified permissions were removed. The updated JSON-formatted // policy is in the policy element of the response. // // RevisionId is a required field RevisionId *string `locationName:"revisionId" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the removePermissionResponse.
func (RemovePermissionOutput) MarshalFields ¶ added in v0.21.0
func (s RemovePermissionOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RemovePermissionOutput) String ¶ added in v0.21.0
func (s RemovePermissionOutput) String() string
String returns the string representation
type RemovePermissionRequest ¶ added in v0.21.0
type RemovePermissionRequest struct { *aws.Request Input *RemovePermissionInput Copy func(*RemovePermissionInput) RemovePermissionRequest }
RemovePermissionRequest is the request type for the RemovePermission API operation.
func (RemovePermissionRequest) Send ¶ added in v0.21.0
func (r RemovePermissionRequest) Send(ctx context.Context) (*RemovePermissionResponse, error)
Send marshals and sends the RemovePermission API request.
type RemovePermissionResponse ¶ added in v0.21.0
type RemovePermissionResponse struct { *RemovePermissionOutput // contains filtered or unexported fields }
RemovePermissionResponse is the response type for the RemovePermission API operation.
func (*RemovePermissionResponse) SDKResponseMetdata ¶ added in v0.21.0
func (r *RemovePermissionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RemovePermission request.
type SubmitFeedbackInput ¶ added in v0.24.0
type SubmitFeedbackInput struct { // The universally unique identifier (UUID) of the AnomalyInstance (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html) // object that is included in the analysis data. // // AnomalyInstanceId is a required field AnomalyInstanceId *string `location:"uri" locationName:"anomalyInstanceId" type:"string" required:"true"` // Optional feedback about this anomaly. Comment *string `locationName:"comment" type:"string"` // The name of the profiling group that is associated with the analysis data. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // The feedback tpye. Thee are two valid values, Positive and Negative. // // Type is a required field Type FeedbackType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The structure representing the SubmitFeedbackRequest.
func (SubmitFeedbackInput) MarshalFields ¶ added in v0.24.0
func (s SubmitFeedbackInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SubmitFeedbackInput) String ¶ added in v0.24.0
func (s SubmitFeedbackInput) String() string
String returns the string representation
func (*SubmitFeedbackInput) Validate ¶ added in v0.24.0
func (s *SubmitFeedbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SubmitFeedbackOutput ¶ added in v0.24.0
type SubmitFeedbackOutput struct {
// contains filtered or unexported fields
}
The structure representing the SubmitFeedbackResponse.
func (SubmitFeedbackOutput) MarshalFields ¶ added in v0.24.0
func (s SubmitFeedbackOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (SubmitFeedbackOutput) String ¶ added in v0.24.0
func (s SubmitFeedbackOutput) String() string
String returns the string representation
type SubmitFeedbackRequest ¶ added in v0.24.0
type SubmitFeedbackRequest struct { *aws.Request Input *SubmitFeedbackInput Copy func(*SubmitFeedbackInput) SubmitFeedbackRequest }
SubmitFeedbackRequest is the request type for the SubmitFeedback API operation.
func (SubmitFeedbackRequest) Send ¶ added in v0.24.0
func (r SubmitFeedbackRequest) Send(ctx context.Context) (*SubmitFeedbackResponse, error)
Send marshals and sends the SubmitFeedback API request.
type SubmitFeedbackResponse ¶ added in v0.24.0
type SubmitFeedbackResponse struct { *SubmitFeedbackOutput // contains filtered or unexported fields }
SubmitFeedbackResponse is the response type for the SubmitFeedback API operation.
func (*SubmitFeedbackResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *SubmitFeedbackResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SubmitFeedback request.
type TagResourceInput ¶ added in v0.24.0
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that the tags are added to. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // The list of tags that are added to the specified resource. // // Tags is a required field Tags map[string]string `locationName:"tags" type:"map" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) MarshalFields ¶ added in v0.24.0
func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceInput) String ¶ added in v0.24.0
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶ added in v0.24.0
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v0.24.0
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) MarshalFields ¶ added in v0.24.0
func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TagResourceOutput) String ¶ added in v0.24.0
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶ added in v0.24.0
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶ added in v0.24.0
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶ added in v0.24.0
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type TimestampStructure ¶ added in v0.24.0
type TimestampStructure struct { // A Timestamp. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z // represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. // // Value is a required field Value *time.Time `locationName:"value" type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
A data type that contains a Timestamp object. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
func (TimestampStructure) MarshalFields ¶ added in v0.24.0
func (s TimestampStructure) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (TimestampStructure) String ¶ added in v0.24.0
func (s TimestampStructure) String() string
String returns the string representation
type UntagResourceInput ¶ added in v0.24.0
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that contains the tags to // remove. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // A list of tag keys. Existing tags of resources with keys in this list are // removed from the specified resource. // // TagKeys is a required field TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) MarshalFields ¶ added in v0.24.0
func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceInput) String ¶ added in v0.24.0
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶ added in v0.24.0
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v0.24.0
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) MarshalFields ¶ added in v0.24.0
func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UntagResourceOutput) String ¶ added in v0.24.0
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶ added in v0.24.0
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶ added in v0.24.0
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶ added in v0.24.0
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶ added in v0.24.0
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
type UpdateProfilingGroupInput ¶
type UpdateProfilingGroupInput struct { // Specifies whether profiling is enabled or disabled for a profiling group. // // AgentOrchestrationConfig is a required field AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure" required:"true"` // The name of the profiling group to update. // // ProfilingGroupName is a required field ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The structure representing the updateProfilingGroupRequest.
func (UpdateProfilingGroupInput) MarshalFields ¶
func (s UpdateProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateProfilingGroupInput) String ¶
func (s UpdateProfilingGroupInput) String() string
String returns the string representation
func (*UpdateProfilingGroupInput) Validate ¶
func (s *UpdateProfilingGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateProfilingGroupOutput ¶
type UpdateProfilingGroupOutput struct { // A ProfilingGroupDescription (https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html) // that contains information about the returned updated profiling group. // // ProfilingGroup is a required field ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"` // contains filtered or unexported fields }
The structure representing the updateProfilingGroupResponse.
func (UpdateProfilingGroupOutput) MarshalFields ¶
func (s UpdateProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateProfilingGroupOutput) String ¶
func (s UpdateProfilingGroupOutput) String() string
String returns the string representation
type UpdateProfilingGroupRequest ¶
type UpdateProfilingGroupRequest struct { *aws.Request Input *UpdateProfilingGroupInput Copy func(*UpdateProfilingGroupInput) UpdateProfilingGroupRequest }
UpdateProfilingGroupRequest is the request type for the UpdateProfilingGroup API operation.
func (UpdateProfilingGroupRequest) Send ¶
func (r UpdateProfilingGroupRequest) Send(ctx context.Context) (*UpdateProfilingGroupResponse, error)
Send marshals and sends the UpdateProfilingGroup API request.
type UpdateProfilingGroupResponse ¶
type UpdateProfilingGroupResponse struct { *UpdateProfilingGroupOutput // contains filtered or unexported fields }
UpdateProfilingGroupResponse is the response type for the UpdateProfilingGroup API operation.
func (*UpdateProfilingGroupResponse) SDKResponseMetdata ¶
func (r *UpdateProfilingGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateProfilingGroup request.
type UserFeedback ¶ added in v0.24.0
type UserFeedback struct { // Optional Positive or Negative feedback submitted by the user about whether // the recommendation is useful or not. // // Type is a required field Type FeedbackType `locationName:"type" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Feedback that can be submitted for each instance of an anomaly by the user. Feedback is be used for improvements in generating recommendations for the application.
func (UserFeedback) MarshalFields ¶ added in v0.24.0
func (s UserFeedback) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UserFeedback) String ¶ added in v0.24.0
func (s UserFeedback) String() string
String returns the string representation
Source Files
¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_AddNotificationChannels.go
- api_op_BatchGetFrameMetricData.go
- api_op_ConfigureAgent.go
- api_op_CreateProfilingGroup.go
- api_op_DeleteProfilingGroup.go
- api_op_DescribeProfilingGroup.go
- api_op_GetFindingsReportAccountSummary.go
- api_op_GetNotificationConfiguration.go
- api_op_GetPolicy.go
- api_op_GetProfile.go
- api_op_GetRecommendations.go
- api_op_ListFindingsReports.go
- api_op_ListProfileTimes.go
- api_op_ListProfilingGroups.go
- api_op_ListTagsForResource.go
- api_op_PostAgentProfile.go
- api_op_PutPermission.go
- api_op_RemoveNotificationChannel.go
- api_op_RemovePermission.go
- api_op_SubmitFeedback.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateProfilingGroup.go
- api_types.go
Directories
¶
Path | Synopsis |
---|---|
Package codeguruprofileriface provides an interface to enable mocking the Amazon CodeGuru Profiler service client for testing your code.
|
Package codeguruprofileriface provides an interface to enable mocking the Amazon CodeGuru Profiler service client for testing your code. |