:doc:`Connect <../../connect>` / Client / create_traffic_distribution_group

*********************************
create_traffic_distribution_group
*********************************



.. py:method:: Connect.Client.create_traffic_distribution_group(**kwargs)

  

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

   

  .. note::

    

    The ``SignInConfig`` distribution is available only on a default ``TrafficDistributionGroup`` (see the ``IsDefault`` parameter in the `TrafficDistributionGroup <https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html>`__ 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 <https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html>`__ in the *Amazon Connect Administrator Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTrafficDistributionGroup>`_  


  **Request Syntax**
  ::

    response = client.create_traffic_distribution_group(
        Name='string',
        Description='string',
        InstanceId='string',
        ClientToken='string',
        Tags={
            'string': 'string'
        }
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

    The name for the traffic distribution group.

    

  
  :type Description: string
  :param Description: 

    A description for the traffic distribution group.

    

  
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

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

    

  
  :type ClientToken: string
  :param ClientToken: 

    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 <https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/>`__.

    This field is autopopulated if not provided.

  
  :type Tags: dict
  :param Tags: 

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

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: 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 of the traffic distribution group.

        
      

      - **Arn** *(string) --* 

        The Amazon Resource Name (ARN) of the traffic distribution group.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Connect.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceConflictException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotReadyException`

  