- 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.
GetTrafficDistributionCommand
Retrieves the current traffic distribution for a given traffic distribution group.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, GetTrafficDistributionCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, GetTrafficDistributionCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // GetTrafficDistributionRequest
Id: "STRING_VALUE", // required
};
const command = new GetTrafficDistributionCommand(input);
const response = await client.send(command);
// { // GetTrafficDistributionResponse
// TelephonyConfig: { // TelephonyConfig
// Distributions: [ // DistributionList // required
// { // Distribution
// Region: "STRING_VALUE", // required
// Percentage: Number("int"), // required
// },
// ],
// },
// Id: "STRING_VALUE",
// Arn: "STRING_VALUE",
// SignInConfig: { // SignInConfig
// Distributions: [ // SignInDistributionList // required
// { // SignInDistribution
// Region: "STRING_VALUE", // required
// Enabled: true || false, // required
// },
// ],
// },
// AgentConfig: { // AgentConfig
// Distributions: [ // required
// {
// Region: "STRING_VALUE", // required
// Percentage: Number("int"), // required
// },
// ],
// },
// };
GetTrafficDistributionCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Id 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. |
GetTrafficDistributionCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AgentConfig | AgentConfig | undefined | The distribution of agents between the instance and its replica(s). |
Arn | string | undefined | The Amazon Resource Name (ARN) of the traffic distribution group. |
Id | 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. |
SignInConfig | SignInConfig | undefined | The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s). |
TelephonyConfig | TelephonyConfig | undefined | The distribution of traffic between the instance and its replicas. |
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. |
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. |