routing_profile_queues

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

Overview

Name	routing_profile_queues
Type	Resource
Id	aws.connect.routing_profile_queues

Fields

The following fields are returned by SELECT queries:

list_routing_profile_queues

Name	Datatype	Description
channel	string	The channels this queue supports. (VOICE, CHAT, TASK, EMAIL)
delay	integer	The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Connect Customer Administrator Guide.
priority	integer	The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
queue_arn	string	The Amazon Resource Name (ARN) of the queue.
queue_id	string	The identifier for the queue.
queue_name	string	The name of the queue.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_routing_profile_queues	select	instance_id, routing_profile_id, region	nextToken, maxResults	Lists the queues associated with a routing profile.
update_routing_profile_queues	update	instance_id, routing_profile_id, region, QueueConfigs		Updates the properties associated with a set of queues for a routing profile.
associate_routing_profile_queues	update	instance_id, routing_profile_id, region		Associates a set of queues with a routing profile.
disassociate_routing_profile_queues	exec	instance_id, routing_profile_id, region		Disassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.

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.
region	string	AWS region (default: us-east-1)
routing_profile_id	string	The identifier of the routing profile.
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_routing_profile_queues

Lists the queues associated with a routing profile.

SELECT
channel,
delay,
priority,
queue_arn,
queue_id,
queue_name
FROM aws.connect.routing_profile_queues
WHERE instance_id = '{{ instance_id }}' -- required
AND routing_profile_id = '{{ routing_profile_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

update_routing_profile_queues

Updates the properties associated with a set of queues for a routing profile.

UPDATE aws.connect.routing_profile_queues
SET 
QueueConfigs = '{{ QueueConfigs }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND routing_profile_id = '{{ routing_profile_id }}' --required
AND region = '{{ region }}' --required
AND QueueConfigs = '{{ QueueConfigs }}' --required;

associate_routing_profile_queues

Associates a set of queues with a routing profile.

UPDATE aws.connect.routing_profile_queues
SET 
QueueConfigs = '{{ QueueConfigs }}',
ManualAssignmentQueueConfigs = '{{ ManualAssignmentQueueConfigs }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND routing_profile_id = '{{ routing_profile_id }}' --required
AND region = '{{ region }}' --required;

Lifecycle Methods

disassociate_routing_profile_queues

Disassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.

EXEC aws.connect.routing_profile_queues.disassociate_routing_profile_queues 
@instance_id='{{ instance_id }}' --required, 
@routing_profile_id='{{ routing_profile_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"QueueReferences": "{{ QueueReferences }}", 
"ManualAssignmentQueueReferences": "{{ ManualAssignmentQueueReferences }}"
}'
;