traffic_distribution_group_users

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

Overview

Name	traffic_distribution_group_users
Type	Resource
Id	aws.connect.traffic_distribution_group_users

Fields

The following fields are returned by SELECT queries:

list_traffic_distribution_group_users

Name	Datatype	Description
user_id	string	The identifier for the user. This can be the ID or the ARN of the user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_traffic_distribution_group_users	select	traffic_distribution_group_id, region	maxResults, nextToken	Lists traffic distribution group users.
associate_traffic_distribution_group_user	update	traffic_distribution_group_id, region, UserId, InstanceId		Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
disassociate_traffic_distribution_group_user	exec	traffic_distribution_group_id, UserId, InstanceId, region		Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

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
InstanceId	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
UserId	string	The identifier for the user. This can be the ID or the ARN of the user.
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.
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

list_traffic_distribution_group_users

Lists traffic distribution group users.

SELECT
user_id
FROM aws.connect.traffic_distribution_group_users
WHERE traffic_distribution_group_id = '{{ traffic_distribution_group_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

associate_traffic_distribution_group_user

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

UPDATE aws.connect.traffic_distribution_group_users
SET 
UserId = '{{ UserId }}',
InstanceId = '{{ InstanceId }}'
WHERE 
traffic_distribution_group_id = '{{ traffic_distribution_group_id }}' --required
AND region = '{{ region }}' --required
AND UserId = '{{ UserId }}' --required
AND InstanceId = '{{ InstanceId }}' --required;

Lifecycle Methods

disassociate_traffic_distribution_group_user

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

EXEC aws.connect.traffic_distribution_group_users.disassociate_traffic_distribution_group_user 
@traffic_distribution_group_id='{{ traffic_distribution_group_id }}' --required, 
@UserId='{{ UserId }}' --required, 
@InstanceId='{{ InstanceId }}' --required, 
@region='{{ region }}' --required
;