@aws-sdk/client-bedrock-agent-runtime 3.755.0 → 3.758.0

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

@@ -0,0 +1,134 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { PutInvocationStepRequest, PutInvocationStepResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutInvocationStepCommand}.
+ */
+export interface PutInvocationStepCommandInput extends PutInvocationStepRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutInvocationStepCommand}.
+ */
+export interface PutInvocationStepCommandOutput extends PutInvocationStepResponse, __MetadataBearer {
+}
+declare const PutInvocationStepCommand_base: {
+    new (input: PutInvocationStepCommandInput): import("@smithy/smithy-client").CommandImpl<PutInvocationStepCommandInput, PutInvocationStepCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PutInvocationStepCommandInput): import("@smithy/smithy-client").CommandImpl<PutInvocationStepCommandInput, PutInvocationStepCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
+ *          <p>Related APIs:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html">GetInvocationStep</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocationSteps.html">ListInvocationSteps</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html">ListInvocations</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html">ListSessions</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, PutInvocationStepCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, PutInvocationStepCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // PutInvocationStepRequest
+ *   sessionIdentifier: "STRING_VALUE", // required
+ *   invocationIdentifier: "STRING_VALUE", // required
+ *   invocationStepTime: new Date("TIMESTAMP"), // required
+ *   payload: { // InvocationStepPayload Union: only one key present
+ *     contentBlocks: [ // BedrockSessionContentBlocks
+ *       { // BedrockSessionContentBlock Union: only one key present
+ *         text: "STRING_VALUE",
+ *         image: { // ImageBlock
+ *           format: "png" || "jpeg" || "gif" || "webp", // required
+ *           source: { // ImageSource Union: only one key present
+ *             bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *             s3Location: { // S3Location
+ *               uri: "STRING_VALUE", // required
+ *             },
+ *           },
+ *         },
+ *       },
+ *     ],
+ *   },
+ *   invocationStepId: "STRING_VALUE",
+ * };
+ * const command = new PutInvocationStepCommand(input);
+ * const response = await client.send(command);
+ * // { // PutInvocationStepResponse
+ * //   invocationStepId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param PutInvocationStepCommandInput - {@link PutInvocationStepCommandInput}
+ * @returns {@link PutInvocationStepCommandOutput}
+ * @see {@link PutInvocationStepCommandInput} for command's `input` shape.
+ * @see {@link PutInvocationStepCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</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 ServiceQuotaExceededException} (client fault)
+ *  <p>The number of requests exceeds the service quota. Resubmit your request later.</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 BedrockAgentRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
+ *
+ * @public
+ */
+export declare class PutInvocationStepCommand extends PutInvocationStepCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutInvocationStepRequest;
+            output: PutInvocationStepResponse;
+        };
+        sdk: {
+            input: PutInvocationStepCommandInput;
+            output: PutInvocationStepCommandOutput;
+        };
+    };
+}

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

@@ -1,7 +1,8 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
-import { RetrieveAndGenerateRequest, RetrieveAndGenerateResponse } from "../models/models_0";
+import { RetrieveAndGenerateResponse } from "../models/models_0";
+import { RetrieveAndGenerateRequest } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,7 +1,8 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
-import { RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamResponse } from "../models/models_0";
+import { RetrieveAndGenerateStreamResponse } from "../models/models_0";
+import { RetrieveAndGenerateStreamRequest } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,7 +1,8 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
-import { RetrieveRequest, RetrieveResponse } from "../models/models_0";
+import { RetrieveResponse } from "../models/models_0";
+import { RetrieveRequest } from "../models/models_1";
 /**
  * @public
  */

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

@@ -0,0 +1,90 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
+}
+declare const TagResourceCommand_base: {
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Associate tags with a resource. For more information, see  <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the Amazon Bedrock User Guide.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, TagResourceCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, TagResourceCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // TagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // TagsMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</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 ServiceQuotaExceededException} (client fault)
+ *  <p>The number of requests exceeds the service quota. Resubmit your request later.</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 BedrockAgentRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
+ *
+ * @public
+ */
+export declare class TagResourceCommand extends TagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: TagResourceRequest;
+            output: {};
+        };
+        sdk: {
+            input: TagResourceCommandInput;
+            output: TagResourceCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,87 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
+}
+declare const UntagResourceCommand_base: {
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Remove tags from a resource.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, UntagResourceCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, UntagResourceCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // UntagResourceRequest
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</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 BedrockAgentRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
+ *
+ * @public
+ */
+export declare class UntagResourceCommand extends UntagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UntagResourceRequest;
+            output: {};
+        };
+        sdk: {
+            input: UntagResourceCommandInput;
+            output: UntagResourceCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,96 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { UpdateSessionRequest, UpdateSessionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateSessionCommand}.
+ */
+export interface UpdateSessionCommandInput extends UpdateSessionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateSessionCommand}.
+ */
+export interface UpdateSessionCommandOutput extends UpdateSessionResponse, __MetadataBearer {
+}
+declare const UpdateSessionCommand_base: {
+    new (input: UpdateSessionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSessionCommandInput, UpdateSessionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateSessionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSessionCommandInput, UpdateSessionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the metadata or encryption settings of a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, UpdateSessionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, UpdateSessionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // UpdateSessionRequest
+ *   sessionMetadata: { // SessionMetadataMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   sessionIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateSessionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateSessionResponse
+ * //   sessionId: "STRING_VALUE", // required
+ * //   sessionArn: "STRING_VALUE", // required
+ * //   sessionStatus: "ACTIVE" || "EXPIRED" || "ENDED", // required
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   lastUpdatedAt: new Date("TIMESTAMP"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateSessionCommandInput - {@link UpdateSessionCommandInput}
+ * @returns {@link UpdateSessionCommandOutput}
+ * @see {@link UpdateSessionCommandInput} for command's `input` shape.
+ * @see {@link UpdateSessionCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</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 BedrockAgentRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
+ *
+ * @public
+ */
+export declare class UpdateSessionCommand extends UpdateSessionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateSessionRequest;
+            output: UpdateSessionResponse;
+        };
+        sdk: {
+            input: UpdateSessionCommandInput;
+            output: UpdateSessionCommandOutput;
+        };
+    };
+}

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

@@ -1,11 +1,25 @@
+export * from "./CreateInvocationCommand";
+export * from "./CreateSessionCommand";
 export * from "./DeleteAgentMemoryCommand";
+export * from "./DeleteSessionCommand";
+export * from "./EndSessionCommand";
 export * from "./GenerateQueryCommand";
 export * from "./GetAgentMemoryCommand";
+export * from "./GetInvocationStepCommand";
+export * from "./GetSessionCommand";
 export * from "./InvokeAgentCommand";
 export * from "./InvokeFlowCommand";
 export * from "./InvokeInlineAgentCommand";
+export * from "./ListInvocationStepsCommand";
+export * from "./ListInvocationsCommand";
+export * from "./ListSessionsCommand";
+export * from "./ListTagsForResourceCommand";
 export * from "./OptimizePromptCommand";
+export * from "./PutInvocationStepCommand";
 export * from "./RerankCommand";
 export * from "./RetrieveAndGenerateCommand";
 export * from "./RetrieveAndGenerateStreamCommand";
 export * from "./RetrieveCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateSessionCommand";

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

@@ -1 +1,2 @@
 export * from "./models_0";
+export * from "./models_1";