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

**************
ListAssistants
**************



.. py:class:: QConnect.Paginator.ListAssistants

  ::

    
    paginator = client.get_paginator('list_assistants')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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**

      
      ::

        {
            'assistantSummaries': [
                {
                    'assistantId': 'string',
                    'assistantArn': 'string',
                    'name': 'string',
                    'type': 'AGENT',
                    'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                    'description': 'string',
                    'tags': {
                        'string': 'string'
                    },
                    'serverSideEncryptionConfiguration': {
                        'kmsKeyId': 'string'
                    },
                    'integrationConfiguration': {
                        'topicIntegrationArn': 'string'
                    },
                    'capabilityConfiguration': {
                        'type': 'V1'|'V2'
                    },
                    'aiAgentConfiguration': {
                        'string': {
                            'aiAgentId': 'string'
                        }
                    },
                    'orchestratorConfigurationList': [
                        {
                            'aiAgentId': 'string',
                            'orchestratorUseCase': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **assistantSummaries** *(list) --* 

          Information about the assistants.

          
          

          - *(dict) --* 

            Summary information about the assistant.

            
            

            - **assistantId** *(string) --* 

              The identifier of the Amazon Q in Connect assistant.

              
            

            - **assistantArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

              
            

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

              The name of the assistant.

              
            

            - **type** *(string) --* 

              The type of the assistant.

              
            

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

              The status of the assistant.

              
            

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

              The description of the assistant.

              
            

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

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

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **serverSideEncryptionConfiguration** *(dict) --* 

              The configuration information for the customer managed key used for encryption.

               

              This KMS key must have a policy that allows ``kms:CreateGrant``, ``kms:DescribeKey``, ``kms:Decrypt``, and ``kms:GenerateDataKey*`` permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow ``kms:Decrypt``, ``kms:GenerateDataKey*``, and ``kms:DescribeKey`` permissions to the ``connect.amazonaws.com`` service principal.

               

              For more information about setting up a customer managed key for Amazon Q in Connect, see `Enable Amazon Q in Connect for your instance <https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html>`__.

              
              

              - **kmsKeyId** *(string) --* 

                The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see `Enable Amazon Q in Connect for your instance <https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html>`__. For information about valid ID values, see `Key identifiers (KeyId) <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id>`__.

                
          
            

            - **integrationConfiguration** *(dict) --* 

              The configuration information for the Amazon Q in Connect assistant integration.

              
              

              - **topicIntegrationArn** *(string) --* 

                The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

                
          
            

            - **capabilityConfiguration** *(dict) --* 

              The configuration information for the Amazon Q in Connect assistant capability.

              
              

              - **type** *(string) --* 

                The type of Amazon Q in Connect assistant capability.

                
          
            

            - **aiAgentConfiguration** *(dict) --* 

              The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.

              
              

              - *(string) --* 
                

                - *(dict) --* 

                  A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

                  
                  

                  - **aiAgentId** *(string) --* 

                    The ID of the AI Agent to be configured.

                    
              
          
        
            

            - **orchestratorConfigurationList** *(list) --* 

              The list of orchestrator configurations for the assistant.

              
              

              - *(dict) --* 

                An entry in the orchestrator configuration list.

                
                

                - **aiAgentId** *(string) --* 

                  The identifier of the AI Agent in the orchestrator configuration.

                  
                

                - **orchestratorUseCase** *(string) --* 

                  The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)

                  
            
          
        
      
        

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

          A token to resume pagination.

          
    