QConnect / Client / update_assistant_ai_agent

update_assistant_ai_agent¶

QConnect.Client.update_assistant_ai_agent(**kwargs)¶

Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Request Syntax

response = client.update_assistant_ai_agent(
    assistantId='string',
    aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
    configuration={
        'aiAgentId': 'string',
        'enabled': True|False
    },
    orchestratorUseCase='string'
)

Parameters:

assistantId (string) –
[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
aiAgentType (string) –
[REQUIRED]

The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
configuration (dict) –
[REQUIRED]

The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
- aiAgentId (string) – [REQUIRED]
  
  The ID of the AI Agent to be configured.
- enabled (boolean) –
  
  Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
orchestratorUseCase (string) – The orchestrator use case for the AI Agent being added.

Return type:

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',
                'enabled': True|False
            }
        },
        'orchestratorConfigurationList': [
            {
                'aiAgentId': 'string',
                'orchestratorUseCase': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- assistant (dict) –
  
  The assistant data.
  - 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.
    - 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. For information about valid ID values, see Key identifiers (KeyId).
  - 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.
        
        enabled (boolean) –
        
        Indicates whether the AI Agent configured for this AI Agent type is enabled. When this value is omitted or set to true, the configured AI Agent runs; when set to false, the AI Agent ID is retained but no AI Agent runs for the AI Agent type. Setting this value to false is currently supported only for the ANSWER_RECOMMENDATION AI Agent type; other requests to set it to false are rejected with a validation error.
  - 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

QConnect.Client.exceptions.ValidationException
QConnect.Client.exceptions.AccessDeniedException
QConnect.Client.exceptions.ResourceNotFoundException
QConnect.Client.exceptions.ThrottlingException