View Source aws_codeguruprofiler (aws v1.0.4)
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: https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html in the Amazon CodeGuru Profiler User Guide.Summary
Functions
Used by profiler agents to report their current state and to receive remote configuration updates.
ProfilingGroupDescription
: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html object that contains information about the requested profiling group.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.Gets the aggregated profile of a profiling group for a specified time range.
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.
Returns a list of profiling groups.
Submits profiling data to an aggregated profile of a profiling group.
Adds permissions to a profiling group's resource-based policy that are provided using an action group.
Removes permissions from a profiling group's resource-based policy that are provided using an action group.
Functions
add_notification_channels(Client, ProfilingGroupName, Input0, Options0)
View Sourcebatch_get_frame_metric_data(Client, ProfilingGroupName, Input0, Options0)
View SourceUsed by profiler agents to report their current state and to receive remote configuration updates.
For example,ConfigureAgent
can be used to tell an agent whether to profile or not and for how long to return profiling data.
delete_profiling_group(Client, ProfilingGroupName, Input0, Options0)
View SourceProfilingGroupDescription
: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html object that contains information about the requested profiling group.
describe_profiling_group(Client, ProfilingGroupName, QueryMap, HeadersMap)
View Sourcedescribe_profiling_group(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0)
View SourceFindingsReportSummary
: 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.
get_findings_report_account_summary(Client, QueryMap, HeadersMap, Options0)
View Sourceget_notification_configuration(Client, ProfilingGroupName, QueryMap, HeadersMap)
View Sourceget_notification_configuration(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0)
View Sourceget_policy(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0)
View SourceGets 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>get_profile(Client, ProfilingGroupName, QueryMap, HeadersMap, Options0)
View Sourceget_recommendations(Client, ProfilingGroupName, EndTime, StartTime)
View SourceReturns 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.
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.
get_recommendations(Client, ProfilingGroupName, EndTime, StartTime, QueryMap, HeadersMap)
View Sourceget_recommendations(Client, ProfilingGroupName, EndTime, StartTime, QueryMap, HeadersMap, Options0)
View Sourcelist_findings_reports(Client, ProfilingGroupName, EndTime, StartTime)
View Sourcelist_findings_reports(Client, ProfilingGroupName, EndTime, StartTime, QueryMap, HeadersMap)
View Sourcelist_findings_reports(Client, ProfilingGroupName, EndTime, StartTime, QueryMap, HeadersMap, Options0)
View Sourcelist_profile_times(Client, ProfilingGroupName, EndTime, Period, StartTime)
View Sourcelist_profile_times(Client, ProfilingGroupName, EndTime, Period, StartTime, QueryMap, HeadersMap)
View Sourcelist_profile_times(Client, ProfilingGroupName, EndTime, Period, StartTime, QueryMap, HeadersMap, Options0)
View SourceReturns a list of profiling groups.
The profiling groups are returned asProfilingGroupDescription
: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html objects.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceSubmits profiling data to an aggregated profile of a profiling group.
To get an aggregated profile that is created with this profiling data, useGetProfile
: https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_GetProfile.html.
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.
put_permission(Client, ActionGroup, ProfilingGroupName, Input0, Options0)
View Sourceremove_notification_channel(Client, ChannelId, ProfilingGroupName, Input)
View Sourceremove_notification_channel(Client, ChannelId, ProfilingGroupName, Input0, Options0)
View SourceRemoves 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 isagentPermission
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.