URI HTTP methods Schemas Properties See also

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
Name	Type	Required	Description
`resource-arn`	String	True	The resource ARN for the tag.

Responses
Status code	Response model	Description
`200`	`Tags`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`404`	`NotFoundException`	The resource specified in the request was not found.
`409`	`ConflictException`	The resource already exists.
`429`	`LimitExceededException`	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
Name	Type	Required	Description
`resource-arn`	String	True	The resource ARN for the tag.

Responses
Status code	Response model	Description
`201`	None	The request has succeeded and has resulted in the creation of a resource.
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`404`	`NotFoundException`	The resource specified in the request was not found.
`409`	`ConflictException`	The resource already exists.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: UntagResource

Deletes a Tag.

Path parameters
Name	Type	Required	Description
`resource-arn`	String	True	The resource ARN for the tag.

Query parameters
Name	Type	Required	Description
`tagKeys`	String	True	The tag keys.

Responses
Status code	Response model	Description
`204`	None	The request has succeeded, and there is no additional content to send in the response payload body.
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`404`	`NotFoundException`	The resource specified in the request was not found.
`409`	`ConflictException`	The resource already exists.
`429`	`LimitExceededException`	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.

Property	Type	Required	Description
`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.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

LimitExceededException

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

Property	Type	Required	Description
`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.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.
`resourceType`	string	False	The resource type.

TagResourceInput

Represents the input parameters for a TagResource request.

Property	Type	Required	Description
`tags`	Tags	False	The collection of tags. Each tag element is associated with a given resource.