TimestreamQuery / Paginator / ListTagsForResource

ListTagsForResource#

class TimestreamQuery.Paginator.ListTagsForResource#
paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from TimestreamQuery.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 Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).

  • 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'
        },
    ],

}

Response Structure

  • (dict) –

    • Tags (list) –

      The tags currently associated with the Timestream resource.

      • (dict) –

        A tag is a label that you assign to a Timestream database and/or table. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize databases and/or tables, for example, by purpose, owner, or environment.

        • Key (string) –

          The key of the tag. Tag keys are case sensitive.

        • Value (string) –

          The value of the tag. Tag values are case sensitive and can be null.