@aws-sdk/client-bedrock-agent-runtime 3.810.0 → 3.815.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/dist-cjs/index.js +829 -176
- package/dist-es/BedrockAgentRuntime.js +12 -0
- package/dist-es/commands/GetExecutionFlowSnapshotCommand.js +22 -0
- package/dist-es/commands/GetFlowExecutionCommand.js +22 -0
- package/dist-es/commands/GetInvocationStepCommand.js +1 -1
- package/dist-es/commands/ListFlowExecutionEventsCommand.js +23 -0
- package/dist-es/commands/ListFlowExecutionsCommand.js +22 -0
- package/dist-es/commands/PutInvocationStepCommand.js +1 -1
- package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +1 -2
- package/dist-es/commands/RetrieveCommand.js +1 -2
- package/dist-es/commands/StartFlowExecutionCommand.js +23 -0
- package/dist-es/commands/StopFlowExecutionCommand.js +22 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +202 -196
- package/dist-es/models/models_1.js +141 -1
- package/dist-es/pagination/ListFlowExecutionEventsPaginator.js +4 -0
- package/dist-es/pagination/ListFlowExecutionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +370 -2
- package/dist-types/BedrockAgentRuntime.d.ts +42 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +8 -2
- package/dist-types/commands/CreateInvocationCommand.d.ts +1 -1
- package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteSessionCommand.d.ts +1 -1
- package/dist-types/commands/EndSessionCommand.d.ts +1 -1
- package/dist-types/commands/GetExecutionFlowSnapshotCommand.d.ts +94 -0
- package/dist-types/commands/GetFlowExecutionCommand.d.ts +102 -0
- package/dist-types/commands/GetInvocationStepCommand.d.ts +1 -1
- package/dist-types/commands/GetSessionCommand.d.ts +1 -1
- package/dist-types/commands/ListFlowExecutionEventsCommand.d.ts +164 -0
- package/dist-types/commands/ListFlowExecutionsCommand.d.ts +101 -0
- package/dist-types/commands/ListInvocationStepsCommand.d.ts +1 -1
- package/dist-types/commands/ListInvocationsCommand.d.ts +1 -1
- package/dist-types/commands/ListSessionsCommand.d.ts +1 -2
- package/dist-types/commands/PutInvocationStepCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +1 -2
- package/dist-types/commands/RetrieveCommand.d.ts +1 -2
- package/dist-types/commands/StartFlowExecutionCommand.d.ts +116 -0
- package/dist-types/commands/StopFlowExecutionCommand.d.ts +99 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +3521 -3592
- package/dist-types/models/models_1.d.ts +972 -1
- package/dist-types/pagination/ListFlowExecutionEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListFlowExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +102 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetExecutionFlowSnapshotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetFlowExecutionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFlowExecutionEventsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListFlowExecutionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/StartFlowExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopFlowExecutionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +393 -507
- package/dist-types/ts3.4/models/models_1.d.ts +490 -2
- package/dist-types/ts3.4/pagination/ListFlowExecutionEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListFlowExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +5 -5
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
+
import { GetExecutionFlowSnapshotRequest, GetExecutionFlowSnapshotResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetExecutionFlowSnapshotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetExecutionFlowSnapshotCommandInput extends GetExecutionFlowSnapshotRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetExecutionFlowSnapshotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetExecutionFlowSnapshotCommandOutput extends GetExecutionFlowSnapshotResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetExecutionFlowSnapshotCommand_base: {
|
|
25
|
+
new (input: GetExecutionFlowSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetExecutionFlowSnapshotCommandInput, GetExecutionFlowSnapshotCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetExecutionFlowSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetExecutionFlowSnapshotCommandInput, GetExecutionFlowSnapshotCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the flow definition snapshot used for an asynchronous execution. The snapshot represents the flow metadata and definition as it existed at the time the asynchronous execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.</p> <note> <p>Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, GetExecutionFlowSnapshotCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, GetExecutionFlowSnapshotCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // GetExecutionFlowSnapshotRequest
|
|
38
|
+
* flowIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* flowAliasIdentifier: "STRING_VALUE", // required
|
|
40
|
+
* executionIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetExecutionFlowSnapshotCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetExecutionFlowSnapshotResponse
|
|
45
|
+
* // flowIdentifier: "STRING_VALUE", // required
|
|
46
|
+
* // flowAliasIdentifier: "STRING_VALUE", // required
|
|
47
|
+
* // flowVersion: "STRING_VALUE", // required
|
|
48
|
+
* // executionRoleArn: "STRING_VALUE", // required
|
|
49
|
+
* // definition: "STRING_VALUE", // required
|
|
50
|
+
* // customerEncryptionKeyArn: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param GetExecutionFlowSnapshotCommandInput - {@link GetExecutionFlowSnapshotCommandInput}
|
|
56
|
+
* @returns {@link GetExecutionFlowSnapshotCommandOutput}
|
|
57
|
+
* @see {@link GetExecutionFlowSnapshotCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link GetExecutionFlowSnapshotCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalServerException} (server fault)
|
|
65
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ValidationException} (client fault)
|
|
74
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class GetExecutionFlowSnapshotCommand extends GetExecutionFlowSnapshotCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: GetExecutionFlowSnapshotRequest;
|
|
87
|
+
output: GetExecutionFlowSnapshotResponse;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: GetExecutionFlowSnapshotCommandInput;
|
|
91
|
+
output: GetExecutionFlowSnapshotCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
+
import { GetFlowExecutionRequest, GetFlowExecutionResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetFlowExecutionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetFlowExecutionCommandInput extends GetFlowExecutionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetFlowExecutionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetFlowExecutionCommandOutput extends GetFlowExecutionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetFlowExecutionCommand_base: {
|
|
25
|
+
new (input: GetFlowExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<GetFlowExecutionCommandInput, GetFlowExecutionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetFlowExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<GetFlowExecutionCommandInput, GetFlowExecutionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves details about a specific asynchronous execution of a flow, including its status, start and end times, and any errors that occurred during execution.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, GetFlowExecutionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, GetFlowExecutionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // GetFlowExecutionRequest
|
|
38
|
+
* flowIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* flowAliasIdentifier: "STRING_VALUE", // required
|
|
40
|
+
* executionIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetFlowExecutionCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetFlowExecutionResponse
|
|
45
|
+
* // executionArn: "STRING_VALUE", // required
|
|
46
|
+
* // status: "Running" || "Succeeded" || "Failed" || "TimedOut" || "Aborted", // required
|
|
47
|
+
* // startedAt: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // endedAt: new Date("TIMESTAMP"),
|
|
49
|
+
* // errors: [ // FlowExecutionErrors
|
|
50
|
+
* // { // FlowExecutionError
|
|
51
|
+
* // nodeName: "STRING_VALUE",
|
|
52
|
+
* // error: "ExecutionTimedOut",
|
|
53
|
+
* // message: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // flowAliasIdentifier: "STRING_VALUE", // required
|
|
57
|
+
* // flowIdentifier: "STRING_VALUE", // required
|
|
58
|
+
* // flowVersion: "STRING_VALUE", // required
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param GetFlowExecutionCommandInput - {@link GetFlowExecutionCommandInput}
|
|
64
|
+
* @returns {@link GetFlowExecutionCommandOutput}
|
|
65
|
+
* @see {@link GetFlowExecutionCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link GetFlowExecutionCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export declare class GetFlowExecutionCommand extends GetFlowExecutionCommand_base {
|
|
91
|
+
/** @internal type navigation helper, not in runtime. */
|
|
92
|
+
protected static __types: {
|
|
93
|
+
api: {
|
|
94
|
+
input: GetFlowExecutionRequest;
|
|
95
|
+
output: GetFlowExecutionResponse;
|
|
96
|
+
};
|
|
97
|
+
sdk: {
|
|
98
|
+
input: GetFlowExecutionCommandInput;
|
|
99
|
+
output: GetFlowExecutionCommandOutput;
|
|
100
|
+
};
|
|
101
|
+
};
|
|
102
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { GetInvocationStepRequest, GetInvocationStepResponse } from "../models/
|
|
4
|
+
import { GetInvocationStepRequest, GetInvocationStepResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { GetSessionRequest, GetSessionResponse } from "../models/
|
|
4
|
+
import { GetSessionRequest, GetSessionResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
+
import { ListFlowExecutionEventsRequest, ListFlowExecutionEventsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListFlowExecutionEventsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListFlowExecutionEventsCommandInput extends ListFlowExecutionEventsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListFlowExecutionEventsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListFlowExecutionEventsCommandOutput extends ListFlowExecutionEventsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListFlowExecutionEventsCommand_base: {
|
|
25
|
+
new (input: ListFlowExecutionEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowExecutionEventsCommandInput, ListFlowExecutionEventsCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListFlowExecutionEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowExecutionEventsCommandInput, ListFlowExecutionEventsCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists events that occurred during an asynchronous execution of a flow. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.</p> <note> <p>Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, ListFlowExecutionEventsCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, ListFlowExecutionEventsCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // ListFlowExecutionEventsRequest
|
|
38
|
+
* flowIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* flowAliasIdentifier: "STRING_VALUE", // required
|
|
40
|
+
* executionIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* eventType: "Node" || "Flow", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new ListFlowExecutionEventsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ListFlowExecutionEventsResponse
|
|
48
|
+
* // flowExecutionEvents: [ // FlowExecutionEvents // required
|
|
49
|
+
* // { // FlowExecutionEvent Union: only one key present
|
|
50
|
+
* // flowInputEvent: { // FlowExecutionInputEvent
|
|
51
|
+
* // nodeName: "STRING_VALUE", // required
|
|
52
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // fields: [ // FlowInputFields // required
|
|
54
|
+
* // { // FlowInputField
|
|
55
|
+
* // name: "STRING_VALUE", // required
|
|
56
|
+
* // content: { // FlowExecutionContent Union: only one key present
|
|
57
|
+
* // document: "DOCUMENT_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // },
|
|
62
|
+
* // flowOutputEvent: { // FlowExecutionOutputEvent
|
|
63
|
+
* // nodeName: "STRING_VALUE", // required
|
|
64
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
65
|
+
* // fields: [ // FlowOutputFields // required
|
|
66
|
+
* // { // FlowOutputField
|
|
67
|
+
* // name: "STRING_VALUE", // required
|
|
68
|
+
* // content: {// Union: only one key present
|
|
69
|
+
* // document: "DOCUMENT_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // },
|
|
74
|
+
* // nodeInputEvent: { // NodeInputEvent
|
|
75
|
+
* // nodeName: "STRING_VALUE", // required
|
|
76
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
77
|
+
* // fields: [ // NodeInputFields // required
|
|
78
|
+
* // { // NodeInputField
|
|
79
|
+
* // name: "STRING_VALUE", // required
|
|
80
|
+
* // content: { // NodeExecutionContent Union: only one key present
|
|
81
|
+
* // document: "DOCUMENT_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // },
|
|
86
|
+
* // nodeOutputEvent: { // NodeOutputEvent
|
|
87
|
+
* // nodeName: "STRING_VALUE", // required
|
|
88
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
89
|
+
* // fields: [ // NodeOutputFields // required
|
|
90
|
+
* // { // NodeOutputField
|
|
91
|
+
* // name: "STRING_VALUE", // required
|
|
92
|
+
* // content: {// Union: only one key present
|
|
93
|
+
* // document: "DOCUMENT_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // },
|
|
98
|
+
* // conditionResultEvent: { // ConditionResultEvent
|
|
99
|
+
* // nodeName: "STRING_VALUE", // required
|
|
100
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
101
|
+
* // satisfiedConditions: [ // SatisfiedConditions // required
|
|
102
|
+
* // { // SatisfiedCondition
|
|
103
|
+
* // conditionName: "STRING_VALUE", // required
|
|
104
|
+
* // },
|
|
105
|
+
* // ],
|
|
106
|
+
* // },
|
|
107
|
+
* // nodeFailureEvent: { // NodeFailureEvent
|
|
108
|
+
* // nodeName: "STRING_VALUE", // required
|
|
109
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
110
|
+
* // errorCode: "VALIDATION" || "DEPENDENCY_FAILED" || "BAD_GATEWAY" || "INTERNAL_SERVER", // required
|
|
111
|
+
* // errorMessage: "STRING_VALUE", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // flowFailureEvent: { // FlowFailureEvent
|
|
114
|
+
* // timestamp: new Date("TIMESTAMP"), // required
|
|
115
|
+
* // errorCode: "VALIDATION" || "INTERNAL_SERVER" || "NODE_EXECUTION_FAILED", // required
|
|
116
|
+
* // errorMessage: "STRING_VALUE", // required
|
|
117
|
+
* // },
|
|
118
|
+
* // },
|
|
119
|
+
* // ],
|
|
120
|
+
* // nextToken: "STRING_VALUE",
|
|
121
|
+
* // };
|
|
122
|
+
*
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
125
|
+
* @param ListFlowExecutionEventsCommandInput - {@link ListFlowExecutionEventsCommandInput}
|
|
126
|
+
* @returns {@link ListFlowExecutionEventsCommandOutput}
|
|
127
|
+
* @see {@link ListFlowExecutionEventsCommandInput} for command's `input` shape.
|
|
128
|
+
* @see {@link ListFlowExecutionEventsCommandOutput} for command's `response` shape.
|
|
129
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
132
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link InternalServerException} (server fault)
|
|
135
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
138
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
141
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link ValidationException} (client fault)
|
|
144
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
147
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
148
|
+
*
|
|
149
|
+
*
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export declare class ListFlowExecutionEventsCommand extends ListFlowExecutionEventsCommand_base {
|
|
153
|
+
/** @internal type navigation helper, not in runtime. */
|
|
154
|
+
protected static __types: {
|
|
155
|
+
api: {
|
|
156
|
+
input: ListFlowExecutionEventsRequest;
|
|
157
|
+
output: ListFlowExecutionEventsResponse;
|
|
158
|
+
};
|
|
159
|
+
sdk: {
|
|
160
|
+
input: ListFlowExecutionEventsCommandInput;
|
|
161
|
+
output: ListFlowExecutionEventsCommandOutput;
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
+
import { ListFlowExecutionsRequest, ListFlowExecutionsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListFlowExecutionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListFlowExecutionsCommandInput extends ListFlowExecutionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListFlowExecutionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListFlowExecutionsCommandOutput extends ListFlowExecutionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListFlowExecutionsCommand_base: {
|
|
25
|
+
new (input: ListFlowExecutionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowExecutionsCommandInput, ListFlowExecutionsCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListFlowExecutionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowExecutionsCommandInput, ListFlowExecutionsCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all asynchronous executions for a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).</p> <note> <p>Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.</p> </note>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, ListFlowExecutionsCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, ListFlowExecutionsCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // ListFlowExecutionsRequest
|
|
38
|
+
* flowIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* flowAliasIdentifier: "STRING_VALUE",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListFlowExecutionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListFlowExecutionsResponse
|
|
46
|
+
* // flowExecutionSummaries: [ // FlowExecutionSummaries // required
|
|
47
|
+
* // { // FlowExecutionSummary
|
|
48
|
+
* // executionArn: "STRING_VALUE", // required
|
|
49
|
+
* // flowAliasIdentifier: "STRING_VALUE", // required
|
|
50
|
+
* // flowIdentifier: "STRING_VALUE", // required
|
|
51
|
+
* // flowVersion: "STRING_VALUE", // required
|
|
52
|
+
* // status: "Running" || "Succeeded" || "Failed" || "TimedOut" || "Aborted", // required
|
|
53
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
54
|
+
* // endedAt: new Date("TIMESTAMP"),
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // nextToken: "STRING_VALUE",
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param ListFlowExecutionsCommandInput - {@link ListFlowExecutionsCommandInput}
|
|
63
|
+
* @returns {@link ListFlowExecutionsCommandOutput}
|
|
64
|
+
* @see {@link ListFlowExecutionsCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link ListFlowExecutionsCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalServerException} (server fault)
|
|
72
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare class ListFlowExecutionsCommand extends ListFlowExecutionsCommand_base {
|
|
90
|
+
/** @internal type navigation helper, not in runtime. */
|
|
91
|
+
protected static __types: {
|
|
92
|
+
api: {
|
|
93
|
+
input: ListFlowExecutionsRequest;
|
|
94
|
+
output: ListFlowExecutionsResponse;
|
|
95
|
+
};
|
|
96
|
+
sdk: {
|
|
97
|
+
input: ListFlowExecutionsCommandInput;
|
|
98
|
+
output: ListFlowExecutionsCommandOutput;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/
|
|
4
|
+
import { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { ListInvocationsRequest, ListInvocationsResponse } from "../models/
|
|
4
|
+
import { ListInvocationsRequest, ListInvocationsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { ListSessionsRequest } from "../models/
|
|
5
|
-
import { ListSessionsResponse } from "../models/models_1";
|
|
4
|
+
import { ListSessionsRequest, ListSessionsResponse } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { PutInvocationStepRequest, PutInvocationStepResponse } from "../models/
|
|
4
|
+
import { PutInvocationStepRequest, PutInvocationStepResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { RetrieveAndGenerateStreamResponse } from "../models/
|
|
5
|
-
import { RetrieveAndGenerateStreamRequest } from "../models/models_1";
|
|
4
|
+
import { RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamResponse } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import { RetrieveResponse } from "../models/
|
|
5
|
-
import { RetrieveRequest } from "../models/models_1";
|
|
4
|
+
import { RetrieveRequest, RetrieveResponse } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|