queues

Creates, updates, deletes or gets a queue resource or lists queues in a region

Overview

Name	queues
Type	Resource
Description	Resource Type definition for AWS::Connect::Queue
Id	aws.connect.queues

Fields

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
description	string	The description of the queue.
hours_of_operation_arn	string	The identifier for the hours of operation.
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.
queue_arn	string	The Amazon Resource Name (ARN) for the queue.
status	string	The status of the queue.
quick_connect_arns	array	The quick connects available to agents who are working the queue.
tags	array	An array of key-value pairs to apply to this resource.
type	string	The type of queue.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, HoursOfOperationArn, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all queues in a region.

SELECT
region,
instance_arn,
description,
hours_of_operation_arn,
max_contacts,
name,
outbound_caller_config,
queue_arn,
status,
quick_connect_arns,
tags,
type
FROM aws.connect.queues
WHERE region = 'us-east-1';

Gets all properties from an individual queue.

SELECT
region,
instance_arn,
description,
hours_of_operation_arn,
max_contacts,
name,
outbound_caller_config,
queue_arn,
status,
quick_connect_arns,
tags,
type
FROM aws.connect.queues
WHERE region = 'us-east-1' AND data__Identifier = '<QueueArn>';

INSERT example

Use the following StackQL query and manifest file to create a new queue resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.connect.queues (
 InstanceArn,
 HoursOfOperationArn,
 Name,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ HoursOfOperationArn }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.queues (
 InstanceArn,
 Description,
 HoursOfOperationArn,
 MaxContacts,
 Name,
 OutboundCallerConfig,
 Status,
 QuickConnectArns,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Description }}',
 '{{ HoursOfOperationArn }}',
 '{{ MaxContacts }}',
 '{{ Name }}',
 '{{ OutboundCallerConfig }}',
 '{{ Status }}',
 '{{ QuickConnectArns }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: queue
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: HoursOfOperationArn
        value: '{{ HoursOfOperationArn }}'
      - name: MaxContacts
        value: '{{ MaxContacts }}'
      - name: Name
        value: '{{ Name }}'
      - name: OutboundCallerConfig
        value:
          OutboundCallerIdName: '{{ OutboundCallerIdName }}'
          OutboundCallerIdNumberArn: '{{ OutboundCallerIdNumberArn }}'
          OutboundFlowArn: '{{ OutboundFlowArn }}'
      - name: Status
        value: '{{ Status }}'
      - name: QuickConnectArns
        value:
          - '{{ QuickConnectArns[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.queues
WHERE data__Identifier = '<QueueArn>'
AND region = 'us-east-1';

Permissions

To operate on the queues resource, the following permissions are required:

Create

connect:CreateQueue,
connect:TagResource

Read

connect:DescribeQueue,
connect:ListQueueQuickConnects

Delete

connect:DeleteQueue,
connect:UntagResource

Update

connect:UpdateQueueHoursOfOperation,
connect:UpdateQueueMaxContacts,
connect:UpdateQueueName,
connect:UpdateQueueOutboundCallerConfig,
connect:UpdateQueueStatus,
connect:AssociateQueueQuickConnects,
connect:DisassociateQueueQuickConnects,
connect:TagResource,
connect:UntagResource

List

connect:ListQueues,
connect:ListQueueQuickConnects