Amazon Web Services, Inc.

Amazon CodeGuru Profiler

This section provides documentation for the Amazon CodeGuru Profiler API operations. Amazon CodeGuru Profiler collects runtime performance data from your live…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 23

Profiling group

  • GETGet notification configuration/profilingGroups/:profilingGroupName/notificationConfigurationGet the current configuration for anomaly notifications for a profiling group.
  • POSTAdd notification channels/profilingGroups/:profilingGroupName/notificationConfigurationAdd up to 2 anomaly notifications channels for a profiling group.
  • POSTBatch get frame metric data/profilingGroups/:profilingGroupName/frames/-/metrics?startTime=string&endTime=string&period=string&targetResolution=stringReturns the time series of values for a requested list of frame metrics from a time period.
  • POSTConfigure agent/profilingGroups/:profilingGroupName/configureAgentUsed by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell an agent…
  • GETList profiling groups/profilingGroups?nextToken=string&maxResults=0&includeDescription=trueReturns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.
  • POSTCreate profiling group/profilingGroups?clientToken=stringCreates a profiling group.
  • GETDescribe profiling group/profilingGroups/:profilingGroupNameReturns a ProfilingGroupDescription object that contains information about the requested profiling group.
  • PUTUpdate profiling group/profilingGroups/:profilingGroupNameUpdates a profiling group.
  • DELETEDelete profiling group/profilingGroups/:profilingGroupNameDeletes a profiling group.
  • GETGet policy/profilingGroups/:profilingGroupName/policyReturns the JSON-formatted resource-based policy on a profiling group.
  • GETGet profile/profilingGroups/:profilingGroupName/profile?startTime=string&period=string&endTime=string&maxDepth=0Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group…
  • GETGet recommendations/internal/profilingGroups/:profilingGroupName/recommendations?startTime=string&endTime=string&locale=stringReturns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains…
  • GETList findings reports/internal/profilingGroups/:profilingGroupName/findingsReports?startTime=string&endTime=string&nextToken=string&maxResults=0&dailyReportsOnly=trueList the available reports for a given profiling group and time range.
  • GETList profile times/profilingGroups/:profilingGroupName/profileTimes?startTime=string&endTime=string&period=string&orderBy=string&maxResults=0&nextToken=stringLists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
  • POSTPost agent profile/profilingGroups/:profilingGroupName/agentProfileSubmits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .
  • PUTPut permission/profilingGroups/:profilingGroupName/policy/:actionGroupAdds 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…
  • DELETERemove permission/profilingGroups/:profilingGroupName/policy/:actionGroup?revisionId=stringRemoves 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…
  • DELETERemove notification channel/profilingGroups/:profilingGroupName/notificationConfiguration/:channelIdRemove one anomaly notifications channel for a profiling group.
  • POSTSubmit feedback/internal/profilingGroups/:profilingGroupName/anomalies/:anomalyInstanceId/feedbackSends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.
  • GETGet findings report account summary/internal/findingsReports?nextToken=string&maxResults=0&dailyReportsOnly=trueReturns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.
  • GETList tags for resource/tags/:resourceArnReturns a list of the tags that are assigned to a specified resource.
  • POSTTag resource/tags/:resourceArnUse to assign one or more tags to a resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Use to remove one or more tags from a resource.

API details

Base URL
https://codeguru-profiler.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
23 operations on 16 pathsGET 10POST 7DELETE 4PUT 2
Main resources
Profiling group 19
Description format
AWS Smithy model, API version 2019-07-18

How to test the Amazon CodeGuru Profiler in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CodeGuru Profiler collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get notification configuration” (GET /profilingGroups/:profilingGroupName/notificationConfiguration), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CodeGuru Profiler?

This section provides documentation for the Amazon CodeGuru Profiler API operations. Amazon CodeGuru Profiler collects runtime performance data from your live… It is listed under Developer tools and has 23 endpoints.

Who publishes the Amazon CodeGuru Profiler?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon CodeGuru Profiler?

Requests go to https://codeguru-profiler.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon CodeGuru Profiler?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon CodeGuru Profiler have?

23 operations on 16 paths (10 GET, 7 POST, 4 DELETE, 2 PUT). The largest groups are Profiling group.

Is forking the Amazon CodeGuru Profiler free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.