@aws-sdk/client-opensearchmemory 0.0.0-stage → 3.1171.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.
Files changed (157) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +320 -2
  3. package/dist-cjs/index.js +1550 -0
  4. package/dist-es/OpenSearchMemory.js +65 -0
  5. package/dist-es/OpenSearchMemoryClient.js +47 -0
  6. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  7. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  8. package/dist-es/commandBuilder.js +9 -0
  9. package/dist-es/commands/BatchGetEventCommand.js +4 -0
  10. package/dist-es/commands/CreateEventCommand.js +4 -0
  11. package/dist-es/commands/CreateMemoryCommand.js +4 -0
  12. package/dist-es/commands/CreateSpaceCommand.js +4 -0
  13. package/dist-es/commands/DeleteEventCommand.js +4 -0
  14. package/dist-es/commands/DeleteMemoryCommand.js +4 -0
  15. package/dist-es/commands/DeleteSpaceCommand.js +4 -0
  16. package/dist-es/commands/GetEventCommand.js +4 -0
  17. package/dist-es/commands/GetMemoryCommand.js +4 -0
  18. package/dist-es/commands/GetSpaceCommand.js +4 -0
  19. package/dist-es/commands/ListEventsCommand.js +4 -0
  20. package/dist-es/commands/ListMemoriesCommand.js +4 -0
  21. package/dist-es/commands/ListSpacesCommand.js +4 -0
  22. package/dist-es/commands/ListTagsForResourceCommand.js +4 -0
  23. package/dist-es/commands/SearchEventsCommand.js +4 -0
  24. package/dist-es/commands/SearchMemoriesCommand.js +4 -0
  25. package/dist-es/commands/TagResourceCommand.js +4 -0
  26. package/dist-es/commands/UntagResourceCommand.js +4 -0
  27. package/dist-es/commands/UpdateMemoryCommand.js +4 -0
  28. package/dist-es/commands/UpdateSpaceCommand.js +4 -0
  29. package/dist-es/commands/index.js +20 -0
  30. package/dist-es/endpoint/EndpointParameters.js +11 -0
  31. package/dist-es/endpoint/bdd.js +33 -0
  32. package/dist-es/endpoint/endpointResolver.js +14 -0
  33. package/dist-es/extensionConfiguration.js +1 -0
  34. package/dist-es/index.js +11 -0
  35. package/dist-es/models/OpenSearchMemoryServiceException.js +9 -0
  36. package/dist-es/models/enums.js +61 -0
  37. package/dist-es/models/errors.js +114 -0
  38. package/dist-es/models/models_0.js +1 -0
  39. package/dist-es/pagination/Interfaces.js +1 -0
  40. package/dist-es/pagination/ListEventsPaginator.js +4 -0
  41. package/dist-es/pagination/ListMemoriesPaginator.js +4 -0
  42. package/dist-es/pagination/ListSpacesPaginator.js +4 -0
  43. package/dist-es/pagination/SearchEventsPaginator.js +4 -0
  44. package/dist-es/pagination/SearchMemoriesPaginator.js +4 -0
  45. package/dist-es/pagination/index.js +6 -0
  46. package/dist-es/runtimeConfig.browser.js +29 -0
  47. package/dist-es/runtimeConfig.js +44 -0
  48. package/dist-es/runtimeConfig.native.js +9 -0
  49. package/dist-es/runtimeConfig.shared.js +40 -0
  50. package/dist-es/runtimeExtensions.js +9 -0
  51. package/dist-es/schemas/schemas_0.js +720 -0
  52. package/dist-es/waiters/index.js +2 -0
  53. package/dist-es/waiters/waitForSpaceActive.js +79 -0
  54. package/dist-es/waiters/waitForSpaceDeleted.js +52 -0
  55. package/dist-types/OpenSearchMemory.d.ts +206 -0
  56. package/dist-types/OpenSearchMemoryClient.d.ts +207 -0
  57. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  58. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  59. package/dist-types/commandBuilder.d.ts +22 -0
  60. package/dist-types/commands/BatchGetEventCommand.d.ts +140 -0
  61. package/dist-types/commands/CreateEventCommand.d.ts +134 -0
  62. package/dist-types/commands/CreateMemoryCommand.d.ts +103 -0
  63. package/dist-types/commands/CreateSpaceCommand.d.ts +122 -0
  64. package/dist-types/commands/DeleteEventCommand.d.ts +89 -0
  65. package/dist-types/commands/DeleteMemoryCommand.d.ts +89 -0
  66. package/dist-types/commands/DeleteSpaceCommand.d.ts +90 -0
  67. package/dist-types/commands/GetEventCommand.d.ts +129 -0
  68. package/dist-types/commands/GetMemoryCommand.d.ts +103 -0
  69. package/dist-types/commands/GetSpaceCommand.d.ts +113 -0
  70. package/dist-types/commands/ListEventsCommand.d.ts +105 -0
  71. package/dist-types/commands/ListMemoriesCommand.d.ts +120 -0
  72. package/dist-types/commands/ListSpacesCommand.d.ts +93 -0
  73. package/dist-types/commands/ListTagsForResourceCommand.d.ts +91 -0
  74. package/dist-types/commands/SearchEventsCommand.d.ts +110 -0
  75. package/dist-types/commands/SearchMemoriesCommand.d.ts +120 -0
  76. package/dist-types/commands/TagResourceCommand.d.ts +90 -0
  77. package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
  78. package/dist-types/commands/UpdateMemoryCommand.d.ts +111 -0
  79. package/dist-types/commands/UpdateSpaceCommand.d.ts +112 -0
  80. package/dist-types/commands/index.d.ts +20 -0
  81. package/dist-types/endpoint/EndpointParameters.d.ts +45 -0
  82. package/dist-types/endpoint/bdd.d.ts +2 -0
  83. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  84. package/dist-types/extensionConfiguration.d.ts +9 -0
  85. package/dist-types/index.d.ts +19 -0
  86. package/dist-types/models/OpenSearchMemoryServiceException.d.ts +15 -0
  87. package/dist-types/models/enums.d.ts +258 -0
  88. package/dist-types/models/errors.d.ts +144 -0
  89. package/dist-types/models/models_0.d.ts +1629 -0
  90. package/dist-types/pagination/Interfaces.d.ts +8 -0
  91. package/dist-types/pagination/ListEventsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListMemoriesPaginator.d.ts +7 -0
  93. package/dist-types/pagination/ListSpacesPaginator.d.ts +7 -0
  94. package/dist-types/pagination/SearchEventsPaginator.d.ts +7 -0
  95. package/dist-types/pagination/SearchMemoriesPaginator.d.ts +7 -0
  96. package/dist-types/pagination/index.d.ts +6 -0
  97. package/dist-types/runtimeConfig.browser.d.ts +57 -0
  98. package/dist-types/runtimeConfig.d.ts +58 -0
  99. package/dist-types/runtimeConfig.native.d.ts +56 -0
  100. package/dist-types/runtimeConfig.shared.d.ts +28 -0
  101. package/dist-types/runtimeExtensions.d.ts +17 -0
  102. package/dist-types/schemas/schemas_0.d.ts +105 -0
  103. package/dist-types/ts3.4/OpenSearchMemory.d.ts +371 -0
  104. package/dist-types/ts3.4/OpenSearchMemoryClient.d.ts +190 -0
  105. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
  106. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
  107. package/dist-types/ts3.4/commandBuilder.d.ts +41 -0
  108. package/dist-types/ts3.4/commands/BatchGetEventCommand.d.ts +38 -0
  109. package/dist-types/ts3.4/commands/CreateEventCommand.d.ts +38 -0
  110. package/dist-types/ts3.4/commands/CreateMemoryCommand.d.ts +38 -0
  111. package/dist-types/ts3.4/commands/CreateSpaceCommand.d.ts +38 -0
  112. package/dist-types/ts3.4/commands/DeleteEventCommand.d.ts +38 -0
  113. package/dist-types/ts3.4/commands/DeleteMemoryCommand.d.ts +38 -0
  114. package/dist-types/ts3.4/commands/DeleteSpaceCommand.d.ts +38 -0
  115. package/dist-types/ts3.4/commands/GetEventCommand.d.ts +38 -0
  116. package/dist-types/ts3.4/commands/GetMemoryCommand.d.ts +38 -0
  117. package/dist-types/ts3.4/commands/GetSpaceCommand.d.ts +38 -0
  118. package/dist-types/ts3.4/commands/ListEventsCommand.d.ts +38 -0
  119. package/dist-types/ts3.4/commands/ListMemoriesCommand.d.ts +38 -0
  120. package/dist-types/ts3.4/commands/ListSpacesCommand.d.ts +38 -0
  121. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
  122. package/dist-types/ts3.4/commands/SearchEventsCommand.d.ts +38 -0
  123. package/dist-types/ts3.4/commands/SearchMemoriesCommand.d.ts +38 -0
  124. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +38 -0
  125. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
  126. package/dist-types/ts3.4/commands/UpdateMemoryCommand.d.ts +38 -0
  127. package/dist-types/ts3.4/commands/UpdateSpaceCommand.d.ts +38 -0
  128. package/dist-types/ts3.4/commands/index.d.ts +20 -0
  129. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +46 -0
  130. package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
  131. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  132. package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
  133. package/dist-types/ts3.4/index.d.ts +14 -0
  134. package/dist-types/ts3.4/models/OpenSearchMemoryServiceException.d.ts +10 -0
  135. package/dist-types/ts3.4/models/enums.d.ts +73 -0
  136. package/dist-types/ts3.4/models/errors.d.ts +59 -0
  137. package/dist-types/ts3.4/models/models_0.d.ts +459 -0
  138. package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
  139. package/dist-types/ts3.4/pagination/ListEventsPaginator.d.ts +8 -0
  140. package/dist-types/ts3.4/pagination/ListMemoriesPaginator.d.ts +11 -0
  141. package/dist-types/ts3.4/pagination/ListSpacesPaginator.d.ts +8 -0
  142. package/dist-types/ts3.4/pagination/SearchEventsPaginator.d.ts +11 -0
  143. package/dist-types/ts3.4/pagination/SearchMemoriesPaginator.d.ts +11 -0
  144. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  145. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
  146. package/dist-types/ts3.4/runtimeConfig.d.ts +96 -0
  147. package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
  148. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
  149. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  150. package/dist-types/ts3.4/schemas/schemas_0.d.ts +105 -0
  151. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  152. package/dist-types/ts3.4/waiters/waitForSpaceActive.d.ts +12 -0
  153. package/dist-types/ts3.4/waiters/waitForSpaceDeleted.d.ts +13 -0
  154. package/dist-types/waiters/index.d.ts +2 -0
  155. package/dist-types/waiters/waitForSpaceActive.d.ts +15 -0
  156. package/dist-types/waiters/waitForSpaceDeleted.d.ts +16 -0
  157. package/package.json +67 -4
