logo
Expand description

This section provides documentation for the Amazon CodeGuru Profiler API operations.

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.

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.

Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages and Python. 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 and Python.

For more information, see What is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide.

If you’re using the service, you’re probably looking for CodeGuruProfilerClient and CodeGuruProfiler.

Structs

The structure representing the AddNotificationChannelsRequest.

The structure representing the AddNotificationChannelsResponse.

The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.

Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.

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).

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.

The specific duration in which the metric is flagged as anomalous.

The structure representing the BatchGetFrameMetricDataRequest.

The structure representing the BatchGetFrameMetricDataResponse.

Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.

A client for the Amazon CodeGuru Profiler API.

The structure representing the configureAgentRequest.

The structure representing the configureAgentResponse.

The structure representing the createProfiliingGroupRequest.

The structure representing the createProfilingGroupResponse.

The structure representing the deleteProfilingGroupRequest.

The structure representing the deleteProfilingGroupResponse.

The structure representing the describeProfilingGroupRequest.

The structure representing the describeProfilingGroupResponse.

Information about potential recommendations that might be created from the analysis of profiling data.

The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

Information about a frame metric and its values.

The structure representing the GetFindingsReportAccountSummaryRequest.

The structure representing the GetFindingsReportAccountSummaryResponse.

The structure representing the GetNotificationConfigurationRequest.

The structure representing the GetNotificationConfigurationResponse.

The structure representing the getPolicyRequest.

The structure representing the getPolicyResponse.

The structure representing the getProfileRequest.

The structure representing the getProfileResponse.

The structure representing the GetRecommendationsRequest.

The structure representing the GetRecommendationsResponse.

The structure representing the ListFindingsReportsRequest.

The structure representing the ListFindingsReportsResponse.

The structure representing the listProfileTimesRequest.

The structure representing the listProfileTimesResponse.

The structure representing the listProfilingGroupsRequest.

The structure representing the listProfilingGroupsResponse.

The part of a profile that contains a recommendation found during analysis.

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.

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.

A set of rules used to make a recommendation during an analysis.

The structure representing the postAgentProfileRequest.

The structure representing the postAgentProfileResponse.

Contains the start time of a profile.

Contains information about a profiling group.

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.

The structure representing the putPermissionRequest.

The structure representing the putPermissionResponse.

A potential improvement that was found from analyzing the profiling data.

The structure representing the RemoveNotificationChannelRequest.

The structure representing the RemoveNotificationChannelResponse.

 The structure representing the <code>removePermissionRequest</code>.</p> 

The structure representing the removePermissionResponse.

The structure representing the SubmitFeedbackRequest.

The structure representing the SubmitFeedbackResponse.

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.

The structure representing the updateProfilingGroupRequest.

The structure representing the updateProfilingGroupResponse.

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.

Enums

Errors returned by AddNotificationChannels

Errors returned by BatchGetFrameMetricData

Errors returned by ConfigureAgent

Errors returned by CreateProfilingGroup

Errors returned by DeleteProfilingGroup

Errors returned by DescribeProfilingGroup

Errors returned by GetFindingsReportAccountSummary

Errors returned by GetNotificationConfiguration

Errors returned by GetPolicy

Errors returned by GetProfile

Errors returned by GetRecommendations

Errors returned by ListFindingsReports

Errors returned by ListProfileTimes

Errors returned by ListProfilingGroups

Errors returned by ListTagsForResource

Errors returned by PostAgentProfile

Errors returned by PutPermission

Errors returned by RemoveNotificationChannel

Errors returned by RemovePermission

Errors returned by SubmitFeedback

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateProfilingGroup

Traits

Trait representing the capabilities of the Amazon CodeGuru Profiler API. Amazon CodeGuru Profiler clients implement this trait.