@aws-sdk/client-bedrock-agent-runtime 3.810.0 → 3.815.0

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

@@ -0,0 +1,116 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { StartFlowExecutionRequest, StartFlowExecutionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartFlowExecutionCommand}.
+ */
+export interface StartFlowExecutionCommandInput extends StartFlowExecutionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartFlowExecutionCommand}.
+ */
+export interface StartFlowExecutionCommandOutput extends StartFlowExecutionResponse, __MetadataBearer {
+}
+declare const StartFlowExecutionCommand_base: {
+    new (input: StartFlowExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<StartFlowExecutionCommandInput, StartFlowExecutionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StartFlowExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<StartFlowExecutionCommandInput, StartFlowExecutionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Starts an asynchronous execution of an Amazon Bedrock flow. Unlike synchronous flows that run until completion or time out after five minutes, you can run asynchronous flows for longer durations. Asynchronous flows also yield control so that your application can perform other tasks.</p> <p>This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow's async execution.</p> <note> <p>Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.</p> </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, StartFlowExecutionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, StartFlowExecutionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // StartFlowExecutionRequest
+ *   flowIdentifier: "STRING_VALUE", // required
+ *   flowAliasIdentifier: "STRING_VALUE", // required
+ *   flowExecutionName: "STRING_VALUE",
+ *   inputs: [ // FlowInputs // required
+ *     { // FlowInput
+ *       nodeName: "STRING_VALUE", // required
+ *       nodeOutputName: "STRING_VALUE",
+ *       content: { // FlowInputContent Union: only one key present
+ *         document: "DOCUMENT_VALUE",
+ *       },
+ *       nodeInputName: "STRING_VALUE",
+ *     },
+ *   ],
+ *   modelPerformanceConfiguration: { // ModelPerformanceConfiguration
+ *     performanceConfig: { // PerformanceConfiguration
+ *       latency: "standard" || "optimized",
+ *     },
+ *   },
+ * };
+ * const command = new StartFlowExecutionCommand(input);
+ * const response = await client.send(command);
+ * // { // StartFlowExecutionResponse
+ * //   executionArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param StartFlowExecutionCommandInput - {@link StartFlowExecutionCommandInput}
+ * @returns {@link StartFlowExecutionCommandOutput}
+ * @see {@link StartFlowExecutionCommandInput} for command's `input` shape.
+ * @see {@link StartFlowExecutionCommandOutput} 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 BadGatewayException} (server fault)
+ *  <p>There was an issue with a dependency due to a server issue. 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 DependencyFailedException} (client fault)
+ *  <p>There was an issue with a dependency. Check the resource configurations and retry the 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 StartFlowExecutionCommand extends StartFlowExecutionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartFlowExecutionRequest;
+            output: StartFlowExecutionResponse;
+        };
+        sdk: {
+            input: StartFlowExecutionCommandInput;
+            output: StartFlowExecutionCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,99 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { StopFlowExecutionRequest, StopFlowExecutionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StopFlowExecutionCommand}.
+ */
+export interface StopFlowExecutionCommandInput extends StopFlowExecutionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StopFlowExecutionCommand}.
+ */
+export interface StopFlowExecutionCommandOutput extends StopFlowExecutionResponse, __MetadataBearer {
+}
+declare const StopFlowExecutionCommand_base: {
+    new (input: StopFlowExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<StopFlowExecutionCommandInput, StopFlowExecutionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StopFlowExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<StopFlowExecutionCommandInput, StopFlowExecutionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Stops an Amazon Bedrock flow's asynchronous execution. This operation prevents further processing of the flow and changes the execution status to <code>Aborted</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, StopFlowExecutionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, StopFlowExecutionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // StopFlowExecutionRequest
+ *   flowIdentifier: "STRING_VALUE", // required
+ *   flowAliasIdentifier: "STRING_VALUE", // required
+ *   executionIdentifier: "STRING_VALUE", // required
+ * };
+ * const command = new StopFlowExecutionCommand(input);
+ * const response = await client.send(command);
+ * // { // StopFlowExecutionResponse
+ * //   executionArn: "STRING_VALUE",
+ * //   status: "Running" || "Succeeded" || "Failed" || "TimedOut" || "Aborted", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StopFlowExecutionCommandInput - {@link StopFlowExecutionCommandInput}
+ * @returns {@link StopFlowExecutionCommandOutput}
+ * @see {@link StopFlowExecutionCommandInput} for command's `input` shape.
+ * @see {@link StopFlowExecutionCommandOutput} 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 BadGatewayException} (server fault)
+ *  <p>There was an issue with a dependency due to a server issue. 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 DependencyFailedException} (client fault)
+ *  <p>There was an issue with a dependency. Check the resource configurations and retry the 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 StopFlowExecutionCommand extends StopFlowExecutionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StopFlowExecutionRequest;
+            output: StopFlowExecutionResponse;
+        };
+        sdk: {
+            input: StopFlowExecutionCommandInput;
+            output: StopFlowExecutionCommandOutput;
+        };
+    };
+}

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

@@ -5,11 +5,15 @@ export * from "./DeleteSessionCommand";
 export * from "./EndSessionCommand";
 export * from "./GenerateQueryCommand";
 export * from "./GetAgentMemoryCommand";
+export * from "./GetExecutionFlowSnapshotCommand";
+export * from "./GetFlowExecutionCommand";
 export * from "./GetInvocationStepCommand";
 export * from "./GetSessionCommand";
 export * from "./InvokeAgentCommand";
 export * from "./InvokeFlowCommand";
 export * from "./InvokeInlineAgentCommand";
+export * from "./ListFlowExecutionEventsCommand";
+export * from "./ListFlowExecutionsCommand";
 export * from "./ListInvocationStepsCommand";
 export * from "./ListInvocationsCommand";
 export * from "./ListSessionsCommand";
@@ -20,6 +24,8 @@ export * from "./RerankCommand";
 export * from "./RetrieveAndGenerateCommand";
 export * from "./RetrieveAndGenerateStreamCommand";
 export * from "./RetrieveCommand";
+export * from "./StartFlowExecutionCommand";
+export * from "./StopFlowExecutionCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateSessionCommand";