AWS Step Functions
API Reference (API Version 2016-11-23)

TagResource

Add a tag to a Step Functions resource.

Request Syntax

{ "resourceArn": "string", "tags": [ { "key": "string", "value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

resourceArn

The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

Type: String

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

Required: Yes

tags

The list of tags to add to a resource.

Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

Type: Array of Tag objects

Required: Yes

Response Elements

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

Errors

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

InvalidArn

The provided Amazon Resource Name (ARN) is invalid.

HTTP Status Code: 400

ResourceNotFound

Could not fine the referenced resource. Only state machine and activity ARNs are supported.

HTTP Status Code: 400

TooManyTags

You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.

HTTP Status Code: 400

See Also

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