Connect / Client / get_traffic_distribution

get_traffic_distribution#

Connect.Client.get_traffic_distribution(**kwargs)#

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

Request Syntax

response = client.get_traffic_distribution(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The identifier of the traffic distribution group.

Return type:

dict

Returns:

Response Syntax

{
    'TelephonyConfig': {
        'Distributions': [
            {
                'Region': 'string',
                'Percentage': 123
            },
        ]
    },
    'Id': 'string',
    'Arn': 'string',
    'SignInConfig': {
        'Distributions': [
            {
                'Region': 'string',
                'Enabled': True|False
            },
        ]
    },
    'AgentConfig': {
        'Distributions': [
            {
                'Region': 'string',
                'Percentage': 123
            },
        ]
    }
}

Response Structure

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

Exceptions

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