@aws-sdk/client-opensearchmemory 0.0.0-stage → 3.1170.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 +320 -2
- package/dist-cjs/index.js +1550 -0
- package/dist-es/OpenSearchMemory.js +65 -0
- package/dist-es/OpenSearchMemoryClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commandBuilder.js +9 -0
- package/dist-es/commands/BatchGetEventCommand.js +4 -0
- package/dist-es/commands/CreateEventCommand.js +4 -0
- package/dist-es/commands/CreateMemoryCommand.js +4 -0
- package/dist-es/commands/CreateSpaceCommand.js +4 -0
- package/dist-es/commands/DeleteEventCommand.js +4 -0
- package/dist-es/commands/DeleteMemoryCommand.js +4 -0
- package/dist-es/commands/DeleteSpaceCommand.js +4 -0
- package/dist-es/commands/GetEventCommand.js +4 -0
- package/dist-es/commands/GetMemoryCommand.js +4 -0
- package/dist-es/commands/GetSpaceCommand.js +4 -0
- package/dist-es/commands/ListEventsCommand.js +4 -0
- package/dist-es/commands/ListMemoriesCommand.js +4 -0
- package/dist-es/commands/ListSpacesCommand.js +4 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +4 -0
- package/dist-es/commands/SearchEventsCommand.js +4 -0
- package/dist-es/commands/SearchMemoriesCommand.js +4 -0
- package/dist-es/commands/TagResourceCommand.js +4 -0
- package/dist-es/commands/UntagResourceCommand.js +4 -0
- package/dist-es/commands/UpdateMemoryCommand.js +4 -0
- package/dist-es/commands/UpdateSpaceCommand.js +4 -0
- package/dist-es/commands/index.js +20 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/bdd.js +33 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +11 -0
- package/dist-es/models/OpenSearchMemoryServiceException.js +9 -0
- package/dist-es/models/enums.js +61 -0
- package/dist-es/models/errors.js +114 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListEventsPaginator.js +4 -0
- package/dist-es/pagination/ListMemoriesPaginator.js +4 -0
- package/dist-es/pagination/ListSpacesPaginator.js +4 -0
- package/dist-es/pagination/SearchEventsPaginator.js +4 -0
- package/dist-es/pagination/SearchMemoriesPaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/runtimeConfig.browser.js +29 -0
- package/dist-es/runtimeConfig.js +44 -0
- package/dist-es/runtimeConfig.native.js +9 -0
- package/dist-es/runtimeConfig.shared.js +40 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +720 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForSpaceActive.js +79 -0
- package/dist-es/waiters/waitForSpaceDeleted.js +52 -0
- package/dist-types/OpenSearchMemory.d.ts +206 -0
- package/dist-types/OpenSearchMemoryClient.d.ts +207 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commandBuilder.d.ts +22 -0
- package/dist-types/commands/BatchGetEventCommand.d.ts +140 -0
- package/dist-types/commands/CreateEventCommand.d.ts +134 -0
- package/dist-types/commands/CreateMemoryCommand.d.ts +103 -0
- package/dist-types/commands/CreateSpaceCommand.d.ts +122 -0
- package/dist-types/commands/DeleteEventCommand.d.ts +89 -0
- package/dist-types/commands/DeleteMemoryCommand.d.ts +89 -0
- package/dist-types/commands/DeleteSpaceCommand.d.ts +90 -0
- package/dist-types/commands/GetEventCommand.d.ts +129 -0
- package/dist-types/commands/GetMemoryCommand.d.ts +103 -0
- package/dist-types/commands/GetSpaceCommand.d.ts +113 -0
- package/dist-types/commands/ListEventsCommand.d.ts +105 -0
- package/dist-types/commands/ListMemoriesCommand.d.ts +120 -0
- package/dist-types/commands/ListSpacesCommand.d.ts +93 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +91 -0
- package/dist-types/commands/SearchEventsCommand.d.ts +110 -0
- package/dist-types/commands/SearchMemoriesCommand.d.ts +120 -0
- package/dist-types/commands/TagResourceCommand.d.ts +90 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateMemoryCommand.d.ts +111 -0
- package/dist-types/commands/UpdateSpaceCommand.d.ts +112 -0
- package/dist-types/commands/index.d.ts +20 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +19 -0
- package/dist-types/models/OpenSearchMemoryServiceException.d.ts +15 -0
- package/dist-types/models/enums.d.ts +258 -0
- package/dist-types/models/errors.d.ts +144 -0
- package/dist-types/models/models_0.d.ts +1629 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMemoriesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSpacesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchMemoriesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/runtimeConfig.browser.d.ts +57 -0
- package/dist-types/runtimeConfig.d.ts +58 -0
- package/dist-types/runtimeConfig.native.d.ts +56 -0
- package/dist-types/runtimeConfig.shared.d.ts +28 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +105 -0
- package/dist-types/ts3.4/OpenSearchMemory.d.ts +371 -0
- package/dist-types/ts3.4/OpenSearchMemoryClient.d.ts +190 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
- package/dist-types/ts3.4/commandBuilder.d.ts +41 -0
- package/dist-types/ts3.4/commands/BatchGetEventCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateEventCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateMemoryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteEventCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteMemoryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetEventCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetMemoryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListEventsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListMemoriesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListSpacesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/SearchEventsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SearchMemoriesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateMemoryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +20 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +46 -0
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
- package/dist-types/ts3.4/index.d.ts +14 -0
- package/dist-types/ts3.4/models/OpenSearchMemoryServiceException.d.ts +10 -0
- package/dist-types/ts3.4/models/enums.d.ts +73 -0
- package/dist-types/ts3.4/models/errors.d.ts +59 -0
- package/dist-types/ts3.4/models/models_0.d.ts +459 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListEventsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListMemoriesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSpacesPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/SearchEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchMemoriesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +105 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForSpaceActive.d.ts +12 -0
- package/dist-types/ts3.4/waiters/waitForSpaceDeleted.d.ts +13 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForSpaceActive.d.ts +15 -0
- package/dist-types/waiters/waitForSpaceDeleted.d.ts +16 -0
- package/package.json +67 -4
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UntagResourceCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UntagResourceCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UntagResourceCommand_base: {
|
|
22
|
+
new (input: UntagResourceCommandInput): import("@smithy/core/client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UntagResourceCommandInput): import("@smithy/core/client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Removes the specified tags from the specified space.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { OpenSearchMemoryClient, UntagResourceCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
|
|
32
|
+
* // const { OpenSearchMemoryClient, UntagResourceCommand } = require("@aws-sdk/client-opensearchmemory"); // CommonJS import
|
|
33
|
+
* // import type { OpenSearchMemoryClientConfig } from "@aws-sdk/client-opensearchmemory";
|
|
34
|
+
* const config = {}; // type is OpenSearchMemoryClientConfig
|
|
35
|
+
* const client = new OpenSearchMemoryClient(config);
|
|
36
|
+
* const input = { // UntagResourceRequest
|
|
37
|
+
* resourceArn: "STRING_VALUE", // required
|
|
38
|
+
* tagKeys: [ // TagKeyList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UntagResourceCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
|
|
49
|
+
* @returns {@link UntagResourceCommandOutput}
|
|
50
|
+
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
+
* <p>You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* <p>The service couldn't process the request because of an internal error. Retry the request.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>The specified resource doesn't exist. Check the IDs in the request.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
64
|
+
* <p>The service throttled the request. Retry the request with exponential backoff.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* <p>The request isn't valid. The <code>reason</code>, <code>message</code>, and <code>fieldList</code> members describe the problem. Fix the request, and then try again.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link OpenSearchMemoryServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class UntagResourceCommand extends UntagResourceCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: UntagResourceRequest;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: UntagResourceCommandInput;
|
|
84
|
+
output: UntagResourceCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateMemoryInput, UpdateMemoryOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateMemoryCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateMemoryCommandInput extends UpdateMemoryInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateMemoryCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateMemoryCommandOutput extends UpdateMemoryOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateMemoryCommand_base: {
|
|
22
|
+
new (input: UpdateMemoryCommandInput): import("@smithy/core/client").CommandImpl<UpdateMemoryCommandInput, UpdateMemoryCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateMemoryCommandInput): import("@smithy/core/client").CommandImpl<UpdateMemoryCommandInput, UpdateMemoryCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates a memory in place. Supply only the fields to change. Omitted fields keep their stored values. A request must supply <code>content</code> or <code>metadata</code>, or it fails with <code>ValidationException</code>. Supplying <code>content</code> re-embeds the memory. A change to metadata alone doesn't.</p> <p>The memory keeps its <code>memoryId</code> across updates. Shortly after an update, searches stop returning the previous content.</p> <p> <code>memoryType</code> can't be changed. To change it, delete the memory and create a new one.</p> <p>A memory past its expiry (set from the space's <code>memoryExpiryDays</code> when the memory is written) reads as not found: the operation fails with <code>ResourceNotFoundException</code> and changes nothing. An update does not move the expiry.</p> <p>Concurrent updates to one memory are last-writer-wins. There is no version check. To avoid lost updates, serialize your updates to a memory.</p> <p>If you supply <code>content</code> and the request would exceed the service's rate for embedding requests, it fails with <code>ThrottlingException</code>. Retry with exponential backoff.</p> <p>If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with <code>AccessDeniedException</code> if you aren't allowed to use the key, and with <code>ThrottlingException</code> if AWS KMS throttles the request. It fails with <code>ValidationException</code> if the key is disabled, pending deletion, or deleted.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { OpenSearchMemoryClient, UpdateMemoryCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
|
|
32
|
+
* // const { OpenSearchMemoryClient, UpdateMemoryCommand } = require("@aws-sdk/client-opensearchmemory"); // CommonJS import
|
|
33
|
+
* // import type { OpenSearchMemoryClientConfig } from "@aws-sdk/client-opensearchmemory";
|
|
34
|
+
* const config = {}; // type is OpenSearchMemoryClientConfig
|
|
35
|
+
* const client = new OpenSearchMemoryClient(config);
|
|
36
|
+
* const input = { // UpdateMemoryInput
|
|
37
|
+
* spaceId: "STRING_VALUE", // required
|
|
38
|
+
* memoryId: "STRING_VALUE", // required
|
|
39
|
+
* content: "STRING_VALUE",
|
|
40
|
+
* metadata: { // MetadataMap
|
|
41
|
+
* "<keys>": "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* metadataMode: "REPLACE" || "MERGE",
|
|
44
|
+
* actorId: "STRING_VALUE",
|
|
45
|
+
* strategyName: "STRING_VALUE",
|
|
46
|
+
* };
|
|
47
|
+
* const command = new UpdateMemoryCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // UpdateMemoryOutput
|
|
50
|
+
* // memory: { // Memory
|
|
51
|
+
* // memoryId: "STRING_VALUE", // required
|
|
52
|
+
* // memoryType: "SEMANTIC" || "SUMMARY" || "CUSTOM", // required
|
|
53
|
+
* // strategyName: "STRING_VALUE",
|
|
54
|
+
* // content: "STRING_VALUE", // required
|
|
55
|
+
* // systemMetadata: { // SystemMetadata
|
|
56
|
+
* // actorId: "STRING_VALUE",
|
|
57
|
+
* // sessionId: "STRING_VALUE",
|
|
58
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
59
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
60
|
+
* // },
|
|
61
|
+
* // metadata: { // MetadataMap
|
|
62
|
+
* // "<keys>": "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param UpdateMemoryCommandInput - {@link UpdateMemoryCommandInput}
|
|
70
|
+
* @returns {@link UpdateMemoryCommandOutput}
|
|
71
|
+
* @see {@link UpdateMemoryCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link UpdateMemoryCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ConflictException} (client fault)
|
|
79
|
+
* <p>The request conflicts with the current state of the resource. For example, the space is being created, updated, or deleted, a space with the same name already exists, or you reused a client token with different parameters. Wait for the space to finish being created, updated, or deleted, or use a different name or client token, and then retry.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServerException} (server fault)
|
|
82
|
+
* <p>The service couldn't process the request because of an internal error. Retry the request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>The specified resource doesn't exist. Check the IDs in the request.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>The service throttled the request. Retry the request with exponential backoff.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p>The request isn't valid. The <code>reason</code>, <code>message</code>, and <code>fieldList</code> members describe the problem. Fix the request, and then try again.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link OpenSearchMemoryServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class UpdateMemoryCommand extends UpdateMemoryCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: UpdateMemoryInput;
|
|
104
|
+
output: UpdateMemoryOutput;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: UpdateMemoryCommandInput;
|
|
108
|
+
output: UpdateMemoryCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateSpaceRequest, UpdateSpaceResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateSpaceCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateSpaceCommandInput extends UpdateSpaceRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateSpaceCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateSpaceCommandOutput extends UpdateSpaceResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateSpaceCommand_base: {
|
|
22
|
+
new (input: UpdateSpaceCommandInput): import("@smithy/core/client").CommandImpl<UpdateSpaceCommandInput, UpdateSpaceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateSpaceCommandInput): import("@smithy/core/client").CommandImpl<UpdateSpaceCommandInput, UpdateSpaceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates a space's memory strategies, retention settings, or extraction model. Supply only the fields to change. Omitted fields keep their current values.</p> <p>If the request changes the set of strategies, a strategy's configuration, a retention setting, or the extraction model, the space moves to <code>UPDATING</code>. When the change is complete, the space returns to <code>ACTIVE</code>, or moves to <code>FAILED</code> if the change can't be applied. While the space is <code>UPDATING</code>, <code>GetSpace</code> returns the previous configuration. A request that only changes strategy descriptions or repeats the values the space has stored is applied immediately and doesn't change the status. Sending a retention value that the space never set also moves the space to <code>UPDATING</code>, even one that matches the behavior without it, such as 90 for <code>eventExpiryDays</code> or 0 for <code>memoryExpiryDays</code>. A space that is <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> can't be updated: the request fails with <code>ConflictException</code>.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { OpenSearchMemoryClient, UpdateSpaceCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
|
|
32
|
+
* // const { OpenSearchMemoryClient, UpdateSpaceCommand } = require("@aws-sdk/client-opensearchmemory"); // CommonJS import
|
|
33
|
+
* // import type { OpenSearchMemoryClientConfig } from "@aws-sdk/client-opensearchmemory";
|
|
34
|
+
* const config = {}; // type is OpenSearchMemoryClientConfig
|
|
35
|
+
* const client = new OpenSearchMemoryClient(config);
|
|
36
|
+
* const input = { // UpdateSpaceRequest
|
|
37
|
+
* spaceId: "STRING_VALUE", // required
|
|
38
|
+
* memoryStrategies: [ // MemoryStrategyList
|
|
39
|
+
* { // MemoryStrategy
|
|
40
|
+
* type: "SEMANTIC" || "SUMMARY" || "CUSTOM", // required
|
|
41
|
+
* name: "STRING_VALUE",
|
|
42
|
+
* description: "STRING_VALUE",
|
|
43
|
+
* configuration: { // MemoryStrategyConfiguration
|
|
44
|
+
* extractionPrompt: "STRING_VALUE",
|
|
45
|
+
* extractEveryNMessages: Number("int"),
|
|
46
|
+
* extractEveryNTokens: Number("int"),
|
|
47
|
+
* idleTimeoutSeconds: Number("int"),
|
|
48
|
+
* extractionSeedTopK: Number("int"),
|
|
49
|
+
* extractionSeedRecentN: Number("int"),
|
|
50
|
+
* consolidationEnabled: true || false,
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* eventExpiryDays: Number("int"),
|
|
55
|
+
* memoryExpiryDays: Number("int"),
|
|
56
|
+
* extractionModelId: "STRING_VALUE",
|
|
57
|
+
* };
|
|
58
|
+
* const command = new UpdateSpaceCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* // { // UpdateSpaceResponse
|
|
61
|
+
* // spaceId: "STRING_VALUE", // required
|
|
62
|
+
* // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED", // required
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param UpdateSpaceCommandInput - {@link UpdateSpaceCommandInput}
|
|
68
|
+
* @returns {@link UpdateSpaceCommandOutput}
|
|
69
|
+
* @see {@link UpdateSpaceCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link UpdateSpaceCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
74
|
+
* <p>You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConflictException} (client fault)
|
|
77
|
+
* <p>The request conflicts with the current state of the resource. For example, the space is being created, updated, or deleted, a space with the same name already exists, or you reused a client token with different parameters. Wait for the space to finish being created, updated, or deleted, or use a different name or client token, and then retry.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InternalServerException} (server fault)
|
|
80
|
+
* <p>The service couldn't process the request because of an internal error. Retry the request.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
|
+
* <p>The specified resource doesn't exist. Check the IDs in the request.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
86
|
+
* <p>The request would exceed a quota, such as the number of spaces in your account or the number of strategies in a space.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
89
|
+
* <p>The service throttled the request. Retry the request with exponential backoff.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* <p>The request isn't valid. The <code>reason</code>, <code>message</code>, and <code>fieldList</code> members describe the problem. Fix the request, and then try again.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link OpenSearchMemoryServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
|
|
96
|
+
*
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class UpdateSpaceCommand extends UpdateSpaceCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: UpdateSpaceRequest;
|
|
105
|
+
output: UpdateSpaceResponse;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: UpdateSpaceCommandInput;
|
|
109
|
+
output: UpdateSpaceCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export * from "./BatchGetEventCommand";
|
|
2
|
+
export * from "./CreateEventCommand";
|
|
3
|
+
export * from "./CreateMemoryCommand";
|
|
4
|
+
export * from "./CreateSpaceCommand";
|
|
5
|
+
export * from "./DeleteEventCommand";
|
|
6
|
+
export * from "./DeleteMemoryCommand";
|
|
7
|
+
export * from "./DeleteSpaceCommand";
|
|
8
|
+
export * from "./GetEventCommand";
|
|
9
|
+
export * from "./GetMemoryCommand";
|
|
10
|
+
export * from "./GetSpaceCommand";
|
|
11
|
+
export * from "./ListEventsCommand";
|
|
12
|
+
export * from "./ListMemoriesCommand";
|
|
13
|
+
export * from "./ListSpacesCommand";
|
|
14
|
+
export * from "./ListTagsForResourceCommand";
|
|
15
|
+
export * from "./SearchEventsCommand";
|
|
16
|
+
export * from "./SearchMemoriesCommand";
|
|
17
|
+
export * from "./TagResourceCommand";
|
|
18
|
+
export * from "./UntagResourceCommand";
|
|
19
|
+
export * from "./UpdateMemoryCommand";
|
|
20
|
+
export * from "./UpdateSpaceCommand";
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ClientInputEndpointParameters {
|
|
6
|
+
region?: string | undefined | Provider<string | undefined>;
|
|
7
|
+
endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
|
|
8
|
+
useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
|
|
14
|
+
defaultSigningName: string;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* @internal
|
|
18
|
+
*/
|
|
19
|
+
export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
|
|
20
|
+
/**
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
export declare const commonParams: {
|
|
24
|
+
readonly UseFIPS: {
|
|
25
|
+
readonly type: "builtInParams";
|
|
26
|
+
readonly name: "useFipsEndpoint";
|
|
27
|
+
};
|
|
28
|
+
readonly Endpoint: {
|
|
29
|
+
readonly type: "builtInParams";
|
|
30
|
+
readonly name: "endpoint";
|
|
31
|
+
};
|
|
32
|
+
readonly Region: {
|
|
33
|
+
readonly type: "builtInParams";
|
|
34
|
+
readonly name: "region";
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* @internal
|
|
39
|
+
*/
|
|
40
|
+
export interface EndpointParameters extends __EndpointParameters {
|
|
41
|
+
Region: string;
|
|
42
|
+
Endpoint?: string | undefined;
|
|
43
|
+
SpaceId?: string | undefined;
|
|
44
|
+
UseFIPS?: boolean | undefined;
|
|
45
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { EndpointV2, Logger } from "@smithy/types";
|
|
2
|
+
import type { EndpointParameters } from "./EndpointParameters";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
|
|
7
|
+
logger?: Logger;
|
|
8
|
+
}) => EndpointV2;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
|
|
2
|
+
import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
|
|
3
|
+
import type { DefaultExtensionConfiguration } from "@smithy/types";
|
|
4
|
+
import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
|
|
5
|
+
/**
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
8
|
+
export interface OpenSearchMemoryExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
|
|
9
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* <p>Amazon OpenSearch Memory lets your AI agents and applications recall facts and summaries across sessions. Your agents send events, such as conversation turns, and search the memories derived from them.</p> <p>A space groups related events and memories, and holds the memory strategies that you configure for them. Use the space operations to create, get, list, update, and delete spaces. Use the event and memory operations to write, read, list, search, update, and delete a space's events and memories.</p>
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
export * from "./OpenSearchMemoryClient";
|
|
7
|
+
export * from "./OpenSearchMemory";
|
|
8
|
+
export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
9
|
+
export type { RuntimeExtension } from "./runtimeExtensions";
|
|
10
|
+
export type { OpenSearchMemoryExtensionConfiguration } from "./extensionConfiguration";
|
|
11
|
+
export * from "./commands";
|
|
12
|
+
export { Command as $Command } from "@smithy/core/client";
|
|
13
|
+
export * from "./pagination";
|
|
14
|
+
export * from "./waiters";
|
|
15
|
+
export * from "./schemas/schemas_0";
|
|
16
|
+
export * from "./models/enums";
|
|
17
|
+
export * from "./models/errors";
|
|
18
|
+
export * from "./models/models_0";
|
|
19
|
+
export { OpenSearchMemoryServiceException } from "./models/OpenSearchMemoryServiceException";
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
|
|
2
|
+
export type { __ServiceExceptionOptions };
|
|
3
|
+
export { __ServiceException };
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*
|
|
7
|
+
* Base exception class for all service exceptions from OpenSearchMemory service.
|
|
8
|
+
*/
|
|
9
|
+
export declare class OpenSearchMemoryServiceException extends __ServiceException {
|
|
10
|
+
static readonly shapeId: string;
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
constructor(options: __ServiceExceptionOptions);
|
|
15
|
+
}
|