openapi: 3.0.0 info: version: '2019-07-18' x-release: v4 title: Amazon CodeGuru Profiler Internal ProfilingGroups API 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.

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 (PT24H or P1D). ' 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:

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.

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, ConfigureAgent 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:

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

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 ProfilingGroupDescription 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 x-microcks-default: true value: example-value '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdateProfilingGroup484Example: summary: Default UpdateProfilingGroup 484 response x-microcks-default: true value: example-value parameters: - name: profilingGroupName in: path required: true description: The name of the profiling group to update. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - agentOrchestrationConfig properties: agentOrchestrationConfig: description: ' Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group. ' type: object properties: profilingEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: ' A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. ' examples: UpdateProfilingGroupRequestExample: summary: Default UpdateProfilingGroup request x-microcks-default: true value: agentOrchestrationConfig: profilingEnabled: example-value summary: Amazon CodeGuru Profiler Update Profiling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/policy: 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' get: operationId: GetPolicy description: ' Returns the JSON-formatted resource-based policy on a profiling group. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPolicyResponse' examples: GetPolicy200Example: summary: Default GetPolicy 200 response x-microcks-default: true value: policy: example-value revisionId: '500123' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetPolicy480Example: summary: Default GetPolicy 480 response x-microcks-default: true value: example-value '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetPolicy481Example: summary: Default GetPolicy 481 response x-microcks-default: true value: example-value '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetPolicy482Example: summary: Default GetPolicy 482 response x-microcks-default: true value: example-value parameters: - name: profilingGroupName in: path required: true description: The name of the profiling group. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 summary: Amazon CodeGuru Profiler Get Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/profile: 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' get: operationId: GetProfile description: '

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>
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetProfileResponse' examples: GetProfile200Example: summary: Default GetProfile 200 response x-microcks-default: true value: profile: example-value '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetProfile480Example: summary: Default GetProfile 480 response x-microcks-default: true value: example-value '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: GetProfile481Example: summary: Default GetProfile 481 response x-microcks-default: true value: example-value '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetProfile482Example: summary: Default GetProfile 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetProfile483Example: summary: Default GetProfile 483 response x-microcks-default: true value: example-value parameters: - name: Accept in: header required: false description: '

The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . 

 <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
' schema: type: string - name: endTime in: query required: false description:

The end time of the requested profile. Specify 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.

If you specify endTime, then you must also specify period or startTime, but not both.

schema: type: string format: date-time - name: maxDepth in: query required: false description: ' The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B. ' schema: type: integer minimum: 1 maximum: 10000 - name: period in: query required: false description:

Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S. 

 <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
schema: type: string minLength: 1 maxLength: 64 - name: profilingGroupName in: path required: true description: The name of the profiling group to get. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 - name: startTime in: query required: false description:

The start time of the profile to get. Specify 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.

 <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
schema: type: string format: date-time summary: Amazon CodeGuru Profiler Get Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/profileTimes#endTime&period&startTime: 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' get: operationId: ListProfileTimes description: Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListProfileTimesResponse' examples: ListProfileTimes200Example: summary: Default ListProfileTimes 200 response x-microcks-default: true value: nextToken: example-value profileTimes: example-value '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListProfileTimes480Example: summary: Default ListProfileTimes 480 response x-microcks-default: true value: example-value '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: ListProfileTimes481Example: summary: Default ListProfileTimes 481 response x-microcks-default: true value: example-value '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListProfileTimes482Example: summary: Default ListProfileTimes 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: ListProfileTimes483Example: summary: Default ListProfileTimes 483 response x-microcks-default: true value: example-value parameters: - name: endTime in: query required: true description: The end time of the time range from which to list the profiles. schema: type: string format: date-time - name: maxResults in: query required: false description: 'The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value. ' schema: type: integer minimum: 1 maximum: 1000 - name: nextToken in: query required: false description:

The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

 schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 64 - name: orderBy in: query required: false description: 'The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING. ' schema: type: string enum: - TimestampDescending - TimestampAscending - name: period in: query required: true description:

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

