- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateAIPromptCommand
Updates an AI Prompt.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, UpdateAIPromptCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, UpdateAIPromptCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // UpdateAIPromptRequest
clientToken: "STRING_VALUE",
assistantId: "STRING_VALUE", // required
aiPromptId: "STRING_VALUE", // required
visibilityStatus: "STRING_VALUE", // required
templateConfiguration: { // AIPromptTemplateConfiguration Union: only one key present
textFullAIPromptEditTemplateConfiguration: { // TextFullAIPromptEditTemplateConfiguration
text: "STRING_VALUE", // required
},
},
description: "STRING_VALUE",
};
const command = new UpdateAIPromptCommand(input);
const response = await client.send(command);
// { // UpdateAIPromptResponse
// aiPrompt: { // AIPromptData
// assistantId: "STRING_VALUE", // required
// assistantArn: "STRING_VALUE", // required
// aiPromptId: "STRING_VALUE", // required
// aiPromptArn: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// type: "STRING_VALUE", // required
// templateType: "STRING_VALUE", // required
// modelId: "STRING_VALUE", // required
// apiFormat: "STRING_VALUE", // required
// templateConfiguration: { // AIPromptTemplateConfiguration Union: only one key present
// textFullAIPromptEditTemplateConfiguration: { // TextFullAIPromptEditTemplateConfiguration
// text: "STRING_VALUE", // required
// },
// },
// modifiedTime: new Date("TIMESTAMP"),
// description: "STRING_VALUE",
// visibilityStatus: "STRING_VALUE", // required
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// origin: "STRING_VALUE",
// status: "STRING_VALUE",
// },
// };
UpdateAIPromptCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
aiPromptId Required | string | undefined | The identifier of the Amazon Q in Connect AI Prompt. |
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. |
visibilityStatus Required | VisibilityStatus | undefined | The visibility status of the Amazon Q in Connect AI prompt. |
clientToken | string | undefined | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .. |
description | string | undefined | The description of the Amazon Q in Connect AI Prompt. |
templateConfiguration | AIPromptTemplateConfiguration | undefined | The configuration of the prompt template for this AI Prompt. |
UpdateAIPromptCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
aiPrompt | AIPromptData | undefined | The data of the updated Amazon Q in Connect AI Prompt. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ConflictException | client | The request could not be processed because of conflict in the current state of the resource. For example, if you're using a |
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. |