Connect / Client / list_traffic_distribution_groups

list_traffic_distribution_groups#

Connect.Client.list_traffic_distribution_groups(**kwargs)#

Lists traffic distribution groups.

Request Syntax

response = client.list_traffic_distribution_groups(
    MaxResults=123,
    NextToken='string',
    InstanceId='string'
)

Parameters:

MaxResults (integer) – The maximum number of results to return per page.
NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
InstanceId (string) – The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'TrafficDistributionGroupSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'InstanceArn': 'string',
            'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS',
            'IsDefault': True|False
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.
- TrafficDistributionGroupSummaryList (list) –
  
  A list of traffic distribution groups.
  - (dict) –
    
    Information about traffic distribution groups.
    - 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.
    - Name (string) –
      
      The name of the traffic distribution group.
    - InstanceArn (string) –
      
      The Amazon Resource Name (ARN) of the traffic distribution group.
    - Status (string) –
      
      The status of the traffic distribution group.
      - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet completed.
      - ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
      - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
      - PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet completed.
      - DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
      - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet completed.
    - IsDefault (boolean) –
      
      Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

Exceptions

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