@@ -0,0 +1,120 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { ListMemoriesInput, ListMemoriesOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link ListMemoriesCommand}.
11
+ */
12
+ export interface ListMemoriesCommandInput extends ListMemoriesInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link ListMemoriesCommand}.
18
+ */
19
+ export interface ListMemoriesCommandOutput extends ListMemoriesOutput, __MetadataBearer {
20
+ }
21
+ declare const ListMemoriesCommand_base: {
22
+ new (input: ListMemoriesCommandInput): import("@smithy/core/client").CommandImpl<ListMemoriesCommandInput, ListMemoriesCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: ListMemoriesCommandInput): import("@smithy/core/client").CommandImpl<ListMemoriesCommandInput, ListMemoriesCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Lists a space's memories without a query, for example the most recent memories or the memories of one strategy. Filter by strategy and optionally by owning actor or session, sort by creation or update time, and page through the results. Results have no relevance score. To query or filter by metadata, use <code>SearchMemories</code>.</p> <p>If memories are written or deleted while you page, the results can skip a memory or return it twice. You can page through only a limited number of results. A request past that limit fails with <code>ValidationException</code> (reason <code>invalidNextToken</code>), and the message gives the limit.</p> <p>Memories past their expiry (set from the space's <code>memoryExpiryDays</code> when each memory is written) are left out. Unlike <code>SearchMemories</code>, this operation also returns memories that consolidation has superseded.</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, ListMemoriesCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
32
+ * // const { OpenSearchMemoryClient, ListMemoriesCommand } = 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 = { // ListMemoriesInput
37
+ * spaceId: "STRING_VALUE", // required
38
+ * memoryStrategies: [ // StrategySelectorList
39
+ * { // StrategySelector
40
+ * memoryType: "SEMANTIC" || "SUMMARY" || "CUSTOM", // required
41
+ * memoryStrategyNames: [ // StrategyNameList
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * },
45
+ * ],
46
+ * actorIds: [ // ActorIdList
47
+ * "STRING_VALUE",
48
+ * ],
49
+ * sessionIds: [ // SessionIdList
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * sortBy: "CREATED_AT" || "UPDATED_AT",
53
+ * sortOrder: "ASC" || "DESC",
54
+ * maxResults: Number("int"),
55
+ * nextToken: "STRING_VALUE",
56
+ * };
57
+ * const command = new ListMemoriesCommand(input);
58
+ * const response = await client.send(command);
59
+ * // { // ListMemoriesOutput
60
+ * // memories: [ // MemoryListSummaryList // required
61
+ * // { // MemoryListSummary
62
+ * // memoryId: "STRING_VALUE", // required
63
+ * // memoryType: "SEMANTIC" || "SUMMARY" || "CUSTOM", // required
64
+ * // strategyName: "STRING_VALUE",
65
+ * // systemMetadata: { // SystemMetadata
66
+ * // actorId: "STRING_VALUE",
67
+ * // sessionId: "STRING_VALUE",
68
+ * // createdAt: new Date("TIMESTAMP"),
69
+ * // updatedAt: new Date("TIMESTAMP"),
70
+ * // },
71
+ * // metadata: { // MetadataMap
72
+ * // "<keys>": "STRING_VALUE",
73
+ * // },
74
+ * // },
75
+ * // ],
76
+ * // nextToken: "STRING_VALUE",
77
+ * // };
78
+ *
79
+ * ```
80
+ *
81
+ * @param ListMemoriesCommandInput - {@link ListMemoriesCommandInput}
82
+ * @returns {@link ListMemoriesCommandOutput}
83
+ * @see {@link ListMemoriesCommandInput} for command's `input` shape.
84
+ * @see {@link ListMemoriesCommandOutput} for command's `response` shape.
85
+ * @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
86
+ *
87
+ * @throws {@link AccessDeniedException} (client fault)
88
+ * <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>
89
+ *
90
+ * @throws {@link InternalServerException} (server fault)
91
+ * <p>The service couldn't process the request because of an internal error. Retry the request.</p>
92
+ *
93
+ * @throws {@link ResourceNotFoundException} (client fault)
94
+ * <p>The specified resource doesn't exist. Check the IDs in the request.</p>
95
+ *
96
+ * @throws {@link ThrottlingException} (client fault)
97
+ * <p>The service throttled the request. Retry the request with exponential backoff.</p>
98
+ *
99
+ * @throws {@link ValidationException} (client fault)
100
+ * <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>
101
+ *
102
+ * @throws {@link OpenSearchMemoryServiceException}
103
+ * <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
104
+ *
105
+ *
106
+ * @public
107
+ */
108
+ export declare class ListMemoriesCommand extends ListMemoriesCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: ListMemoriesInput;
113
+ output: ListMemoriesOutput;
114
+ };
115
+ sdk: {
116
+ input: ListMemoriesCommandInput;
117
+ output: ListMemoriesCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -0,0 +1,93 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { ListSpacesRequest, ListSpacesResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link ListSpacesCommand}.
11
+ */
12
+ export interface ListSpacesCommandInput extends ListSpacesRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link ListSpacesCommand}.
18
+ */
19
+ export interface ListSpacesCommandOutput extends ListSpacesResponse, __MetadataBearer {
20
+ }
21
+ declare const ListSpacesCommand_base: {
22
+ new (input: ListSpacesCommandInput): import("@smithy/core/client").CommandImpl<ListSpacesCommandInput, ListSpacesCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (...[input]: [] | [ListSpacesCommandInput]): import("@smithy/core/client").CommandImpl<ListSpacesCommandInput, ListSpacesCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Lists the spaces in your account in the current Region.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { OpenSearchMemoryClient, ListSpacesCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
32
+ * // const { OpenSearchMemoryClient, ListSpacesCommand } = 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 = { // ListSpacesRequest
37
+ * maxResults: Number("int"),
38
+ * nextToken: "STRING_VALUE",
39
+ * };
40
+ * const command = new ListSpacesCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListSpacesResponse
43
+ * // spaces: [ // SpaceSummaryList // required
44
+ * // { // SpaceSummary
45
+ * // spaceId: "STRING_VALUE", // required
46
+ * // arn: "STRING_VALUE", // required
47
+ * // name: "STRING_VALUE", // required
48
+ * // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED", // required
49
+ * // createdAt: new Date("TIMESTAMP"), // required
50
+ * // },
51
+ * // ],
52
+ * // nextToken: "STRING_VALUE",
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param ListSpacesCommandInput - {@link ListSpacesCommandInput}
58
+ * @returns {@link ListSpacesCommandOutput}
59
+ * @see {@link ListSpacesCommandInput} for command's `input` shape.
60
+ * @see {@link ListSpacesCommandOutput} for command's `response` shape.
61
+ * @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
62
+ *
63
+ * @throws {@link AccessDeniedException} (client fault)
64
+ * <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>
65
+ *
66
+ * @throws {@link InternalServerException} (server fault)
67
+ * <p>The service couldn't process the request because of an internal error. Retry the request.</p>
68
+ *
69
+ * @throws {@link ThrottlingException} (client fault)
70
+ * <p>The service throttled the request. Retry the request with exponential backoff.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <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>
74
+ *
75
+ * @throws {@link OpenSearchMemoryServiceException}
76
+ * <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
77
+ *
78
+ *
79
+ * @public
80
+ */
81
+ export declare class ListSpacesCommand extends ListSpacesCommand_base {
82
+ /** @internal type navigation helper, not in runtime. */
83
+ protected static __types: {
84
+ api: {
85
+ input: ListSpacesRequest;
86
+ output: ListSpacesResponse;
87
+ };
88
+ sdk: {
89
+ input: ListSpacesCommandInput;
90
+ output: ListSpacesCommandOutput;
91
+ };
92
+ };
93
+ }
@@ -0,0 +1,91 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link ListTagsForResourceCommand}.
11
+ */
12
+ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link ListTagsForResourceCommand}.
18
+ */
19
+ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
20
+ }
21
+ declare const ListTagsForResourceCommand_base: {
22
+ new (input: ListTagsForResourceCommandInput): import("@smithy/core/client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: ListTagsForResourceCommandInput): import("@smithy/core/client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Lists the tags for 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, ListTagsForResourceCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
32
+ * // const { OpenSearchMemoryClient, ListTagsForResourceCommand } = 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 = { // ListTagsForResourceRequest
37
+ * resourceArn: "STRING_VALUE", // required
38
+ * };
39
+ * const command = new ListTagsForResourceCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // ListTagsForResourceResponse
42
+ * // tags: [ // TagList
43
+ * // { // Tag
44
+ * // key: "STRING_VALUE", // required
45
+ * // value: "STRING_VALUE", // required
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
53
+ * @returns {@link ListTagsForResourceCommandOutput}
54
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
55
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
56
+ * @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
57
+ *
58
+ * @throws {@link AccessDeniedException} (client fault)
59
+ * <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>
60
+ *
61
+ * @throws {@link InternalServerException} (server fault)
62
+ * <p>The service couldn't process the request because of an internal error. Retry the request.</p>
63
+ *
64
+ * @throws {@link ResourceNotFoundException} (client fault)
65
+ * <p>The specified resource doesn't exist. Check the IDs in the request.</p>
66
+ *
67
+ * @throws {@link ThrottlingException} (client fault)
68
+ * <p>The service throttled the request. Retry the request with exponential backoff.</p>
69
+ *
70
+ * @throws {@link ValidationException} (client fault)
71
+ * <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>
72
+ *
73
+ * @throws {@link OpenSearchMemoryServiceException}
74
+ * <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
75
+ *
76
+ *
77
+ * @public
78
+ */
79
+ export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: ListTagsForResourceRequest;
84
+ output: ListTagsForResourceResponse;
85
+ };
86
+ sdk: {
87
+ input: ListTagsForResourceCommandInput;
88
+ output: ListTagsForResourceCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,110 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { SearchEventsInput, SearchEventsOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link SearchEventsCommand}.
11
+ */
12
+ export interface SearchEventsCommandInput extends SearchEventsInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link SearchEventsCommand}.
18
+ */
19
+ export interface SearchEventsCommandOutput extends SearchEventsOutput, __MetadataBearer {
20
+ }
21
+ declare const SearchEventsCommand_base: {
22
+ new (input: SearchEventsCommandInput): import("@smithy/core/client").CommandImpl<SearchEventsCommandInput, SearchEventsCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: SearchEventsCommandInput): import("@smithy/core/client").CommandImpl<SearchEventsCommandInput, SearchEventsCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Searches a space's events by relevance. It works like <code>SearchMemories</code> without the memory type and strategy selector. The query is a subset of the OpenSearch Query DSL. The service validates it, limits the search to the actor in <code>actorId</code> and the sessions in <code>sessionIds</code>, and returns ranked results. Each result is the matching chunk of an event, not the whole event. You can page through only a limited number of results. A request past that limit fails with <code>ValidationException</code> (reason <code>invalidNextToken</code>), and the message gives the limit.</p> <p>If the results are larger than 5 MiB, the request fails with <code>ValidationException</code> (reason <code>queryBodyTooLarge</code>). Lower <code>maxResults</code>.</p> <p>If 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, SearchEventsCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
32
+ * // const { OpenSearchMemoryClient, SearchEventsCommand } = 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 = { // SearchEventsInput
37
+ * spaceId: "STRING_VALUE", // required
38
+ * actorId: "STRING_VALUE", // required
39
+ * sessionIds: [ // SessionIdList
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * query: "DOCUMENT_VALUE", // required
43
+ * sort: "DOCUMENT_VALUE",
44
+ * maxResults: Number("int"),
45
+ * nextToken: "STRING_VALUE",
46
+ * };
47
+ * const command = new SearchEventsCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // SearchEventsOutput
50
+ * // events: [ // EventSearchSummaryList // required
51
+ * // { // EventSearchSummary
52
+ * // eventId: "STRING_VALUE", // required
53
+ * // score: Number("double"),
54
+ * // systemMetadata: { // SystemMetadata
55
+ * // actorId: "STRING_VALUE",
56
+ * // sessionId: "STRING_VALUE",
57
+ * // createdAt: new Date("TIMESTAMP"),
58
+ * // updatedAt: new Date("TIMESTAMP"),
59
+ * // },
60
+ * // metadata: { // MetadataMap
61
+ * // "<keys>": "STRING_VALUE",
62
+ * // },
63
+ * // matchedContent: "STRING_VALUE",
64
+ * // },
65
+ * // ],
66
+ * // nextToken: "STRING_VALUE",
67
+ * // };
68
+ *
69
+ * ```
70
+ *
71
+ * @param SearchEventsCommandInput - {@link SearchEventsCommandInput}
72
+ * @returns {@link SearchEventsCommandOutput}
73
+ * @see {@link SearchEventsCommandInput} for command's `input` shape.
74
+ * @see {@link SearchEventsCommandOutput} for command's `response` shape.
75
+ * @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
76
+ *
77
+ * @throws {@link AccessDeniedException} (client fault)
78
+ * <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>
79
+ *
80
+ * @throws {@link InternalServerException} (server fault)
81
+ * <p>The service couldn't process the request because of an internal error. Retry the request.</p>
82
+ *
83
+ * @throws {@link ResourceNotFoundException} (client fault)
84
+ * <p>The specified resource doesn't exist. Check the IDs in the request.</p>
85
+ *
86
+ * @throws {@link ThrottlingException} (client fault)
87
+ * <p>The service throttled the request. Retry the request with exponential backoff.</p>
88
+ *
89
+ * @throws {@link ValidationException} (client fault)
90
+ * <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>
91
+ *
92
+ * @throws {@link OpenSearchMemoryServiceException}
93
+ * <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
94
+ *
95
+ *
96
+ * @public
97
+ */
98
+ export declare class SearchEventsCommand extends SearchEventsCommand_base {
99
+ /** @internal type navigation helper, not in runtime. */
100
+ protected static __types: {
101
+ api: {
102
+ input: SearchEventsInput;
103
+ output: SearchEventsOutput;
104
+ };
105
+ sdk: {
106
+ input: SearchEventsCommandInput;
107
+ output: SearchEventsCommandOutput;
108
+ };
109
+ };
110
+ }
@@ -0,0 +1,120 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { SearchMemoriesInput, SearchMemoriesOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link SearchMemoriesCommand}.
11
+ */
12
+ export interface SearchMemoriesCommandInput extends SearchMemoriesInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link SearchMemoriesCommand}.
18
+ */
19
+ export interface SearchMemoriesCommandOutput extends SearchMemoriesOutput, __MetadataBearer {
20
+ }
21
+ declare const SearchMemoriesCommand_base: {
22
+ new (input: SearchMemoriesCommandInput): import("@smithy/core/client").CommandImpl<SearchMemoriesCommandInput, SearchMemoriesCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: SearchMemoriesCommandInput): import("@smithy/core/client").CommandImpl<SearchMemoriesCommandInput, SearchMemoriesCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Searches a space's memories by relevance. The query is a subset of the OpenSearch Query DSL. The service validates it, limits the search to the requested strategies and to the actor in <code>actorId</code>, and returns one ranked list of memories. You can page through only a limited number of results. A request past that limit fails with <code>ValidationException</code> (reason <code>invalidNextToken</code>), and the message gives the limit.</p> <p>Memories past their expiry (set from the space's <code>memoryExpiryDays</code> when each memory is written) are left out of the results. Only current memories are returned: a memory that consolidation has superseded (an older version of a fact that a newer memory replaced) is left out.</p> <p>If the results are larger than 5 MiB, the request fails with <code>ValidationException</code> (reason <code>queryBodyTooLarge</code>). Lower <code>maxResults</code>.</p> <p>If 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, SearchMemoriesCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
32
+ * // const { OpenSearchMemoryClient, SearchMemoriesCommand } = 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 = { // SearchMemoriesInput
37
+ * spaceId: "STRING_VALUE", // required
38
+ * memoryStrategies: [ // StrategySelectorList
39
+ * { // StrategySelector
40
+ * memoryType: "SEMANTIC" || "SUMMARY" || "CUSTOM", // required
41
+ * memoryStrategyNames: [ // StrategyNameList
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * },
45
+ * ],
46
+ * actorId: "STRING_VALUE", // required
47
+ * query: "DOCUMENT_VALUE", // required
48
+ * sort: "DOCUMENT_VALUE",
49
+ * maxResults: Number("int"),
50
+ * nextToken: "STRING_VALUE",
51
+ * };
52
+ * const command = new SearchMemoriesCommand(input);
53
+ * const response = await client.send(command);
54
+ * // { // SearchMemoriesOutput
55
+ * // memories: [ // MemorySearchSummaryList // required
56
+ * // { // MemorySearchSummary
57
+ * // memoryId: "STRING_VALUE", // required
58
+ * // memoryType: "SEMANTIC" || "SUMMARY" || "CUSTOM",
59
+ * // strategyName: "STRING_VALUE",
60
+ * // content: "STRING_VALUE",
61
+ * // score: Number("double"),
62
+ * // systemMetadata: { // SystemMetadata
63
+ * // actorId: "STRING_VALUE",
64
+ * // sessionId: "STRING_VALUE",
65
+ * // createdAt: new Date("TIMESTAMP"),
66
+ * // updatedAt: new Date("TIMESTAMP"),
67
+ * // },
68
+ * // metadata: { // MetadataMap
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // sourceEventIds: [ // SourceEventIdList
72
+ * // "STRING_VALUE",
73
+ * // ],
74
+ * // },
75
+ * // ],
76
+ * // nextToken: "STRING_VALUE",
77
+ * // };
78
+ *
79
+ * ```
80
+ *
81
+ * @param SearchMemoriesCommandInput - {@link SearchMemoriesCommandInput}
82
+ * @returns {@link SearchMemoriesCommandOutput}
83
+ * @see {@link SearchMemoriesCommandInput} for command's `input` shape.
84
+ * @see {@link SearchMemoriesCommandOutput} for command's `response` shape.
85
+ * @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
86
+ *
87
+ * @throws {@link AccessDeniedException} (client fault)
88
+ * <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>
89
+ *
90
+ * @throws {@link InternalServerException} (server fault)
91
+ * <p>The service couldn't process the request because of an internal error. Retry the request.</p>
92
+ *
93
+ * @throws {@link ResourceNotFoundException} (client fault)
94
+ * <p>The specified resource doesn't exist. Check the IDs in the request.</p>
95
+ *
96
+ * @throws {@link ThrottlingException} (client fault)
97
+ * <p>The service throttled the request. Retry the request with exponential backoff.</p>
98
+ *
99
+ * @throws {@link ValidationException} (client fault)
100
+ * <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>
101
+ *
102
+ * @throws {@link OpenSearchMemoryServiceException}
103
+ * <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
104
+ *
105
+ *
106
+ * @public
107
+ */
108
+ export declare class SearchMemoriesCommand extends SearchMemoriesCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: SearchMemoriesInput;
113
+ output: SearchMemoriesOutput;
114
+ };
115
+ sdk: {
116
+ input: SearchMemoriesCommandInput;
117
+ output: SearchMemoriesCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -0,0 +1,90 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { TagResourceRequest, TagResourceResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link TagResourceCommand}.
11
+ */
12
+ export interface TagResourceCommandInput extends TagResourceRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link TagResourceCommand}.
18
+ */
19
+ export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
20
+ }
21
+ declare const TagResourceCommand_base: {
22
+ new (input: TagResourceCommandInput): import("@smithy/core/client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: TagResourceCommandInput): import("@smithy/core/client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, import("..").OpenSearchMemoryClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Adds the specified tags to 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, TagResourceCommand } from "@aws-sdk/client-opensearchmemory"; // ES Modules import
32
+ * // const { OpenSearchMemoryClient, TagResourceCommand } = 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 = { // TagResourceRequest
37
+ * resourceArn: "STRING_VALUE", // required
38
+ * tags: [ // TagList // required
39
+ * { // Tag
40
+ * key: "STRING_VALUE", // required
41
+ * value: "STRING_VALUE", // required
42
+ * },
43
+ * ],
44
+ * };
45
+ * const command = new TagResourceCommand(input);
46
+ * const response = await client.send(command);
47
+ * // {};
48
+ *
49
+ * ```
50
+ *
51
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
52
+ * @returns {@link TagResourceCommandOutput}
53
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
54
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
55
+ * @see {@link OpenSearchMemoryClientResolvedConfig | config} for OpenSearchMemoryClient's `config` shape.
56
+ *
57
+ * @throws {@link AccessDeniedException} (client fault)
58
+ * <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>
59
+ *
60
+ * @throws {@link InternalServerException} (server fault)
61
+ * <p>The service couldn't process the request because of an internal error. Retry the request.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The specified resource doesn't exist. Check the IDs in the request.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (client fault)
67
+ * <p>The service throttled the request. Retry the request with exponential backoff.</p>
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ * <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>
71
+ *
72
+ * @throws {@link OpenSearchMemoryServiceException}
73
+ * <p>Base exception class for all service exceptions from OpenSearchMemory service.</p>
74
+ *
75
+ *
76
+ * @public
77
+ */
78
+ export declare class TagResourceCommand extends TagResourceCommand_base {
79
+ /** @internal type navigation helper, not in runtime. */
80
+ protected static __types: {
81
+ api: {
82
+ input: TagResourceRequest;
83
+ output: {};
84
+ };
85
+ sdk: {
86
+ input: TagResourceCommandInput;
87
+ output: TagResourceCommandOutput;
88
+ };
89
+ };
90
+ }