Connect / Client / update_traffic_distribution

update_traffic_distribution#

Connect.Client.update_traffic_distribution(**kwargs)#

Updates the traffic distribution for a given traffic distribution group.

Warning

When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don’t shift the agents, voice calls will go to the shifted Region but there won’t be any agents available to receive the calls.

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 Amazon Web Services Regions in the Amazon Connect Administrator Guide.

Request Syntax

response = client.update_traffic_distribution(
    Id='string',
    TelephonyConfig={
        'Distributions': [
            {
                'Region': 'string',
                'Percentage': 123
            },
        ]
    },
    SignInConfig={
        'Distributions': [
            {
                'Region': 'string',
                'Enabled': True|False
            },
        ]
    },
    AgentConfig={
        'Distributions': [
            {
                'Region': 'string',
                'Percentage': 123
            },
        ]
    }
)

Parameters:

Id (string) –
[REQUIRED]

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.
TelephonyConfig (dict) –
The distribution of traffic between the instance and its replica(s).
- Distributions (list) – [REQUIRED]
  
  Information about traffic distributions.
  - (dict) –
    
    Information about a traffic distribution.
    - Region (string) – [REQUIRED]
      
      The Amazon Web Services Region where the traffic is distributed.
    - Percentage (integer) – [REQUIRED]
      
      The percentage of the traffic that is distributed, in increments of 10.
SignInConfig (dict) –
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).
- Distributions (list) – [REQUIRED]
  
  Information about traffic distributions.
  - (dict) –
    
    The distribution of sign in traffic between the instance and its replica(s).
    - Region (string) – [REQUIRED]
      
      The Amazon Web Services Region of the sign in distribution.
    - Enabled (boolean) – [REQUIRED]
      
      Whether sign in distribution is enabled.
AgentConfig (dict) –
The distribution of agents between the instance and its replica(s).
- Distributions (list) – [REQUIRED]
  
  Information about traffic distributions.
  - (dict) –
    
    Information about a traffic distribution.
    - Region (string) – [REQUIRED]
      
      The Amazon Web Services Region where the traffic is distributed.
    - Percentage (integer) – [REQUIRED]
      
      The percentage of the traffic that is distributed, in increments of 10.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.AccessDeniedException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ResourceConflictException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException