Connect / Client / list_queue_quick_connects

list_queue_quick_connects#

Connect.Client.list_queue_quick_connects(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Lists the quick connects associated with a queue.

See also: AWS API Documentation

Request Syntax

response = client.list_queue_quick_connects(
    InstanceId='string',
    QueueId='string',
    NextToken='string',
    MaxResults=123
)
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.

  • QueueId (string) –

    [REQUIRED]

    The identifier for the queue.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

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

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

        • LastModifiedTime (datetime) –

          The timestamp when this resource was last modified.

        • LastModifiedRegion (string) –

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

    • LastModifiedTime (datetime) –

      The timestamp when this resource was last modified.

    • LastModifiedRegion (string) –

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException