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§
- AddNotification
Channels Request The structure representing the AddNotificationChannelsRequest.
- AddNotification
Channels Response The structure representing the AddNotificationChannelsResponse.
- Agent
Configuration The response of
ConfigureAgentthat specifies if an agent profiles or not and for how long to return profiling data.- Agent
Orchestration Config Specifies whether profiling is enabled or disabled for a profiling group. It is used by
ConfigureAgentto enable or disable profiling for a profiling group.- Aggregated
Profile Time 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).
- Anomaly
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.
- Anomaly
Instance The specific duration in which the metric is flagged as anomalous.
- Batch
GetFrame Metric Data Request The structure representing the BatchGetFrameMetricDataRequest.
- Batch
GetFrame Metric Data Response The structure representing the BatchGetFrameMetricDataResponse.
- Channel
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
- Code
Guru Profiler Client - A client for the Amazon CodeGuru Profiler API.
- Configure
Agent Request The structure representing the configureAgentRequest.
- Configure
Agent Response The structure representing the configureAgentResponse.
- Create
Profiling Group Request The structure representing the createProfiliingGroupRequest.
- Create
Profiling Group Response The structure representing the createProfilingGroupResponse.
- Delete
Profiling Group Request The structure representing the deleteProfilingGroupRequest.
- Delete
Profiling Group Response The structure representing the deleteProfilingGroupResponse.
- Describe
Profiling Group Request The structure representing the describeProfilingGroupRequest.
- Describe
Profiling Group Response The structure representing the describeProfilingGroupResponse.
- Findings
Report Summary Information about potential recommendations that might be created from the analysis of profiling data.
- Frame
Metric The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
- Frame
Metric Datum Information about a frame metric and its values.
- GetFindings
Report Account Summary Request The structure representing the GetFindingsReportAccountSummaryRequest.
- GetFindings
Report Account Summary Response The structure representing the GetFindingsReportAccountSummaryResponse.
- GetNotification
Configuration Request The structure representing the GetNotificationConfigurationRequest.
- GetNotification
Configuration Response The structure representing the GetNotificationConfigurationResponse.
- GetPolicy
Request The structure representing the
getPolicyRequest.- GetPolicy
Response The structure representing the
getPolicyResponse.- GetProfile
Request The structure representing the getProfileRequest.
- GetProfile
Response The structure representing the getProfileResponse.
- GetRecommendations
Request The structure representing the GetRecommendationsRequest.
- GetRecommendations
Response The structure representing the GetRecommendationsResponse.
- List
Findings Reports Request The structure representing the ListFindingsReportsRequest.
- List
Findings Reports Response The structure representing the ListFindingsReportsResponse.
- List
Profile Times Request The structure representing the listProfileTimesRequest.
- List
Profile Times Response The structure representing the listProfileTimesResponse.
- List
Profiling Groups Request The structure representing the listProfilingGroupsRequest.
- List
Profiling Groups Response The structure representing the listProfilingGroupsResponse.
- List
Tags ForResource Request - List
Tags ForResource Response - Match
The part of a profile that contains a recommendation found during analysis.
- Metric
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.
- Notification
Configuration 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.
- Pattern
A set of rules used to make a recommendation during an analysis.
- Post
Agent Profile Request The structure representing the postAgentProfileRequest.
- Post
Agent Profile Response The structure representing the postAgentProfileResponse.
- Profile
Time Contains the start time of a profile.
- Profiling
Group Description Contains information about a profiling group.
- Profiling
Status 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.
- PutPermission
Request The structure representing the
putPermissionRequest.- PutPermission
Response The structure representing the
putPermissionResponse.- Recommendation
A potential improvement that was found from analyzing the profiling data.
- Remove
Notification Channel Request The structure representing the RemoveNotificationChannelRequest.
- Remove
Notification Channel Response The structure representing the RemoveNotificationChannelResponse.
- Remove
Permission Request The structure representing the <code>removePermissionRequest</code>.</p>- Remove
Permission Response The structure representing the
removePermissionResponse.- Submit
Feedback Request The structure representing the SubmitFeedbackRequest.
- Submit
Feedback Response The structure representing the SubmitFeedbackResponse.
- TagResource
Request - TagResource
Response - Timestamp
Structure A data type that contains a
Timestampobject. 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.- Untag
Resource Request - Untag
Resource Response - Update
Profiling Group Request The structure representing the updateProfilingGroupRequest.
- Update
Profiling Group Response The structure representing the updateProfilingGroupResponse.
- User
Feedback 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§
- AddNotification
Channels Error - Errors returned by AddNotificationChannels
- Batch
GetFrame Metric Data Error - Errors returned by BatchGetFrameMetricData
- Configure
Agent Error - Errors returned by ConfigureAgent
- Create
Profiling Group Error - Errors returned by CreateProfilingGroup
- Delete
Profiling Group Error - Errors returned by DeleteProfilingGroup
- Describe
Profiling Group Error - Errors returned by DescribeProfilingGroup
- GetFindings
Report Account Summary Error - Errors returned by GetFindingsReportAccountSummary
- GetNotification
Configuration Error - Errors returned by GetNotificationConfiguration
- GetPolicy
Error - Errors returned by GetPolicy
- GetProfile
Error - Errors returned by GetProfile
- GetRecommendations
Error - Errors returned by GetRecommendations
- List
Findings Reports Error - Errors returned by ListFindingsReports
- List
Profile Times Error - Errors returned by ListProfileTimes
- List
Profiling Groups Error - Errors returned by ListProfilingGroups
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Post
Agent Profile Error - Errors returned by PostAgentProfile
- PutPermission
Error - Errors returned by PutPermission
- Remove
Notification Channel Error - Errors returned by RemoveNotificationChannel
- Remove
Permission Error - Errors returned by RemovePermission
- Submit
Feedback Error - Errors returned by SubmitFeedback
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Profiling Group Error - Errors returned by UpdateProfilingGroup
Traits§
- Code
Guru Profiler - Trait representing the capabilities of the Amazon CodeGuru Profiler API. Amazon CodeGuru Profiler clients implement this trait.