Connect / Client / create_traffic_distribution_group

create_traffic_distribution_group#

Connect.Client.create_traffic_distribution_group(**kwargs)#

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

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.

For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_traffic_distribution_group(
    Name='string',
    Description='string',
    InstanceId='string',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name for the traffic distribution group.

  • Description (string) – A description for the traffic distribution group.

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.

  • ClientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    This field is autopopulated if not provided.

  • Tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

  • (dict) –

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.ServiceQuotaExceededException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ResourceConflictException

  • Connect.Client.exceptions.ResourceNotReadyException