DAX / Client / list_tags

list_tags#

DAX.Client.list_tags(**kwargs)#

List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    ResourceName='string',
    NextToken='string'
)
Parameters:

  • ResourceName (string) –

    [REQUIRED]

    The name of the DAX resource to which the tags belong.

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Tags (list) –

      A list of tags currently associated with the DAX cluster.

      • (dict) –

        A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

        AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:.

        You cannot backdate the application of a tag.

        • Key (string) –

          The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have 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 present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.

Exceptions

  • DAX.Client.exceptions.ClusterNotFoundFault

  • DAX.Client.exceptions.InvalidARNFault

  • DAX.Client.exceptions.InvalidClusterStateFault

  • DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • DAX.Client.exceptions.InvalidParameterValueException

  • DAX.Client.exceptions.InvalidParameterCombinationException