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	awscc.connect.queues

Fields

get (all properties)

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.
▶outbound_email_config	object	The outbound email address ID.
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.

list (identifiers only)

Name	Datatype	Description
queue_arn	string	The Amazon Resource Name (ARN) for the queue.
region	string	AWS region.

For more information, see AWS::Connect::Queue.

Methods

Name	Resource	Accessible by	Required Params
create_resource	queues	INSERT	InstanceArn, HoursOfOperationArn, Name, region
delete_resource	queues	DELETE	Identifier, region
update_resource	queues	UPDATE	Identifier, PatchDocument, region
list_resources	queues_list_only	SELECT	region
get_resource	queues	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual queue.

SELECT
  region,
  instance_arn,
  description,
  hours_of_operation_arn,
  max_contacts,
  name,
  outbound_caller_config,
  outbound_email_config,
  queue_arn,
  status,
  quick_connect_arns,
  tags,
  type
FROM awscc.connect.queues
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ queue_arn }}';

list (identifiers only)

Lists all queues in a region.

SELECT
  region,
  queue_arn
FROM awscc.connect.queues_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.connect.queues (
  InstanceArn,
  Description,
  HoursOfOperationArn,
  MaxContacts,
  Name,
  OutboundCallerConfig,
  OutboundEmailConfig,
  Status,
  QuickConnectArns,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ description }}',
  '{{ hours_of_operation_arn }}',
  '{{ max_contacts }}',
  '{{ name }}',
  '{{ outbound_caller_config }}',
  '{{ outbound_email_config }}',
  '{{ status }}',
  '{{ quick_connect_arns }}',
  '{{ 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: instance_arn
        value: '{{ instance_arn }}'
      - name: description
        value: '{{ description }}'
      - name: hours_of_operation_arn
        value: '{{ hours_of_operation_arn }}'
      - name: max_contacts
        value: '{{ max_contacts }}'
      - name: name
        value: '{{ name }}'
      - name: outbound_caller_config
        value:
          outbound_caller_id_name: '{{ outbound_caller_id_name }}'
          outbound_caller_id_number_arn: '{{ outbound_caller_id_number_arn }}'
          outbound_flow_arn: '{{ outbound_flow_arn }}'
      - name: outbound_email_config
        value:
          outbound_email_address_id: '{{ outbound_email_address_id }}'
      - name: status
        value: '{{ status }}'
      - name: quick_connect_arns
        value:
          - '{{ quick_connect_arns[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.queues
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Description": description,
    "HoursOfOperationArn": hours_of_operation_arn,
    "MaxContacts": max_contacts,
    "Name": name,
    "OutboundCallerConfig": outbound_caller_config,
    "OutboundEmailConfig": outbound_email_config,
    "Status": status,
    "QuickConnectArns": quick_connect_arns,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ queue_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.connect.queues
WHERE
  Identifier = '{{ queue_arn }}' 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:UpdateQueueOutboundEmailConfig,
connect:UpdateQueueStatus,
connect:AssociateQueueQuickConnects,
connect:DisassociateQueueQuickConnects,
connect:TagResource,
connect:UntagResource

List

connect:ListQueues,
connect:ListQueueQuickConnects