traffic_distributions
Creates, updates, deletes, gets or lists a traffic_distributions resource.
Overview
| Name | traffic_distributions |
| Type | Resource |
| Id | aws.connect.traffic_distributions |
Fields
The following fields are returned by SELECT queries:
- get_traffic_distribution
| Name | Datatype | Description |
|---|---|---|
agent_config | object | The distribution of agents between the instance and its replica(s). |
arn | string | The Amazon Resource Name (ARN) of the traffic distribution group. (pattern: <code>^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>) |
id | string | The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>) |
sign_in_config | object | The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s). |
telephony_config | object | The distribution of traffic between the instance and its replicas. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_traffic_distribution | select | id, region | Retrieves the current traffic distribution for a given traffic distribution group. | |
update_traffic_distribution | update | id, region | Updates the traffic distribution for a given traffic distribution group. When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Connect Customer Administrator Guide. Important things to know Invoke the UpdateTrafficDistribution API in the region that should handle traffic. |
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 |
|---|---|---|
id | string | The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_traffic_distribution
Retrieves the current traffic distribution for a given traffic distribution group.
SELECT
agent_config,
arn,
id,
sign_in_config,
telephony_config
FROM aws.connect.traffic_distributions
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- update_traffic_distribution
Updates the traffic distribution for a given traffic distribution group. When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls. The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Connect Customer Administrator Guide. Important things to know Invoke the UpdateTrafficDistribution API in the region that should handle traffic.
UPDATE aws.connect.traffic_distributions
SET
TelephonyConfig = '{{ TelephonyConfig }}',
SignInConfig = '{{ SignInConfig }}',
AgentConfig = '{{ AgentConfig }}'
WHERE
id = '{{ id }}' --required
AND region = '{{ region }}' --required;