Tag - Amazon EventBridge Schemas

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.

URI

/tags/resource-arn

HTTP methods

GET

Operation ID: ListTagsForResource

Get tags for resource.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The ARN of the resource.

Responses
Status codeResponse modelDescription
200ListTagsForResourceOutput

200 response

400ErrorOutput

400 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

POST

Operation ID: TagResource

Add tags to a resource.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The ARN of the resource.

Responses
Status codeResponse modelDescription
204None

204 response

400ErrorOutput

400 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

DELETE

Operation ID: UntagResource

Removes tags from a resource.

Path parameters
NameTypeRequiredDescription
resource-arnStringTrue

The ARN of the resource.

Query parameters
NameTypeRequiredDescription
tagKeysStringTrue

Keys of key-value pairs.

Responses
Status codeResponse modelDescription
204None

204 response

400ErrorOutput

400 response

403ErrorOutput

403 response

404ErrorOutput

404 response

500ErrorOutput

500 response

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "tags": { } }

Response bodies

{ "tags": { } }
{ "Message": "string", "Code": "string" }

Properties

ErrorOutput

PropertyTypeRequiredDescription
Code

string

True

The error code.

Message

string

True

The message string of the error output.

ListTagsForResourceOutput

PropertyTypeRequiredDescription
tags

Tags

False

TagResourceInput

PropertyTypeRequiredDescription
tags

Tags

True

Tags associated with the resource.

Tags

Key-value pairs associated with a resource.

PropertyTypeRequiredDescription

*

string

False