CloudHSMV2 / Paginator / ListTags

ListTags

class CloudHSMV2.Paginator.ListTags

paginator = client.get_paginator('list_tags')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceId (string) –

  [REQUIRED]

  The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

• 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.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • TagList (list) –

    A list of tags.

    • (dict) –

      Contains a tag. A tag is a key-value pair.

      • Key (string) –

        The key of the tag.

      • Value (string) –

        The value of the tag.