queues

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

Overview

Name	queues
Type	Resource
Id	aws.connect.queues

Fields

The following fields are returned by SELECT queries:

describe_queue

Name	Datatype	Description
description	string	The description of the queue.
hours_of_operation_id	string	The identifier for the hours of operation.
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.
max_contacts	integer	The maximum number of contacts that can be in the queue before it is considered full.
name	string	The name of the queue.
outbound_caller_config	object	The outbound caller ID name, number, and outbound whisper flow.
outbound_email_config	object	The outbound email address ID.
queue_arn	string	The Amazon Resource Name (ARN) for the queue.
queue_id	string	The identifier for the queue.
status	string	The status of the queue. (ENABLED, DISABLED)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_queues

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the queue.
id	string	The identifier of the queue.
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 queue.
queue_type	string	The type of queue. (STANDARD, AGENT)

search_queues

Name	Datatype	Description
description	string	The description of the queue.
hours_of_operation_id	string	The identifier for the hours of operation.
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.
max_contacts	integer	The maximum number of contacts that can be in the queue before it is considered full.
name	string	The name of the queue.
outbound_caller_config	object	The outbound caller ID name, number, and outbound whisper flow.
outbound_email_config	object	The outbound email address ID.
queue_arn	string	The Amazon Resource Name (ARN) for the queue.
queue_id	string	The identifier for the queue.
status	string	The status of the queue. (ENABLED, DISABLED)
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_queue	select	instance_id, queue_id, region		Describes the specified queue.
list_queues	select	instance_id, region	queueTypes, nextToken, maxResults	Provides information about the queues for the specified Connect Customer instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Connect Customer Administrator Guide.
search_queues	select	region		Searches queues in an Connect Customer instance, with optional filtering.
create_queue	insert	instance_id, region, HoursOfOperationId		Creates a new queue for the specified Connect Customer instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
update_queue_outbound_caller_config	update	instance_id, queue_id, region, OutboundCallerConfig		Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.
update_queue_outbound_email_config	update	instance_id, queue_id, region, OutboundEmailConfig		Updates the outbound email address Id for a specified queue.
update_routing_profile_default_outbound_queue	update	instance_id, routing_profile_id, region, DefaultOutboundQueueId		Updates the default outbound queue of a routing profile.
update_queue_name	update	instance_id, queue_id, region		Updates the name and description of a queue. At least Name or Description must be provided.
delete_queue	delete	instance_id, queue_id, region		Deletes a queue.
update_queue_status	exec	instance_id, queue_id, region		Updates the status of the 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)
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.
queueTypes	array	The type of queue.

SELECT examples

describe_queue

Describes the specified queue.

SELECT
description,
hours_of_operation_id,
last_modified_region,
last_modified_time,
max_contacts,
name,
outbound_caller_config,
outbound_email_config,
queue_arn,
queue_id,
status,
tags
FROM aws.connect.queues
WHERE instance_id = '{{ instance_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND region = '{{ region }}' -- required
;

list_queues

Provides information about the queues for the specified Connect Customer instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Connect Customer Administrator Guide.

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

search_queues

Searches queues in an Connect Customer instance, with optional filtering.

SELECT
description,
hours_of_operation_id,
last_modified_region,
last_modified_time,
max_contacts,
name,
outbound_caller_config,
outbound_email_config,
queue_arn,
queue_id,
status,
tags
FROM aws.connect.queues
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_queue

Creates a new queue for the specified Connect Customer instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

INSERT INTO aws.connect.queues (
Name,
Description,
OutboundCallerConfig,
OutboundEmailConfig,
HoursOfOperationId,
MaxContacts,
QuickConnectIds,
EmailAddressesConfig,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ OutboundCallerConfig }}',
'{{ OutboundEmailConfig }}',
'{{ HoursOfOperationId }}' /* required */,
{{ MaxContacts }},
'{{ QuickConnectIds }}',
'{{ EmailAddressesConfig }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
queue_arn,
queue_id
;

Manifest

# Description fields are for documentation purposes
- name: queues
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the queues resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the queues resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: OutboundCallerConfig
    description: |
      The outbound caller ID name, number, and outbound whisper flow.
    value:
      OutboundCallerIdName: "{{ OutboundCallerIdName }}"
      OutboundCallerIdNumberId: "{{ OutboundCallerIdNumberId }}"
      OutboundFlowId: "{{ OutboundFlowId }}"
  - name: OutboundEmailConfig
    description: |
      The outbound email address ID.
    value:
      OutboundEmailAddressId: "{{ OutboundEmailAddressId }}"
  - name: HoursOfOperationId
    value: "{{ HoursOfOperationId }}"
  - name: MaxContacts
    value: {{ MaxContacts }}
  - name: QuickConnectIds
    value:
      - "{{ QuickConnectIds }}"
  - name: EmailAddressesConfig
    value:
      - EmailAddressId: "{{ EmailAddressId }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_queue_outbound_caller_config

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API. If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

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

update_queue_outbound_email_config

Updates the outbound email address Id for a specified queue.

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

update_routing_profile_default_outbound_queue

Updates the default outbound queue of a routing profile.

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

update_queue_name

Updates the name and description of a queue. At least Name or Description must be provided.

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

DELETE examples

delete_queue

Deletes a queue.

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

Lifecycle Methods

update_queue_status

Updates the status of the queue.

EXEC aws.connect.queues.update_queue_status 
@instance_id='{{ instance_id }}' --required, 
@queue_id='{{ queue_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Status": "{{ Status }}"
}'
;