Tag - Amazon MQ
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.

Tag

A tag is a key-value pair associated with a resource. You can use these metadata tags to identify the purpose of a broker or configuration. For more information see Tagging resources in the Amazon MQ Developer Guide.

URI

/v1/tags/resource-arn

HTTP methods

GET

Operation ID: ListTags

Lists tags for a resource.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The Amazon Resource Name (ARN) of the resource tag.

Responses
Status codeResponse modelDescription
200Tags

HTTP Status Code 200: OK.

400Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

POST

Operation ID: CreateTags

Add a tag to a resource.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The Amazon Resource Name (ARN) of the resource tag.

Responses
Status codeResponse modelDescription
204None

HTTP Status Code 204: Successful response.

400Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DELETE

Operation ID: DeleteTags

Removes a tag from a resource.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The Amazon Resource Name (ARN) of the resource tag.

Query parameters
NameTypeRequiredDescription
tagKeysStringTrue

An array of tag keys to delete

Responses
Status codeResponse modelDescription
204None

HTTP Status Code 204: Successful response.

400Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

OPTIONS

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The Amazon Resource Name (ARN) of the resource tag.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Request bodies

{ "tags": { } }

Response bodies

{ "tags": { } }
{ "errorAttribute": "string", "message": "string" }

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

Tags

A map of the key-value pairs for the resource tag.

PropertyTypeRequiredDescription
tags

object

False

The key-value pair for the resource tag.