TimestreamQuery / Client / list_tags_for_resource

list_tags_for_resource#

TimestreamQuery.Client.list_tags_for_resource(**kwargs)#

List all tags on a Timestream query resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ResourceARN (string) –

    [REQUIRED]

    The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).

  • MaxResults (integer) – The maximum number of tags to return.

  • NextToken (string) – A pagination token to resume pagination.

Return type:

dict

Returns:

Response Syntax

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

    • NextToken (string) –

      A pagination token to resume pagination with a subsequent call to ListTagsForResourceResponse.

Exceptions