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

UpdateTrafficDistribution

Updates the traffic distribution for a given traffic distribution group.

Note

The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

For more information about updating a traffic distribution group, see Update telephony traffic distribution across AWS Regions in the Amazon Connect Administrator Guide.

Request Syntax


PUT /traffic-distribution/Id HTTP/1.1
Content-type: application/json

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

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 accepts the following data in JSON format.

AgentConfig

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

Type: AgentConfig object

Required: No

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

Required: No

TelephonyConfig

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

Type: TelephonyConfig object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

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

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429