Amazon CodeGuru Profiler Tags API
The Tags API from Amazon CodeGuru Profiler — 2 operation(s) for tags.
The Tags API from Amazon CodeGuru Profiler — 2 operation(s) for tags.
openapi: 3.0.0
info:
version: '2019-07-18'
x-release: v4
title: Amazon CodeGuru Profiler Internal Tags 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: Tags
paths:
/tags/{resourceArn}:
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: ListTagsForResource
description: ' Returns a list of the tags that are assigned to a specified resource. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
examples:
ListTagsForResource200Example:
summary: Default ListTagsForResource 200 response
x-microcks-default: true
value:
tags: example-value
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
ListTagsForResource480Example:
summary: Default ListTagsForResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
ListTagsForResource481Example:
summary: Default ListTagsForResource 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListTagsForResource482Example:
summary: Default ListTagsForResource 482 response
x-microcks-default: true
value: example-value
parameters:
- name: resourceArn
in: path
required: true
description: ' The Amazon Resource Name (ARN) of the resource that contains the tags to return. '
schema:
type: string
summary: Amazon CodeGuru Profiler List Tags for Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Tags
post:
operationId: TagResource
description: ' Use to assign one or more tags to a resource. '
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceResponse'
examples:
TagResource204Example:
summary: Default TagResource 204 response
x-microcks-default: true
value: {}
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
TagResource481Example:
summary: Default TagResource 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
TagResource482Example:
summary: Default TagResource 482 response
x-microcks-default: true
value: example-value
parameters:
- name: resourceArn
in: path
required: true
description: ' The Amazon Resource Name (ARN) of the resource that the tags are added to. '
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tags
properties:
tags:
description: ' The list of tags that are added to the specified resource. '
type: object
additionalProperties:
$ref: '#/components/schemas/String'
examples:
TagResourceRequestExample:
summary: Default TagResource request
x-microcks-default: true
value:
tags: {}
summary: Amazon CodeGuru Profiler Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Tags
/tags/{resourceArn}#tagKeys:
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: UntagResource
description: ' Use to remove one or more tags from a resource. '
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
examples:
UntagResource204Example:
summary: Default UntagResource 204 response
x-microcks-default: true
value: {}
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
UntagResource480Example:
summary: Default UntagResource 480 response
x-microcks-default: true
value: example-value
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UntagResource481Example:
summary: Default UntagResource 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UntagResource482Example:
summary: Default UntagResource 482 response
x-microcks-default: true
value: example-value
parameters:
- name: resourceArn
in: path
required: true
description: ' The Amazon Resource Name (ARN) of the resource that contains the tags to remove. '
schema:
type: string
- name: tagKeys
in: query
required: true
description: ' A list of tag keys. Existing tags of resources with keys in this list are removed from the specified resource. '
schema:
type: array
items:
$ref: '#/components/schemas/String'
summary: Amazon CodeGuru Profiler Untag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Tags
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
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-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-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
ResourceNotFoundException: {}
UntagResourceResponse:
type: object
properties: {}
TagsMap:
type: object
additionalProperties:
$ref: '#/components/schemas/String'
String:
type: string
ListTagsForResourceResponse:
type: object
properties:
tags:
allOf:
- $ref: '#/components/schemas/TagsMap'
- description: ' The list of tags assigned to the specified resource. This is the list of tags returned in the response. '
TagResourceResponse:
type: object
properties: {}
InternalServerException: {}
ValidationException: {}
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