SFN / Client / tag_resource

tag_resource#

SFN.Client.tag_resource(**kwargs)#

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • resourceArn (string) –

    [REQUIRED]

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

  • tags (list) –

    [REQUIRED]

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    • (dict) –

      Tags are key-value pairs that can be associated with Step Functions state machines and activities.

      An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

      Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

      • key (string) –

        The key of a tag.

      • value (string) –

        The value of a tag.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions