@aws-sdk/client-bedrock-agent 3.1151.0 → 3.1153.0

package/dist-types/commands/ListRetrievalInstructionVersionsCommand.d.ts

@@ -0,0 +1,94 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListRetrievalInstructionVersionsRequest, ListRetrievalInstructionVersionsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListRetrievalInstructionVersionsCommand}.
+ */
+export interface ListRetrievalInstructionVersionsCommandInput extends ListRetrievalInstructionVersionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListRetrievalInstructionVersionsCommand}.
+ */
+export interface ListRetrievalInstructionVersionsCommandOutput extends ListRetrievalInstructionVersionsResponse, __MetadataBearer {
+}
+declare const ListRetrievalInstructionVersionsCommand_base: {
+    new (input: ListRetrievalInstructionVersionsCommandInput): import("@smithy/core/client").CommandImpl<ListRetrievalInstructionVersionsCommandInput, ListRetrievalInstructionVersionsCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListRetrievalInstructionVersionsCommandInput): import("@smithy/core/client").CommandImpl<ListRetrievalInstructionVersionsCommandInput, ListRetrievalInstructionVersionsCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the numbered versions of a retrieval instruction, newest first. DRAFT is not listed; read it with GetRetrievalInstruction without retrievalInstructionVersion. Results are paginated. Use the nextToken parameter to retrieve additional results.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentClient, ListRetrievalInstructionVersionsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
+ * // const { BedrockAgentClient, ListRetrievalInstructionVersionsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
+ * const config = {}; // type is BedrockAgentClientConfig
+ * const client = new BedrockAgentClient(config);
+ * const input = { // ListRetrievalInstructionVersionsRequest
+ *   retrievalInstructionId: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListRetrievalInstructionVersionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListRetrievalInstructionVersionsResponse
+ * //   retrievalInstructionVersionSummaries: [ // RetrievalInstructionVersionSummaries // required
+ * //     { // RetrievalInstructionVersionSummary
+ * //       version: "STRING_VALUE", // required
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListRetrievalInstructionVersionsCommandInput - {@link ListRetrievalInstructionVersionsCommandInput}
+ * @returns {@link ListRetrievalInstructionVersionsCommandOutput}
+ * @see {@link ListRetrievalInstructionVersionsCommandInput} for command's `input` shape.
+ * @see {@link ListRetrievalInstructionVersionsCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockAgentServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListRetrievalInstructionVersionsCommand extends ListRetrievalInstructionVersionsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListRetrievalInstructionVersionsRequest;
+            output: ListRetrievalInstructionVersionsResponse;
+        };
+        sdk: {
+            input: ListRetrievalInstructionVersionsCommandInput;
+            output: ListRetrievalInstructionVersionsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListRetrievalInstructionsCommand.d.ts

@@ -0,0 +1,97 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListRetrievalInstructionsRequest, ListRetrievalInstructionsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListRetrievalInstructionsCommand}.
+ */
+export interface ListRetrievalInstructionsCommandInput extends ListRetrievalInstructionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListRetrievalInstructionsCommand}.
+ */
+export interface ListRetrievalInstructionsCommandOutput extends ListRetrievalInstructionsResponse, __MetadataBearer {
+}
+declare const ListRetrievalInstructionsCommand_base: {
+    new (input: ListRetrievalInstructionsCommandInput): import("@smithy/core/client").CommandImpl<ListRetrievalInstructionsCommandInput, ListRetrievalInstructionsCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (...[input]: [] | [ListRetrievalInstructionsCommandInput]): import("@smithy/core/client").CommandImpl<ListRetrievalInstructionsCommandInput, ListRetrievalInstructionsCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentClient, ListRetrievalInstructionsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
+ * // const { BedrockAgentClient, ListRetrievalInstructionsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
+ * const config = {}; // type is BedrockAgentClientConfig
+ * const client = new BedrockAgentClient(config);
+ * const input = { // ListRetrievalInstructionsRequest
+ *   status: "ACTIVE" || "INACTIVE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListRetrievalInstructionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListRetrievalInstructionsResponse
+ * //   retrievalInstructionSummaries: [ // RetrievalInstructionSummaries // required
+ * //     { // RetrievalInstructionSummary
+ * //       retrievalInstructionId: "STRING_VALUE", // required
+ * //       retrievalInstructionArn: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       status: "ACTIVE" || "INACTIVE", // required
+ * //       lastTransitionStatus: "CREATING" || "UPDATING" || "CREATE_SUCCESSFUL" || "CREATE_FAILED" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED", // required
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       updatedAt: new Date("TIMESTAMP"), // required
+ * //       description: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListRetrievalInstructionsCommandInput - {@link ListRetrievalInstructionsCommandInput}
+ * @returns {@link ListRetrievalInstructionsCommandOutput}
+ * @see {@link ListRetrievalInstructionsCommandInput} for command's `input` shape.
+ * @see {@link ListRetrievalInstructionsCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockAgentServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListRetrievalInstructionsCommand extends ListRetrievalInstructionsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListRetrievalInstructionsRequest;
+            output: ListRetrievalInstructionsResponse;
+        };
+        sdk: {
+            input: ListRetrievalInstructionsCommandInput;
+            output: ListRetrievalInstructionsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateRetrievalInstructionCommand.d.ts

@@ -0,0 +1,102 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateRetrievalInstructionRequest, UpdateRetrievalInstructionResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link UpdateRetrievalInstructionCommand}.
+ */
+export interface UpdateRetrievalInstructionCommandInput extends UpdateRetrievalInstructionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateRetrievalInstructionCommand}.
+ */
+export interface UpdateRetrievalInstructionCommandOutput extends UpdateRetrievalInstructionResponse, __MetadataBearer {
+}
+declare const UpdateRetrievalInstructionCommand_base: {
+    new (input: UpdateRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<UpdateRetrievalInstructionCommandInput, UpdateRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: UpdateRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<UpdateRetrievalInstructionCommandInput, UpdateRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the content of a retrieval instruction. The update is processed asynchronously; the stored content is a candidate until content review passes, and the served content does not change while the update is in flight. The service rejects the request with ConflictException while lastTransitionStatus is CREATING or UPDATING.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentClient, UpdateRetrievalInstructionCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
+ * // const { BedrockAgentClient, UpdateRetrievalInstructionCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
+ * const config = {}; // type is BedrockAgentClientConfig
+ * const client = new BedrockAgentClient(config);
+ * const input = { // UpdateRetrievalInstructionRequest
+ *   retrievalInstructionId: "STRING_VALUE", // required
+ *   instruction: { // RetrievalInstructionContent
+ *     retrievalGuidance: "STRING_VALUE",
+ *     persona: "STRING_VALUE",
+ *     answerFormat: "STRING_VALUE",
+ *     answerPolicy: "STRING_VALUE",
+ *   },
+ *   description: "STRING_VALUE",
+ * };
+ * const command = new UpdateRetrievalInstructionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateRetrievalInstructionResponse
+ * //   retrievalInstructionId: "STRING_VALUE", // required
+ * //   retrievalInstructionArn: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   status: "ACTIVE" || "INACTIVE", // required
+ * //   lastTransitionStatus: "CREATING" || "UPDATING" || "CREATE_SUCCESSFUL" || "CREATE_FAILED" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED", // required
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   updatedAt: new Date("TIMESTAMP"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateRetrievalInstructionCommandInput - {@link UpdateRetrievalInstructionCommandInput}
+ * @returns {@link UpdateRetrievalInstructionCommandOutput}
+ * @see {@link UpdateRetrievalInstructionCommandInput} for command's `input` shape.
+ * @see {@link UpdateRetrievalInstructionCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There was a conflict performing an operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockAgentServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateRetrievalInstructionCommand extends UpdateRetrievalInstructionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateRetrievalInstructionRequest;
+            output: UpdateRetrievalInstructionResponse;
+        };
+        sdk: {
+            input: UpdateRetrievalInstructionCommandInput;
+            output: UpdateRetrievalInstructionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -10,6 +10,8 @@ export * from "./CreateFlowVersionCommand";
 export * from "./CreateKnowledgeBaseCommand";
 export * from "./CreatePromptCommand";
 export * from "./CreatePromptVersionCommand";
+export * from "./CreateRetrievalInstructionCommand";
+export * from "./CreateRetrievalInstructionVersionCommand";
 export * from "./CreateVpcConfigurationCommand";
 export * from "./DeleteAgentActionGroupCommand";
 export * from "./DeleteAgentAliasCommand";
@@ -23,6 +25,7 @@ export * from "./DeleteKnowledgeBaseCommand";
 export * from "./DeleteKnowledgeBaseDocumentsCommand";
 export * from "./DeletePromptCommand";
 export * from "./DeleteResourcePolicyCommand";
+export * from "./DeleteRetrievalInstructionCommand";
 export * from "./DeleteVpcConfigurationCommand";
 export * from "./DisassociateAgentCollaboratorCommand";
 export * from "./DisassociateAgentKnowledgeBaseCommand";
@@ -41,6 +44,7 @@ export * from "./GetKnowledgeBaseCommand";
 export * from "./GetKnowledgeBaseDocumentsCommand";
 export * from "./GetPromptCommand";
 export * from "./GetResourcePolicyCommand";
+export * from "./GetRetrievalInstructionCommand";
 export * from "./GetVpcConfigurationCommand";
 export * from "./IngestKnowledgeBaseDocumentsCommand";
 export * from "./ListAgentActionGroupsCommand";
@@ -57,6 +61,8 @@ export * from "./ListIngestionJobsCommand";
 export * from "./ListKnowledgeBaseDocumentsCommand";
 export * from "./ListKnowledgeBasesCommand";
 export * from "./ListPromptsCommand";
+export * from "./ListRetrievalInstructionVersionsCommand";
+export * from "./ListRetrievalInstructionsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListVpcConfigurationsCommand";
 export * from "./PrepareAgentCommand";
@@ -76,4 +82,5 @@ export * from "./UpdateFlowAliasCommand";
 export * from "./UpdateFlowCommand";
 export * from "./UpdateKnowledgeBaseCommand";
 export * from "./UpdatePromptCommand";
+export * from "./UpdateRetrievalInstructionCommand";
 export * from "./ValidateFlowDefinitionCommand";

package/dist-types/models/enums.d.ts

@@ -1059,3 +1059,58 @@ export declare const KnowledgeBaseStatus: {
  * @public
  */
 export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const RetrievalInstructionLastTransitionStatus: {
+    readonly CREATE_FAILED: "CREATE_FAILED";
+    readonly CREATE_SUCCESSFUL: "CREATE_SUCCESSFUL";
+    readonly CREATING: "CREATING";
+    readonly UPDATE_FAILED: "UPDATE_FAILED";
+    readonly UPDATE_SUCCESSFUL: "UPDATE_SUCCESSFUL";
+    readonly UPDATING: "UPDATING";
+};
+/**
+ * @public
+ */
+export type RetrievalInstructionLastTransitionStatus = (typeof RetrievalInstructionLastTransitionStatus)[keyof typeof RetrievalInstructionLastTransitionStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const RetrievalInstructionStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type RetrievalInstructionStatus = (typeof RetrievalInstructionStatus)[keyof typeof RetrievalInstructionStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const RetrievalInstructionFailureReasonCode: {
+    readonly CLIENT_ERROR: "CLIENT_ERROR";
+    readonly CONTENT_REJECTED: "CONTENT_REJECTED";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+};
+/**
+ * @public
+ */
+export type RetrievalInstructionFailureReasonCode = (typeof RetrievalInstructionFailureReasonCode)[keyof typeof RetrievalInstructionFailureReasonCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const RetrievalInstructionFieldName: {
+    readonly ANSWER_FORMAT: "ANSWER_FORMAT";
+    readonly ANSWER_POLICY: "ANSWER_POLICY";
+    readonly PERSONA: "PERSONA";
+    readonly RETRIEVAL_GUIDANCE: "RETRIEVAL_GUIDANCE";
+};
+/**
+ * @public
+ */
+export type RetrievalInstructionFieldName = (typeof RetrievalInstructionFieldName)[keyof typeof RetrievalInstructionFieldName];