ServiceCatalog / Paginator / ListTagOptions

ListTagOptions

class ServiceCatalog.Paginator.ListTagOptions

paginator = client.get_paginator('list_tag_options')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_tag_options().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters={
        'Key': 'string',
        'Value': 'string',
        'Active': True|False
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (dict) –

  The search filters. If no search filters are specified, the output includes all TagOptions.

  • Key (string) –

    The TagOption key.

  • Value (string) –

    The TagOption value.

  • Active (boolean) –

    The active state.

• 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

{
    'TagOptionDetails': [
        {
            'Key': 'string',
            'Value': 'string',
            'Active': True|False,
            'Id': 'string',
            'Owner': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • TagOptionDetails (list) –

    Information about the TagOptions.

    • (dict) –

      Information about a TagOption.

      • Key (string) –

        The TagOption key.

      • Value (string) –

        The TagOption value.

      • Active (boolean) –

        The TagOption active state.

      • Id (string) –

        The TagOption identifier.

      • Owner (string) –

        The Amazon Web Services account Id of the owner account that created the TagOption.

  • NextToken (string) –

    A token to resume pagination.