quick_connects

Creates, updates, deletes, gets or lists a quick_connects resource.

Overview

Name	quick_connects
Type	Resource
Id	aws.connect.quick_connects

Fields

The following fields are returned by SELECT queries:

describe_quick_connect

Name	Datatype	Description
description	string	The description.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the quick connect.
quick_connect_arn	string	The Amazon Resource Name (ARN) of the quick connect.
quick_connect_config	object	Contains configuration settings for a quick connect.
quick_connect_id	string	The identifier for the quick connect.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_quick_connects

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the quick connect.
id	string	The identifier for the quick connect.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the quick connect.
quick_connect_type	string	The type of quick connect. In the Connect Customer 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). (USER, QUEUE, PHONE_NUMBER, FLOW)

search_quick_connects

Name	Datatype	Description
description	string	The description.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the quick connect.
quick_connect_arn	string	The Amazon Resource Name (ARN) of the quick connect.
quick_connect_config	object	Contains configuration settings for a quick connect.
quick_connect_id	string	The identifier for the quick connect.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_quick_connect	select	instance_id, quick_connect_id, region		Describes the quick connect.
list_quick_connects	select	instance_id, region	nextToken, maxResults, QuickConnectTypes	Provides information about the quick connects for the specified Connect Customer instance.
search_quick_connects	select	region		Searches quick connects in an Connect Customer instance, with optional filtering.
create_quick_connect	insert	instance_id, region, QuickConnectConfig		Creates a quick connect for the specified Connect Customer instance.
update_quick_connect_config	update	instance_id, quick_connect_id, region, QuickConnectConfig		Updates the configuration settings for the specified quick connect.
update_quick_connect_name	update	instance_id, quick_connect_id, region		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.
delete_quick_connect	delete	instance_id, quick_connect_id, region		Deletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
quick_connect_id	string	The identifier for the quick connect.
region	string	AWS region (default: us-east-1)
QuickConnectTypes	array	The type of quick connect. In the Connect Customer 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).
maxResults	integer	The maximum number of results to return per page. The default MaxResult size is 100.
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.

SELECT examples

describe_quick_connect

Describes the quick connect.

SELECT
description,
last_modified_region,
last_modified_time,
name,
quick_connect_arn,
quick_connect_config,
quick_connect_id,
tags
FROM aws.connect.quick_connects
WHERE instance_id = '{{ instance_id }}' -- required
AND quick_connect_id = '{{ quick_connect_id }}' -- required
AND region = '{{ region }}' -- required
;

list_quick_connects

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

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name,
quick_connect_type
FROM aws.connect.quick_connects
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND QuickConnectTypes = '{{ QuickConnectTypes }}'
;

search_quick_connects

Searches quick connects in an Connect Customer instance, with optional filtering.

SELECT
description,
last_modified_region,
last_modified_time,
name,
quick_connect_arn,
quick_connect_config,
quick_connect_id,
tags
FROM aws.connect.quick_connects
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_quick_connect

Creates a quick connect for the specified Connect Customer instance.

INSERT INTO aws.connect.quick_connects (
Name,
Description,
QuickConnectConfig,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ QuickConnectConfig }}' /* required */,
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
quick_connect_arn,
quick_connect_id
;

Manifest

# Description fields are for documentation purposes
- name: quick_connects
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the quick_connects resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the quick_connects resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: QuickConnectConfig
    description: |
      Contains configuration settings for a quick connect.
    value:
      QuickConnectType: "{{ QuickConnectType }}"
      UserConfig:
        UserId: "{{ UserId }}"
        ContactFlowId: "{{ ContactFlowId }}"
      QueueConfig:
        QueueId: "{{ QueueId }}"
        ContactFlowId: "{{ ContactFlowId }}"
      PhoneConfig:
        PhoneNumber: "{{ PhoneNumber }}"
      FlowConfig:
        ContactFlowId: "{{ ContactFlowId }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_quick_connect_config

Updates the configuration settings for the specified quick connect.

UPDATE aws.connect.quick_connects
SET 
QuickConnectConfig = '{{ QuickConnectConfig }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND quick_connect_id = '{{ quick_connect_id }}' --required
AND region = '{{ region }}' --required
AND QuickConnectConfig = '{{ QuickConnectConfig }}' --required;

update_quick_connect_name

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.

UPDATE aws.connect.quick_connects
SET 
Name = '{{ Name }}',
Description = '{{ Description }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND quick_connect_id = '{{ quick_connect_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_quick_connect

Deletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you're using Connect Customer Global Resiliency.

DELETE FROM aws.connect.quick_connects
WHERE instance_id = '{{ instance_id }}' --required
AND quick_connect_id = '{{ quick_connect_id }}' --required
AND region = '{{ region }}' --required
;