Amazon CodeGuru Profiler ProfilingGroups API
The ProfilingGroups API from Amazon CodeGuru Profiler — 12 operation(s) for profilinggroups.
The ProfilingGroups API from Amazon CodeGuru Profiler — 12 operation(s) for profilinggroups.
openapi: 3.0.0
info:
version: '2019-07-18'
x-release: v4
title: Amazon CodeGuru Profiler Internal ProfilingGroups API
description: <p> This section provides documentation for the Amazon CodeGuru Profiler API operations. </p> <p> 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. </p> <p> 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. </p> <note> <p>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.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html">What is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>. </p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codeguruprofiler
x-aws-signingName: codeguru-profiler
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeguruprofiler-2019-07-18.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codeguru-profiler.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon CodeGuru Profiler multi-region endpoint
- url: https://codeguru-profiler.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon CodeGuru Profiler multi-region endpoint
- url: http://codeguru-profiler.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon CodeGuru Profiler endpoint for China (Beijing) and China (Ningxia)
- url: https://codeguru-profiler.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon CodeGuru Profiler endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: ProfilingGroups
paths:
/profilingGroups/{profilingGroupName}/notificationConfiguration:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AddNotificationChannels
description: Add up to 2 anomaly notifications channels for a profiling group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AddNotificationChannelsResponse'
examples:
AddNotificationChannels200Example:
summary: Default AddNotificationChannels 200 response
x-microcks-default: true
value:
notificationConfiguration: example-value
'480':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
AddNotificationChannels480Example:
summary: Default AddNotificationChannels 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
AddNotificationChannels481Example:
summary: Default AddNotificationChannels 481 response
x-microcks-default: true
value: example-value
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
AddNotificationChannels482Example:
summary: Default AddNotificationChannels 482 response
x-microcks-default: true
value: example-value
'483':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
AddNotificationChannels483Example:
summary: Default AddNotificationChannels 483 response
x-microcks-default: true
value: example-value
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
AddNotificationChannels484Example:
summary: Default AddNotificationChannels 484 response
x-microcks-default: true
value: example-value
'485':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
AddNotificationChannels485Example:
summary: Default AddNotificationChannels 485 response
x-microcks-default: true
value: example-value
parameters:
- name: profilingGroupName
in: path
required: true
description: The name of the profiling group that we are setting up notifications for.
schema:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 255
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- channels
properties:
channels:
description: One or 2 channels to report to when anomalies are detected.
type: array
items:
$ref: '#/components/schemas/Channel'
minItems: 1
maxItems: 2
examples:
AddNotificationChannelsRequestExample:
summary: Default AddNotificationChannels request
x-microcks-default: true
value:
channels:
- eventPublishers: example-value
id: '500123'
uri: https://example.amazonaws.com
summary: Amazon CodeGuru Profiler Add Notification Channels
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- ProfilingGroups
get:
operationId: GetNotificationConfiguration
description: Get the current configuration for anomaly notifications for a profiling group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetNotificationConfigurationResponse'
examples:
GetNotificationConfiguration200Example:
summary: Default GetNotificationConfiguration 200 response
x-microcks-default: true
value:
notificationConfiguration: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
GetNotificationConfiguration480Example:
summary: Default GetNotificationConfiguration 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
GetNotificationConfiguration481Example:
summary: Default GetNotificationConfiguration 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
GetNotificationConfiguration482Example:
summary: Default GetNotificationConfiguration 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
GetNotificationConfiguration483Example:
summary: Default GetNotificationConfiguration 483 response
x-microcks-default: true
value: example-value
parameters:
- name: profilingGroupName
in: path
required: true
description: The name of the profiling group we want to get the notification configuration for.
schema:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 255
summary: Amazon CodeGuru Profiler Get Notification Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- ProfilingGroups
/profilingGroups/{profilingGroupName}/frames/-/metrics:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: BatchGetFrameMetricData
description: ' Returns the time series of values for a requested list of frame metrics from a time period.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchGetFrameMetricDataResponse'
examples:
BatchGetFrameMetricData200Example:
summary: Default BatchGetFrameMetricData 200 response
x-microcks-default: true
value:
endTime: example-value
endTimes: example-value
frameMetricData: example-value
resolution: example-value
startTime: example-value
unprocessedEndTimes: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
BatchGetFrameMetricData480Example:
summary: Default BatchGetFrameMetricData 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
BatchGetFrameMetricData481Example:
summary: Default BatchGetFrameMetricData 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
BatchGetFrameMetricData482Example:
summary: Default BatchGetFrameMetricData 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
BatchGetFrameMetricData483Example:
summary: Default BatchGetFrameMetricData 483 response
x-microcks-default: true
value: example-value
parameters:
- name: endTime
in: query
required: false
description: ' The end time of the time period for the returned time series values. 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. '
schema:
type: string
format: date-time
- name: period
in: query
required: false
description: ' The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (<code>PT24H</code> or <code>P1D</code>). '
schema:
type: string
minLength: 1
maxLength: 64
- name: profilingGroupName
in: path
required: true
description: ' The name of the profiling group associated with the the frame metrics used to return the time series values. '
schema:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 255
- name: startTime
in: query
required: false
description: ' The start time of the time period for the frame metrics used to return the time series values. 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. '
schema:
type: string
format: date-time
- name: targetResolution
in: query
required: false
description: <p>The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. </p> <ul> <li> <p> <code>P1D</code> — 1 day </p> </li> <li> <p> <code>PT1H</code> — 1 hour </p> </li> <li> <p> <code>PT5M</code> — 5 minutes </p> </li> </ul>
schema:
type: string
enum:
- PT5M
- PT1H
- P1D
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
frameMetrics:
description: ' The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.'
type: array
items:
$ref: '#/components/schemas/FrameMetric'
examples:
BatchGetFrameMetricDataRequestExample:
summary: Default BatchGetFrameMetricData request
x-microcks-default: true
value:
frameMetrics:
- frameName: example-resource
threadStates: example-value
type: STANDARD
summary: Amazon CodeGuru Profiler Batch Get Frame Metric Data
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- ProfilingGroups
/profilingGroups/{profilingGroupName}/configureAgent:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ConfigureAgent
description: ' Used by profiler agents to report their current state and to receive remote configuration updates. For example, <code>ConfigureAgent</code> can be used to tell an agent whether to profile or not and for how long to return profiling data. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureAgentResponse'
examples:
ConfigureAgent200Example:
summary: Default ConfigureAgent 200 response
x-microcks-default: true
value:
configuration: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ConfigureAgent480Example:
summary: Default ConfigureAgent 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ConfigureAgent481Example:
summary: Default ConfigureAgent 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
ConfigureAgent482Example:
summary: Default ConfigureAgent 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ConfigureAgent483Example:
summary: Default ConfigureAgent 483 response
x-microcks-default: true
value: example-value
parameters:
- name: profilingGroupName
in: path
required: true
description: ' The name of the profiling group for which the configured agent is collecting profiling data. '
schema:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 255
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
fleetInstanceId:
description: ' A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container''s task ID. '
type: string
minLength: 1
maxLength: 255
metadata:
description: <p> Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p> <ul> <li> <p> <code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running </p> </li> <li> <p> <code>AGENT_ID</code> - The ID for an agent instance. </p> </li> <li> <p> <code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation. </p> </li> <li> <p> <code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on. </p> </li> <li> <p> <code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function. </p> </li> <li> <p> <code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function. </p> </li> <li> <p> <code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out. </p> </li> <li> <p> <code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function. </p> </li> <li> <p> <code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation. </p> </li> </ul>
type: object
additionalProperties:
$ref: '#/components/schemas/String'
examples:
ConfigureAgentRequestExample:
summary: Default ConfigureAgent request
x-microcks-default: true
value:
fleetInstanceId: '500123'
metadata: {}
summary: Amazon CodeGuru Profiler Configure Agent
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- ProfilingGroups
/profilingGroups/{profilingGroupName}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteProfilingGroup
description: Deletes a profiling group.
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProfilingGroupResponse'
examples:
DeleteProfilingGroup204Example:
summary: Default DeleteProfilingGroup 204 response
x-microcks-default: true
value: {}
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DeleteProfilingGroup480Example:
summary: Default DeleteProfilingGroup 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeleteProfilingGroup481Example:
summary: Default DeleteProfilingGroup 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DeleteProfilingGroup482Example:
summary: Default DeleteProfilingGroup 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DeleteProfilingGroup483Example:
summary: Default DeleteProfilingGroup 483 response
x-microcks-default: true
value: example-value
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DeleteProfilingGroup484Example:
summary: Default DeleteProfilingGroup 484 response
x-microcks-default: true
value: example-value
parameters:
- name: profilingGroupName
in: path
required: true
description: The name of the profiling group to delete.
schema:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 255
summary: Amazon CodeGuru Profiler Delete Profiling Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- ProfilingGroups
get:
operationId: DescribeProfilingGroup
description: ' Returns a <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> object that contains information about the requested profiling group. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeProfilingGroupResponse'
examples:
DescribeProfilingGroup200Example:
summary: Default DescribeProfilingGroup 200 response
x-microcks-default: true
value:
profilingGroup: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DescribeProfilingGroup480Example:
summary: Default DescribeProfilingGroup 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DescribeProfilingGroup481Example:
summary: Default DescribeProfilingGroup 481 response
x-microcks-default: true
value: example-value
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DescribeProfilingGroup482Example:
summary: Default DescribeProfilingGroup 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DescribeProfilingGroup483Example:
summary: Default DescribeProfilingGroup 483 response
x-microcks-default: true
value: example-value
parameters:
- name: profilingGroupName
in: path
required: true
description: ' The name of the profiling group to get information about. '
schema:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 255
summary: Amazon CodeGuru Profiler Describe Profiling Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- ProfilingGroups
put:
operationId: UpdateProfilingGroup
description: Updates a profiling group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProfilingGroupResponse'
examples:
UpdateProfilingGroup200Example:
summary: Default UpdateProfilingGroup 200 response
x-microcks-default: true
value:
profilingGroup: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
UpdateProfilingGroup480Example:
summary: Default UpdateProfilingGroup 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
UpdateProfilingGroup481Example:
summary: Default UpdateProfilingGroup 481 response
x-microcks-default: true
value: example-value
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateProfilingGroup482Example:
summary: Default UpdateProfilingGroup 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
UpdateProfilingGroup483Example:
summary: Default UpdateProfilingGroup 483 response
# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-profiler/refs/heads/main/openapi/amazon-codeguru-profiler-profilinggroups-api-openapi.yml