Connect / Client / describe_traffic_distribution_group

describe_traffic_distribution_group#

Connect.Client.describe_traffic_distribution_group(**kwargs)#

Gets details and status of a traffic distribution group.

See also: AWS API Documentation

Request Syntax

response = client.describe_traffic_distribution_group(
    TrafficDistributionGroupId='string'
)
Parameters:

TrafficDistributionGroupId (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.

Return type:

dict

Returns:

Response Syntax

{
    'TrafficDistributionGroup': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'InstanceArn': 'string',
        'Status': 'CREATION_IN_PROGRESS'|'ACTIVE'|'CREATION_FAILED'|'PENDING_DELETION'|'DELETION_FAILED'|'UPDATE_IN_PROGRESS',
        'Tags': {
            'string': 'string'
        },
        'IsDefault': True|False
    }
}

Response Structure

  • (dict) –

    • TrafficDistributionGroup (dict) –

      Information about the traffic distribution group.

      • 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.

      • Description (string) –

        The description of the traffic distribution group.

      • InstanceArn (string) –

        The Amazon Resource Name (ARN).

      • Status (string) –

        The status of the traffic distribution group.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

        • (string) –

          • (string) –

      • 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.

        Note

        You can change the SignInConfig distribution only for 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.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException