integrations.sh
← all integrations

amazonaws.com – codeguruprofiler

OpenAPI apis-guru cloud

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 in the Amazon CodeGuru Profiler User Guide.

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:codeguruprofiler/2019-07-18.json
Provider
amazonaws.com:codeguruprofiler / codeguruprofiler
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/codeguruprofiler/2019-07-18/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/codeguruprofiler/2019-07-18/openapi.yaml

Tools (25)

Extracted live via the executor SDK.

  • internal.getFindingsReportAccountSummary

    Returns a list of objects that contain analysis results for all profiling groups in your AWS account.

  • internal.getRecommendations

    Returns a list of objects that contain recommendations for a profiling group for a given time period. A list of objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

  • internal.listFindingsReports

    List the available reports for a given profiling group and time range.

  • internal.submitFeedback

    Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.

  • profilingGroups.addNotificationChannels

    Add up to 2 anomaly notifications channels for a profiling group.

  • profilingGroups.batchGetFrameMetricData

    Returns the time series of values for a requested list of frame metrics from a time period.

  • profilingGroups.configureAgent

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

  • profilingGroups.deleteProfilingGroup

    Deletes a profiling group.

  • profilingGroups.describeProfilingGroup

    Returns a object that contains information about the requested profiling group.

  • profilingGroups.getNotificationConfiguration

    Get the current configuration for anomaly notifications for a profiling group.

  • profilingGroups.getPolicy

    Returns the JSON-formatted resource-based policy on a profiling group.

  • profilingGroups.getProfile

    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> 
  • profilingGroups.listProfileTimes

    Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

  • profilingGroups.listProfilingGroups

    Returns a list of profiling groups. The profiling groups are returned as objects.

  • profilingGroups.postAgentProfile

    Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use .

  • profilingGroups.putPermission

    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> 
  • profilingGroups.removeNotificationChannel

    Remove one anomaly notifications channel for a profiling group.

  • profilingGroups.removePermission

    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 in the Amazon CodeGuru Profiler User Guide, , and .

  • profilingGroups.updateProfilingGroup

    Updates a profiling group.

  • profilingGroupsClientToken.createProfilingGroup

    Creates a profiling group.

  • tags.listTagsForResource

    Returns a list of the tags that are assigned to a specified resource.

  • tags.tagResource

    Use to assign one or more tags to a resource.

  • tags.untagResource

    Use to remove one or more tags from a resource.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools