Connect / Paginator / SearchPrompts

SearchPrompts#

class Connect.Paginator.SearchPrompts#
paginator = client.get_paginator('search_prompts')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    SearchFilter={
        'TagFilter': {
            'OrConditions': [
                [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
            ],
            'AndConditions': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': '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.

  • SearchFilter (dict) –

    Filters to be applied to search results.

    • TagFilter (dict) –

      An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

      • Top level list specifies conditions that need to be applied with OR operator

      • Inner list specifies conditions that need to be applied with AND operator.

      • OrConditions (list) –

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

        • (list) –

          • (dict) –

            A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

            • TagKey (string) –

              The tag key in the tag condition.

            • TagValue (string) –

              The tag value in the tag condition.

      • AndConditions (list) –

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

        • (dict) –

          A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

          • TagKey (string) –

            The tag key in the tag condition.

          • TagValue (string) –

            The tag value in the tag condition.

      • TagCondition (dict) –

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

        • TagKey (string) –

          The tag key in the tag condition.

        • TagValue (string) –

          The tag value in the tag condition.

  • SearchCriteria (dict) –

    The search criteria to be used to return prompts.

    • OrConditions (list) –

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

      • (dict) –

        The search criteria to be used to return prompts.

    • AndConditions (list) –

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

      • (dict) –

        The search criteria to be used to return prompts.

    • StringCondition (dict) –

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

      Note

      The currently supported values for FieldName are name, description, and resourceID.

      • 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

{
    'Prompts': [
        {
            'PromptARN': 'string',
            'PromptId': 'string',
            'Name': 'string',
            'Description': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'ApproximateTotalCount': 123
}

Response Structure

  • (dict) –

    • Prompts (list) –

      Information about the prompts.

      • (dict) –

        Information about a prompt.

        • PromptARN (string) –

          The Amazon Resource Name (ARN) of the prompt.

        • PromptId (string) –

          A unique identifier for the prompt.

        • Name (string) –

          The name of the prompt.

        • Description (string) –

          The description of the prompt.

        • Tags (dict) –

          The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

          • (string) –

            • (string) –

    • ApproximateTotalCount (integer) –

      The total number of quick connects which matched your search query.