:doc:`Connect <../../connect>` / Paginator / ListTrafficDistributionGroups

*****************************
ListTrafficDistributionGroups
*****************************



.. py:class:: Connect.Paginator.ListTrafficDistributionGroups

  ::

    
    paginator = client.get_paginator('list_traffic_distribution_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Connect.Client.list_traffic_distribution_groups`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstanceId: string
    :param InstanceId: 

      The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            '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) --* 
        

        - **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 <https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html>`__ operation is still in progress and has not yet completed.
               
              * ``ACTIVE`` means the previous `CreateTrafficDistributionGroup <https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html>`__ operation has succeeded.
               
              * ``CREATION_FAILED`` indicates that the previous `CreateTrafficDistributionGroup <https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html>`__ operation has failed.
               
              * ``PENDING_DELETION`` means the previous `DeleteTrafficDistributionGroup <https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html>`__ operation is still in progress and has not yet completed.
               
              * ``DELETION_FAILED`` means the previous `DeleteTrafficDistributionGroup <https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html>`__ operation has failed.
               
              * ``UPDATE_IN_PROGRESS`` means the previous `UpdateTrafficDistributionGroup <https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html>`__ 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.

              
        
      
    