Synthetics / Client / tag_resource

tag_resource#

Synthetics.Client.tag_resource(**kwargs)#

Assigns one or more tags (key-value pairs) to the specified canary or group.

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 Amazon Web Services and are interpreted strictly as strings of characters.

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

You can associate as many as 50 tags with a canary or group.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ResourceArn (string) –

    [REQUIRED]

    The ARN of the canary or group that you’re adding tags to.

    The ARN format of a canary is ``arn:aws:synthetics:Region:account-id:canary:canary-name ``.

    The ARN format of a group is arn:aws:synthetics:Region:account-id:group:group-name

  • Tags (dict) –

    [REQUIRED]

    The list of key-value pairs to associate with the resource.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions