Tags - Amazon API Gateway
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Tags

Represents a collection of tags associated with the resource.

URI

/v2/tags/resource-arn

HTTP methods

GET

Operation ID: GetTags

Gets a collection of Tag resources.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The resource ARN for the tag.

Responses
Status codeResponse modelDescription
200Tags

Success

400BadRequestException

One of the parameters in the request is invalid.

404NotFoundException

The resource specified in the request was not found.

409ConflictException

The resource already exists.

429LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

POST

Operation ID: TagResource

Creates a new Tag resource to represent a tag.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The resource ARN for the tag.

Responses
Status codeResponse modelDescription
201None

The request has succeeded and has resulted in the creation of a resource.

400BadRequestException

One of the parameters in the request is invalid.

404NotFoundException

The resource specified in the request was not found.

409ConflictException

The resource already exists.

429LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: UntagResource

Deletes a Tag.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The resource ARN for the tag.

Query parameters
NameTypeRequiredDescription
tagKeysStringTrue

The tag keys.

Responses
Status codeResponse modelDescription
204None

The request has succeeded, and there is no additional content to send in the response payload body.

400BadRequestException

One of the parameters in the request is invalid.

404NotFoundException

The resource specified in the request was not found.

409ConflictException

The resource already exists.

429LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies

{ "tags": { } }

Response bodies

{ }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
{ "message": "string", "limitType": "string" }

Properties

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

PropertyTypeRequiredDescription
limitType

string

False

The limit type.

message

string

False

Describes the error encountered.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

PropertyTypeRequiredDescription
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

TagResourceInput

Represents the input parameters for a TagResource request.

PropertyTypeRequiredDescription
tags

Tags

False

The collection of tags. Each tag element is associated with a given resource.

Tags

Represents a collection of tags associated with the resource.

PropertyTypeRequiredDescription

*

string

False