DisassociateTrafficDistributionGroupUser
Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Request Syntax
DELETE /traffic-distribution-group/TrafficDistributionGroupId
/user?InstanceId=InstanceId
&UserId=UserId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- TrafficDistributionGroupId
-
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
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
- UserId
-
The identifier for the user. This can be the ID or the ARN of the user.
Required: Yes
Request Body
The request does not have a request body.
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 disassociates an agent from a traffic distribution group.
Sample Request
DELETE connect.[region].amazonaws.com/traffic-distribution-group/[traffic_distribution_group_id]/user?instanceId=[instance_id]&userId=[user_id]
{
}
Sample Response
{}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: