traffic_distribution_groups

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

Overview

Name	traffic_distribution_groups
Type	Resource
Id	aws.connect.traffic_distribution_groups

Fields

The following fields are returned by SELECT queries:

describe_traffic_distribution_group

Name	Datatype	Description
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>)
description	string	The description of the traffic distribution group. (pattern: <code>(^[\S].*[\S]$)|(^[\S]$)</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>)
instance_arn	string	The Amazon Resource Name (ARN). (pattern: <code>arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
is_default	boolean	Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica. 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.
name	string	The name of the traffic distribution group. (pattern: <code>(^[\S].*[\S]$)|(^[\S]$)</code>)
status	string	The status of the traffic distribution group. CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded. CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed. PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed. UPDATE_IN_PROGRESS means the previous UpdateTrafficDistribution operation is still in progress and has not yet completed. (CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

list_traffic_distribution_groups

Name	Datatype	Description
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>)
instance_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}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
is_default	boolean	Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.
name	string	The name of the traffic distribution group. (pattern: <code>(^[\S].*[\S]$)|(^[\S]$)</code>)
status	string	The status of the traffic distribution group. CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed. ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded. CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed. PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed. DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed. UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed. (CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, PENDING_DELETION, DELETION_FAILED, UPDATE_IN_PROGRESS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_traffic_distribution_group	select	traffic_distribution_group_id, region		Gets details and status of a traffic distribution group.
list_traffic_distribution_groups	select	region	maxResults, nextToken, instanceId	Lists traffic distribution groups.
create_traffic_distribution_group	insert	region, InstanceId		Creates a traffic distribution group given an Connect Customer instance that has been replicated. 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 creating traffic distribution groups, see Set up traffic distribution groups in the Connect Customer Administrator Guide.
delete_traffic_distribution_group	delete	traffic_distribution_group_id, region		Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Connect Customer Administrator Guide.

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
region	string	AWS region (default: us-east-1)
traffic_distribution_group_id	string	The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
instanceId	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
maxResults	integer	The maximum number of results to return per page.
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_traffic_distribution_group

Gets details and status of a traffic distribution group.

SELECT
arn,
description,
id,
instance_arn,
is_default,
name,
status,
tags
FROM aws.connect.traffic_distribution_groups
WHERE traffic_distribution_group_id = '{{ traffic_distribution_group_id }}' -- required
AND region = '{{ region }}' -- required
;

list_traffic_distribution_groups

Lists traffic distribution groups.

SELECT
arn,
id,
instance_arn,
is_default,
name,
status
FROM aws.connect.traffic_distribution_groups
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND instanceId = '{{ instanceId }}'
;

INSERT examples

create_traffic_distribution_group

Creates a traffic distribution group given an Connect Customer instance that has been replicated. 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 creating traffic distribution groups, see Set up traffic distribution groups in the Connect Customer Administrator Guide.

INSERT INTO aws.connect.traffic_distribution_groups (
Name,
Description,
InstanceId,
ClientToken,
Tags,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ InstanceId }}' /* required */,
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: traffic_distribution_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the traffic_distribution_groups resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: InstanceId
    value: "{{ InstanceId }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_traffic_distribution_group

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Connect Customer Administrator Guide.

DELETE FROM aws.connect.traffic_distribution_groups
WHERE traffic_distribution_group_id = '{{ traffic_distribution_group_id }}' --required
AND region = '{{ region }}' --required
;