GetAIPromptCommand

Gets and Amazon Q in Connect AI Prompt.

Example Syntax

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

import { QConnectClient, GetAIPromptCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, GetAIPromptCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // GetAIPromptRequest
  assistantId: "STRING_VALUE", // required
  aiPromptId: "STRING_VALUE", // required
};
const command = new GetAIPromptCommand(input);
const response = await client.send(command);
// { // GetAIPromptResponse
//   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",
//   },
//   versionNumber: Number("long"),
// };

GetAIPromptCommand Input

See GetAIPromptCommandInput for more details

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.

GetAIPromptCommand Output

See GetAIPromptCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
aiPrompt
AIPromptData | undefined

The data of the AI Prompt.

versionNumber
number | undefined

The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).

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.