Tags - Amazon Managed Streaming for Apache Kafka

Tags

Represents the set of tags for an MSK resource. A tag is a key-value pair that you define for the cluster. Using tags is a simple yet powerful way to manage Amazon resources and organize data, including billing data.

URI

/v1/tags/resourceArn

HTTP methods

DELETE

Operation ID: UntagResource

Removes the tags associated with the keys that are provided in the query.

Path parameters
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Query parameters
NameTypeRequiredDescription
tagKeysStringTrue

Tag keys must be unique for a given cluster. In addition, the following restrictions apply:

  • Each tag key must be unique. If you add a tag with a key that's already in use, your new tag overwrites the existing key-value pair.

  • You can't start a tag key with aws: because this prefix is reserved for use by Amazon. Amazon creates tags that begin with this prefix on your behalf, but you can't edit or delete them.

  • Tag keys must be between 1 and 128 Unicode characters in length.

  • Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following special characters: _ . / = + - @.

Responses
Status codeResponse modelDescription
204None

204 response

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

GET

Operation ID: ListTagsForResource

Returns a list of the tags associated with the specified resource.

Path parameters
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Responses
Status codeResponse modelDescription
200 ListTagsForResourceResponse

Success response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

POST

Operation ID: TagResource

Adds tags to the specified MSK resource.

Path parameters
NameTypeRequiredDescription
resourceArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Responses
Status codeResponse modelDescription
204None

204 response

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

Schemas

Request bodies

{ "tags": { } }

Response bodies

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

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

ListTagsForResourceResponse

Response of listing tags for a resource.

PropertyTypeRequiredDescription
tags

object

True

The key-value pair for the resource tag.

TagResourceRequest

Tag a resource.

PropertyTypeRequiredDescription
tags

object

True

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:

UntagResource

ListTagsForResource

TagResource