:doc:`QBusiness <../../qbusiness>` / Paginator / ListChatResponseConfigurations

******************************
ListChatResponseConfigurations
******************************



.. py:class:: QBusiness.Paginator.ListChatResponseConfigurations

  ::

    
    paginator = client.get_paginator('list_chat_response_configurations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QBusiness.Client.list_chat_response_configurations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListChatResponseConfigurations>`_    


    **Request Syntax**
    ::

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

      The unique identifier of the Amazon Q Business application for which to list available chat response configurations.

      

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

      
      ::

        {
            'chatResponseConfigurations': [
                {
                    'chatResponseConfigurationId': 'string',
                    'chatResponseConfigurationArn': 'string',
                    'displayName': 'string',
                    'responseConfigurationSummary': 'string',
                    'status': 'CREATING'|'UPDATING'|'FAILED'|'ACTIVE',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **chatResponseConfigurations** *(list) --* 

          A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.

          
          

          - *(dict) --* 

            Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.

            
            

            - **chatResponseConfigurationId** *(string) --* 

              A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.

              
            

            - **chatResponseConfigurationArn** *(string) --* 

              The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.

              
            

            - **displayName** *(string) --* 

              A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.

              
            

            - **responseConfigurationSummary** *(string) --* 

              A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.

              
            

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

              The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.

              
            

            - **updatedAt** *(datetime) --* 

              The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.

              
        
      
        

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

          A token to resume pagination.

          
    