DeleteTrafficDistributionGroupCommand

Suggest an Edit

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 Amazon Connect Administrator Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, DeleteTrafficDistributionGroupCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DeleteTrafficDistributionGroupCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DeleteTrafficDistributionGroupRequest
  TrafficDistributionGroupId: "STRING_VALUE", // required
};
const command = new DeleteTrafficDistributionGroupCommand(input);
const response = await client.send(command);
// {};

DeleteTrafficDistributionGroupCommand Input

See DeleteTrafficDistributionGroupCommandInput for more details

Parameter
Type
Description
TrafficDistributionGroupId
Required
string | undefined

The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.

DeleteTrafficDistributionGroupCommand Output

See DeleteTrafficDistributionGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

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.

ResourceInUseException
client

That resource is already in use. Please try another.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.