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.
| Name | Type | Required | Description |
|---|---|---|---|
resource-arn | String | True | The Amazon Resource Name (ARN) of the resource tag. |
| Status code | Response model | Description |
|---|---|---|
200 | Tags | HTTP Status Code 200: OK. |
400 | Error | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. |
403 | Error | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. |
404 | Error | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. |
500 | Error | 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.
| Name | Type | Required | Description |
|---|---|---|---|
resource-arn | String | True | The Amazon Resource Name (ARN) of the resource tag. |
| Status code | Response model | Description |
|---|---|---|
204 | None | HTTP Status Code 204: Successful response. |
400 | Error | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. |
403 | Error | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. |
404 | Error | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. |
500 | Error | 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.
| Name | Type | Required | Description |
|---|---|---|---|
resource-arn | String | True | The Amazon Resource Name (ARN) of the resource tag. |
| Name | Type | Required | Description |
|---|---|---|---|
tagKeys | String | True | An array of tag keys to delete |
| Status code | Response model | Description |
|---|---|---|
204 | None | HTTP Status Code 204: Successful response. |
400 | Error | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. |
403 | Error | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. |
404 | Error | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. |
500 | Error | HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. |
OPTIONS
| Name | Type | Required | Description |
|---|---|---|---|
resource-arn | String | True | The Amazon Resource Name (ARN) of the resource tag. |
| Status code | Response model | Description |
|---|---|---|
200 | None | Default response for CORS method |
Schemas
Request bodies
{
"tags": {
}
}Response bodies
{
"tags": {
}
}{
"errorAttribute": "string",
"message": "string"
}Properties
Error
Returns information about an error.
| Property | Type | Required | Description |
|---|---|---|---|
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.
| Property | Type | Required | Description |
|---|---|---|---|
tags | object | False | The key-value pair for the resource tag. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListTags
CreateTags
DeleteTags
