list_quick_connects

Connect.Client.list_quick_connects(**kwargs)

Provides information about the quick connects for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_quick_connects(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    QuickConnectTypes=[
        'USER'|'QUEUE'|'PHONE_NUMBER',
    ]
)

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.

• NextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
• MaxResults (integer) -- The maximum number of results to return per page. The default MaxResult size is 100.
• QuickConnectTypes (list) --

  The type of quick connect. In the Amazon Connect console, 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) --

Return type

dict

Returns

Response Syntax

{
    'QuickConnectSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'
        },
    ],
    'NextToken': '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 console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

  • NextToken (string) --

    If there are additional results, this is the token for the next set of results.

Exceptions

• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException