create_quick_connect¶

create_quick_connect(**kwargs)¶

Creates a quick connect for the specified Amazon Connect instance.

Request Syntax

response = client.create_quick_connect(
    InstanceId='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'
    }
)

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.
Name (string) --
[REQUIRED]

The name of the quick connect.
Description (string) -- The description of the quick connect.
QuickConnectConfig (dict) --
[REQUIRED]

Configuration settings for the quick connect.
- QuickConnectType (string) -- [REQUIRED]
  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).
- UserConfig (dict) --
  The user configuration. This is required only if QuickConnectType is USER.
  - UserId (string) -- [REQUIRED]
    The identifier of the user.
  - ContactFlowId (string) -- [REQUIRED]
    The identifier of the flow.
- QueueConfig (dict) --
  The queue configuration. This is required only if QuickConnectType is QUEUE.
  - QueueId (string) -- [REQUIRED]
    The identifier for the queue.
  - ContactFlowId (string) -- [REQUIRED]
    The identifier of the flow.
- PhoneConfig (dict) --
  The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
  - PhoneNumber (string) -- [REQUIRED]
    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) --

Return type

dict

Returns

Response Syntax

{
    'QuickConnectARN': 'string',
    'QuickConnectId': 'string'
}

Response Structure

(dict) --
- QuickConnectARN (string) --
  
  The Amazon Resource Name (ARN) for the quick connect.
- QuickConnectId (string) --
  
  The identifier for the quick connect.

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.DuplicateResourceException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.LimitExceededException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException

Table Of Contents

create_quick_connect¶