QConnect / Client / delete_ai_agent

delete_ai_agent#

QConnect.Client.delete_ai_agent(**kwargs)#

Deletes an Amazon Q in Connect AI Agent.

See also: AWS API Documentation

Request Syntax

response = client.delete_ai_agent(
    aiAgentId='string',
    assistantId='string'
)
Parameters:
  • aiAgentId (string) –

    [REQUIRED]

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

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException

  • QConnect.Client.exceptions.ThrottlingException