Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

AssociateTrafficDistributionGroupUser

Associates an agent with a traffic distribution group.

Request Syntax


PUT /traffic-distribution-group/TrafficDistributionGroupId/user HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "UserId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

TrafficDistributionGroupId

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: ^(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}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

UserId

The identifier of the user account. This can be the ID or the ARN of the user.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example

The following example associates an agent with a traffic distribution group.

Sample Request


PUT connect.[region].amazonaws.com/traffic-distribution-group/[traffic_distribution_group_id]/user
{
   "InstanceId": "[instance_id]",
   "UserId": "[user_id]"
}

Sample Response

{}