schema: type: string enum: - PT5M - PT1H - P1D - name: profilingGroupName in: path required: true description: The name of the profiling group. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 - name: startTime in: query required: true description: The start time of the time range from which to list the profiles. schema: type: string format: date-time summary: Amazon CodeGuru Profiler List Profile Times x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups: 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' get: operationId: ListProfilingGroups description: ' Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListProfilingGroupsResponse' examples: ListProfilingGroups200Example: summary: Default ListProfilingGroups 200 response x-microcks-default: true value: nextToken: example-value profilingGroupNames: example-resource profilingGroups: example-value '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: ListProfilingGroups480Example: summary: Default ListProfilingGroups 480 response x-microcks-default: true value: example-value '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: ListProfilingGroups481Example: summary: Default ListProfilingGroups 481 response x-microcks-default: true value: example-value parameters: - name: includeDescription in: query required: false description: A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned. schema: type: boolean - name: maxResults in: query required: false description: 'The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value. ' schema: type: integer minimum: 1 maximum: 1000 - name: nextToken in: query required: false description:

The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

 schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 64 summary: Amazon CodeGuru Profiler List Profiling Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/agentProfile#Content-Type: 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: PostAgentProfile description: ' Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile . ' responses: '204': description: Success content: application/json: schema: $ref: '#/components/schemas/PostAgentProfileResponse' examples: PostAgentProfile204Example: summary: Default PostAgentProfile 204 response x-microcks-default: true value: {} '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: PostAgentProfile480Example: summary: Default PostAgentProfile 480 response x-microcks-default: true value: example-value '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: PostAgentProfile481Example: summary: Default PostAgentProfile 481 response x-microcks-default: true value: example-value '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: PostAgentProfile482Example: summary: Default PostAgentProfile 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: PostAgentProfile483Example: summary: Default PostAgentProfile 483 response x-microcks-default: true value: example-value parameters: - name: Content-Type in: header required: true description: '

The format of the submitted profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . 

 <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
