routing_profiles

Creates, updates, deletes or gets a routing_profile resource or lists routing_profiles in a region

Overview

Name	routing_profiles
Type	Resource
Description	Resource Type definition for AWS::Connect::RoutingProfile
Id	awscc.connect.routing_profiles

Fields

get (all properties)

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
name	string	The name of the routing profile.
description	string	The description of the routing profile.
▶media_concurrencies	array	The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
default_outbound_queue_arn	string	The identifier of the default outbound queue for this routing profile.
routing_profile_arn	string	The Amazon Resource Name (ARN) of the routing profile.
▶queue_configs	array	The queues to associate with this routing profile.
▶tags	array	An array of key-value pairs to apply to this resource.
agent_availability_timer	string	Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
routing_profile_arn	string	The Amazon Resource Name (ARN) of the routing profile.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	routing_profiles	INSERT	InstanceArn, Name, Description, MediaConcurrencies, DefaultOutboundQueueArn, region
delete_resource	routing_profiles	DELETE	Identifier, region
update_resource	routing_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	routing_profiles_list_only	SELECT	region
get_resource	routing_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual routing_profile.

SELECT
  region,
  instance_arn,
  name,
  description,
  media_concurrencies,
  default_outbound_queue_arn,
  routing_profile_arn,
  queue_configs,
  tags,
  agent_availability_timer
FROM awscc.connect.routing_profiles
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ routing_profile_arn }}';

list (identifiers only)

Lists all routing_profiles in a region.

SELECT
  region,
  routing_profile_arn
FROM awscc.connect.routing_profiles_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.connect.routing_profiles (
  InstanceArn,
  Name,
  Description,
  MediaConcurrencies,
  DefaultOutboundQueueArn,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ description }}',
  '{{ media_concurrencies }}',
  '{{ default_outbound_queue_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.routing_profiles (
  InstanceArn,
  Name,
  Description,
  MediaConcurrencies,
  DefaultOutboundQueueArn,
  QueueConfigs,
  Tags,
  AgentAvailabilityTimer,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ description }}',
  '{{ media_concurrencies }}',
  '{{ default_outbound_queue_arn }}',
  '{{ queue_configs }}',
  '{{ tags }}',
  '{{ agent_availability_timer }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: routing_profile
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: media_concurrencies
      value:
        - channel: '{{ channel }}'
          concurrency: '{{ concurrency }}'
          cross_channel_behavior:
            behavior_type: '{{ behavior_type }}'
    - name: default_outbound_queue_arn
      value: '{{ default_outbound_queue_arn }}'
    - name: queue_configs
      value:
        - delay: '{{ delay }}'
          priority: '{{ priority }}'
          queue_reference:
            channel: null
            queue_arn: '{{ queue_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: agent_availability_timer
      value: '{{ agent_availability_timer }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.routing_profiles
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Name": name,
    "Description": description,
    "MediaConcurrencies": media_concurrencies,
    "DefaultOutboundQueueArn": default_outbound_queue_arn,
    "QueueConfigs": queue_configs,
    "Tags": tags,
    "AgentAvailabilityTimer": agent_availability_timer
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ routing_profile_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.routing_profiles
WHERE
  Identifier = '{{ routing_profile_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

connect:CreateRoutingProfile,
connect:TagResource

Read

connect:DescribeRoutingProfile,
connect:ListRoutingProfileQueues

Delete

connect:DeleteRoutingProfile,
connect:UntagResource

Update

connect:AssociateRoutingProfileQueues,
connect:DisassociateRoutingProfileQueues,
connect:UpdateRoutingProfileConcurrency,
connect:UpdateRoutingProfileName,
connect:UpdateRoutingProfileDefaultOutboundQueue,
connect:UpdateRoutingProfileQueues,
connect:TagResource,
connect:UntagResource,
connect:ListRoutingProfileQueues,
connect:UpdateRoutingProfileAgentAvailabilityTimer

List

connect:ListRoutingProfiles,
connect:ListRoutingProfileQueues