UpdateAssistantAIAgentCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QConnectClient, UpdateAssistantAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, UpdateAssistantAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // UpdateAssistantAIAgentRequest
  assistantId: "STRING_VALUE", // required
  aiAgentType: "STRING_VALUE", // required
  configuration: { // AIAgentConfigurationData
    aiAgentId: "STRING_VALUE", // required
  },
};
const command = new UpdateAssistantAIAgentCommand(input);
const response = await client.send(command);
// { // UpdateAssistantAIAgentResponse
//   assistant: { // AssistantData
//     assistantId: "STRING_VALUE", // required
//     assistantArn: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     type: "STRING_VALUE", // required
//     status: "STRING_VALUE", // required
//     description: "STRING_VALUE",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     serverSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
//       kmsKeyId: "STRING_VALUE",
//     },
//     integrationConfiguration: { // AssistantIntegrationConfiguration
//       topicIntegrationArn: "STRING_VALUE",
//     },
//     capabilityConfiguration: { // AssistantCapabilityConfiguration
//       type: "STRING_VALUE",
//     },
//     aiAgentConfiguration: { // AIAgentConfigurationMap
//       "<keys>": { // AIAgentConfigurationData
//         aiAgentId: "STRING_VALUE", // required
//       },
//     },
//   },
// };

UpdateAssistantAIAgentCommand Input

See UpdateAssistantAIAgentCommandInput for more details

Parameter
Type
Description
aiAgentType
Required
AIAgentType | undefined

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

assistantId
Required
string | undefined

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

configuration
Required
AIAgentConfigurationData | undefined

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

UpdateAssistantAIAgentCommand Output

See UpdateAssistantAIAgentCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
assistant
AssistantData | undefined

The assistant data.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ResourceNotFoundException
client

The specified resource does not exist.

ThrottlingException
client

The throttling limit has been exceeded.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.