IoTThingsGraph / Paginator / ListTagsForResource

ListTagsForResource

class IoTThingsGraph.Paginator.ListTagsForResource

paginator = client.get_paginator('list_tags_for_resource')

paginate(**kwargs)

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

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 whose tags are to be returned.

• 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

{
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tags (list) –

    List of tags returned by the ListTagsForResource operation.

    • (dict) –

      Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.

      • key (string) –

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.

      • value (string) –

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.

  • NextToken (string) –

    A token to resume pagination.