TagResource - Amazon EventBridge Pipes


Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a pipe.

Request Syntax

POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.


The ARN of the pipe.

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: arn:aws([a-z]|\-)*:([a-zA-Z0-9\-]+):([a-z]|\d|\-)*:([0-9]{12})?:(.+)

Required: Yes

Request Body

The request accepts the following data in JSON format.


The list of key-value pairs associated with the pipe.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


This exception occurs due to unexpected causes.

HTTP Status Code: 500


An entity that you specified does not exist.

HTTP Status Code: 404


Indicates that an error has occurred while performing a validate operation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: