DynamoDB / Client / list_tags_of_resource

list_tags_of_resource#

DynamoDB.Client.list_tags_of_resource(**kwargs)#

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_of_resource(
    ResourceArn='string',
    NextToken='string'
)
Parameters:

  • ResourceArn (string) –

    [REQUIRED]

    The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

  • NextToken (string) – An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Tags (list) –

      The tags currently associated with the Amazon DynamoDB resource.

      • (dict) –

        Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.

        Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

        For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

        • Key (string) –

          The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

        • Value (string) –

          The value of the tag. Tag values are case-sensitive and can be null.

    • NextToken (string) –

      If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

Exceptions