:doc:`QConnect <../../qconnect>` / Paginator / ListQuickResponses

******************
ListQuickResponses
******************



.. py:class:: QConnect.Paginator.ListQuickResponses

  ::

    
    paginator = client.get_paginator('list_quick_responses')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QConnect.Client.list_quick_responses`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponses>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          knowledgeBaseId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type knowledgeBaseId: string
    :param knowledgeBaseId: **[REQUIRED]** 

      The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

      

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

      
      ::

        {
            'quickResponseSummaries': [
                {
                    'quickResponseArn': 'string',
                    'quickResponseId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string',
                    'name': 'string',
                    'contentType': 'string',
                    'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
                    'createdTime': datetime(2015, 1, 1),
                    'lastModifiedTime': datetime(2015, 1, 1),
                    'description': 'string',
                    'lastModifiedBy': 'string',
                    'isActive': True|False,
                    'channels': [
                        'string',
                    ],
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **quickResponseSummaries** *(list) --* 

          Summary information about the quick responses.

          
          

          - *(dict) --* 

            The summary information about the quick response.

            
            

            - **quickResponseArn** *(string) --* 

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

              
            

            - **quickResponseId** *(string) --* 

              The identifier of the quick response.

              
            

            - **knowledgeBaseArn** *(string) --* 

              The Amazon Resource Name (ARN) of the knowledge base.

              
            

            - **knowledgeBaseId** *(string) --* 

              The identifier of the knowledge base.

              
            

            - **name** *(string) --* 

              The name of the quick response.

              
            

            - **contentType** *(string) --* 

              The media type of the quick response content.

               

              
              * Use ``application/x.quickresponse;format=plain`` for quick response written in plain text.
               
              * Use ``application/x.quickresponse;format=markdown`` for quick response written in richtext.
              

              
            

            - **status** *(string) --* 

              The resource status of the quick response.

              
            

            - **createdTime** *(datetime) --* 

              The timestamp when the quick response was created.

              
            

            - **lastModifiedTime** *(datetime) --* 

              The timestamp when the quick response summary was last modified.

              
            

            - **description** *(string) --* 

              The description of the quick response.

              
            

            - **lastModifiedBy** *(string) --* 

              The Amazon Resource Name (ARN) of the user who last updated the quick response data.

              
            

            - **isActive** *(boolean) --* 

              Whether the quick response is active.

              
            

            - **channels** *(list) --* 

              The Amazon Connect contact channels this quick response applies to. The supported contact channel types include ``Chat``.

              
              

              - *(string) --* 
          
            

            - **tags** *(dict) --* 

              The tags used to organize, track, or control access for this resource.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    