ApplicationDiscoveryService / Paginator / DescribeTags

DescribeTags

class ApplicationDiscoveryService.Paginator.DescribeTags

paginator = client.get_paginator('describe_tags')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

  • (dict) –

    The tag filter. Valid names are: tagKey, tagValue, configurationId.

    • name (string) – [REQUIRED]

      A name of the tag filter.

    • values (list) – [REQUIRED]

      Values for the tag filter.

      • (string) –

• 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': [
        {
            'configurationType': 'SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
            'configurationId': 'string',
            'key': 'string',
            'value': 'string',
            'timeOfCreation': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • tags (list) –

    Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

    • (dict) –

      Tags for a configuration item. Tags are metadata that help you categorize IT assets.

      • configurationType (string) –

        A type of IT asset to tag.

      • configurationId (string) –

        The configuration ID for the item to tag. You can specify a list of keys and values.

      • key (string) –

        A type of tag on which to filter. For example, serverType.

      • value (string) –

        A value on which to filter. For example key = serverType and value = web server.

      • timeOfCreation (datetime) –

        The time the configuration tag was created in Coordinated Universal Time (UTC).

  • NextToken (string) –

    A token to resume pagination.