:doc:`ConnectWisdomService <../../wisdom>` / Client / list_assistants

***************
list_assistants
***************



.. py:method:: ConnectWisdomService.Client.list_assistants(**kwargs)

  

  Lists information about assistants.

  

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


  **Request Syntax**
  ::

    response = client.list_assistants(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

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

    
    ::

      {
          'assistantSummaries': [
              {
                  'assistantArn': 'string',
                  'assistantId': 'string',
                  'description': 'string',
                  'integrationConfiguration': {
                      'topicIntegrationArn': 'string'
                  },
                  'name': 'string',
                  'serverSideEncryptionConfiguration': {
                      'kmsKeyId': 'string'
                  },
                  'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
                  'tags': {
                      'string': 'string'
                  },
                  'type': 'AGENT'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Information about the assistants.

        
        

        - *(dict) --* 

          Summary information about the assistant.

          
          

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

            The Amazon Resource Name (ARN) of the Wisdom assistant.

            
          

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

            The identifier of the Wisdom assistant.

            
          

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

            The description of the assistant.

            
          

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

            The configuration information for the Wisdom assistant integration.

            
            

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

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

              
        
          

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

            The name of the assistant.

            
          

          - **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``, and ``kms:Decrypt/kms:GenerateDataKey`` permissions to the IAM identity using the key to invoke Wisdom. To use Wisdom 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 Wisdom, see `Enable Amazon Connect Wisdom for your instance <https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html>`__.

            
            

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

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

              
        
          

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

            The status of the assistant.

            
          

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

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

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

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

            The type of the assistant.

            
      
    
      

      - **nextToken** *(string) --* 

        If there are additional results, this is the token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`ConnectWisdomService.Client.exceptions.ValidationException`

  
  *   :py:class:`ConnectWisdomService.Client.exceptions.AccessDeniedException`

  