' schema: type: string - name: profileToken in: query required: false description: ' Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries. ' schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 64 - name: profilingGroupName in: path required: true description: ' The name of the profiling group with the aggregated profile that receives the submitted profiling data. ' schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - agentProfile properties: agentProfile: description: ' The submitted profiling data. ' type: string examples: PostAgentProfileRequestExample: summary: Default PostAgentProfile request x-microcks-default: true value: agentProfile: example-value summary: Amazon CodeGuru Profiler Post Agent Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/policy/{actionGroup}: 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' put: operationId: PutPermission description:

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>
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutPermissionResponse' examples: PutPermission200Example: summary: Default PutPermission 200 response x-microcks-default: true value: policy: example-value revisionId: '500123' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: PutPermission480Example: summary: Default PutPermission 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: PutPermission481Example: summary: Default PutPermission 481 response x-microcks-default: true value: example-value '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: PutPermission482Example: summary: Default PutPermission 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: PutPermission483Example: summary: Default PutPermission 483 response x-microcks-default: true value: example-value '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: PutPermission484Example: summary: Default PutPermission 484 response x-microcks-default: true value: example-value parameters: - name: actionGroup in: path required: true description: ' Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions. ' schema: type: string enum: - agentPermissions - name: profilingGroupName in: path required: true description: The name of the profiling group to grant access to. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - principals properties: principals: description: ' A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs. ' type: array items: $ref: '#/components/schemas/Principal' minItems: 1 maxItems: 50 revisionId: description: ' A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId. ' type: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' examples: PutPermissionRequestExample: summary: Default PutPermission request x-microcks-default: true value: principals: - example-value revisionId: '500123' summary: Amazon CodeGuru Profiler Put Permission x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/notificationConfiguration/{channelId}: 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: RemoveNotificationChannel description: Remove one anomaly notifications channel for a profiling group. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveNotificationChannelResponse' examples: RemoveNotificationChannel200Example: summary: Default RemoveNotificationChannel 200 response x-microcks-default: true value: notificationConfiguration: example-value '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: RemoveNotificationChannel480Example: summary: Default RemoveNotificationChannel 480 response x-microcks-default: true value: example-value '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: RemoveNotificationChannel481Example: summary: Default RemoveNotificationChannel 481 response x-microcks-default: true value: example-value '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: RemoveNotificationChannel482Example: summary: Default RemoveNotificationChannel 482 response x-microcks-default: true value: example-value '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: RemoveNotificationChannel483Example: summary: Default RemoveNotificationChannel 483 response x-microcks-default: true value: example-value parameters: - name: channelId in: path required: true description: The id of the channel that we want to stop receiving notifications. schema: type: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' - name: profilingGroupName in: path required: true description: The name of the profiling group we want to change notification configuration for. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 summary: Amazon CodeGuru Profiler Remove Notification Channel x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups /profilingGroups/{profilingGroupName}/policy/{actionGroup}#revisionId: 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: RemovePermission description: ' 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 Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile . ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemovePermissionResponse' examples: RemovePermission200Example: summary: Default RemovePermission 200 response x-microcks-default: true value: policy: example-value revisionId: '500123' '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: RemovePermission480Example: summary: Default RemovePermission 480 response x-microcks-default: true value: example-value '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: RemovePermission481Example: summary: Default RemovePermission 481 response x-microcks-default: true value: example-value '482': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: RemovePermission482Example: summary: Default RemovePermission 482 response x-microcks-default: true value: example-value '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: RemovePermission483Example: summary: Default RemovePermission 483 response x-microcks-default: true value: example-value '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: RemovePermission484Example: summary: Default RemovePermission 484 response x-microcks-default: true value: example-value parameters: - name: actionGroup in: path required: true description: ' Specifies an action group that contains the permissions to remove from a profiling group''s resource-based policy. One action group is supported, agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions. ' schema: type: string enum: - agentPermissions - name: profilingGroupName in: path required: true description: The name of the profiling group. schema: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 - name: revisionId in: query required: true description: ' A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions. ' schema: type: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' summary: Amazon CodeGuru Profiler Remove Permission x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - ProfilingGroups components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false schemas: ResourceNotFoundException: {} AddNotificationChannelsResponse: type: object properties: notificationConfiguration: allOf: - $ref: '#/components/schemas/NotificationConfiguration' - description: The new notification configuration for this profiling group. description: The structure representing the AddNotificationChannelsResponse. Channels: type: array items: $ref: '#/components/schemas/Channel' minItems: 1 maxItems: 2 ListOfTimestamps: type: array items: $ref: '#/components/schemas/TimestampStructure' Timestamp: type: string format: date-time ComputePlatform: type: string enum: - Default - AWSLambda AgentConfiguration: type: object required: - periodInSeconds - shouldProfile properties: agentParameters: allOf: - $ref: '#/components/schemas/AgentParameters' - description: '

Parameters used by the profiler. The valid parameters are:

