DAX / Paginator / ListTags

ListTags#

class DAX.Paginator.ListTags#
paginator = client.get_paginator('list_tags')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DAX.Client.list_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ResourceName (string) –

    [REQUIRED]

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': '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.