Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetTrafficDistribution

Retrieves the current traffic distribution for a given traffic distribution group.

Request Syntax


GET /traffic-distribution/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

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.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AgentConfig": { 
      "Distributions": [ 
         { 
            "Percentage": number,
            "Region": "string"
         }
      ]
   },
   "Arn": "string",
   "Id": "string",
   "SignInConfig": { 
      "Distributions": [ 
         { 
            "Enabled": boolean,
            "Region": "string"
         }
      ]
   },
   "TelephonyConfig": { 
      "Distributions": [ 
         { 
            "Percentage": number,
            "Region": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AgentConfig

The distribution of agents between the instance and its replica(s).

Type: AgentConfig object

Arn

The Amazon Resource Name (ARN) of the traffic distribution group.

Type: String

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}$

Id

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

SignInConfig

The distribution that determines which AWS Regions should be used to sign in agents in to both the instance and its replica(s).

Type: SignInConfig object

TelephonyConfig

The distribution of traffic between the instance and its replicas.

Type: TelephonyConfig object

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

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429