URI HTTP methods Schemas Properties See also

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

GET

Operation ID: ListTagsForResource

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

Path parameters
Name	Type	Required	Description
`resourceArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Responses
Status code	Response model	Description
`200`	`ListTagsForResourceResponse`	Success response.
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

POST

Operation ID: TagResource

Adds tags to the specified MSK resource.

Path parameters
Name	Type	Required	Description
`resourceArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Responses
Status code	Response model	Description
`204`	None	204 response
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

DELETE

Operation ID: UntagResource

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

Path parameters
Name	Type	Required	Description
`resourceArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Query parameters
Name	Type	Required	Description
`tagKeys`	String	True	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 code	Response model	Description
`204`	None	204 response
`400`	`Error`	The request isn't valid because the input is incorrect. Correct your input and then submit it again.
`401`	`Error`	The request is not authorized. The provided credentials couldn't be validated.
`403`	`Error`	Access forbidden. Check your credentials and then retry your request.
`404`	`Error`	The resource could not be found due to incorrect input. Correct the input, then retry the request.
`429`	`Error`	429 response
`500`	`Error`	There was an unexpected internal server error. Retrying your request might resolve the issue.
`503`	`Error`	503 response

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
Name	Type	Required	Description
`resourceArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

Schemas

Request bodies


{
  "tags": {
  }
}

Response bodies


{
  "tags": {
  }
}


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

Properties

Error

Returns information about an error.

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

Property	Type	Required	Description
`tags`	object	True	The key-value pair for the resource tag.

TagResourceRequest

Tag a resource.

Property	Type	Required	Description
`tags`	object	True	The key-value pair for the resource tag.