AWS API Changes

2020/12/22 - Amazon Connect Service - 6 new api methods

Changes This release adds support for quick connects. For details, see the Release Notes in the Amazon Connect Administrator Guide.

DescribeQuickConnect (new)

Link ¶

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

Describes the quick connect.

See also: AWS API Documentation

Request Syntax

client.describe_quick_connect(
    InstanceId='string',
    QuickConnectId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QuickConnectId

string

param QuickConnectId

[REQUIRED]

The identifier for the quick connect.

rtype

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'
        }
    }
}

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 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) --
        
        The identifier of the user.
      - ContactFlowId (string) --
        
        The identifier of the contact flow.
    - QueueConfig (dict) --
      
      The queue configuration. This is required only if QuickConnectType is QUEUE.
      - QueueId (string) --
        
        The identifier of the queue.
      - ContactFlowId (string) --
        
        The identifier of the contact 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) --
    
    One or more tags.
    - (string) --
      - (string) --

UpdateQuickConnectName (new)

Link ¶

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

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

See also: AWS API Documentation

Request Syntax

client.update_quick_connect_name(
    InstanceId='string',
    QuickConnectId='string',
    Name='string',
    Description='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QuickConnectId

string

param QuickConnectId

[REQUIRED]

The identifier for the quick connect.

type Name

string

param Name

The name of the quick connect.

type Description

string

param Description

The description of the quick connect.

returns

None

DeleteQuickConnect (new)

Link ¶

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

Deletes a quick connect.

See also: AWS API Documentation

Request Syntax

client.delete_quick_connect(
    InstanceId='string',
    QuickConnectId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QuickConnectId

string

param QuickConnectId

[REQUIRED]

The identifier for the quick connect.

returns

None

ListQuickConnects (new)

Link ¶

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

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

See also: AWS API Documentation

Request Syntax

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

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

The maximimum number of results to return per page.

type QuickConnectTypes

list

param QuickConnectTypes

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

rtype

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).
    - Name (string) --
      
      The name.
    - 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.

UpdateQuickConnectConfig (new)

Link ¶

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

Updates the configuration settings for the specified quick connect.

See also: AWS API Documentation

Request Syntax

client.update_quick_connect_config(
    InstanceId='string',
    QuickConnectId='string',
    QuickConnectConfig={
        'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
        'UserConfig': {
            'UserId': 'string',
            'ContactFlowId': 'string'
        },
        'QueueConfig': {
            'QueueId': 'string',
            'ContactFlowId': 'string'
        },
        'PhoneConfig': {
            'PhoneNumber': 'string'
        }
    }
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QuickConnectId

string

param QuickConnectId

[REQUIRED]

The identifier for the quick connect.

type QuickConnectConfig

dict

param QuickConnectConfig

[REQUIRED]

Information about the 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 contact flow.
QueueConfig (dict) --

The queue configuration. This is required only if QuickConnectType is QUEUE.
- QueueId (string) -- [REQUIRED]
  
  The identifier of the queue.
- ContactFlowId (string) -- [REQUIRED]
  
  The identifier of the contact 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.

returns

None

CreateQuickConnect (new)

Link ¶

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

Creates a quick connect for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

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'
    }
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type Name

string

param Name

[REQUIRED]

The name of the quick connect.

type Description

string

param Description

The description of the quick connect.

type QuickConnectConfig

dict

param QuickConnectConfig

[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 contact flow.
QueueConfig (dict) --

The queue configuration. This is required only if QuickConnectType is QUEUE.
- QueueId (string) -- [REQUIRED]
  
  The identifier of the queue.
- ContactFlowId (string) -- [REQUIRED]
  
  The identifier of the contact 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.

type Tags

dict

param Tags

One or more tags.

(string) --
- (string) --

rtype

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.