ConfigService / Paginator / ListTagsForResource

ListTagsForResource#

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

Creates an iterator that will paginate through responses from ConfigService.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) that identifies the resource for which to list the tags. The following resources are supported:

    • ConfigurationRecorder

    • ConfigRule

    • OrganizationConfigRule

    • ConformancePack

    • OrganizationConformancePack

    • ConfigurationAggregator

    • AggregationAuthorization

    • StoredQuery

  • 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 for the resource.

      • (dict) –

        The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

        • Key (string) –

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • Value (string) –

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).