Connect / Client / describe_quick_connect

describe_quick_connect#

Connect.Client.describe_quick_connect(**kwargs)#

Describes the quick connect.

See also: AWS API Documentation

Request Syntax

response = client.describe_quick_connect(
    InstanceId='string',
    QuickConnectId='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.

  • QuickConnectId (string) –

    [REQUIRED]

    The identifier for the quick connect.

Return type:

dict

Returns:

Response Syntax

{
    'QuickConnect': {
        'QuickConnectARN': 'string',
        'QuickConnectId': 'string',
        'Name': 'string',
        'Description': 'string',
        'QuickConnectConfig': {
            'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
            'UserConfig': {
                'UserId': 'string',
                'ContactFlowId': 'string'
            },
            'QueueConfig': {
                'QueueId': 'string',
                'ContactFlowId': 'string'
            },
            'PhoneConfig': {
                'PhoneNumber': 'string'
            }
        },
        'Tags': {
            'string': 'string'
        },
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string'
    }
}

Response Structure

  • (dict) –

    • QuickConnect (dict) –

      Information about the quick connect.

      • QuickConnectARN (string) –

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

      • QuickConnectId (string) –

        The identifier for the quick connect.

      • Name (string) –

        The name of the quick connect.

      • Description (string) –

        The description.

      • QuickConnectConfig (dict) –

        Contains information about 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).

        • UserConfig (dict) –

          The user configuration. This is required only if QuickConnectType is USER.

          • UserId (string) –

            The identifier of the user.

          • ContactFlowId (string) –

            The identifier of the flow.

        • QueueConfig (dict) –

          The queue configuration. This is required only if QuickConnectType is QUEUE.

          • QueueId (string) –

            The identifier for the queue.

          • ContactFlowId (string) –

            The identifier of the flow.

        • PhoneConfig (dict) –

          The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

          • PhoneNumber (string) –

            The phone number in E.164 format.

      • Tags (dict) –

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

        • (string) –

          • (string) –

      • LastModifiedTime (datetime) –

        The timestamp when this resource was last modified.

      • LastModifiedRegion (string) –

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

Exceptions