' periodInSeconds: allOf: - $ref: '#/components/schemas/Integer' - description: ' How long a profiling agent should send profiling data using ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period. ' shouldProfile: allOf: - $ref: '#/components/schemas/Boolean' - description: ' A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. ' description: ' The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data. ' ChannelUri: type: string description: Channel URI uniquely identifies a Notification Channel. TopicArn is the uri for an SNS channel, emailId is uri for an email channel etc. Currently we only support SNS channels and thus required to be an ARN PutPermissionResponse: type: object required: - policy - revisionId properties: policy: allOf: - $ref: '#/components/schemas/String' - description: ' The JSON-formatted resource-based policy on the profiling group that includes the added permissions. ' revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: ' A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response. ' description: The structure representing the putPermissionResponse. DeleteProfilingGroupResponse: type: object properties: {} description: The structure representing the deleteProfilingGroupResponse. InternalServerException: {} ConflictException: {} AggregationPeriod: type: string enum: - PT5M - PT1H - P1D ProfilingStatus: type: object properties: latestAgentOrchestratedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the profiling agent most recently pinged back. Specify 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. latestAgentProfileReportedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time when the most recent profile was received. Specify 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. latestAggregatedProfile: allOf: - $ref: '#/components/schemas/AggregatedProfileTime' - description: ' An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile. ' description: ' 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. ' ListProfileTimesResponse: type: object required: - profileTimes properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: 'The nextToken value to include in a future ListProfileTimes request. When the results of a ListProfileTimes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. ' profileTimes: allOf: - $ref: '#/components/schemas/ProfileTimes' - description: 'The list of start times of the available profiles for the aggregation period in the specified time range. ' description: The structure representing the listProfileTimesResponse. AgentParameters: type: object additionalProperties: $ref: '#/components/schemas/String' PaginationToken: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 64 FrameMetricValue: type: number format: double FrameMetricData: type: array items: $ref: '#/components/schemas/FrameMetricDatum' FrameMetric: type: object required: - frameName - threadStates - type properties: frameName: allOf: - $ref: '#/components/schemas/String' - description: ' Name of the method common across the multiple occurrences of a frame in an application profile.' threadStates: allOf: - $ref: '#/components/schemas/ThreadStates' - description: List of application runtime thread states used to get the counts for a frame a derive a metric value. type: allOf: - $ref: '#/components/schemas/MetricType' - description: ' A type of aggregation that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile. ' description: ' The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.' ThreadStates: type: array items: $ref: '#/components/schemas/String' ListProfilingGroupsResponse: type: object required: - profilingGroupNames properties: nextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: 'The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. ' profilingGroupNames: allOf: - $ref: '#/components/schemas/ProfilingGroupNames' - description: ' A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned. ' profilingGroups: allOf: - $ref: '#/components/schemas/ProfilingGroupDescriptions' - description: ' A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned. ' description: The structure representing the listProfilingGroupsResponse. ProfileTime: type: object properties: start: allOf: - $ref: '#/components/schemas/Timestamp' - description: The start time of a profile. It 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. description: ' Contains the start time of a profile. ' AgentOrchestrationConfig: type: object required: - profilingEnabled properties: profilingEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: ' A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling. ' description: ' Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group. ' Boolean: type: boolean RemovePermissionResponse: type: object required: - policy - revisionId properties: policy: allOf: - $ref: '#/components/schemas/String' - description: ' The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed. ' revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: ' A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the policy element of the response. ' description: The structure representing the removePermissionResponse. GetProfileResponse: type: object required: - profile properties: profile: allOf: - $ref: '#/components/schemas/AggregatedProfile' - description: Information about the profile. description: The structure representing the getProfileResponse. Integer: type: integer DescribeProfilingGroupResponse: type: object required: - profilingGroup properties: profilingGroup: allOf: - $ref: '#/components/schemas/ProfilingGroupDescription' - description: ' The returned ProfilingGroupDescription object that contains information about the requested profiling group. ' description: The structure representing the describeProfilingGroupResponse. Principal: type: string AggregatedProfile: type: string UpdateProfilingGroupResponse: type: object required: - profilingGroup properties: profilingGroup: allOf: - $ref: '#/components/schemas/ProfilingGroupDescription' - description: ' A ProfilingGroupDescription that contains information about the returned updated profiling group. ' description: The structure representing the updateProfilingGroupResponse. ConfigureAgentResponse: type: object required: - configuration properties: configuration: allOf: - $ref: '#/components/schemas/AgentConfiguration' - description: ' An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data. ' description: The structure representing the configureAgentResponse. ThrottlingException: {} ProfileTimes: type: array items: $ref: '#/components/schemas/ProfileTime' ChannelId: type: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' ProfilingGroupName: type: string pattern: ^[\w-]+$ minLength: 1 maxLength: 255 ProfilingGroupDescription: type: object properties: agentOrchestrationConfig: allOf: - $ref: '#/components/schemas/AgentOrchestrationConfig' - description: ' An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not. ' arn: allOf: - $ref: '#/components/schemas/ProfilingGroupArn' - description: The Amazon Resource Name (ARN) identifying the profiling group resource. computePlatform: allOf: - $ref: '#/components/schemas/ComputePlatform' - description: ' The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default. ' createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The time when the profiling group was created. Specify 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. ' name: allOf: - $ref: '#/components/schemas/ProfilingGroupName' - description: The name of the profiling group. profilingStatus: allOf: - $ref: '#/components/schemas/ProfilingStatus' - description: ' A ProfilingStatus object that 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. ' tags: allOf: - $ref: '#/components/schemas/TagsMap' - description: ' A list of the tags that belong to this profiling group. ' updatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' The date and time when the profiling group was last updated. Specify 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. ' description: ' Contains information about a profiling group. ' NotificationConfiguration: type: object properties: channels: allOf: - $ref: '#/components/schemas/Channels' - description: List of up to two channels to be used for sending notifications for events detected from the application profile. description: 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. TagsMap: type: object additionalProperties: $ref: '#/components/schemas/String' EventPublishers: type: array items: $ref: '#/components/schemas/EventPublisher' minItems: 1 maxItems: 1 String: type: string BatchGetFrameMetricDataResponse: type: object required: - endTime - endTimes - frameMetricData - resolution - startTime - unprocessedEndTimes properties: endTime: allOf: - $ref: '#/components/schemas/Timestamp' - 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. ' endTimes: allOf: - $ref: '#/components/schemas/ListOfTimestamps' - description: ' List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart. ' frameMetricData: allOf: - $ref: '#/components/schemas/FrameMetricData' - description: Details of the metrics 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. resolution: allOf: - $ref: '#/components/schemas/AggregationPeriod' - description:

Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

startTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' The start 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. ' unprocessedEndTimes: allOf: - $ref: '#/components/schemas/UnprocessedEndTimeMap' - description: List of instances which remained unprocessed. This will create a missing time step in the list of end times. description: The structure representing the BatchGetFrameMetricDataResponse. GetPolicyResponse: type: object required: - policy - revisionId properties: policy: allOf: - $ref: '#/components/schemas/String' - description: The JSON-formatted resource-based policy attached to the ProfilingGroup. revisionId: allOf: - $ref: '#/components/schemas/RevisionId' - description: A unique identifier for the current revision of the returned policy. description: The structure representing the getPolicyResponse. ValidationException: {} MetricType: type: string enum: - AggregatedRelativeTotalTime EventPublisher: type: string enum: - AnomalyDetection PostAgentProfileResponse: type: object properties: {} description: The structure representing the postAgentProfileResponse. RevisionId: type: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}' FrameMetricValues: type: array items: $ref: '#/components/schemas/FrameMetricValue' UnprocessedEndTimeMap: type: object additionalProperties: $ref: '#/components/schemas/ListOfTimestamps' TimestampStructure: type: object required: - value properties: value: allOf: - $ref: '#/components/schemas/Timestamp' - description: ' A Timestamp. 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. ' description: ' A data type that contains a Timestamp object. 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. ' AggregatedProfileTime: type: object properties: period: allOf: - $ref: '#/components/schemas/AggregationPeriod' - description:

The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

start: allOf: - $ref: '#/components/schemas/Timestamp' - description:

The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

Specify start 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.

description: ' 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). ' ProfilingGroupNames: type: array items: $ref: '#/components/schemas/ProfilingGroupName' GetNotificationConfigurationResponse: type: object required: - notificationConfiguration properties: notificationConfiguration: allOf: - $ref: '#/components/schemas/NotificationConfiguration' - description: The current notification configuration for this profiling group. description: The structure representing the GetNotificationConfigurationResponse. ProfilingGroupDescriptions: type: array items: $ref: '#/components/schemas/ProfilingGroupDescription' Channel: type: object required: - eventPublishers - uri properties: eventPublishers: allOf: - $ref: '#/components/schemas/EventPublishers' - description: List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler. id: allOf: - $ref: '#/components/schemas/ChannelId' - description: Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request. uri: allOf: - $ref: '#/components/schemas/ChannelUri' - description: Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri. description: Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel. FrameMetricDatum: type: object required: - frameMetric - values properties: frameMetric: $ref: '#/components/schemas/FrameMetric' values: allOf: - $ref: '#/components/schemas/FrameMetricValues' - description: ' A list of values that are associated with a frame metric. ' description: ' Information about a frame metric and its values. ' ServiceQuotaExceededException: {} ProfilingGroupArn: type: string RemoveNotificationChannelResponse: type: object properties: notificationConfiguration: allOf: - $ref: '#/components/schemas/NotificationConfiguration' - description: The new notification configuration for this profiling group. description: The structure representing the RemoveNotificationChannelResponse. securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/codeguru-profiler/ x-hasEquivalentPaths: true