queue_quick_connects

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

Overview

Name	queue_quick_connects
Type	Resource
Id	aws.connect.queue_quick_connects

Fields

The following fields are returned by SELECT queries:

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_queue_quick_connects	select	instance_id, queue_id, region	nextToken, maxResults	Lists the quick connects associated with a queue.
associate_queue_quick_connects	update	instance_id, queue_id, region, QuickConnectIds		Associates a set of quick connects with a queue.
disassociate_queue_quick_connects	exec	instance_id, queue_id, region, QuickConnectIds		Disassociates a set of quick connects from a queue.

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.
queue_id	string	The identifier for the queue.
region	string	AWS region (default: us-east-1)
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

list_queue_quick_connects

Lists the quick connects associated with a queue.

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

UPDATE examples

associate_queue_quick_connects

Associates a set of quick connects with a queue.

UPDATE aws.connect.queue_quick_connects
SET 
QuickConnectIds = '{{ QuickConnectIds }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND region = '{{ region }}' --required
AND QuickConnectIds = '{{ QuickConnectIds }}' --required;

Lifecycle Methods

disassociate_queue_quick_connects

Disassociates a set of quick connects from a queue.

EXEC aws.connect.queue_quick_connects.disassociate_queue_quick_connects 
@instance_id='{{ instance_id }}' --required, 
@queue_id='{{ queue_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"QuickConnectIds": "{{ QuickConnectIds }}"
}'
;