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

*****************
ListQuickConnects
*****************



.. py:class:: Connect.Paginator.ListQuickConnects

  ::

    
    paginator = client.get_paginator('list_quick_connects')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          InstanceId='string',
          QuickConnectTypes=[
              'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type InstanceId: string
    :param InstanceId: **[REQUIRED]** 

      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. Both Instance ID and Instance ARN are supported input formats.

      

    
    :type QuickConnectTypes: list
    :param QuickConnectTypes: 

      The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

      

    
      - *(string) --* 

      
  
    :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**

      
      ::

        {
            'QuickConnectSummaryList': [
                {
                    'Id': 'string',
                    'Arn': 'string',
                    'Name': 'string',
                    'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'LastModifiedRegion': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **QuickConnectSummaryList** *(list) --* 

          Information about the quick connects.

          
          

          - *(dict) --* 

            Contains summary information about a quick connect.

            
            

            - **Id** *(string) --* 

              The identifier for the quick connect.

              
            

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

              The Amazon Resource Name (ARN) of the quick connect.

              
            

            - **Name** *(string) --* 

              The name of the quick connect.

              
            

            - **QuickConnectType** *(string) --* 

              The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

              
            

            - **LastModifiedTime** *(datetime) --* 

              The timestamp when this resource was last modified.

              
            

            - **LastModifiedRegion** *(string) --* 

              The Amazon Web Services Region where this resource was last modified.

              
        
      
    