:doc:`QConnect <../../qconnect>` / Client / get_assistant

*************
get_assistant
*************



.. py:method:: QConnect.Client.get_assistant(**kwargs)

  

  Retrieves information about an assistant.

  

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


  **Request Syntax**
  ::

    response = client.get_assistant(
        assistantId='string'
    )
    
  :type assistantId: string
  :param assistantId: **[REQUIRED]** 

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    

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

    
    ::

      {
          'assistant': {
              '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'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **assistant** *(dict) --* 

        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.

          
        

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

          The type of assistant.

          
        

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

          The status of the assistant.

          
        

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

          The description.

          
        

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

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

  
  *   :py:class:`QConnect.Client.exceptions.UnauthorizedException`

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

  
  *   :py:class:`QConnect.Client.exceptions.ResourceNotFoundException`

  