@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,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 { ListCodeInterpreterSessionsRequest, ListCodeInterpreterSessionsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListCodeInterpreterSessionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListCodeInterpreterSessionsCommandInput extends ListCodeInterpreterSessionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListCodeInterpreterSessionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListCodeInterpreterSessionsCommandOutput extends ListCodeInterpreterSessionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListCodeInterpreterSessionsCommand_base: {
|
|
25
|
+
new (input: ListCodeInterpreterSessionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCodeInterpreterSessionsCommandInput, ListCodeInterpreterSessionsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListCodeInterpreterSessionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCodeInterpreterSessionsCommandInput, ListCodeInterpreterSessionsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a list of code interpreter 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 code interpreter 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>ListCodeInterpreterSessions</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, ListCodeInterpreterSessionsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, ListCodeInterpreterSessionsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // ListCodeInterpreterSessionsRequest
|
|
38
|
+
* codeInterpreterIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* nextToken: "STRING_VALUE",
|
|
41
|
+
* status: "READY" || "TERMINATED",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListCodeInterpreterSessionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListCodeInterpreterSessionsResponse
|
|
46
|
+
* // items: [ // CodeInterpreterSessionSummaries // required
|
|
47
|
+
* // { // CodeInterpreterSessionSummary
|
|
48
|
+
* // codeInterpreterIdentifier: "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 ListCodeInterpreterSessionsCommandInput - {@link ListCodeInterpreterSessionsCommandInput}
|
|
62
|
+
* @returns {@link ListCodeInterpreterSessionsCommandOutput}
|
|
63
|
+
* @see {@link ListCodeInterpreterSessionsCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link ListCodeInterpreterSessionsCommandOutput} 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 ListCodeInterpreterSessionsCommand extends ListCodeInterpreterSessionsCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: ListCodeInterpreterSessionsRequest;
|
|
93
|
+
output: ListCodeInterpreterSessionsResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: ListCodeInterpreterSessionsCommandInput;
|
|
97
|
+
output: ListCodeInterpreterSessionsCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
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 { ListEventsInput, ListEventsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListEventsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListEventsCommandInput extends ListEventsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListEventsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListEventsCommandOutput extends ListEventsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListEventsCommand_base: {
|
|
25
|
+
new (input: ListEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEventsCommandInput, ListEventsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListEventsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEventsCommandInput, ListEventsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists events in a memory store based on specified criteria. 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:ListEvents</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, ListEventsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, ListEventsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // ListEventsInput
|
|
38
|
+
* memoryId: "STRING_VALUE", // required
|
|
39
|
+
* sessionId: "STRING_VALUE", // required
|
|
40
|
+
* actorId: "STRING_VALUE", // required
|
|
41
|
+
* includePayloads: true || false,
|
|
42
|
+
* filter: { // FilterInput
|
|
43
|
+
* branch: { // BranchFilter
|
|
44
|
+
* name: "STRING_VALUE", // required
|
|
45
|
+
* includeParentBranches: true || false,
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* maxResults: Number("int"),
|
|
49
|
+
* nextToken: "STRING_VALUE",
|
|
50
|
+
* };
|
|
51
|
+
* const command = new ListEventsCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // ListEventsOutput
|
|
54
|
+
* // events: [ // EventList // required
|
|
55
|
+
* // { // Event
|
|
56
|
+
* // memoryId: "STRING_VALUE", // required
|
|
57
|
+
* // actorId: "STRING_VALUE", // required
|
|
58
|
+
* // sessionId: "STRING_VALUE", // required
|
|
59
|
+
* // eventId: "STRING_VALUE", // required
|
|
60
|
+
* // eventTimestamp: new Date("TIMESTAMP"), // required
|
|
61
|
+
* // payload: [ // PayloadTypeList // required
|
|
62
|
+
* // { // PayloadType Union: only one key present
|
|
63
|
+
* // conversational: { // Conversational
|
|
64
|
+
* // content: { // Content Union: only one key present
|
|
65
|
+
* // text: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // role: "ASSISTANT" || "USER" || "TOOL" || "OTHER", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // blob: "DOCUMENT_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // branch: { // Branch
|
|
73
|
+
* // rootEventId: "STRING_VALUE",
|
|
74
|
+
* // name: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // nextToken: "STRING_VALUE",
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @param ListEventsCommandInput - {@link ListEventsCommandInput}
|
|
84
|
+
* @returns {@link ListEventsCommandOutput}
|
|
85
|
+
* @see {@link ListEventsCommandInput} for command's `input` shape.
|
|
86
|
+
* @see {@link ListEventsCommandOutput} for command's `response` shape.
|
|
87
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
90
|
+
* <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>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
93
|
+
* <p>The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
+
* <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>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ServiceException} (server fault)
|
|
99
|
+
* <p>The service encountered an internal error. Try your request again later.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
102
|
+
* <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>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ThrottledException} (client fault)
|
|
105
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ValidationException} (client fault)
|
|
108
|
+
* <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>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
112
|
+
*
|
|
113
|
+
*
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
export declare class ListEventsCommand extends ListEventsCommand_base {
|
|
117
|
+
/** @internal type navigation helper, not in runtime. */
|
|
118
|
+
protected static __types: {
|
|
119
|
+
api: {
|
|
120
|
+
input: ListEventsInput;
|
|
121
|
+
output: ListEventsOutput;
|
|
122
|
+
};
|
|
123
|
+
sdk: {
|
|
124
|
+
input: ListEventsCommandInput;
|
|
125
|
+
output: ListEventsCommandOutput;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
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 { ListMemoryRecordsInput, ListMemoryRecordsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListMemoryRecordsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListMemoryRecordsCommandInput extends ListMemoryRecordsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListMemoryRecordsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListMemoryRecordsCommandOutput extends ListMemoryRecordsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListMemoryRecordsCommand_base: {
|
|
25
|
+
new (input: ListMemoryRecordsCommandInput): import("@smithy/smithy-client").CommandImpl<ListMemoryRecordsCommandInput, ListMemoryRecordsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListMemoryRecordsCommandInput): import("@smithy/smithy-client").CommandImpl<ListMemoryRecordsCommandInput, ListMemoryRecordsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists memory records in a memory store based on specified criteria. 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:ListMemoryRecords</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, ListMemoryRecordsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, ListMemoryRecordsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // ListMemoryRecordsInput
|
|
38
|
+
* memoryId: "STRING_VALUE", // required
|
|
39
|
+
* namespace: "STRING_VALUE", // required
|
|
40
|
+
* memoryStrategyId: "STRING_VALUE",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new ListMemoryRecordsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // ListMemoryRecordsOutput
|
|
47
|
+
* // memoryRecordSummaries: [ // MemoryRecordSummaryList // required
|
|
48
|
+
* // { // MemoryRecordSummary
|
|
49
|
+
* // memoryRecordId: "STRING_VALUE", // required
|
|
50
|
+
* // content: { // MemoryContent Union: only one key present
|
|
51
|
+
* // text: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // memoryStrategyId: "STRING_VALUE", // required
|
|
54
|
+
* // namespaces: [ // NamespacesList // required
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
58
|
+
* // score: Number("double"),
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // nextToken: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param ListMemoryRecordsCommandInput - {@link ListMemoryRecordsCommandInput}
|
|
67
|
+
* @returns {@link ListMemoryRecordsCommandOutput}
|
|
68
|
+
* @see {@link ListMemoryRecordsCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link ListMemoryRecordsCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
73
|
+
* <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>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
76
|
+
* <p>The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <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>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ServiceException} (server fault)
|
|
82
|
+
* <p>The service encountered an internal error. Try your request again later.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
85
|
+
* <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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottledException} (client fault)
|
|
88
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <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>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class ListMemoryRecordsCommand extends ListMemoryRecordsCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: ListMemoryRecordsInput;
|
|
104
|
+
output: ListMemoryRecordsOutput;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: ListMemoryRecordsCommandInput;
|
|
108
|
+
output: ListMemoryRecordsCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
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 { ListSessionsInput, ListSessionsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListSessionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListSessionsCommandInput extends ListSessionsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListSessionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListSessionsCommandOutput extends ListSessionsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListSessionsCommand_base: {
|
|
25
|
+
new (input: ListSessionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSessionsCommandInput, ListSessionsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListSessionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSessionsCommandInput, ListSessionsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists sessions in a memory store based on specified criteria. 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:ListSessions</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, ListSessionsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, ListSessionsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // ListSessionsInput
|
|
38
|
+
* memoryId: "STRING_VALUE", // required
|
|
39
|
+
* actorId: "STRING_VALUE", // required
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* nextToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListSessionsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListSessionsOutput
|
|
46
|
+
* // sessionSummaries: [ // SessionSummaryList // required
|
|
47
|
+
* // { // SessionSummary
|
|
48
|
+
* // sessionId: "STRING_VALUE", // required
|
|
49
|
+
* // actorId: "STRING_VALUE", // required
|
|
50
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // nextToken: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param ListSessionsCommandInput - {@link ListSessionsCommandInput}
|
|
59
|
+
* @returns {@link ListSessionsCommandOutput}
|
|
60
|
+
* @see {@link ListSessionsCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link ListSessionsCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <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>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
68
|
+
* <p>The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <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>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ServiceException} (server fault)
|
|
74
|
+
* <p>The service encountered an internal error. Try your request again later.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ThrottledException} (client fault)
|
|
80
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ValidationException} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class ListSessionsCommand extends ListSessionsCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: ListSessionsInput;
|
|
96
|
+
output: ListSessionsOutput;
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: ListSessionsCommandInput;
|
|
100
|
+
output: ListSessionsCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|
|
@@ -0,0 +1,115 @@
|
|
|
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 { RetrieveMemoryRecordsInput, RetrieveMemoryRecordsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link RetrieveMemoryRecordsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RetrieveMemoryRecordsCommandInput extends RetrieveMemoryRecordsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RetrieveMemoryRecordsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RetrieveMemoryRecordsCommandOutput extends RetrieveMemoryRecordsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RetrieveMemoryRecordsCommand_base: {
|
|
25
|
+
new (input: RetrieveMemoryRecordsCommandInput): import("@smithy/smithy-client").CommandImpl<RetrieveMemoryRecordsCommandInput, RetrieveMemoryRecordsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: RetrieveMemoryRecordsCommandInput): import("@smithy/smithy-client").CommandImpl<RetrieveMemoryRecordsCommandInput, RetrieveMemoryRecordsCommandOutput, BedrockAgentCoreClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Searches for and retrieves memory records from a memory store based on specified search criteria. 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:RetrieveMemoryRecords</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, RetrieveMemoryRecordsCommand } from "@aws-sdk/client-bedrock-agentcore"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentCoreClient, RetrieveMemoryRecordsCommand } = require("@aws-sdk/client-bedrock-agentcore"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentCoreClient(config);
|
|
37
|
+
* const input = { // RetrieveMemoryRecordsInput
|
|
38
|
+
* memoryId: "STRING_VALUE", // required
|
|
39
|
+
* namespace: "STRING_VALUE", // required
|
|
40
|
+
* searchCriteria: { // SearchCriteria
|
|
41
|
+
* searchQuery: "STRING_VALUE", // required
|
|
42
|
+
* memoryStrategyId: "STRING_VALUE",
|
|
43
|
+
* topK: Number("int"),
|
|
44
|
+
* },
|
|
45
|
+
* nextToken: "STRING_VALUE",
|
|
46
|
+
* maxResults: Number("int"),
|
|
47
|
+
* };
|
|
48
|
+
* const command = new RetrieveMemoryRecordsCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // RetrieveMemoryRecordsOutput
|
|
51
|
+
* // memoryRecordSummaries: [ // MemoryRecordSummaryList // required
|
|
52
|
+
* // { // MemoryRecordSummary
|
|
53
|
+
* // memoryRecordId: "STRING_VALUE", // required
|
|
54
|
+
* // content: { // MemoryContent Union: only one key present
|
|
55
|
+
* // text: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // memoryStrategyId: "STRING_VALUE", // required
|
|
58
|
+
* // namespaces: [ // NamespacesList // required
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
62
|
+
* // score: Number("double"),
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // nextToken: "STRING_VALUE",
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param RetrieveMemoryRecordsCommandInput - {@link RetrieveMemoryRecordsCommandInput}
|
|
71
|
+
* @returns {@link RetrieveMemoryRecordsCommandOutput}
|
|
72
|
+
* @see {@link RetrieveMemoryRecordsCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link RetrieveMemoryRecordsCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link BedrockAgentCoreClientResolvedConfig | config} for BedrockAgentCoreClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <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>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
80
|
+
* <p>The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ServiceException} (server fault)
|
|
86
|
+
* <p>The service encountered an internal error. Try your request again later.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
89
|
+
* <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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ThrottledException} (client fault)
|
|
92
|
+
* <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ValidationException} (client fault)
|
|
95
|
+
* <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>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link BedrockAgentCoreServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from BedrockAgentCore service.</p>
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class RetrieveMemoryRecordsCommand extends RetrieveMemoryRecordsCommand_base {
|
|
104
|
+
/** @internal type navigation helper, not in runtime. */
|
|
105
|
+
protected static __types: {
|
|
106
|
+
api: {
|
|
107
|
+
input: RetrieveMemoryRecordsInput;
|
|
108
|
+
output: RetrieveMemoryRecordsOutput;
|
|
109
|
+
};
|
|
110
|
+
sdk: {
|
|
111
|
+
input: RetrieveMemoryRecordsCommandInput;
|
|
112
|
+
output: RetrieveMemoryRecordsCommandOutput;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
}
|