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 defafult on an Amazon Q in Connect Assistant.

See also: AWS API Documentation

Request Syntax

response = client.update_assistant_ai_agent(
    aiAgentType='MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
    assistantId='string',
    configuration={
        'aiAgentId': 'string'
    }
)
Parameters:

  • aiAgentType (string) –

    [REQUIRED]

    The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.

  • 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.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'assistant': {
        'aiAgentConfiguration': {
            'string': {
                'aiAgentId': 'string'
            }
        },
        'assistantArn': 'string',
        'assistantId': 'string',
        'capabilityConfiguration': {
            'type': 'V1'|'V2'
        },
        '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'
    }
}

Response Structure

  • (dict) –

    • assistant (dict) –

      The assistant data.

      • 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.

      • assistantArn (string) –

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

      • assistantId (string) –

        The identifier of the Amazon Q in Connect assistant.

      • capabilityConfiguration (dict) –

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

        • type (string) –

          The type of Amazon Q in Connect assistant capability.

      • description (string) –

        The description.

      • 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.

      • name (string) –

        The name.

      • 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.

      • 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 assistant.

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException

  • QConnect.Client.exceptions.ThrottlingException