Connect / Paginator / SearchPredefinedAttributes

SearchPredefinedAttributes#

class Connect.Paginator.SearchPredefinedAttributes#
paginator = client.get_paginator('search_predefined_attributes')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': '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 instance ID in the Amazon Resource Name (ARN) of the instance.

  • SearchCriteria (dict) –

    The search criteria to be used to return predefined attributes.

    • OrConditions (list) –

      A list of conditions which would be applied together with an OR condition.

      • (dict) –

        The search criteria to be used to return predefined attributes.

    • AndConditions (list) –

      A list of conditions which would be applied together with an AND condition.

      • (dict) –

        The search criteria to be used to return predefined attributes.

    • StringCondition (dict) –

      A leaf node condition which can be used to specify a string condition.

      Note

      The currently supported values for FieldName are name and description.

      • FieldName (string) –

        The name of the field in the string condition.

      • Value (string) –

        The value of the string.

      • ComparisonType (string) –

        The type of comparison to be made when evaluating the string 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

{
    'PredefinedAttributes': [
        {
            'Name': 'string',
            'Values': {
                'StringList': [
                    'string',
                ]
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'ApproximateTotalCount': 123
}

Response Structure

  • (dict) –

    • PredefinedAttributes (list) –

      Predefined attributes matched by the search criteria.

      • (dict) –

        Information about a predefined attribute.

        • Name (string) –

          The name of the predefined attribute.

        • Values (dict) –

          The values of the predefined attribute.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: StringList. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          
          • StringList (list) –

            Predefined attribute values of type string list.

            • (string) –

        • LastModifiedTime (datetime) –

          Last modified time.

        • LastModifiedRegion (string) –

          Last modified region.

    • ApproximateTotalCount (integer) –

      The approximate number of predefined attributes which matched your search query.