DescribeTrafficDistributionGroupCommand

Suggest an Edit

Gets details and status of a traffic distribution group.

Example Syntax

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

import { ConnectClient, DescribeTrafficDistributionGroupCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DescribeTrafficDistributionGroupCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DescribeTrafficDistributionGroupRequest
  TrafficDistributionGroupId: "STRING_VALUE", // required
};
const command = new DescribeTrafficDistributionGroupCommand(input);
const response = await client.send(command);
// { // DescribeTrafficDistributionGroupResponse
//   TrafficDistributionGroup: { // TrafficDistributionGroup
//     Id: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     InstanceArn: "STRING_VALUE",
//     Status: "CREATION_IN_PROGRESS" || "ACTIVE" || "CREATION_FAILED" || "PENDING_DELETION" || "DELETION_FAILED" || "UPDATE_IN_PROGRESS",
//     Tags: { // TagMap
//       "<keys>": "STRING_VALUE",
//     },
//     IsDefault: true || false,
//   },
// };

DescribeTrafficDistributionGroupCommand Input

See DescribeTrafficDistributionGroupCommandInput 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 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.

DescribeTrafficDistributionGroupCommand Output

See DescribeTrafficDistributionGroupCommandOutput for details

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

Information about the traffic distribution group.

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.

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.