StorageGateway / Paginator / ListTagsForResource

ListTagsForResource

class StorageGateway.Paginator.ListTagsForResource

paginator = client.get_paginator('list_tags_for_resource')

paginate(**kwargs)

Creates an iterator that will paginate through responses from StorageGateway.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ResourceARN (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the resource for which you want to list tags.

• 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

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

Response Structure

• (dict) –

  ListTagsForResourceOutput

  • ResourceARN (string) –

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

  • Tags (list) –

    An array that contains the tags for the specified resource.

    • (dict) –

      A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

      • Key (string) –

        Tag key. The key can’t start with aws:.

      • Value (string) –

        Value of the tag key.

  • NextToken (string) –

    A token to resume pagination.