routing_profiles

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

Overview

Name	routing_profiles
Type	Resource
Id	aws.connect.routing_profiles

Fields

The following fields are returned by SELECT queries:

describe_routing_profile

Name	Datatype	Description
agent_availability_timer	string	Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time. (TIME_SINCE_LAST_ACTIVITY, TIME_SINCE_LAST_INBOUND)
associated_manual_assignment_queue_ids	array	The IDs of the associated manual assignment queues.
associated_queue_ids	array	The IDs of the associated queue.
default_outbound_queue_id	string	The identifier of the default outbound queue for this routing profile.
description	string	The description of the routing profile.
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.
is_default	boolean	Whether this a default routing profile.
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.
media_concurrencies	array	The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
name	string	The name of the routing profile.
number_of_associated_manual_assignment_queues	integer (int64)	The number of associated manual assignment queues in routing profile.
number_of_associated_queues	integer (int64)	The number of associated queues in routing profile.
number_of_associated_users	integer (int64)	The number of associated users in routing profile.
routing_profile_arn	string	The Amazon Resource Name (ARN) of the routing profile.
routing_profile_id	string	The identifier of the routing profile.
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_routing_profiles

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the routing profile.
id	string	The identifier of the routing profile.
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 routing profile.

search_routing_profiles

Name	Datatype	Description
agent_availability_timer	string	Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time. (TIME_SINCE_LAST_ACTIVITY, TIME_SINCE_LAST_INBOUND)
associated_manual_assignment_queue_ids	array	The IDs of the associated manual assignment queues.
associated_queue_ids	array	The IDs of the associated queue.
default_outbound_queue_id	string	The identifier of the default outbound queue for this routing profile.
description	string	The description of the routing profile.
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.
is_default	boolean	Whether this a default routing profile.
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.
media_concurrencies	array	The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
name	string	The name of the routing profile.
number_of_associated_manual_assignment_queues	integer (int64)	The number of associated manual assignment queues in routing profile.
number_of_associated_queues	integer (int64)	The number of associated queues in routing profile.
number_of_associated_users	integer (int64)	The number of associated users in routing profile.
routing_profile_arn	string	The Amazon Resource Name (ARN) of the routing profile.
routing_profile_id	string	The identifier of the routing profile.
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_routing_profile	select	instance_id, routing_profile_id, region		Describes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.
list_routing_profiles	select	instance_id, region	nextToken, maxResults	Provides summary information about the routing profiles for the specified Connect Customer instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Connect Customer Administrator Guide.
search_routing_profiles	select	region		Searches routing profiles in an Connect Customer instance, with optional filtering. SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does.
create_routing_profile	insert	instance_id, region, DefaultOutboundQueueId, MediaConcurrencies		Creates a new routing profile.
update_routing_profile_agent_availability_timer	update	instance_id, routing_profile_id, region, AgentAvailabilityTimer		Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
update_routing_profile_concurrency	update	instance_id, routing_profile_id, region, MediaConcurrencies		Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
update_user_routing_profile	update	user_id, instance_id, region, RoutingProfileId		Assigns the specified routing profile to the specified user.
update_routing_profile_name	update	instance_id, routing_profile_id, region		Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.
delete_routing_profile	delete	instance_id, routing_profile_id, region		Deletes a routing profile.

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.
user_id	string	The identifier of the user account.
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

describe_routing_profile

Describes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.

SELECT
agent_availability_timer,
associated_manual_assignment_queue_ids,
associated_queue_ids,
default_outbound_queue_id,
description,
instance_id,
is_default,
last_modified_region,
last_modified_time,
media_concurrencies,
name,
number_of_associated_manual_assignment_queues,
number_of_associated_queues,
number_of_associated_users,
routing_profile_arn,
routing_profile_id,
tags
FROM aws.connect.routing_profiles
WHERE instance_id = '{{ instance_id }}' -- required
AND routing_profile_id = '{{ routing_profile_id }}' -- required
AND region = '{{ region }}' -- required
;

list_routing_profiles

Provides summary information about the routing profiles for the specified Connect Customer instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Connect Customer Administrator Guide.

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

search_routing_profiles

Searches routing profiles in an Connect Customer instance, with optional filtering. SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does.

SELECT
agent_availability_timer,
associated_manual_assignment_queue_ids,
associated_queue_ids,
default_outbound_queue_id,
description,
instance_id,
is_default,
last_modified_region,
last_modified_time,
media_concurrencies,
name,
number_of_associated_manual_assignment_queues,
number_of_associated_queues,
number_of_associated_users,
routing_profile_arn,
routing_profile_id,
tags
FROM aws.connect.routing_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_routing_profile

Creates a new routing profile.

INSERT INTO aws.connect.routing_profiles (
Name,
Description,
DefaultOutboundQueueId,
QueueConfigs,
ManualAssignmentQueueConfigs,
MediaConcurrencies,
Tags,
AgentAvailabilityTimer,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ DefaultOutboundQueueId }}' /* required */,
'{{ QueueConfigs }}',
'{{ ManualAssignmentQueueConfigs }}',
'{{ MediaConcurrencies }}' /* required */,
'{{ Tags }}',
'{{ AgentAvailabilityTimer }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
routing_profile_arn,
routing_profile_id
;

Manifest

# Description fields are for documentation purposes
- name: routing_profiles
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the routing_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the routing_profiles resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: DefaultOutboundQueueId
    value: "{{ DefaultOutboundQueueId }}"
  - name: QueueConfigs
    value:
      - QueueReference:
          QueueId: "{{ QueueId }}"
          Channel: "{{ Channel }}"
        Priority: {{ Priority }}
        Delay: {{ Delay }}
  - name: ManualAssignmentQueueConfigs
    value:
      - QueueReference:
          QueueId: "{{ QueueId }}"
          Channel: "{{ Channel }}"
  - name: MediaConcurrencies
    value:
      - Channel: "{{ Channel }}"
        Concurrency: {{ Concurrency }}
        CrossChannelBehavior:
          BehaviorType: "{{ BehaviorType }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: AgentAvailabilityTimer
    value: "{{ AgentAvailabilityTimer }}"
    valid_values: ['TIME_SINCE_LAST_ACTIVITY', 'TIME_SINCE_LAST_INBOUND']

UPDATE examples

update_routing_profile_agent_availability_timer

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

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

update_routing_profile_concurrency

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

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

update_user_routing_profile

Assigns the specified routing profile to the specified user.

UPDATE aws.connect.routing_profiles
SET 
RoutingProfileId = '{{ RoutingProfileId }}'
WHERE 
user_id = '{{ user_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND RoutingProfileId = '{{ RoutingProfileId }}' --required;

update_routing_profile_name

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

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

DELETE examples

delete_routing_profile

Deletes a routing profile.

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