- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DisassociateTrafficDistributionGroupUserCommand
Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, DisassociateTrafficDistributionGroupUserCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DisassociateTrafficDistributionGroupUserCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DisassociateTrafficDistributionGroupUserRequest
TrafficDistributionGroupId: "STRING_VALUE", // required
UserId: "STRING_VALUE", // required
InstanceId: "STRING_VALUE", // required
};
const command = new DisassociateTrafficDistributionGroupUserCommand(input);
const response = await client.send(command);
// {};
DisassociateTrafficDistributionGroupUserCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
TrafficDistributionGroupIdRequired | string | undefined | The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group. |
UserIdRequired | string | undefined | The identifier for the user. This can be the ID or the ARN of the user. |
DisassociateTrafficDistributionGroupUserCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidRequestException | client | The request is not valid. |
| ResourceConflictException | client | A resource already has that name. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |