Connect / Paginator / SearchResourceTags

SearchResourceTags

class Connect.Paginator.SearchResourceTags

paginator = client.get_paginator('search_resource_tags')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.search_resource_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ResourceTypes=[
        'string',
    ],
    SearchCriteria={
        'TagSearchCondition': {
            'tagKey': 'string',
            'tagValue': 'string',
            'tagKeyComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT',
            'tagValueComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.

• ResourceTypes (list) –

  The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.

  • (string) –

• SearchCriteria (dict) –

  The search criteria to be used to return tags.

  • TagSearchCondition (dict) –

    The search criteria to be used to return tags.

    • tagKey (string) –

      The tag key used in the tag search condition.

    • tagValue (string) –

      The tag value used in the tag search condition.

    • tagKeyComparisonType (string) –

      The type of comparison to be made when evaluating the tag key in tag search condition.

    • tagValueComparisonType (string) –

      The type of comparison to be made when evaluating the tag value in tag search condition.

• 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) –

    A list of tags used in the Amazon Connect instance.

    • (dict) –

      A tag set contains tag key and tag value.

      • key (string) –

        The tag key in the tagSet.

      • value (string) –

        The tag value in the tagSet.