Connect / Paginator / ListQuickConnects

ListQuickConnects

class Connect.Paginator.ListQuickConnects

paginator = client.get_paginator('list_quick_connects')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    QuickConnectTypes=[
        'USER'|'QUEUE'|'PHONE_NUMBER',
    ],
    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. Both Instance ID and Instance ARN are supported input formats.

• QuickConnectTypes (list) –

  The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

  • (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

{
    'QuickConnectSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • QuickConnectSummaryList (list) –

    Information about the quick connects.

    • (dict) –

      Contains summary information about a quick connect.

      • Id (string) –

        The identifier for the quick connect.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the quick connect.

      • Name (string) –

        The name of the quick connect.

      • QuickConnectType (string) –

        The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

      • LastModifiedTime (datetime) –

        The timestamp when this resource was last modified.

      • LastModifiedRegion (string) –

        The Amazon Web Services Region where this resource was last modified.