@aws-sdk/client-bedrock-agentcore 3.847.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/LICENSE +201 -0
- package/README.md +413 -0
- package/dist-cjs/BedrockAgentCore.js +63 -0
- package/dist-cjs/BedrockAgentCoreClient.js +54 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateEventCommand.js +27 -0
- package/dist-cjs/commands/DeleteEventCommand.js +26 -0
- package/dist-cjs/commands/DeleteMemoryRecordCommand.js +26 -0
- package/dist-cjs/commands/GetBrowserSessionCommand.js +26 -0
- package/dist-cjs/commands/GetCodeInterpreterSessionCommand.js +26 -0
- package/dist-cjs/commands/GetEventCommand.js +27 -0
- package/dist-cjs/commands/GetMemoryRecordCommand.js +27 -0
- package/dist-cjs/commands/GetResourceApiKeyCommand.js +27 -0
- package/dist-cjs/commands/GetResourceOauth2TokenCommand.js +27 -0
- package/dist-cjs/commands/GetWorkloadAccessTokenCommand.js +27 -0
- package/dist-cjs/commands/GetWorkloadAccessTokenForJWTCommand.js +27 -0
- package/dist-cjs/commands/GetWorkloadAccessTokenForUserIdCommand.js +27 -0
- package/dist-cjs/commands/InvokeAgentRuntimeCommand.js +27 -0
- package/dist-cjs/commands/InvokeCodeInterpreterCommand.js +31 -0
- package/dist-cjs/commands/ListActorsCommand.js +26 -0
- package/dist-cjs/commands/ListBrowserSessionsCommand.js +26 -0
- package/dist-cjs/commands/ListCodeInterpreterSessionsCommand.js +26 -0
- package/dist-cjs/commands/ListEventsCommand.js +27 -0
- package/dist-cjs/commands/ListMemoryRecordsCommand.js +27 -0
- package/dist-cjs/commands/ListSessionsCommand.js +26 -0
- package/dist-cjs/commands/RetrieveMemoryRecordsCommand.js +27 -0
- package/dist-cjs/commands/StartBrowserSessionCommand.js +26 -0
- package/dist-cjs/commands/StartCodeInterpreterSessionCommand.js +26 -0
- package/dist-cjs/commands/StopBrowserSessionCommand.js +26 -0
- package/dist-cjs/commands/StopCodeInterpreterSessionCommand.js +26 -0
- package/dist-cjs/commands/UpdateBrowserStreamCommand.js +26 -0
- package/dist-cjs/commands/index.js +29 -0
- package/dist-cjs/endpoint/EndpointParameters.js +17 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/BedrockAgentCoreServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +468 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListActorsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEventsPaginator.js +7 -0
- package/dist-cjs/pagination/ListMemoryRecordsPaginator.js +7 -0
- package/dist-cjs/pagination/ListSessionsPaginator.js +7 -0
- package/dist-cjs/pagination/RetrieveMemoryRecordsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +9 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1423 -0
- package/dist-cjs/runtimeConfig.browser.js +41 -0
- package/dist-cjs/runtimeConfig.js +58 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +36 -0
- package/dist-cjs/runtimeExtensions.js +13 -0
- package/dist-es/BedrockAgentCore.js +59 -0
- package/dist-es/BedrockAgentCoreClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateEventCommand.js +23 -0
- package/dist-es/commands/DeleteEventCommand.js +22 -0
- package/dist-es/commands/DeleteMemoryRecordCommand.js +22 -0
- package/dist-es/commands/GetBrowserSessionCommand.js +22 -0
- package/dist-es/commands/GetCodeInterpreterSessionCommand.js +22 -0
- package/dist-es/commands/GetEventCommand.js +23 -0
- package/dist-es/commands/GetMemoryRecordCommand.js +23 -0
- package/dist-es/commands/GetResourceApiKeyCommand.js +23 -0
- package/dist-es/commands/GetResourceOauth2TokenCommand.js +23 -0
- package/dist-es/commands/GetWorkloadAccessTokenCommand.js +23 -0
- package/dist-es/commands/GetWorkloadAccessTokenForJWTCommand.js +23 -0
- package/dist-es/commands/GetWorkloadAccessTokenForUserIdCommand.js +23 -0
- package/dist-es/commands/InvokeAgentRuntimeCommand.js +23 -0
- package/dist-es/commands/InvokeCodeInterpreterCommand.js +27 -0
- package/dist-es/commands/ListActorsCommand.js +22 -0
- package/dist-es/commands/ListBrowserSessionsCommand.js +22 -0
- package/dist-es/commands/ListCodeInterpreterSessionsCommand.js +22 -0
- package/dist-es/commands/ListEventsCommand.js +23 -0
- package/dist-es/commands/ListMemoryRecordsCommand.js +23 -0
- package/dist-es/commands/ListSessionsCommand.js +22 -0
- package/dist-es/commands/RetrieveMemoryRecordsCommand.js +23 -0
- package/dist-es/commands/StartBrowserSessionCommand.js +22 -0
- package/dist-es/commands/StartCodeInterpreterSessionCommand.js +22 -0
- package/dist-es/commands/StopBrowserSessionCommand.js +22 -0
- package/dist-es/commands/StopCodeInterpreterSessionCommand.js +22 -0
- package/dist-es/commands/UpdateBrowserStreamCommand.js +22 -0
- package/dist-es/commands/index.js +26 -0
- package/dist-es/endpoint/EndpointParameters.js +13 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/BedrockAgentCoreServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +421 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListActorsPaginator.js +4 -0
- package/dist-es/pagination/ListEventsPaginator.js +4 -0
- package/dist-es/pagination/ListMemoryRecordsPaginator.js +4 -0
- package/dist-es/pagination/ListSessionsPaginator.js +4 -0
- package/dist-es/pagination/RetrieveMemoryRecordsPaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +1367 -0
- package/dist-es/runtimeConfig.browser.js +36 -0
- package/dist-es/runtimeConfig.js +53 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +32 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-types/BedrockAgentCore.d.ts +192 -0
- package/dist-types/BedrockAgentCoreClient.d.ts +223 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/CreateEventCommand.d.ts +133 -0
- package/dist-types/commands/DeleteEventCommand.d.ts +96 -0
- package/dist-types/commands/DeleteMemoryRecordCommand.d.ts +94 -0
- package/dist-types/commands/GetBrowserSessionCommand.d.ts +108 -0
- package/dist-types/commands/GetCodeInterpreterSessionCommand.d.ts +93 -0
- package/dist-types/commands/GetEventCommand.d.ts +117 -0
- package/dist-types/commands/GetMemoryRecordCommand.d.ts +104 -0
- package/dist-types/commands/GetResourceApiKeyCommand.d.ts +91 -0
- package/dist-types/commands/GetResourceOauth2TokenCommand.d.ts +102 -0
- package/dist-types/commands/GetWorkloadAccessTokenCommand.d.ts +90 -0
- package/dist-types/commands/GetWorkloadAccessTokenForJWTCommand.d.ts +91 -0
- package/dist-types/commands/GetWorkloadAccessTokenForUserIdCommand.d.ts +91 -0
- package/dist-types/commands/InvokeAgentRuntimeCommand.d.ts +126 -0
- package/dist-types/commands/InvokeCodeInterpreterCommand.d.ts +174 -0
- package/dist-types/commands/ListActorsCommand.d.ts +100 -0
- package/dist-types/commands/ListBrowserSessionsCommand.d.ts +100 -0
- package/dist-types/commands/ListCodeInterpreterSessionsCommand.d.ts +100 -0
- package/dist-types/commands/ListEventsCommand.d.ts +128 -0
- package/dist-types/commands/ListMemoryRecordsCommand.d.ts +111 -0
- package/dist-types/commands/ListSessionsCommand.d.ts +103 -0
- package/dist-types/commands/RetrieveMemoryRecordsCommand.d.ts +115 -0
- package/dist-types/commands/StartBrowserSessionCommand.d.ts +111 -0
- package/dist-types/commands/StartCodeInterpreterSessionCommand.d.ts +98 -0
- package/dist-types/commands/StopBrowserSessionCommand.d.ts +97 -0
- package/dist-types/commands/StopCodeInterpreterSessionCommand.d.ts +97 -0
- package/dist-types/commands/UpdateBrowserStreamCommand.d.ts +111 -0
- package/dist-types/commands/index.d.ts +26 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +38 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/BedrockAgentCoreServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2440 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListActorsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMemoryRecordsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/RetrieveMemoryRecordsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +236 -0
- package/dist-types/runtimeConfig.browser.d.ts +52 -0
- package/dist-types/runtimeConfig.d.ts +52 -0
- package/dist-types/runtimeConfig.native.d.ts +51 -0
- package/dist-types/runtimeConfig.shared.d.ts +22 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentCore.d.ts +449 -0
- package/dist-types/ts3.4/BedrockAgentCoreClient.d.ts +288 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateEventCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteEventCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteMemoryRecordCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetBrowserSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCodeInterpreterSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetEventCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetMemoryRecordCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetResourceApiKeyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetResourceOauth2TokenCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetWorkloadAccessTokenCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetWorkloadAccessTokenForJWTCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetWorkloadAccessTokenForUserIdCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/InvokeAgentRuntimeCommand.d.ts +66 -0
- package/dist-types/ts3.4/commands/InvokeCodeInterpreterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListActorsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListBrowserSessionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCodeInterpreterSessionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEventsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListMemoryRecordsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/RetrieveMemoryRecordsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartBrowserSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartCodeInterpreterSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopBrowserSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopCodeInterpreterSessionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateBrowserStreamCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +26 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/BedrockAgentCoreServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +872 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListActorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMemoryRecordsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/RetrieveMemoryRecordsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +321 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +100 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +24 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +105 -0
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
|
|
4
|
+
import { GetWorkloadAccessTokenForUserIdRequest, GetWorkloadAccessTokenForUserIdResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetWorkloadAccessTokenForUserIdCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetWorkloadAccessTokenForUserIdCommandInput extends GetWorkloadAccessTokenForUserIdRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetWorkloadAccessTokenForUserIdCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetWorkloadAccessTokenForUserIdCommandOutput extends GetWorkloadAccessTokenForUserIdResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetWorkloadAccessTokenForUserIdCommand_base: {
|
|
25
|
+
new (input: GetWorkloadAccessTokenForUserIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetWorkloadAccessTokenForUserIdCommandInput, GetWorkloadAccessTokenForUserIdCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetWorkloadAccessTokenForUserIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetWorkloadAccessTokenForUserIdCommandInput, GetWorkloadAccessTokenForUserIdCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Obtains an Workload access token for agentic workloads acting on behalf of user with User Id.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, GetWorkloadAccessTokenForUserIdCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, GetWorkloadAccessTokenForUserIdCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // GetWorkloadAccessTokenForUserIdRequest
|
|
38
|
+
* workloadName: "STRING_VALUE", // required
|
|
39
|
+
* userId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetWorkloadAccessTokenForUserIdCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetWorkloadAccessTokenForUserIdResponse
|
|
44
|
+
* // workloadAccessToken: "STRING_VALUE", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param GetWorkloadAccessTokenForUserIdCommandInput - {@link GetWorkloadAccessTokenForUserIdCommandInput}
|
|
50
|
+
* @returns {@link GetWorkloadAccessTokenForUserIdCommandOutput}
|
|
51
|
+
* @see {@link GetWorkloadAccessTokenForUserIdCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link GetWorkloadAccessTokenForUserIdCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InternalServerException} (server fault)
|
|
59
|
+
* <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
+
* <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
+
* <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
68
|
+
* <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ValidationException} (client fault)
|
|
71
|
+
* <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class GetWorkloadAccessTokenForUserIdCommand extends GetWorkloadAccessTokenForUserIdCommand_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: GetWorkloadAccessTokenForUserIdRequest;
|
|
84
|
+
output: GetWorkloadAccessTokenForUserIdResponse;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: GetWorkloadAccessTokenForUserIdCommandInput;
|
|
88
|
+
output: GetWorkloadAccessTokenForUserIdCommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer, StreamingBlobPayloadOutputTypes } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
|
|
4
|
+
import { InvokeAgentRuntimeRequest, InvokeAgentRuntimeResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export type InvokeAgentRuntimeCommandInputType = Omit<InvokeAgentRuntimeRequest, "payload"> & {
|
|
14
|
+
payload: BlobPayloadInputTypes;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The input for {@link InvokeAgentRuntimeCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface InvokeAgentRuntimeCommandInput extends InvokeAgentRuntimeCommandInputType {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* The output of {@link InvokeAgentRuntimeCommand}.
|
|
27
|
+
*/
|
|
28
|
+
export interface InvokeAgentRuntimeCommandOutput extends Omit<InvokeAgentRuntimeResponse, "response">, __MetadataBearer {
|
|
29
|
+
response?: StreamingBlobPayloadOutputTypes;
|
|
30
|
+
}
|
|
31
|
+
declare const InvokeAgentRuntimeCommand_base: {
|
|
32
|
+
new (input: InvokeAgentRuntimeCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeAgentRuntimeCommandInput, InvokeAgentRuntimeCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
33
|
+
new (input: InvokeAgentRuntimeCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeAgentRuntimeCommandInput, InvokeAgentRuntimeCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
34
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* <p>Sends a request to an agent runtime in Amazon Bedrock and receives responses in real-time. The agent processes the request using the configured foundation model and any associated knowledge bases or action groups.</p> <p>To invoke an agent runtime, you must specify the agent runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or alias of the agent.</p> <p>This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.</p>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { BedrockAgentCoreClient, InvokeAgentRuntimeCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
42
|
+
* // const { BedrockAgentCoreClient, InvokeAgentRuntimeCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
43
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
44
|
+
* const input = { // InvokeAgentRuntimeRequest
|
|
45
|
+
* contentType: "STRING_VALUE",
|
|
46
|
+
* accept: "STRING_VALUE",
|
|
47
|
+
* mcpSessionId: "STRING_VALUE",
|
|
48
|
+
* runtimeSessionId: "STRING_VALUE",
|
|
49
|
+
* mcpProtocolVersion: "STRING_VALUE",
|
|
50
|
+
* runtimeUserId: "STRING_VALUE",
|
|
51
|
+
* traceId: "STRING_VALUE",
|
|
52
|
+
* traceParent: "STRING_VALUE",
|
|
53
|
+
* traceState: "STRING_VALUE",
|
|
54
|
+
* baggage: "STRING_VALUE",
|
|
55
|
+
* agentRuntimeArn: "STRING_VALUE", // required
|
|
56
|
+
* qualifier: "STRING_VALUE",
|
|
57
|
+
* payload: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
58
|
+
* };
|
|
59
|
+
* const command = new InvokeAgentRuntimeCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* // consume or destroy the stream to free the socket.
|
|
62
|
+
* const bytes = await response.response.transformToByteArray();
|
|
63
|
+
* // const str = await response.response.transformToString();
|
|
64
|
+
* // response.response.destroy(); // only applicable to Node.js Readable streams.
|
|
65
|
+
*
|
|
66
|
+
* // { // InvokeAgentRuntimeResponse
|
|
67
|
+
* // runtimeSessionId: "STRING_VALUE",
|
|
68
|
+
* // mcpSessionId: "STRING_VALUE",
|
|
69
|
+
* // mcpProtocolVersion: "STRING_VALUE",
|
|
70
|
+
* // traceId: "STRING_VALUE",
|
|
71
|
+
* // traceParent: "STRING_VALUE",
|
|
72
|
+
* // traceState: "STRING_VALUE",
|
|
73
|
+
* // baggage: "STRING_VALUE",
|
|
74
|
+
* // contentType: "STRING_VALUE", // required
|
|
75
|
+
* // response: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes
|
|
76
|
+
* // statusCode: Number("int"),
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
79
|
+
* ```
|
|
80
|
+
*
|
|
81
|
+
* @param InvokeAgentRuntimeCommandInput - {@link InvokeAgentRuntimeCommandInput}
|
|
82
|
+
* @returns {@link InvokeAgentRuntimeCommandOutput}
|
|
83
|
+
* @see {@link InvokeAgentRuntimeCommandInput} for command's `input` shape.
|
|
84
|
+
* @see {@link InvokeAgentRuntimeCommandOutput} for command's `response` shape.
|
|
85
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
88
|
+
* <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link InternalServerException} (server fault)
|
|
91
|
+
* <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
+
* <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link RuntimeClientError} (client fault)
|
|
97
|
+
* <p>The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
100
|
+
* <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
103
|
+
* <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ValidationException} (client fault)
|
|
106
|
+
* <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
109
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
110
|
+
*
|
|
111
|
+
*
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export declare class InvokeAgentRuntimeCommand extends InvokeAgentRuntimeCommand_base {
|
|
115
|
+
/** @internal type navigation helper, not in runtime. */
|
|
116
|
+
protected static __types: {
|
|
117
|
+
api: {
|
|
118
|
+
input: InvokeAgentRuntimeRequest;
|
|
119
|
+
output: InvokeAgentRuntimeResponse;
|
|
120
|
+
};
|
|
121
|
+
sdk: {
|
|
122
|
+
input: InvokeAgentRuntimeCommandInput;
|
|
123
|
+
output: InvokeAgentRuntimeCommandOutput;
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
}
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
|
|
4
|
+
import { InvokeCodeInterpreterRequest, InvokeCodeInterpreterResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link InvokeCodeInterpreterCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface InvokeCodeInterpreterCommandInput extends InvokeCodeInterpreterRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link InvokeCodeInterpreterCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface InvokeCodeInterpreterCommandOutput extends InvokeCodeInterpreterResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const InvokeCodeInterpreterCommand_base: {
|
|
25
|
+
new (input: InvokeCodeInterpreterCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeCodeInterpreterCommandInput, InvokeCodeInterpreterCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: InvokeCodeInterpreterCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeCodeInterpreterCommandInput, InvokeCodeInterpreterCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Executes code within an active code interpreter session in Amazon Bedrock. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.</p> <p>To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.</p> <p>This operation is subject to request rate limiting based on your account's service quotas.</p> <p>The following operations are related to <code>InvokeCodeInterpreter</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/API_StartCodeInterpreterSession.html">StartCodeInterpreterSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_GetCodeInterpreterSession.html">GetCodeInterpreterSession</a> </p> </li> </ul>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, InvokeCodeInterpreterCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, InvokeCodeInterpreterCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // InvokeCodeInterpreterRequest
|
|
38
|
+
* codeInterpreterIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* sessionId: "STRING_VALUE",
|
|
40
|
+
* name: "executeCode" || "executeCommand" || "readFiles" || "listFiles" || "removeFiles" || "writeFiles" || "startCommandExecution" || "getTask" || "stopTask", // required
|
|
41
|
+
* arguments: { // ToolArguments
|
|
42
|
+
* code: "STRING_VALUE",
|
|
43
|
+
* language: "python" || "javascript" || "typescript",
|
|
44
|
+
* clearContext: true || false,
|
|
45
|
+
* command: "STRING_VALUE",
|
|
46
|
+
* path: "STRING_VALUE",
|
|
47
|
+
* paths: [ // StringList
|
|
48
|
+
* "STRING_VALUE",
|
|
49
|
+
* ],
|
|
50
|
+
* content: [ // InputContentBlockList
|
|
51
|
+
* { // InputContentBlock
|
|
52
|
+
* path: "STRING_VALUE", // required
|
|
53
|
+
* text: "STRING_VALUE",
|
|
54
|
+
* blob: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* directoryPath: "STRING_VALUE",
|
|
58
|
+
* taskId: "STRING_VALUE",
|
|
59
|
+
* },
|
|
60
|
+
* };
|
|
61
|
+
* const command = new InvokeCodeInterpreterCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* // { // InvokeCodeInterpreterResponse
|
|
64
|
+
* // sessionId: "STRING_VALUE",
|
|
65
|
+
* // stream: { // CodeInterpreterStreamOutput Union: only one key present
|
|
66
|
+
* // result: { // CodeInterpreterResult
|
|
67
|
+
* // content: [ // ContentBlockList // required
|
|
68
|
+
* // { // ContentBlock
|
|
69
|
+
* // type: "text" || "image" || "resource" || "resource_link", // required
|
|
70
|
+
* // text: "STRING_VALUE",
|
|
71
|
+
* // data: new Uint8Array(),
|
|
72
|
+
* // mimeType: "STRING_VALUE",
|
|
73
|
+
* // uri: "STRING_VALUE",
|
|
74
|
+
* // name: "STRING_VALUE",
|
|
75
|
+
* // description: "STRING_VALUE",
|
|
76
|
+
* // size: Number("long"),
|
|
77
|
+
* // resource: { // ResourceContent
|
|
78
|
+
* // type: "text" || "blob", // required
|
|
79
|
+
* // uri: "STRING_VALUE",
|
|
80
|
+
* // mimeType: "STRING_VALUE",
|
|
81
|
+
* // text: "STRING_VALUE",
|
|
82
|
+
* // blob: new Uint8Array(),
|
|
83
|
+
* // },
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // structuredContent: { // ToolResultStructuredContent
|
|
87
|
+
* // taskId: "STRING_VALUE",
|
|
88
|
+
* // taskStatus: "submitted" || "working" || "completed" || "canceled" || "failed",
|
|
89
|
+
* // stdout: "STRING_VALUE",
|
|
90
|
+
* // stderr: "STRING_VALUE",
|
|
91
|
+
* // exitCode: Number("int"),
|
|
92
|
+
* // executionTime: Number("double"),
|
|
93
|
+
* // },
|
|
94
|
+
* // isError: true || false,
|
|
95
|
+
* // },
|
|
96
|
+
* // accessDeniedException: { // AccessDeniedException
|
|
97
|
+
* // message: "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // conflictException: { // ConflictException
|
|
100
|
+
* // message: "STRING_VALUE",
|
|
101
|
+
* // },
|
|
102
|
+
* // internalServerException: { // InternalServerException
|
|
103
|
+
* // message: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // resourceNotFoundException: { // ResourceNotFoundException
|
|
106
|
+
* // message: "STRING_VALUE",
|
|
107
|
+
* // },
|
|
108
|
+
* // serviceQuotaExceededException: { // ServiceQuotaExceededException
|
|
109
|
+
* // message: "STRING_VALUE",
|
|
110
|
+
* // },
|
|
111
|
+
* // throttlingException: { // ThrottlingException
|
|
112
|
+
* // message: "STRING_VALUE",
|
|
113
|
+
* // },
|
|
114
|
+
* // validationException: { // ValidationException
|
|
115
|
+
* // message: "STRING_VALUE", // required
|
|
116
|
+
* // reason: "CannotParse" || "FieldValidationFailed" || "IdempotentParameterMismatchException" || "EventInOtherSession" || "ResourceConflict", // required
|
|
117
|
+
* // fieldList: [ // ValidationExceptionFieldList
|
|
118
|
+
* // { // ValidationExceptionField
|
|
119
|
+
* // name: "STRING_VALUE", // required
|
|
120
|
+
* // message: "STRING_VALUE", // required
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // };
|
|
126
|
+
*
|
|
127
|
+
* ```
|
|
128
|
+
*
|
|
129
|
+
* @param InvokeCodeInterpreterCommandInput - {@link InvokeCodeInterpreterCommandInput}
|
|
130
|
+
* @returns {@link InvokeCodeInterpreterCommandOutput}
|
|
131
|
+
* @see {@link InvokeCodeInterpreterCommandInput} for command's `input` shape.
|
|
132
|
+
* @see {@link InvokeCodeInterpreterCommandOutput} for command's `response` shape.
|
|
133
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
136
|
+
* <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ConflictException} (client fault)
|
|
139
|
+
* <p>The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link InternalServerException} (server fault)
|
|
142
|
+
* <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
145
|
+
* <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
148
|
+
* <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
|
|
149
|
+
*
|
|
150
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
151
|
+
* <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
|
|
152
|
+
*
|
|
153
|
+
* @throws {@link ValidationException} (client fault)
|
|
154
|
+
* <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
157
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
158
|
+
*
|
|
159
|
+
*
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
export declare class InvokeCodeInterpreterCommand extends InvokeCodeInterpreterCommand_base {
|
|
163
|
+
/** @internal type navigation helper, not in runtime. */
|
|
164
|
+
protected static __types: {
|
|
165
|
+
api: {
|
|
166
|
+
input: InvokeCodeInterpreterRequest;
|
|
167
|
+
output: InvokeCodeInterpreterResponse;
|
|
168
|
+
};
|
|
169
|
+
sdk: {
|
|
170
|
+
input: InvokeCodeInterpreterCommandInput;
|
|
171
|
+
output: InvokeCodeInterpreterCommandOutput;
|
|
172
|
+
};
|
|
173
|
+
};
|
|
174
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
|
|
4
|
+
import { ListActorsInput, ListActorsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListActorsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListActorsCommandInput extends ListActorsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListActorsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListActorsCommandOutput extends ListActorsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListActorsCommand_base: {
|
|
25
|
+
new (input: ListActorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListActorsCommandInput, ListActorsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListActorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListActorsCommandInput, ListActorsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all actors in a memory store. We recommend using pagination to ensure that the operation returns quickly and successfully.</p> <p>To use this operation, you must have the <code>genesismemory:ListActors</code> permission.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, ListActorsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, ListActorsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // ListActorsInput
|
|
38
|
+
* memoryId: "STRING_VALUE", // required
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListActorsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListActorsOutput
|
|
45
|
+
* // actorSummaries: [ // ActorSummaryList // required
|
|
46
|
+
* // { // ActorSummary
|
|
47
|
+
* // actorId: "STRING_VALUE", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // ],
|
|
50
|
+
* // nextToken: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param ListActorsCommandInput - {@link ListActorsCommandInput}
|
|
56
|
+
* @returns {@link ListActorsCommandOutput}
|
|
57
|
+
* @see {@link ListActorsCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link ListActorsCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
+
* <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
65
|
+
* <p>The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
+
* <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ServiceException} (server fault)
|
|
71
|
+
* <p>The service encountered an internal error. Try your request again later.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
74
|
+
* <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottledException} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class ListActorsCommand extends ListActorsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: ListActorsInput;
|
|
93
|
+
output: ListActorsOutput;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: ListActorsCommandInput;
|
|
97
|
+
output: ListActorsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentCoreClient";
|
|
4
|
+
import { ListBrowserSessionsRequest, ListBrowserSessionsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListBrowserSessionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListBrowserSessionsCommandInput extends ListBrowserSessionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListBrowserSessionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListBrowserSessionsCommandOutput extends ListBrowserSessionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListBrowserSessionsCommand_base: {
|
|
25
|
+
new (input: ListBrowserSessionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListBrowserSessionsCommandInput, ListBrowserSessionsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListBrowserSessionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListBrowserSessionsCommandInput, ListBrowserSessionsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.</p> <p>You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.</p> <p>We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.</p> <p>The following operations are related to <code>ListBrowserSessions</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/API_StartBrowserSession.html">StartBrowserSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_GetBrowserSession.html">GetBrowserSession</a> </p> </li> </ul>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentCoreClient, ListBrowserSessionsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, ListBrowserSessionsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // ListBrowserSessionsRequest
|
|
38
|
+
* browserIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* status: "READY" || "TERMINATED",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListBrowserSessionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListBrowserSessionsResponse
|
|
46
|
+
* // items: [ // BrowserSessionSummaries // required
|
|
47
|
+
* // { // BrowserSessionSummary
|
|
48
|
+
* // browserIdentifier: "STRING_VALUE", // required
|
|
49
|
+
* // sessionId: "STRING_VALUE", // required
|
|
50
|
+
* // name: "STRING_VALUE",
|
|
51
|
+
* // status: "READY" || "TERMINATED", // required
|
|
52
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // lastUpdatedAt: new Date("TIMESTAMP"),
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // nextToken: "STRING_VALUE",
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param ListBrowserSessionsCommandInput - {@link ListBrowserSessionsCommandInput}
|
|
62
|
+
* @returns {@link ListBrowserSessionsCommandOutput}
|
|
63
|
+
* @see {@link ListBrowserSessionsCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link ListBrowserSessionsCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class ListBrowserSessionsCommand extends ListBrowserSessionsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: ListBrowserSessionsRequest;
|
|
93
|
+
output: ListBrowserSessionsResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: ListBrowserSessionsCommandInput;
|
|
97
|
+
output: ListBrowserSessionsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|