aws-sdk-opensearchmemory 1.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-opensearchmemory/client.rb +2227 -0
- data/lib/aws-sdk-opensearchmemory/client_api.rb +932 -0
- data/lib/aws-sdk-opensearchmemory/customizations.rb +0 -0
- data/lib/aws-sdk-opensearchmemory/endpoint_parameters.rb +70 -0
- data/lib/aws-sdk-opensearchmemory/endpoint_provider.rb +36 -0
- data/lib/aws-sdk-opensearchmemory/endpoints.rb +155 -0
- data/lib/aws-sdk-opensearchmemory/errors.rb +207 -0
- data/lib/aws-sdk-opensearchmemory/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-opensearchmemory/resource.rb +26 -0
- data/lib/aws-sdk-opensearchmemory/types.rb +2283 -0
- data/lib/aws-sdk-opensearchmemory/waiters.rb +207 -0
- data/lib/aws-sdk-opensearchmemory.rb +62 -0
- data/sig/client.rbs +451 -0
- data/sig/errors.rbs +46 -0
- data/sig/params.rbs +30 -0
- data/sig/resource.rbs +87 -0
- data/sig/types.rbs +588 -0
- data/sig/waiters.rbs +33 -0
- metadata +98 -0
|
@@ -0,0 +1,2283 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
|
4
|
+
#
|
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
|
+
#
|
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
|
9
|
+
|
|
10
|
+
module Aws::OpenSearchMemory
|
|
11
|
+
module Types
|
|
12
|
+
|
|
13
|
+
# You don't have sufficient access to perform this operation. To use
|
|
14
|
+
# this operation, you must have AWS Identity and Access Management (IAM)
|
|
15
|
+
# permissions for the operation, and on the resource it acts on. If the
|
|
16
|
+
# space uses a customer managed AWS Key Management Service (AWS KMS)
|
|
17
|
+
# key, you must also have permission to use the key.
|
|
18
|
+
#
|
|
19
|
+
# @!attribute [rw] message
|
|
20
|
+
# A message that describes which access the request is missing.
|
|
21
|
+
# @return [String]
|
|
22
|
+
#
|
|
23
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/AccessDeniedException AWS API Documentation
|
|
24
|
+
#
|
|
25
|
+
class AccessDeniedException < Struct.new(
|
|
26
|
+
:message)
|
|
27
|
+
SENSITIVE = []
|
|
28
|
+
include Aws::Structure
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# A requested event that the call didn't return, and the reason.
|
|
32
|
+
#
|
|
33
|
+
# @!attribute [rw] event_id
|
|
34
|
+
# The ID of the requested event.
|
|
35
|
+
# @return [String]
|
|
36
|
+
#
|
|
37
|
+
# @!attribute [rw] error_code
|
|
38
|
+
# The reason that the call didn't return the event.
|
|
39
|
+
# @return [String]
|
|
40
|
+
#
|
|
41
|
+
# @!attribute [rw] message
|
|
42
|
+
# A human-readable description.
|
|
43
|
+
# @return [String]
|
|
44
|
+
#
|
|
45
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/BatchGetEventError AWS API Documentation
|
|
46
|
+
#
|
|
47
|
+
class BatchGetEventError < Struct.new(
|
|
48
|
+
:event_id,
|
|
49
|
+
:error_code,
|
|
50
|
+
:message)
|
|
51
|
+
SENSITIVE = []
|
|
52
|
+
include Aws::Structure
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# @!attribute [rw] space_id
|
|
56
|
+
# The ID of the space.
|
|
57
|
+
# @return [String]
|
|
58
|
+
#
|
|
59
|
+
# @!attribute [rw] actor_id
|
|
60
|
+
# The actor that every requested event must belong to. Omit it to skip
|
|
61
|
+
# this check. The operation reports an event that doesn't match in
|
|
62
|
+
# `errors` as `RESOURCE_NOT_FOUND`.
|
|
63
|
+
# @return [String]
|
|
64
|
+
#
|
|
65
|
+
# @!attribute [rw] session_id
|
|
66
|
+
# The session that every requested event must belong to. Omit it to
|
|
67
|
+
# skip this check. The operation reports an event that doesn't match
|
|
68
|
+
# in `errors` as `RESOURCE_NOT_FOUND`.
|
|
69
|
+
# @return [String]
|
|
70
|
+
#
|
|
71
|
+
# @!attribute [rw] event_ids
|
|
72
|
+
# The IDs of the events to get: 1 to 10, without duplicates.
|
|
73
|
+
# @return [Array<String>]
|
|
74
|
+
#
|
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/BatchGetEventInput AWS API Documentation
|
|
76
|
+
#
|
|
77
|
+
class BatchGetEventInput < Struct.new(
|
|
78
|
+
:space_id,
|
|
79
|
+
:actor_id,
|
|
80
|
+
:session_id,
|
|
81
|
+
:event_ids)
|
|
82
|
+
SENSITIVE = []
|
|
83
|
+
include Aws::Structure
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# @!attribute [rw] events
|
|
87
|
+
# The events found, in the order that you requested their IDs.
|
|
88
|
+
# @return [Array<Types::Event>]
|
|
89
|
+
#
|
|
90
|
+
# @!attribute [rw] errors
|
|
91
|
+
# An entry for each requested event that the call didn't return.
|
|
92
|
+
# Empty when the call returned every event.
|
|
93
|
+
# @return [Array<Types::BatchGetEventError>]
|
|
94
|
+
#
|
|
95
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/BatchGetEventOutput AWS API Documentation
|
|
96
|
+
#
|
|
97
|
+
class BatchGetEventOutput < Struct.new(
|
|
98
|
+
:events,
|
|
99
|
+
:errors)
|
|
100
|
+
SENSITIVE = []
|
|
101
|
+
include Aws::Structure
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# A document stored in Amazon S3, such as a PDF, and its media type.
|
|
105
|
+
#
|
|
106
|
+
# @!attribute [rw] content_type
|
|
107
|
+
# The document's media type. Only `application/pdf` is supported. Any
|
|
108
|
+
# other value fails with `ValidationException`.
|
|
109
|
+
# @return [String]
|
|
110
|
+
#
|
|
111
|
+
# @!attribute [rw] source
|
|
112
|
+
# The location of the document.
|
|
113
|
+
# @return [Types::BlobSource]
|
|
114
|
+
#
|
|
115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/BlobPayload AWS API Documentation
|
|
116
|
+
#
|
|
117
|
+
class BlobPayload < Struct.new(
|
|
118
|
+
:content_type,
|
|
119
|
+
:source)
|
|
120
|
+
SENSITIVE = [:source]
|
|
121
|
+
include Aws::Structure
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# The source of a blob's content. Set exactly one member. Currently,
|
|
125
|
+
# the only member is `s3Location`.
|
|
126
|
+
#
|
|
127
|
+
# @note BlobSource is a union - when making an API calls you must set exactly one of the members.
|
|
128
|
+
#
|
|
129
|
+
# @note BlobSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of BlobSource corresponding to the set member.
|
|
130
|
+
#
|
|
131
|
+
# @!attribute [rw] s3_location
|
|
132
|
+
# The S3 object holding the document.
|
|
133
|
+
# @return [Types::S3Location]
|
|
134
|
+
#
|
|
135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/BlobSource AWS API Documentation
|
|
136
|
+
#
|
|
137
|
+
class BlobSource < Struct.new(
|
|
138
|
+
:s3_location,
|
|
139
|
+
:unknown)
|
|
140
|
+
SENSITIVE = []
|
|
141
|
+
include Aws::Structure
|
|
142
|
+
include Aws::Structure::Union
|
|
143
|
+
|
|
144
|
+
class S3Location < BlobSource; end
|
|
145
|
+
class Unknown < BlobSource; end
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# The request conflicts with the current state of the resource. For
|
|
149
|
+
# example, the space is being created, updated, or deleted, a space with
|
|
150
|
+
# the same name already exists, or you reused a client token with
|
|
151
|
+
# different parameters. Wait for the space to finish being created,
|
|
152
|
+
# updated, or deleted, or use a different name or client token, and then
|
|
153
|
+
# retry.
|
|
154
|
+
#
|
|
155
|
+
# @!attribute [rw] message
|
|
156
|
+
# A message that describes the conflict.
|
|
157
|
+
# @return [String]
|
|
158
|
+
#
|
|
159
|
+
# @!attribute [rw] resource_id
|
|
160
|
+
# The ID of the resource that caused the conflict.
|
|
161
|
+
# @return [String]
|
|
162
|
+
#
|
|
163
|
+
# @!attribute [rw] resource_type
|
|
164
|
+
# The type of the resource that caused the conflict.
|
|
165
|
+
# @return [String]
|
|
166
|
+
#
|
|
167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ConflictException AWS API Documentation
|
|
168
|
+
#
|
|
169
|
+
class ConflictException < Struct.new(
|
|
170
|
+
:message,
|
|
171
|
+
:resource_id,
|
|
172
|
+
:resource_type)
|
|
173
|
+
SENSITIVE = []
|
|
174
|
+
include Aws::Structure
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Conversational content. Exactly one member is set.
|
|
178
|
+
#
|
|
179
|
+
# @note ConversationalPayload is a union - when making an API calls you must set exactly one of the members.
|
|
180
|
+
#
|
|
181
|
+
# @note ConversationalPayload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConversationalPayload corresponding to the set member.
|
|
182
|
+
#
|
|
183
|
+
# @!attribute [rw] unified
|
|
184
|
+
# Conversation turns in the service's own format.
|
|
185
|
+
# @return [Types::UnifiedConversational]
|
|
186
|
+
#
|
|
187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ConversationalPayload AWS API Documentation
|
|
188
|
+
#
|
|
189
|
+
class ConversationalPayload < Struct.new(
|
|
190
|
+
:unified,
|
|
191
|
+
:unknown)
|
|
192
|
+
SENSITIVE = []
|
|
193
|
+
include Aws::Structure
|
|
194
|
+
include Aws::Structure::Union
|
|
195
|
+
|
|
196
|
+
class Unified < ConversationalPayload; end
|
|
197
|
+
class Unknown < ConversationalPayload; end
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
# @!attribute [rw] space_id
|
|
201
|
+
# The ID of the space that owns the event, for example
|
|
202
|
+
# `sp-02864597b164`.
|
|
203
|
+
# @return [String]
|
|
204
|
+
#
|
|
205
|
+
# @!attribute [rw] actor_id
|
|
206
|
+
# The ID of the actor (end user or agent) that the event belongs to.
|
|
207
|
+
# @return [String]
|
|
208
|
+
#
|
|
209
|
+
# @!attribute [rw] session_id
|
|
210
|
+
# The session the event belongs to. Send every event of one
|
|
211
|
+
# conversation with the same session ID, so that `SUMMARY` strategies
|
|
212
|
+
# summarize the conversation as one session. If you omit it, the
|
|
213
|
+
# service generates a session ID and returns it.
|
|
214
|
+
# @return [String]
|
|
215
|
+
#
|
|
216
|
+
# @!attribute [rw] event_timestamp
|
|
217
|
+
# When the event occurred. The default is the time that the service
|
|
218
|
+
# receives the request.
|
|
219
|
+
# @return [Time]
|
|
220
|
+
#
|
|
221
|
+
# @!attribute [rw] payload
|
|
222
|
+
# The event content. Set exactly one union member.
|
|
223
|
+
# @return [Types::EventPayload]
|
|
224
|
+
#
|
|
225
|
+
# @!attribute [rw] metadata
|
|
226
|
+
# Metadata tags to store with the event. Memories derived from the
|
|
227
|
+
# event carry the same tags. Keys that begin with `x-amz-`, the keys
|
|
228
|
+
# `documentS3Source` and `documentS3Url`, and other keys that the
|
|
229
|
+
# service uses internally are reserved: a request that sets one fails
|
|
230
|
+
# with `ValidationException`, and the message names the key.
|
|
231
|
+
#
|
|
232
|
+
# A space can use at most 50 distinct metadata keys across all of its
|
|
233
|
+
# events and memories. A request that would add a key beyond that
|
|
234
|
+
# fails with `ValidationException`. Reuse an existing key instead.
|
|
235
|
+
# @return [Hash<String,String>]
|
|
236
|
+
#
|
|
237
|
+
# @!attribute [rw] client_token
|
|
238
|
+
# A unique, case-sensitive identifier that makes the request
|
|
239
|
+
# idempotent. Within 2 hours of the first request, a retry with the
|
|
240
|
+
# same token and the same request, including the same `sessionId`,
|
|
241
|
+
# returns the same event. If you omit `sessionId`, the service
|
|
242
|
+
# generates a new one on each attempt, so a retry fails with
|
|
243
|
+
# `ConflictException`. Reusing the token with different request
|
|
244
|
+
# content also fails with `ConflictException`. `eventTimestamp` isn't
|
|
245
|
+
# compared. After 2 hours, the token starts a new event.
|
|
246
|
+
#
|
|
247
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
248
|
+
# not need to pass this option.
|
|
249
|
+
# @return [String]
|
|
250
|
+
#
|
|
251
|
+
# @!attribute [rw] infer
|
|
252
|
+
# Specifies whether to extract memories from this event. The default
|
|
253
|
+
# is `true`. Set it to `false` to store the event without extraction:
|
|
254
|
+
# the service skips strategies that infer memories, and still indexes
|
|
255
|
+
# the event's turns for `SearchEvents`. A document submitted as a
|
|
256
|
+
# `blob` is still extracted.
|
|
257
|
+
# @return [Boolean]
|
|
258
|
+
#
|
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateEventInput AWS API Documentation
|
|
260
|
+
#
|
|
261
|
+
class CreateEventInput < Struct.new(
|
|
262
|
+
:space_id,
|
|
263
|
+
:actor_id,
|
|
264
|
+
:session_id,
|
|
265
|
+
:event_timestamp,
|
|
266
|
+
:payload,
|
|
267
|
+
:metadata,
|
|
268
|
+
:client_token,
|
|
269
|
+
:infer)
|
|
270
|
+
SENSITIVE = []
|
|
271
|
+
include Aws::Structure
|
|
272
|
+
end
|
|
273
|
+
|
|
274
|
+
# @!attribute [rw] event
|
|
275
|
+
# The stored event's identifiers: its ID, session, and timestamp.
|
|
276
|
+
# @return [Types::EventDetail]
|
|
277
|
+
#
|
|
278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateEventOutput AWS API Documentation
|
|
279
|
+
#
|
|
280
|
+
class CreateEventOutput < Struct.new(
|
|
281
|
+
:event)
|
|
282
|
+
SENSITIVE = []
|
|
283
|
+
include Aws::Structure
|
|
284
|
+
end
|
|
285
|
+
|
|
286
|
+
# The memory as `CreateMemory` acknowledges it: its identifiers. The
|
|
287
|
+
# memory isn't searchable yet when the call returns.
|
|
288
|
+
#
|
|
289
|
+
# @!attribute [rw] memory_id
|
|
290
|
+
# The final ID of the memory. Until the memory is indexed,
|
|
291
|
+
# `GetMemory`, `UpdateMemory`, and `DeleteMemory` return
|
|
292
|
+
# `ResourceNotFoundException` for it.
|
|
293
|
+
# @return [String]
|
|
294
|
+
#
|
|
295
|
+
# @!attribute [rw] space_id
|
|
296
|
+
# The ID of the space.
|
|
297
|
+
# @return [String]
|
|
298
|
+
#
|
|
299
|
+
# @!attribute [rw] name
|
|
300
|
+
# The name of the strategy the memory belongs to.
|
|
301
|
+
# @return [String]
|
|
302
|
+
#
|
|
303
|
+
# @!attribute [rw] actor_id
|
|
304
|
+
# The ID of the actor the memory belongs to.
|
|
305
|
+
# @return [String]
|
|
306
|
+
#
|
|
307
|
+
# @!attribute [rw] session_id
|
|
308
|
+
# The ID of the session the memory belongs to, including one the
|
|
309
|
+
# service generated.
|
|
310
|
+
# @return [String]
|
|
311
|
+
#
|
|
312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateMemoryDetail AWS API Documentation
|
|
313
|
+
#
|
|
314
|
+
class CreateMemoryDetail < Struct.new(
|
|
315
|
+
:memory_id,
|
|
316
|
+
:space_id,
|
|
317
|
+
:name,
|
|
318
|
+
:actor_id,
|
|
319
|
+
:session_id)
|
|
320
|
+
SENSITIVE = []
|
|
321
|
+
include Aws::Structure
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
# The request for `CreateMemory`.
|
|
325
|
+
#
|
|
326
|
+
# @!attribute [rw] space_id
|
|
327
|
+
# The ID of the space that owns the memory, for example
|
|
328
|
+
# `sp-02864597b164`.
|
|
329
|
+
# @return [String]
|
|
330
|
+
#
|
|
331
|
+
# @!attribute [rw] name
|
|
332
|
+
# The name of the strategy that the memory belongs to. The space must
|
|
333
|
+
# already declare the strategy, and the memory's type comes from that
|
|
334
|
+
# strategy. The name must be 1 to 64 characters: letters, digits,
|
|
335
|
+
# periods, hyphens, and underscores, starting with a letter or digit.
|
|
336
|
+
# @return [String]
|
|
337
|
+
#
|
|
338
|
+
# @!attribute [rw] content
|
|
339
|
+
# The memory text, stored and embedded as provided.
|
|
340
|
+
# @return [String]
|
|
341
|
+
#
|
|
342
|
+
# @!attribute [rw] actor_id
|
|
343
|
+
# The actor (end user or agent) that owns the memory.
|
|
344
|
+
# @return [String]
|
|
345
|
+
#
|
|
346
|
+
# @!attribute [rw] session_id
|
|
347
|
+
# The session that the memory belongs to. If you omit it, the service
|
|
348
|
+
# generates a session ID and returns it.
|
|
349
|
+
# @return [String]
|
|
350
|
+
#
|
|
351
|
+
# @!attribute [rw] metadata
|
|
352
|
+
# Metadata tags to store with the memory. Keys that begin with
|
|
353
|
+
# `x-amz-`, the key `documentS3Source`, and other keys that the
|
|
354
|
+
# service uses internally are reserved: a request that sets one fails
|
|
355
|
+
# with `ValidationException`, and the message names the key.
|
|
356
|
+
#
|
|
357
|
+
# A space can use at most 50 distinct metadata keys across all of its
|
|
358
|
+
# events and memories. A request that would add a key beyond that
|
|
359
|
+
# fails with `ValidationException`. Reuse an existing key instead.
|
|
360
|
+
# @return [Hash<String,String>]
|
|
361
|
+
#
|
|
362
|
+
# @!attribute [rw] client_token
|
|
363
|
+
# A unique, case-sensitive identifier that makes the request
|
|
364
|
+
# idempotent. Within 2 hours of the first request, a retry with the
|
|
365
|
+
# same token returns the same `memoryId` instead of creating a second
|
|
366
|
+
# memory. Reusing the token with a different `name`, `content`,
|
|
367
|
+
# `metadata`, `actorId`, or `sessionId` fails with
|
|
368
|
+
# `ConflictException`. If you omit `sessionId`, a retry with the same
|
|
369
|
+
# token gets the same session. If you omit the token, each call
|
|
370
|
+
# creates a new memory.
|
|
371
|
+
#
|
|
372
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
373
|
+
# not need to pass this option.
|
|
374
|
+
# @return [String]
|
|
375
|
+
#
|
|
376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateMemoryInput AWS API Documentation
|
|
377
|
+
#
|
|
378
|
+
class CreateMemoryInput < Struct.new(
|
|
379
|
+
:space_id,
|
|
380
|
+
:name,
|
|
381
|
+
:content,
|
|
382
|
+
:actor_id,
|
|
383
|
+
:session_id,
|
|
384
|
+
:metadata,
|
|
385
|
+
:client_token)
|
|
386
|
+
SENSITIVE = [:content]
|
|
387
|
+
include Aws::Structure
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# The acknowledged memory. It isn't searchable yet when the call
|
|
391
|
+
# returns.
|
|
392
|
+
#
|
|
393
|
+
# @!attribute [rw] memory
|
|
394
|
+
# The memory, identified but not yet indexed.
|
|
395
|
+
# @return [Types::CreateMemoryDetail]
|
|
396
|
+
#
|
|
397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateMemoryOutput AWS API Documentation
|
|
398
|
+
#
|
|
399
|
+
class CreateMemoryOutput < Struct.new(
|
|
400
|
+
:memory)
|
|
401
|
+
SENSITIVE = []
|
|
402
|
+
include Aws::Structure
|
|
403
|
+
end
|
|
404
|
+
|
|
405
|
+
# @!attribute [rw] name
|
|
406
|
+
# A name for the space, unique within your account in the Region. If
|
|
407
|
+
# another space already has the name, the request fails with
|
|
408
|
+
# `ConflictException`.
|
|
409
|
+
# @return [String]
|
|
410
|
+
#
|
|
411
|
+
# @!attribute [rw] memory_strategies
|
|
412
|
+
# The memory strategies that extract memories from the space's
|
|
413
|
+
# events: up to 10 strategies, each with a name that is unique within
|
|
414
|
+
# the space.
|
|
415
|
+
#
|
|
416
|
+
# Optional. Omit it, or send an empty list, to create a space with no
|
|
417
|
+
# memory strategies. Such a space stores the conversation events you
|
|
418
|
+
# send it and returns them through `SearchEvents` and `ListEvents`,
|
|
419
|
+
# but extracts no memories and has none to search. You can add
|
|
420
|
+
# strategies later with `UpdateSpace`.
|
|
421
|
+
#
|
|
422
|
+
# The serialized list can be at most 384 KiB.
|
|
423
|
+
# @return [Array<Types::MemoryStrategy>]
|
|
424
|
+
#
|
|
425
|
+
# @!attribute [rw] event_expiry_days
|
|
426
|
+
# How many days the space keeps each event, from 1 to 365. The default
|
|
427
|
+
# is 90.
|
|
428
|
+
# @return [Integer]
|
|
429
|
+
#
|
|
430
|
+
# @!attribute [rw] memory_expiry_days
|
|
431
|
+
# How many days the space keeps each memory, from 0 to 3650, counted
|
|
432
|
+
# from when the service writes the memory. Updating a memory with
|
|
433
|
+
# `UpdateMemory` doesn't restart the count. 0 means memories never
|
|
434
|
+
# expire. If you omit it, memories never expire.
|
|
435
|
+
#
|
|
436
|
+
# Searches and lists leave out a memory past its expiry, and reading,
|
|
437
|
+
# updating, or deleting it returns `ResourceNotFoundException`.
|
|
438
|
+
# @return [Integer]
|
|
439
|
+
#
|
|
440
|
+
# @!attribute [rw] extraction_model_id
|
|
441
|
+
# The model that extracts and consolidates memories for every strategy
|
|
442
|
+
# in the space, as an Amazon Bedrock model ID without an
|
|
443
|
+
# inference-profile prefix: `anthropic.claude-opus-5-5` or
|
|
444
|
+
# `anthropic.claude-haiku-5-5`. Another value fails with
|
|
445
|
+
# `ValidationException`, and the message lists the supported IDs. Omit
|
|
446
|
+
# it to use the service default, which can change over time and isn't
|
|
447
|
+
# returned by `GetSpace`. Setting a value pins the model.
|
|
448
|
+
# @return [String]
|
|
449
|
+
#
|
|
450
|
+
# @!attribute [rw] encryption_configuration
|
|
451
|
+
# The AWS KMS key that encrypts the space's data. Omit it, or omit
|
|
452
|
+
# its `kmsKeyArn`, to use an AWS owned key. You can't change the key
|
|
453
|
+
# after you create the space.
|
|
454
|
+
# @return [Types::EncryptionConfiguration]
|
|
455
|
+
#
|
|
456
|
+
# @!attribute [rw] tags
|
|
457
|
+
# The tags to add to the space.
|
|
458
|
+
# @return [Array<Types::Tag>]
|
|
459
|
+
#
|
|
460
|
+
# @!attribute [rw] client_token
|
|
461
|
+
# A unique, case-sensitive identifier that makes the request
|
|
462
|
+
# idempotent. A retry with the same token and the same parameters
|
|
463
|
+
# within 2 hours returns the space that the first request created,
|
|
464
|
+
# instead of creating another. Reusing the token with different
|
|
465
|
+
# parameters, or while the first request is still in progress, fails
|
|
466
|
+
# with `ConflictException`.
|
|
467
|
+
#
|
|
468
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
469
|
+
# not need to pass this option.
|
|
470
|
+
# @return [String]
|
|
471
|
+
#
|
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateSpaceRequest AWS API Documentation
|
|
473
|
+
#
|
|
474
|
+
class CreateSpaceRequest < Struct.new(
|
|
475
|
+
:name,
|
|
476
|
+
:memory_strategies,
|
|
477
|
+
:event_expiry_days,
|
|
478
|
+
:memory_expiry_days,
|
|
479
|
+
:extraction_model_id,
|
|
480
|
+
:encryption_configuration,
|
|
481
|
+
:tags,
|
|
482
|
+
:client_token)
|
|
483
|
+
SENSITIVE = []
|
|
484
|
+
include Aws::Structure
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
# @!attribute [rw] space_id
|
|
488
|
+
# The ID of the space.
|
|
489
|
+
# @return [String]
|
|
490
|
+
#
|
|
491
|
+
# @!attribute [rw] arn
|
|
492
|
+
# The Amazon Resource Name (ARN) of the space.
|
|
493
|
+
# @return [String]
|
|
494
|
+
#
|
|
495
|
+
# @!attribute [rw] name
|
|
496
|
+
# The name of the space.
|
|
497
|
+
# @return [String]
|
|
498
|
+
#
|
|
499
|
+
# @!attribute [rw] status
|
|
500
|
+
# The status of the space: `CREATING`.
|
|
501
|
+
# @return [String]
|
|
502
|
+
#
|
|
503
|
+
# @!attribute [rw] created_at
|
|
504
|
+
# When the space was created.
|
|
505
|
+
# @return [Time]
|
|
506
|
+
#
|
|
507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/CreateSpaceResponse AWS API Documentation
|
|
508
|
+
#
|
|
509
|
+
class CreateSpaceResponse < Struct.new(
|
|
510
|
+
:space_id,
|
|
511
|
+
:arn,
|
|
512
|
+
:name,
|
|
513
|
+
:status,
|
|
514
|
+
:created_at)
|
|
515
|
+
SENSITIVE = []
|
|
516
|
+
include Aws::Structure
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
# @!attribute [rw] space_id
|
|
520
|
+
# The ID of the space.
|
|
521
|
+
# @return [String]
|
|
522
|
+
#
|
|
523
|
+
# @!attribute [rw] event_id
|
|
524
|
+
# The ID of the event to delete.
|
|
525
|
+
# @return [String]
|
|
526
|
+
#
|
|
527
|
+
# @!attribute [rw] actor_id
|
|
528
|
+
# The actor that the event must belong to. Omit it to skip this check.
|
|
529
|
+
# If it doesn't match the stored event, the call fails with
|
|
530
|
+
# `ResourceNotFoundException`, as if the event did not exist.
|
|
531
|
+
# @return [String]
|
|
532
|
+
#
|
|
533
|
+
# @!attribute [rw] session_id
|
|
534
|
+
# The session that the event must belong to. Omit it to skip this
|
|
535
|
+
# check. If it doesn't match the stored event, the call fails with
|
|
536
|
+
# `ResourceNotFoundException`, as if the event did not exist.
|
|
537
|
+
# @return [String]
|
|
538
|
+
#
|
|
539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/DeleteEventInput AWS API Documentation
|
|
540
|
+
#
|
|
541
|
+
class DeleteEventInput < Struct.new(
|
|
542
|
+
:space_id,
|
|
543
|
+
:event_id,
|
|
544
|
+
:actor_id,
|
|
545
|
+
:session_id)
|
|
546
|
+
SENSITIVE = []
|
|
547
|
+
include Aws::Structure
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
# @!attribute [rw] event_id
|
|
551
|
+
# The ID of the deleted event.
|
|
552
|
+
# @return [String]
|
|
553
|
+
#
|
|
554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/DeleteEventOutput AWS API Documentation
|
|
555
|
+
#
|
|
556
|
+
class DeleteEventOutput < Struct.new(
|
|
557
|
+
:event_id)
|
|
558
|
+
SENSITIVE = []
|
|
559
|
+
include Aws::Structure
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
# @!attribute [rw] space_id
|
|
563
|
+
# The ID of the space that owns the memory.
|
|
564
|
+
# @return [String]
|
|
565
|
+
#
|
|
566
|
+
# @!attribute [rw] memory_id
|
|
567
|
+
# The ID of the memory to delete.
|
|
568
|
+
# @return [String]
|
|
569
|
+
#
|
|
570
|
+
# @!attribute [rw] actor_id
|
|
571
|
+
# The ID of the actor that the memory must belong to. Omit it to skip
|
|
572
|
+
# this check. If it doesn't match the stored memory, the call fails
|
|
573
|
+
# with `ResourceNotFoundException`, as if the memory did not exist.
|
|
574
|
+
# @return [String]
|
|
575
|
+
#
|
|
576
|
+
# @!attribute [rw] strategy_name
|
|
577
|
+
# The name of the strategy that the memory must belong to. Omit it to
|
|
578
|
+
# skip this check. If it doesn't match the stored memory, the call
|
|
579
|
+
# fails with `ResourceNotFoundException`, as if the memory did not
|
|
580
|
+
# exist.
|
|
581
|
+
# @return [String]
|
|
582
|
+
#
|
|
583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/DeleteMemoryInput AWS API Documentation
|
|
584
|
+
#
|
|
585
|
+
class DeleteMemoryInput < Struct.new(
|
|
586
|
+
:space_id,
|
|
587
|
+
:memory_id,
|
|
588
|
+
:actor_id,
|
|
589
|
+
:strategy_name)
|
|
590
|
+
SENSITIVE = []
|
|
591
|
+
include Aws::Structure
|
|
592
|
+
end
|
|
593
|
+
|
|
594
|
+
# @!attribute [rw] memory_id
|
|
595
|
+
# The ID of the deleted memory.
|
|
596
|
+
# @return [String]
|
|
597
|
+
#
|
|
598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/DeleteMemoryOutput AWS API Documentation
|
|
599
|
+
#
|
|
600
|
+
class DeleteMemoryOutput < Struct.new(
|
|
601
|
+
:memory_id)
|
|
602
|
+
SENSITIVE = []
|
|
603
|
+
include Aws::Structure
|
|
604
|
+
end
|
|
605
|
+
|
|
606
|
+
# @!attribute [rw] space_id
|
|
607
|
+
# The ID of the space to delete.
|
|
608
|
+
# @return [String]
|
|
609
|
+
#
|
|
610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/DeleteSpaceRequest AWS API Documentation
|
|
611
|
+
#
|
|
612
|
+
class DeleteSpaceRequest < Struct.new(
|
|
613
|
+
:space_id)
|
|
614
|
+
SENSITIVE = []
|
|
615
|
+
include Aws::Structure
|
|
616
|
+
end
|
|
617
|
+
|
|
618
|
+
# @!attribute [rw] space_id
|
|
619
|
+
# The ID of the space.
|
|
620
|
+
# @return [String]
|
|
621
|
+
#
|
|
622
|
+
# @!attribute [rw] status
|
|
623
|
+
# The status of the space: `DELETING`.
|
|
624
|
+
# @return [String]
|
|
625
|
+
#
|
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/DeleteSpaceResponse AWS API Documentation
|
|
627
|
+
#
|
|
628
|
+
class DeleteSpaceResponse < Struct.new(
|
|
629
|
+
:space_id,
|
|
630
|
+
:status)
|
|
631
|
+
SENSITIVE = []
|
|
632
|
+
include Aws::Structure
|
|
633
|
+
end
|
|
634
|
+
|
|
635
|
+
# Encryption settings for a space.
|
|
636
|
+
#
|
|
637
|
+
# @!attribute [rw] kms_key_arn
|
|
638
|
+
# The ARN of a customer managed AWS KMS key that encrypts the space's
|
|
639
|
+
# data. The key must be an enabled symmetric encryption key in the
|
|
640
|
+
# space's Region, and you need permission to create grants on it
|
|
641
|
+
# (`kms:CreateGrant`). Otherwise, the request fails with
|
|
642
|
+
# `ValidationException` or `AccessDeniedException`.
|
|
643
|
+
# @return [String]
|
|
644
|
+
#
|
|
645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/EncryptionConfiguration AWS API Documentation
|
|
646
|
+
#
|
|
647
|
+
class EncryptionConfiguration < Struct.new(
|
|
648
|
+
:kms_key_arn)
|
|
649
|
+
SENSITIVE = []
|
|
650
|
+
include Aws::Structure
|
|
651
|
+
end
|
|
652
|
+
|
|
653
|
+
# An event, including its payload.
|
|
654
|
+
#
|
|
655
|
+
# @!attribute [rw] event_id
|
|
656
|
+
# The event's ID.
|
|
657
|
+
# @return [String]
|
|
658
|
+
#
|
|
659
|
+
# @!attribute [rw] space_id
|
|
660
|
+
# The ID of the space.
|
|
661
|
+
# @return [String]
|
|
662
|
+
#
|
|
663
|
+
# @!attribute [rw] actor_id
|
|
664
|
+
# The ID of the actor the event belongs to.
|
|
665
|
+
# @return [String]
|
|
666
|
+
#
|
|
667
|
+
# @!attribute [rw] session_id
|
|
668
|
+
# The ID of the session the event belongs to.
|
|
669
|
+
# @return [String]
|
|
670
|
+
#
|
|
671
|
+
# @!attribute [rw] payload
|
|
672
|
+
# The event's content, as submitted to `CreateEvent`.
|
|
673
|
+
# @return [Types::EventPayload]
|
|
674
|
+
#
|
|
675
|
+
# @!attribute [rw] metadata
|
|
676
|
+
# The event's metadata tags, as supplied to `CreateEvent`. May be
|
|
677
|
+
# empty.
|
|
678
|
+
# @return [Hash<String,String>]
|
|
679
|
+
#
|
|
680
|
+
# @!attribute [rw] event_timestamp
|
|
681
|
+
# The time the event occurred.
|
|
682
|
+
# @return [Time]
|
|
683
|
+
#
|
|
684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/Event AWS API Documentation
|
|
685
|
+
#
|
|
686
|
+
class Event < Struct.new(
|
|
687
|
+
:event_id,
|
|
688
|
+
:space_id,
|
|
689
|
+
:actor_id,
|
|
690
|
+
:session_id,
|
|
691
|
+
:payload,
|
|
692
|
+
:metadata,
|
|
693
|
+
:event_timestamp)
|
|
694
|
+
SENSITIVE = []
|
|
695
|
+
include Aws::Structure
|
|
696
|
+
end
|
|
697
|
+
|
|
698
|
+
# The stored event's identifiers. Call `GetEvent` for the payload.
|
|
699
|
+
#
|
|
700
|
+
# @!attribute [rw] event_id
|
|
701
|
+
# The event's ID, assigned by the service. Use it with `GetEvent` and
|
|
702
|
+
# `DeleteEvent`.
|
|
703
|
+
# @return [String]
|
|
704
|
+
#
|
|
705
|
+
# @!attribute [rw] space_id
|
|
706
|
+
# The ID of the space.
|
|
707
|
+
# @return [String]
|
|
708
|
+
#
|
|
709
|
+
# @!attribute [rw] actor_id
|
|
710
|
+
# The ID of the actor the event belongs to.
|
|
711
|
+
# @return [String]
|
|
712
|
+
#
|
|
713
|
+
# @!attribute [rw] session_id
|
|
714
|
+
# The ID of the session the event belongs to, including one the
|
|
715
|
+
# service generated.
|
|
716
|
+
# @return [String]
|
|
717
|
+
#
|
|
718
|
+
# @!attribute [rw] event_timestamp
|
|
719
|
+
# When the event occurred: the value supplied, or the time the request
|
|
720
|
+
# was received.
|
|
721
|
+
# @return [Time]
|
|
722
|
+
#
|
|
723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/EventDetail AWS API Documentation
|
|
724
|
+
#
|
|
725
|
+
class EventDetail < Struct.new(
|
|
726
|
+
:event_id,
|
|
727
|
+
:space_id,
|
|
728
|
+
:actor_id,
|
|
729
|
+
:session_id,
|
|
730
|
+
:event_timestamp)
|
|
731
|
+
SENSITIVE = []
|
|
732
|
+
include Aws::Structure
|
|
733
|
+
end
|
|
734
|
+
|
|
735
|
+
# The event content. Exactly one member must be set.
|
|
736
|
+
#
|
|
737
|
+
# @note EventPayload is a union - when making an API calls you must set exactly one of the members.
|
|
738
|
+
#
|
|
739
|
+
# @note EventPayload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EventPayload corresponding to the set member.
|
|
740
|
+
#
|
|
741
|
+
# @!attribute [rw] conversational
|
|
742
|
+
# Conversation turns.
|
|
743
|
+
# @return [Types::ConversationalPayload]
|
|
744
|
+
#
|
|
745
|
+
# @!attribute [rw] structured_data
|
|
746
|
+
# Structured (non-conversational) content, for example a deployment
|
|
747
|
+
# result that an agent should remember.
|
|
748
|
+
# @return [Types::StructuredDataPayload]
|
|
749
|
+
#
|
|
750
|
+
# @!attribute [rw] blob
|
|
751
|
+
# A document stored in Amazon S3, such as a PDF.
|
|
752
|
+
# @return [Types::BlobPayload]
|
|
753
|
+
#
|
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/EventPayload AWS API Documentation
|
|
755
|
+
#
|
|
756
|
+
class EventPayload < Struct.new(
|
|
757
|
+
:conversational,
|
|
758
|
+
:structured_data,
|
|
759
|
+
:blob,
|
|
760
|
+
:unknown)
|
|
761
|
+
SENSITIVE = []
|
|
762
|
+
include Aws::Structure
|
|
763
|
+
include Aws::Structure::Union
|
|
764
|
+
|
|
765
|
+
class Conversational < EventPayload; end
|
|
766
|
+
class StructuredData < EventPayload; end
|
|
767
|
+
class Blob < EventPayload; end
|
|
768
|
+
class Unknown < EventPayload; end
|
|
769
|
+
end
|
|
770
|
+
|
|
771
|
+
# A `SearchEvents` result: the matching chunk of an event and its
|
|
772
|
+
# provenance. Unlike `EventSummary` from `ListEvents`, it has a
|
|
773
|
+
# relevance score and the matched content, but not the full payload.
|
|
774
|
+
#
|
|
775
|
+
# @!attribute [rw] event_id
|
|
776
|
+
# The ID of the event that the chunk belongs to. Use it with
|
|
777
|
+
# `GetEvent` or `DeleteEvent`.
|
|
778
|
+
# @return [String]
|
|
779
|
+
#
|
|
780
|
+
# @!attribute [rw] score
|
|
781
|
+
# The relevance score of the result. A higher score is more relevant.
|
|
782
|
+
# Scores aren't normalized to a fixed range and can be greater than
|
|
783
|
+
# 1, so use them only to order results.
|
|
784
|
+
# @return [Float]
|
|
785
|
+
#
|
|
786
|
+
# @!attribute [rw] system_metadata
|
|
787
|
+
# Provenance for the chunk: the owning actor and session, and when it
|
|
788
|
+
# was created and last updated. It is the same block that
|
|
789
|
+
# `ListMemories` and `SearchMemories` return. Event chunks are never
|
|
790
|
+
# modified, so `updatedAt` always equals `createdAt`.
|
|
791
|
+
#
|
|
792
|
+
# Absent when the service has no provenance for the chunk.
|
|
793
|
+
# @return [Types::SystemMetadata]
|
|
794
|
+
#
|
|
795
|
+
# @!attribute [rw] metadata
|
|
796
|
+
# The event's metadata tags. All values are strings. In a query,
|
|
797
|
+
# filter on a tag as `metadata.<key>`.
|
|
798
|
+
# @return [Hash<String,String>]
|
|
799
|
+
#
|
|
800
|
+
# @!attribute [rw] matched_content
|
|
801
|
+
# The text of the matching chunk.
|
|
802
|
+
# @return [String]
|
|
803
|
+
#
|
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/EventSearchSummary AWS API Documentation
|
|
805
|
+
#
|
|
806
|
+
class EventSearchSummary < Struct.new(
|
|
807
|
+
:event_id,
|
|
808
|
+
:score,
|
|
809
|
+
:system_metadata,
|
|
810
|
+
:metadata,
|
|
811
|
+
:matched_content)
|
|
812
|
+
SENSITIVE = [:matched_content]
|
|
813
|
+
include Aws::Structure
|
|
814
|
+
end
|
|
815
|
+
|
|
816
|
+
# A summary of an event, as returned by `ListEvents`. It doesn't
|
|
817
|
+
# include the payload.
|
|
818
|
+
#
|
|
819
|
+
# @!attribute [rw] event_id
|
|
820
|
+
# The event's ID.
|
|
821
|
+
# @return [String]
|
|
822
|
+
#
|
|
823
|
+
# @!attribute [rw] metadata
|
|
824
|
+
# The event's metadata tags, as supplied to `CreateEvent`. May be
|
|
825
|
+
# empty.
|
|
826
|
+
# @return [Hash<String,String>]
|
|
827
|
+
#
|
|
828
|
+
# @!attribute [rw] event_timestamp
|
|
829
|
+
# The time the event occurred.
|
|
830
|
+
# @return [Time]
|
|
831
|
+
#
|
|
832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/EventSummary AWS API Documentation
|
|
833
|
+
#
|
|
834
|
+
class EventSummary < Struct.new(
|
|
835
|
+
:event_id,
|
|
836
|
+
:metadata,
|
|
837
|
+
:event_timestamp)
|
|
838
|
+
SENSITIVE = []
|
|
839
|
+
include Aws::Structure
|
|
840
|
+
end
|
|
841
|
+
|
|
842
|
+
# @!attribute [rw] space_id
|
|
843
|
+
# The ID of the space.
|
|
844
|
+
# @return [String]
|
|
845
|
+
#
|
|
846
|
+
# @!attribute [rw] event_id
|
|
847
|
+
# The event's ID, as returned by `CreateEvent`, `ListEvents`, or
|
|
848
|
+
# `SearchEvents`.
|
|
849
|
+
# @return [String]
|
|
850
|
+
#
|
|
851
|
+
# @!attribute [rw] actor_id
|
|
852
|
+
# The actor the event must belong to. Omit it to skip this check. If
|
|
853
|
+
# it doesn't match the stored event, the call fails with
|
|
854
|
+
# `ResourceNotFoundException`, as if the event did not exist.
|
|
855
|
+
# @return [String]
|
|
856
|
+
#
|
|
857
|
+
# @!attribute [rw] session_id
|
|
858
|
+
# The session the event must belong to. Omit it to skip this check. If
|
|
859
|
+
# it doesn't match the stored event, the call fails with
|
|
860
|
+
# `ResourceNotFoundException`, as if the event did not exist.
|
|
861
|
+
# @return [String]
|
|
862
|
+
#
|
|
863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/GetEventInput AWS API Documentation
|
|
864
|
+
#
|
|
865
|
+
class GetEventInput < Struct.new(
|
|
866
|
+
:space_id,
|
|
867
|
+
:event_id,
|
|
868
|
+
:actor_id,
|
|
869
|
+
:session_id)
|
|
870
|
+
SENSITIVE = []
|
|
871
|
+
include Aws::Structure
|
|
872
|
+
end
|
|
873
|
+
|
|
874
|
+
# @!attribute [rw] event
|
|
875
|
+
# The event, including its payload.
|
|
876
|
+
# @return [Types::Event]
|
|
877
|
+
#
|
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/GetEventOutput AWS API Documentation
|
|
879
|
+
#
|
|
880
|
+
class GetEventOutput < Struct.new(
|
|
881
|
+
:event)
|
|
882
|
+
SENSITIVE = []
|
|
883
|
+
include Aws::Structure
|
|
884
|
+
end
|
|
885
|
+
|
|
886
|
+
# @!attribute [rw] space_id
|
|
887
|
+
# The ID of the space that holds the memory.
|
|
888
|
+
# @return [String]
|
|
889
|
+
#
|
|
890
|
+
# @!attribute [rw] memory_id
|
|
891
|
+
# The memory's ID, as returned by `SearchMemories` or `ListMemories`.
|
|
892
|
+
# @return [String]
|
|
893
|
+
#
|
|
894
|
+
# @!attribute [rw] actor_id
|
|
895
|
+
# The ID of the actor the memory must belong to. Omit it to skip this
|
|
896
|
+
# check. If it doesn't match the stored memory, the call fails with
|
|
897
|
+
# `ResourceNotFoundException`, as if the memory did not exist.
|
|
898
|
+
# @return [String]
|
|
899
|
+
#
|
|
900
|
+
# @!attribute [rw] strategy_name
|
|
901
|
+
# The name of the strategy the memory must belong to. Omit it to skip
|
|
902
|
+
# this check. If it doesn't match the stored memory, the call fails
|
|
903
|
+
# with `ResourceNotFoundException`, as if the memory did not exist.
|
|
904
|
+
# @return [String]
|
|
905
|
+
#
|
|
906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/GetMemoryInput AWS API Documentation
|
|
907
|
+
#
|
|
908
|
+
class GetMemoryInput < Struct.new(
|
|
909
|
+
:space_id,
|
|
910
|
+
:memory_id,
|
|
911
|
+
:actor_id,
|
|
912
|
+
:strategy_name)
|
|
913
|
+
SENSITIVE = []
|
|
914
|
+
include Aws::Structure
|
|
915
|
+
end
|
|
916
|
+
|
|
917
|
+
# @!attribute [rw] memory
|
|
918
|
+
# The memory. Always present: a memory that doesn't exist returns
|
|
919
|
+
# `ResourceNotFoundException`.
|
|
920
|
+
# @return [Types::Memory]
|
|
921
|
+
#
|
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/GetMemoryOutput AWS API Documentation
|
|
923
|
+
#
|
|
924
|
+
class GetMemoryOutput < Struct.new(
|
|
925
|
+
:memory)
|
|
926
|
+
SENSITIVE = []
|
|
927
|
+
include Aws::Structure
|
|
928
|
+
end
|
|
929
|
+
|
|
930
|
+
# @!attribute [rw] space_id
|
|
931
|
+
# The ID of the space.
|
|
932
|
+
# @return [String]
|
|
933
|
+
#
|
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/GetSpaceRequest AWS API Documentation
|
|
935
|
+
#
|
|
936
|
+
class GetSpaceRequest < Struct.new(
|
|
937
|
+
:space_id)
|
|
938
|
+
SENSITIVE = []
|
|
939
|
+
include Aws::Structure
|
|
940
|
+
end
|
|
941
|
+
|
|
942
|
+
# @!attribute [rw] space_id
|
|
943
|
+
# The ID of the space.
|
|
944
|
+
# @return [String]
|
|
945
|
+
#
|
|
946
|
+
# @!attribute [rw] arn
|
|
947
|
+
# The Amazon Resource Name (ARN) of the space.
|
|
948
|
+
# @return [String]
|
|
949
|
+
#
|
|
950
|
+
# @!attribute [rw] name
|
|
951
|
+
# The name of the space.
|
|
952
|
+
# @return [String]
|
|
953
|
+
#
|
|
954
|
+
# @!attribute [rw] status
|
|
955
|
+
# The status of the space.
|
|
956
|
+
# @return [String]
|
|
957
|
+
#
|
|
958
|
+
# @!attribute [rw] status_reason
|
|
959
|
+
# Details about why the space is `FAILED`. Read it only when `status`
|
|
960
|
+
# is `FAILED`: it can still hold the reason for an earlier failure.
|
|
961
|
+
# @return [String]
|
|
962
|
+
#
|
|
963
|
+
# @!attribute [rw] created_at
|
|
964
|
+
# When the space was created.
|
|
965
|
+
# @return [Time]
|
|
966
|
+
#
|
|
967
|
+
# @!attribute [rw] memory_strategies
|
|
968
|
+
# The space's memory strategies, including the names the service
|
|
969
|
+
# generated for strategies created without one. Empty for a space that
|
|
970
|
+
# has no memory strategies.
|
|
971
|
+
# @return [Array<Types::MemoryStrategy>]
|
|
972
|
+
#
|
|
973
|
+
# @!attribute [rw] event_expiry_days
|
|
974
|
+
# How many days the space keeps each event. Absent when it was never
|
|
975
|
+
# set, in which case the default of 90 days applies.
|
|
976
|
+
# @return [Integer]
|
|
977
|
+
#
|
|
978
|
+
# @!attribute [rw] memory_expiry_days
|
|
979
|
+
# How many days the space keeps each memory. 0 means memories never
|
|
980
|
+
# expire. Absent when it was never set, in which case memories never
|
|
981
|
+
# expire.
|
|
982
|
+
# @return [Integer]
|
|
983
|
+
#
|
|
984
|
+
# @!attribute [rw] extraction_model_id
|
|
985
|
+
# The model that extracts and consolidates memories for the space.
|
|
986
|
+
# Absent when it was never set, in which case the service default
|
|
987
|
+
# applies.
|
|
988
|
+
# @return [String]
|
|
989
|
+
#
|
|
990
|
+
# @!attribute [rw] encryption_configuration
|
|
991
|
+
# The AWS KMS key the space was created with. Absent when the space
|
|
992
|
+
# uses an AWS owned key.
|
|
993
|
+
# @return [Types::EncryptionConfiguration]
|
|
994
|
+
#
|
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/GetSpaceResponse AWS API Documentation
|
|
996
|
+
#
|
|
997
|
+
class GetSpaceResponse < Struct.new(
|
|
998
|
+
:space_id,
|
|
999
|
+
:arn,
|
|
1000
|
+
:name,
|
|
1001
|
+
:status,
|
|
1002
|
+
:status_reason,
|
|
1003
|
+
:created_at,
|
|
1004
|
+
:memory_strategies,
|
|
1005
|
+
:event_expiry_days,
|
|
1006
|
+
:memory_expiry_days,
|
|
1007
|
+
:extraction_model_id,
|
|
1008
|
+
:encryption_configuration)
|
|
1009
|
+
SENSITIVE = []
|
|
1010
|
+
include Aws::Structure
|
|
1011
|
+
end
|
|
1012
|
+
|
|
1013
|
+
# The service couldn't process the request because of an internal
|
|
1014
|
+
# error. Retry the request.
|
|
1015
|
+
#
|
|
1016
|
+
# @!attribute [rw] message
|
|
1017
|
+
# A message that describes the internal error.
|
|
1018
|
+
# @return [String]
|
|
1019
|
+
#
|
|
1020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/InternalServerException AWS API Documentation
|
|
1021
|
+
#
|
|
1022
|
+
class InternalServerException < Struct.new(
|
|
1023
|
+
:message)
|
|
1024
|
+
SENSITIVE = []
|
|
1025
|
+
include Aws::Structure
|
|
1026
|
+
end
|
|
1027
|
+
|
|
1028
|
+
# @!attribute [rw] space_id
|
|
1029
|
+
# The ID of the space.
|
|
1030
|
+
# @return [String]
|
|
1031
|
+
#
|
|
1032
|
+
# @!attribute [rw] actor_id
|
|
1033
|
+
# The actor whose events to list.
|
|
1034
|
+
# @return [String]
|
|
1035
|
+
#
|
|
1036
|
+
# @!attribute [rw] session_id
|
|
1037
|
+
# The session whose events to list. To find events across sessions,
|
|
1038
|
+
# use `SearchEvents`.
|
|
1039
|
+
# @return [String]
|
|
1040
|
+
#
|
|
1041
|
+
# @!attribute [rw] event_timestamp_before
|
|
1042
|
+
# Inclusive upper bound on `eventTimestamp`: only events at or before
|
|
1043
|
+
# this time are returned. Omit for no upper bound.
|
|
1044
|
+
# @return [Time]
|
|
1045
|
+
#
|
|
1046
|
+
# @!attribute [rw] event_timestamp_after
|
|
1047
|
+
# Inclusive lower bound on `eventTimestamp`: only events at or after
|
|
1048
|
+
# this time are returned. Omit for no lower bound.
|
|
1049
|
+
#
|
|
1050
|
+
# If it's later than `eventTimestampBefore`, the request fails with
|
|
1051
|
+
# `ValidationException`.
|
|
1052
|
+
# @return [Time]
|
|
1053
|
+
#
|
|
1054
|
+
# @!attribute [rw] sort_order
|
|
1055
|
+
# The order of the results by `eventTimestamp`: `ASC` or `DESC`. The
|
|
1056
|
+
# default is `DESC`, most recent first.
|
|
1057
|
+
# @return [String]
|
|
1058
|
+
#
|
|
1059
|
+
# @!attribute [rw] metadata_filters
|
|
1060
|
+
# Returns only events whose metadata contains every one of these
|
|
1061
|
+
# key-value pairs. Omit, or leave empty, for no metadata filter. The
|
|
1062
|
+
# service applies the filter after it reads events, so a page can hold
|
|
1063
|
+
# fewer than `maxResults` events, or none, and still return a
|
|
1064
|
+
# `nextToken`. Keep paging until `nextToken` is absent.
|
|
1065
|
+
# @return [Hash<String,String>]
|
|
1066
|
+
#
|
|
1067
|
+
# @!attribute [rw] max_results
|
|
1068
|
+
# The maximum number of events to return, from 1 to 100. The default
|
|
1069
|
+
# is 20.
|
|
1070
|
+
# @return [Integer]
|
|
1071
|
+
#
|
|
1072
|
+
# @!attribute [rw] next_token
|
|
1073
|
+
# The token for the next set of results. Use the value returned in the
|
|
1074
|
+
# previous response in the next request to retrieve the next set of
|
|
1075
|
+
# results.
|
|
1076
|
+
# @return [String]
|
|
1077
|
+
#
|
|
1078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListEventsInput AWS API Documentation
|
|
1079
|
+
#
|
|
1080
|
+
class ListEventsInput < Struct.new(
|
|
1081
|
+
:space_id,
|
|
1082
|
+
:actor_id,
|
|
1083
|
+
:session_id,
|
|
1084
|
+
:event_timestamp_before,
|
|
1085
|
+
:event_timestamp_after,
|
|
1086
|
+
:sort_order,
|
|
1087
|
+
:metadata_filters,
|
|
1088
|
+
:max_results,
|
|
1089
|
+
:next_token)
|
|
1090
|
+
SENSITIVE = []
|
|
1091
|
+
include Aws::Structure
|
|
1092
|
+
end
|
|
1093
|
+
|
|
1094
|
+
# @!attribute [rw] events
|
|
1095
|
+
# The events, without their payloads. Call `GetEvent` for an event's
|
|
1096
|
+
# payload.
|
|
1097
|
+
# @return [Array<Types::EventSummary>]
|
|
1098
|
+
#
|
|
1099
|
+
# @!attribute [rw] next_token
|
|
1100
|
+
# The token for the next set of results. Absent when there are no more
|
|
1101
|
+
# results.
|
|
1102
|
+
# @return [String]
|
|
1103
|
+
#
|
|
1104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListEventsOutput AWS API Documentation
|
|
1105
|
+
#
|
|
1106
|
+
class ListEventsOutput < Struct.new(
|
|
1107
|
+
:events,
|
|
1108
|
+
:next_token)
|
|
1109
|
+
SENSITIVE = []
|
|
1110
|
+
include Aws::Structure
|
|
1111
|
+
end
|
|
1112
|
+
|
|
1113
|
+
# @!attribute [rw] space_id
|
|
1114
|
+
# The space whose memories to list.
|
|
1115
|
+
# @return [String]
|
|
1116
|
+
#
|
|
1117
|
+
# @!attribute [rw] memory_strategies
|
|
1118
|
+
# The strategies to list, as selectors. A selector without
|
|
1119
|
+
# `memoryStrategyNames` lists every strategy of its type, and omitting
|
|
1120
|
+
# `memoryStrategies` lists every strategy in the space. A name that is
|
|
1121
|
+
# not a declared strategy of that type fails with
|
|
1122
|
+
# `ValidationException`.
|
|
1123
|
+
# @return [Array<Types::StrategySelector>]
|
|
1124
|
+
#
|
|
1125
|
+
# @!attribute [rw] actor_ids
|
|
1126
|
+
# Lists only memories owned by one of these actors. Combined with
|
|
1127
|
+
# `sessionIds` by AND: a memory must match both filters when both are
|
|
1128
|
+
# given. Omit for no actor filter. An empty list fails validation. A
|
|
1129
|
+
# memory stored without an actor never matches an actor filter.
|
|
1130
|
+
# @return [Array<String>]
|
|
1131
|
+
#
|
|
1132
|
+
# @!attribute [rw] session_ids
|
|
1133
|
+
# Lists only memories from one of these sessions. Combined with
|
|
1134
|
+
# `actorIds` by AND. Omit for no session filter. An empty list fails
|
|
1135
|
+
# validation. A memory stored without a session never matches a
|
|
1136
|
+
# session filter.
|
|
1137
|
+
# @return [Array<String>]
|
|
1138
|
+
#
|
|
1139
|
+
# @!attribute [rw] sort_by
|
|
1140
|
+
# The timestamp to sort by, as returned in `systemMetadata`:
|
|
1141
|
+
# `CREATED_AT` (the default) or `UPDATED_AT`.
|
|
1142
|
+
# @return [String]
|
|
1143
|
+
#
|
|
1144
|
+
# @!attribute [rw] sort_order
|
|
1145
|
+
# The sort order: `ASC` or `DESC`. The default is `DESC`, most recent
|
|
1146
|
+
# first.
|
|
1147
|
+
# @return [String]
|
|
1148
|
+
#
|
|
1149
|
+
# @!attribute [rw] max_results
|
|
1150
|
+
# The maximum number of memories to return, from 1 to 100. The default
|
|
1151
|
+
# is 20.
|
|
1152
|
+
# @return [Integer]
|
|
1153
|
+
#
|
|
1154
|
+
# @!attribute [rw] next_token
|
|
1155
|
+
# The token for the next set of results. Use the value returned in the
|
|
1156
|
+
# previous response in the next request to retrieve the next set of
|
|
1157
|
+
# results.
|
|
1158
|
+
# @return [String]
|
|
1159
|
+
#
|
|
1160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListMemoriesInput AWS API Documentation
|
|
1161
|
+
#
|
|
1162
|
+
class ListMemoriesInput < Struct.new(
|
|
1163
|
+
:space_id,
|
|
1164
|
+
:memory_strategies,
|
|
1165
|
+
:actor_ids,
|
|
1166
|
+
:session_ids,
|
|
1167
|
+
:sort_by,
|
|
1168
|
+
:sort_order,
|
|
1169
|
+
:max_results,
|
|
1170
|
+
:next_token)
|
|
1171
|
+
SENSITIVE = []
|
|
1172
|
+
include Aws::Structure
|
|
1173
|
+
end
|
|
1174
|
+
|
|
1175
|
+
# @!attribute [rw] memories
|
|
1176
|
+
# The memories, in the requested order. Empty when there are none.
|
|
1177
|
+
# @return [Array<Types::MemoryListSummary>]
|
|
1178
|
+
#
|
|
1179
|
+
# @!attribute [rw] next_token
|
|
1180
|
+
# The token for the next set of results. Absent when there are no more
|
|
1181
|
+
# results.
|
|
1182
|
+
# @return [String]
|
|
1183
|
+
#
|
|
1184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListMemoriesOutput AWS API Documentation
|
|
1185
|
+
#
|
|
1186
|
+
class ListMemoriesOutput < Struct.new(
|
|
1187
|
+
:memories,
|
|
1188
|
+
:next_token)
|
|
1189
|
+
SENSITIVE = []
|
|
1190
|
+
include Aws::Structure
|
|
1191
|
+
end
|
|
1192
|
+
|
|
1193
|
+
# @!attribute [rw] max_results
|
|
1194
|
+
# The maximum number of spaces to return, from 1 to 100. The default
|
|
1195
|
+
# is 100.
|
|
1196
|
+
# @return [Integer]
|
|
1197
|
+
#
|
|
1198
|
+
# @!attribute [rw] next_token
|
|
1199
|
+
# The token for the next set of results. Use the value returned in the
|
|
1200
|
+
# previous response in the next request to retrieve the next set of
|
|
1201
|
+
# results.
|
|
1202
|
+
# @return [String]
|
|
1203
|
+
#
|
|
1204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListSpacesRequest AWS API Documentation
|
|
1205
|
+
#
|
|
1206
|
+
class ListSpacesRequest < Struct.new(
|
|
1207
|
+
:max_results,
|
|
1208
|
+
:next_token)
|
|
1209
|
+
SENSITIVE = []
|
|
1210
|
+
include Aws::Structure
|
|
1211
|
+
end
|
|
1212
|
+
|
|
1213
|
+
# @!attribute [rw] spaces
|
|
1214
|
+
# The spaces.
|
|
1215
|
+
# @return [Array<Types::SpaceSummary>]
|
|
1216
|
+
#
|
|
1217
|
+
# @!attribute [rw] next_token
|
|
1218
|
+
# The token for the next set of results. Absent when there are no more
|
|
1219
|
+
# results.
|
|
1220
|
+
# @return [String]
|
|
1221
|
+
#
|
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListSpacesResponse AWS API Documentation
|
|
1223
|
+
#
|
|
1224
|
+
class ListSpacesResponse < Struct.new(
|
|
1225
|
+
:spaces,
|
|
1226
|
+
:next_token)
|
|
1227
|
+
SENSITIVE = []
|
|
1228
|
+
include Aws::Structure
|
|
1229
|
+
end
|
|
1230
|
+
|
|
1231
|
+
# @!attribute [rw] resource_arn
|
|
1232
|
+
# The Amazon Resource Name (ARN) of the space.
|
|
1233
|
+
# @return [String]
|
|
1234
|
+
#
|
|
1235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListTagsForResourceRequest AWS API Documentation
|
|
1236
|
+
#
|
|
1237
|
+
class ListTagsForResourceRequest < Struct.new(
|
|
1238
|
+
:resource_arn)
|
|
1239
|
+
SENSITIVE = []
|
|
1240
|
+
include Aws::Structure
|
|
1241
|
+
end
|
|
1242
|
+
|
|
1243
|
+
# @!attribute [rw] tags
|
|
1244
|
+
# The tags for the space.
|
|
1245
|
+
# @return [Array<Types::Tag>]
|
|
1246
|
+
#
|
|
1247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ListTagsForResourceResponse AWS API Documentation
|
|
1248
|
+
#
|
|
1249
|
+
class ListTagsForResourceResponse < Struct.new(
|
|
1250
|
+
:tags)
|
|
1251
|
+
SENSITIVE = []
|
|
1252
|
+
include Aws::Structure
|
|
1253
|
+
end
|
|
1254
|
+
|
|
1255
|
+
# A memory, as returned by `GetMemory` and `UpdateMemory`. Unlike
|
|
1256
|
+
# `MemoryListSummary` it includes `content`, and unlike
|
|
1257
|
+
# `MemorySearchSummary` it has no relevance score.
|
|
1258
|
+
#
|
|
1259
|
+
# @!attribute [rw] memory_id
|
|
1260
|
+
# The memory's ID, assigned by the service.
|
|
1261
|
+
# @return [String]
|
|
1262
|
+
#
|
|
1263
|
+
# @!attribute [rw] memory_type
|
|
1264
|
+
# The memory type.
|
|
1265
|
+
# @return [String]
|
|
1266
|
+
#
|
|
1267
|
+
# @!attribute [rw] strategy_name
|
|
1268
|
+
# The name of the strategy the memory belongs to, for example
|
|
1269
|
+
# `user-facts`. A space can hold several strategies of the same type,
|
|
1270
|
+
# so this tells them apart. Absent when the memory's strategy is no
|
|
1271
|
+
# longer declared on the space, for example right after the strategy
|
|
1272
|
+
# is deleted.
|
|
1273
|
+
# @return [String]
|
|
1274
|
+
#
|
|
1275
|
+
# @!attribute [rw] content
|
|
1276
|
+
# The memory text.
|
|
1277
|
+
# @return [String]
|
|
1278
|
+
#
|
|
1279
|
+
# @!attribute [rw] system_metadata
|
|
1280
|
+
# Provenance for the memory: the owning actor and session, and when it
|
|
1281
|
+
# was created and last updated. Always present. `updatedAt` equals
|
|
1282
|
+
# `createdAt` for a memory that has never been updated.
|
|
1283
|
+
# @return [Types::SystemMetadata]
|
|
1284
|
+
#
|
|
1285
|
+
# @!attribute [rw] metadata
|
|
1286
|
+
# The memory's metadata tags. All values are strings. May be empty.
|
|
1287
|
+
# @return [Hash<String,String>]
|
|
1288
|
+
#
|
|
1289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/Memory AWS API Documentation
|
|
1290
|
+
#
|
|
1291
|
+
class Memory < Struct.new(
|
|
1292
|
+
:memory_id,
|
|
1293
|
+
:memory_type,
|
|
1294
|
+
:strategy_name,
|
|
1295
|
+
:content,
|
|
1296
|
+
:system_metadata,
|
|
1297
|
+
:metadata)
|
|
1298
|
+
SENSITIVE = [:content]
|
|
1299
|
+
include Aws::Structure
|
|
1300
|
+
end
|
|
1301
|
+
|
|
1302
|
+
# A summary of a memory, as returned by `ListMemories`: its ID, type,
|
|
1303
|
+
# provenance, and tags. It doesn't include `content`. Call `GetMemory`
|
|
1304
|
+
# for the full memory.
|
|
1305
|
+
#
|
|
1306
|
+
# @!attribute [rw] memory_id
|
|
1307
|
+
# The memory's ID, assigned by the service. IDs are opaque, can
|
|
1308
|
+
# contain hyphens and underscores, and can be up to 512 characters
|
|
1309
|
+
# long.
|
|
1310
|
+
# @return [String]
|
|
1311
|
+
#
|
|
1312
|
+
# @!attribute [rw] memory_type
|
|
1313
|
+
# The memory type.
|
|
1314
|
+
# @return [String]
|
|
1315
|
+
#
|
|
1316
|
+
# @!attribute [rw] strategy_name
|
|
1317
|
+
# The name of the strategy the memory belongs to, for example
|
|
1318
|
+
# `user-facts`: the strategy `memoryStrategies` selects on in
|
|
1319
|
+
# `ListMemories`. Absent when the memory's strategy is no longer
|
|
1320
|
+
# declared on the space, for example right after the strategy is
|
|
1321
|
+
# deleted.
|
|
1322
|
+
# @return [String]
|
|
1323
|
+
#
|
|
1324
|
+
# @!attribute [rw] system_metadata
|
|
1325
|
+
# Provenance for the memory: the owning actor and session, and when it
|
|
1326
|
+
# was created and last updated. Always present, with both timestamps.
|
|
1327
|
+
# @return [Types::SystemMetadata]
|
|
1328
|
+
#
|
|
1329
|
+
# @!attribute [rw] metadata
|
|
1330
|
+
# The memory's metadata tags. All values are strings.
|
|
1331
|
+
# @return [Hash<String,String>]
|
|
1332
|
+
#
|
|
1333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/MemoryListSummary AWS API Documentation
|
|
1334
|
+
#
|
|
1335
|
+
class MemoryListSummary < Struct.new(
|
|
1336
|
+
:memory_id,
|
|
1337
|
+
:memory_type,
|
|
1338
|
+
:strategy_name,
|
|
1339
|
+
:system_metadata,
|
|
1340
|
+
:metadata)
|
|
1341
|
+
SENSITIVE = []
|
|
1342
|
+
include Aws::Structure
|
|
1343
|
+
end
|
|
1344
|
+
|
|
1345
|
+
# A `SearchMemories` result: a matching memory and its relevance score.
|
|
1346
|
+
#
|
|
1347
|
+
# @!attribute [rw] memory_id
|
|
1348
|
+
# The memory's ID, assigned by the service. Always present.
|
|
1349
|
+
# @return [String]
|
|
1350
|
+
#
|
|
1351
|
+
# @!attribute [rw] memory_type
|
|
1352
|
+
# The memory type of the result.
|
|
1353
|
+
# @return [String]
|
|
1354
|
+
#
|
|
1355
|
+
# @!attribute [rw] strategy_name
|
|
1356
|
+
# The name of the strategy the memory belongs to, for example
|
|
1357
|
+
# `user-facts`: the strategy `memoryStrategies` selects on in
|
|
1358
|
+
# `SearchMemories`. Absent when the memory's strategy is no longer
|
|
1359
|
+
# declared on the space, for example right after the strategy is
|
|
1360
|
+
# deleted.
|
|
1361
|
+
# @return [String]
|
|
1362
|
+
#
|
|
1363
|
+
# @!attribute [rw] content
|
|
1364
|
+
# The memory text.
|
|
1365
|
+
# @return [String]
|
|
1366
|
+
#
|
|
1367
|
+
# @!attribute [rw] score
|
|
1368
|
+
# The relevance score of the result. A higher score is more relevant.
|
|
1369
|
+
# Scores aren't normalized to a fixed range and can be greater than
|
|
1370
|
+
# 1, so use them only to order results.
|
|
1371
|
+
# @return [Float]
|
|
1372
|
+
#
|
|
1373
|
+
# @!attribute [rw] system_metadata
|
|
1374
|
+
# Provenance for the memory: the actor and session that own it, and
|
|
1375
|
+
# when it was created and last updated. It is the same block that
|
|
1376
|
+
# `ListMemories`, `GetMemory`, and `SearchEvents` return.
|
|
1377
|
+
#
|
|
1378
|
+
# In a query, filter or sort on the timestamps as
|
|
1379
|
+
# `system_metadata.created_at` and `system_metadata.updated_at`. Scope
|
|
1380
|
+
# by owner with the top-level `actorId`, not in the query. Searching
|
|
1381
|
+
# memories doesn't filter by session.
|
|
1382
|
+
#
|
|
1383
|
+
# Absent when the service has no provenance for the memory.
|
|
1384
|
+
# @return [Types::SystemMetadata]
|
|
1385
|
+
#
|
|
1386
|
+
# @!attribute [rw] metadata
|
|
1387
|
+
# The memory's metadata tags. All values are strings. In a query,
|
|
1388
|
+
# filter on a tag as `metadata.<key>`.
|
|
1389
|
+
# @return [Hash<String,String>]
|
|
1390
|
+
#
|
|
1391
|
+
# @!attribute [rw] source_event_ids
|
|
1392
|
+
# The IDs of the events the memory was derived from, without
|
|
1393
|
+
# duplicates. Use them with `GetEvent` or `BatchGetEvent`, or to
|
|
1394
|
+
# search those events' content with `SearchEvents` by filtering on
|
|
1395
|
+
# `event_ids` in the query. Absent for a memory created directly with
|
|
1396
|
+
# `CreateMemory`. A memory can be derived from several events. The
|
|
1397
|
+
# service sets this value.
|
|
1398
|
+
# @return [Array<String>]
|
|
1399
|
+
#
|
|
1400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/MemorySearchSummary AWS API Documentation
|
|
1401
|
+
#
|
|
1402
|
+
class MemorySearchSummary < Struct.new(
|
|
1403
|
+
:memory_id,
|
|
1404
|
+
:memory_type,
|
|
1405
|
+
:strategy_name,
|
|
1406
|
+
:content,
|
|
1407
|
+
:score,
|
|
1408
|
+
:system_metadata,
|
|
1409
|
+
:metadata,
|
|
1410
|
+
:source_event_ids)
|
|
1411
|
+
SENSITIVE = [:content]
|
|
1412
|
+
include Aws::Structure
|
|
1413
|
+
end
|
|
1414
|
+
|
|
1415
|
+
# A memory strategy: how a space extracts one kind of memory from its
|
|
1416
|
+
# events.
|
|
1417
|
+
#
|
|
1418
|
+
# @!attribute [rw] type
|
|
1419
|
+
# The type of memory the strategy extracts.
|
|
1420
|
+
# @return [String]
|
|
1421
|
+
#
|
|
1422
|
+
# @!attribute [rw] name
|
|
1423
|
+
# A name for the strategy, unique within the space. Omit it to have
|
|
1424
|
+
# the service generate one from the type, for example `semantic_1`.
|
|
1425
|
+
# The name must be 1 to 64 characters: letters, digits, periods,
|
|
1426
|
+
# hyphens, and underscores, starting with a letter or digit. A
|
|
1427
|
+
# strategy's name can't be changed, and the strategy's memories are
|
|
1428
|
+
# stored under it: a strategy added under a new name starts with no
|
|
1429
|
+
# memories.
|
|
1430
|
+
# @return [String]
|
|
1431
|
+
#
|
|
1432
|
+
# @!attribute [rw] description
|
|
1433
|
+
# A description of the strategy.
|
|
1434
|
+
# @return [String]
|
|
1435
|
+
#
|
|
1436
|
+
# @!attribute [rw] configuration
|
|
1437
|
+
# Settings for the strategy. When you create a strategy, omit it to
|
|
1438
|
+
# use the defaults for the strategy's type.
|
|
1439
|
+
#
|
|
1440
|
+
# A `CUSTOM` strategy must set `extractionPrompt`.
|
|
1441
|
+
# @return [Types::MemoryStrategyConfiguration]
|
|
1442
|
+
#
|
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/MemoryStrategy AWS API Documentation
|
|
1444
|
+
#
|
|
1445
|
+
class MemoryStrategy < Struct.new(
|
|
1446
|
+
:type,
|
|
1447
|
+
:name,
|
|
1448
|
+
:description,
|
|
1449
|
+
:configuration)
|
|
1450
|
+
SENSITIVE = []
|
|
1451
|
+
include Aws::Structure
|
|
1452
|
+
end
|
|
1453
|
+
|
|
1454
|
+
# Settings for a memory strategy. The defaults described here apply when
|
|
1455
|
+
# you create a strategy. In `UpdateSpace`, a member you omit for a kept
|
|
1456
|
+
# strategy keeps its current value.
|
|
1457
|
+
#
|
|
1458
|
+
# @!attribute [rw] extraction_prompt
|
|
1459
|
+
# Instructions that define what a `CUSTOM` strategy extracts, up to
|
|
1460
|
+
# 30,720 characters. Required for a `CUSTOM` strategy: `CreateSpace`
|
|
1461
|
+
# and `UpdateSpace` fail with `ValidationException` if a `CUSTOM`
|
|
1462
|
+
# strategy has none.
|
|
1463
|
+
#
|
|
1464
|
+
# Only `CUSTOM` strategies use it. `SEMANTIC` and `SUMMARY` strategies
|
|
1465
|
+
# always extract with the service's built-in instructions: the
|
|
1466
|
+
# service accepts and stores a prompt on them, and `GetSpace` returns
|
|
1467
|
+
# it, but extraction doesn't use it.
|
|
1468
|
+
# @return [String]
|
|
1469
|
+
#
|
|
1470
|
+
# @!attribute [rw] extract_every_n_messages
|
|
1471
|
+
# Extract once this many messages have accumulated, from 1 to 1000.
|
|
1472
|
+
# Lower values extract more often, in smaller batches. The default is
|
|
1473
|
+
# 12.
|
|
1474
|
+
#
|
|
1475
|
+
# Messages accumulate until the first of `extractEveryNMessages`,
|
|
1476
|
+
# `extractEveryNTokens`, and `idleTimeoutSeconds` is reached. The
|
|
1477
|
+
# service then extracts them together in one pass.
|
|
1478
|
+
# @return [Integer]
|
|
1479
|
+
#
|
|
1480
|
+
# @!attribute [rw] extract_every_n_tokens
|
|
1481
|
+
# Extract once this many tokens of conversation have accumulated, from
|
|
1482
|
+
# 1 to 80,000, however few messages that takes. Use it to bound how
|
|
1483
|
+
# much text one extraction call carries when message sizes vary
|
|
1484
|
+
# widely. Omit it to bound a batch only by `extractEveryNMessages`,
|
|
1485
|
+
# `idleTimeoutSeconds`, and the service's maximum batch size.
|
|
1486
|
+
# @return [Integer]
|
|
1487
|
+
#
|
|
1488
|
+
# @!attribute [rw] idle_timeout_seconds
|
|
1489
|
+
# Extract what has accumulated once the conversation has been idle for
|
|
1490
|
+
# this many seconds, from 1 to 86,400. The default is 60. This is what
|
|
1491
|
+
# extracts the end of a conversation that stops. Raise it when the
|
|
1492
|
+
# pauses in your conversations are longer than that, so that one
|
|
1493
|
+
# exchange isn't split across several extraction passes.
|
|
1494
|
+
# @return [Integer]
|
|
1495
|
+
#
|
|
1496
|
+
# @!attribute [rw] extraction_seed_top_k
|
|
1497
|
+
# How many of the strategy's stored memories that are most relevant
|
|
1498
|
+
# to the conversation to include in the extraction prompt, from 0 to
|
|
1499
|
+
# 20, to improve extraction and reduce duplicates. If you omit this or
|
|
1500
|
+
# set it to 0, the service uses its default (see
|
|
1501
|
+
# `extractionSeedRecentN`). When this and `extractionSeedRecentN` are
|
|
1502
|
+
# both set, the two sets of memories are combined without duplicates.
|
|
1503
|
+
# @return [Integer]
|
|
1504
|
+
#
|
|
1505
|
+
# @!attribute [rw] extraction_seed_recent_n
|
|
1506
|
+
# How many of the strategy's most recent stored memories to include
|
|
1507
|
+
# in the extraction prompt, from 0 to 20. If you omit this or set it
|
|
1508
|
+
# to 0, the service uses its default: no seeding for most strategy
|
|
1509
|
+
# types, and the 10 most recent memories for a `SUMMARY` strategy when
|
|
1510
|
+
# neither seed setting is given. When this and `extractionSeedTopK`
|
|
1511
|
+
# are both set, the two sets of memories are combined without
|
|
1512
|
+
# duplicates.
|
|
1513
|
+
# @return [Integer]
|
|
1514
|
+
#
|
|
1515
|
+
# @!attribute [rw] consolidation_enabled
|
|
1516
|
+
# Specifies whether the strategy consolidates memories. With
|
|
1517
|
+
# consolidation, each new memory is compared with similar stored
|
|
1518
|
+
# memories, and the service adds it, updates a stored memory, or skips
|
|
1519
|
+
# it, so duplicate or contradicting facts don't accumulate. Without
|
|
1520
|
+
# it, every extracted memory is stored as a new memory, which costs
|
|
1521
|
+
# less and keeps a full history.
|
|
1522
|
+
#
|
|
1523
|
+
# When omitted, the default depends on the strategy's type: on for
|
|
1524
|
+
# `SEMANTIC` and `SUMMARY`, off for `CUSTOM`.
|
|
1525
|
+
# @return [Boolean]
|
|
1526
|
+
#
|
|
1527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/MemoryStrategyConfiguration AWS API Documentation
|
|
1528
|
+
#
|
|
1529
|
+
class MemoryStrategyConfiguration < Struct.new(
|
|
1530
|
+
:extraction_prompt,
|
|
1531
|
+
:extract_every_n_messages,
|
|
1532
|
+
:extract_every_n_tokens,
|
|
1533
|
+
:idle_timeout_seconds,
|
|
1534
|
+
:extraction_seed_top_k,
|
|
1535
|
+
:extraction_seed_recent_n,
|
|
1536
|
+
:consolidation_enabled)
|
|
1537
|
+
SENSITIVE = [:extraction_prompt]
|
|
1538
|
+
include Aws::Structure
|
|
1539
|
+
end
|
|
1540
|
+
|
|
1541
|
+
# A conversation turn.
|
|
1542
|
+
#
|
|
1543
|
+
# @!attribute [rw] role
|
|
1544
|
+
# The author of the turn.
|
|
1545
|
+
# @return [String]
|
|
1546
|
+
#
|
|
1547
|
+
# @!attribute [rw] content
|
|
1548
|
+
# The content of the turn.
|
|
1549
|
+
# @return [Types::MessageContent]
|
|
1550
|
+
#
|
|
1551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/Message AWS API Documentation
|
|
1552
|
+
#
|
|
1553
|
+
class Message < Struct.new(
|
|
1554
|
+
:role,
|
|
1555
|
+
:content)
|
|
1556
|
+
SENSITIVE = []
|
|
1557
|
+
include Aws::Structure
|
|
1558
|
+
end
|
|
1559
|
+
|
|
1560
|
+
# The content of a conversation turn.
|
|
1561
|
+
#
|
|
1562
|
+
# @!attribute [rw] text
|
|
1563
|
+
# The text of the turn.
|
|
1564
|
+
# @return [String]
|
|
1565
|
+
#
|
|
1566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/MessageContent AWS API Documentation
|
|
1567
|
+
#
|
|
1568
|
+
class MessageContent < Struct.new(
|
|
1569
|
+
:text)
|
|
1570
|
+
SENSITIVE = [:text]
|
|
1571
|
+
include Aws::Structure
|
|
1572
|
+
end
|
|
1573
|
+
|
|
1574
|
+
# The specified resource doesn't exist. Check the IDs in the request.
|
|
1575
|
+
#
|
|
1576
|
+
# @!attribute [rw] message
|
|
1577
|
+
# A message that describes which resource wasn't found.
|
|
1578
|
+
# @return [String]
|
|
1579
|
+
#
|
|
1580
|
+
# @!attribute [rw] resource_id
|
|
1581
|
+
# The ID of the resource that wasn't found.
|
|
1582
|
+
# @return [String]
|
|
1583
|
+
#
|
|
1584
|
+
# @!attribute [rw] resource_type
|
|
1585
|
+
# The type of the resource that wasn't found.
|
|
1586
|
+
# @return [String]
|
|
1587
|
+
#
|
|
1588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ResourceNotFoundException AWS API Documentation
|
|
1589
|
+
#
|
|
1590
|
+
class ResourceNotFoundException < Struct.new(
|
|
1591
|
+
:message,
|
|
1592
|
+
:resource_id,
|
|
1593
|
+
:resource_type)
|
|
1594
|
+
SENSITIVE = []
|
|
1595
|
+
include Aws::Structure
|
|
1596
|
+
end
|
|
1597
|
+
|
|
1598
|
+
# An object in Amazon S3.
|
|
1599
|
+
#
|
|
1600
|
+
# @!attribute [rw] uri
|
|
1601
|
+
# The object's S3 URI, for example `s3://bucket/key`. The bucket must
|
|
1602
|
+
# be in the space's Region. You need `s3:GetObject` on the object,
|
|
1603
|
+
# and `kms:Decrypt` on its key if the object uses SSE-KMS. The event
|
|
1604
|
+
# doesn't store the object itself.
|
|
1605
|
+
# @return [String]
|
|
1606
|
+
#
|
|
1607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/S3Location AWS API Documentation
|
|
1608
|
+
#
|
|
1609
|
+
class S3Location < Struct.new(
|
|
1610
|
+
:uri)
|
|
1611
|
+
SENSITIVE = []
|
|
1612
|
+
include Aws::Structure
|
|
1613
|
+
end
|
|
1614
|
+
|
|
1615
|
+
# @!attribute [rw] space_id
|
|
1616
|
+
# The space whose events to search. Use `actorId` and `sessionIds` to
|
|
1617
|
+
# narrow the search within it.
|
|
1618
|
+
# @return [String]
|
|
1619
|
+
#
|
|
1620
|
+
# @!attribute [rw] actor_id
|
|
1621
|
+
# The actor whose events to search (exact match). Required: every
|
|
1622
|
+
# search covers exactly one actor, and an event stored without an
|
|
1623
|
+
# actor is never returned. Narrow the search further with
|
|
1624
|
+
# `sessionIds`, combined by AND. This is the only way to filter by
|
|
1625
|
+
# actor: a query that references `system_metadata.actor_id` fails with
|
|
1626
|
+
# `ValidationException` (reason `nonFilterableField`).
|
|
1627
|
+
# @return [String]
|
|
1628
|
+
#
|
|
1629
|
+
# @!attribute [rw] session_ids
|
|
1630
|
+
# Returns only events from one of these sessions (exact match).
|
|
1631
|
+
# Combined with `actorId` by AND. Omit for no session filter. An empty
|
|
1632
|
+
# list fails validation. An event stored without a session never
|
|
1633
|
+
# matches a session filter. This is the only way to filter by session:
|
|
1634
|
+
# a query that references `system_metadata.session_id` fails with
|
|
1635
|
+
# `ValidationException` (reason `nonFilterableField`).
|
|
1636
|
+
# @return [Array<String>]
|
|
1637
|
+
#
|
|
1638
|
+
# @!attribute [rw] query
|
|
1639
|
+
# The query: a subset of the OpenSearch Query DSL (see `SearchQuery`),
|
|
1640
|
+
# validated by the same rules as on `SearchMemories`. Query event text
|
|
1641
|
+
# as `text` and embeddings as `vector`. A search covers both
|
|
1642
|
+
# conversation turns and chunks of documents submitted as a `blob`.
|
|
1643
|
+
# You can't use actor and session fields here. Use the top-level
|
|
1644
|
+
# `actorId` and `sessionIds`.
|
|
1645
|
+
#
|
|
1646
|
+
# To search only the content of particular events, filter on
|
|
1647
|
+
# `event_ids` with `term` or `terms`, for example with the
|
|
1648
|
+
# `sourceEventIds` that a `SearchMemories` result returns. A `terms`
|
|
1649
|
+
# clause on `event_ids` can list up to 10 event IDs. More IDs fail
|
|
1650
|
+
# with `ValidationException` (reason `queryBodyTooLarge`). You can use
|
|
1651
|
+
# `event_ids` only in `term`, `terms`, and `exists` queries.
|
|
1652
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1653
|
+
#
|
|
1654
|
+
# @!attribute [rw] sort
|
|
1655
|
+
# The sort order (see `SearchSort`). Omit to return the most relevant
|
|
1656
|
+
# events first.
|
|
1657
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1658
|
+
#
|
|
1659
|
+
# @!attribute [rw] max_results
|
|
1660
|
+
# The maximum number of events to return, from 1 to 100. The default
|
|
1661
|
+
# is 20.
|
|
1662
|
+
# @return [Integer]
|
|
1663
|
+
#
|
|
1664
|
+
# @!attribute [rw] next_token
|
|
1665
|
+
# The token for the next set of results. Use the value returned in the
|
|
1666
|
+
# previous response in the next request to retrieve the next set of
|
|
1667
|
+
# results.
|
|
1668
|
+
# @return [String]
|
|
1669
|
+
#
|
|
1670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/SearchEventsInput AWS API Documentation
|
|
1671
|
+
#
|
|
1672
|
+
class SearchEventsInput < Struct.new(
|
|
1673
|
+
:space_id,
|
|
1674
|
+
:actor_id,
|
|
1675
|
+
:session_ids,
|
|
1676
|
+
:query,
|
|
1677
|
+
:sort,
|
|
1678
|
+
:max_results,
|
|
1679
|
+
:next_token)
|
|
1680
|
+
SENSITIVE = [:query, :sort]
|
|
1681
|
+
include Aws::Structure
|
|
1682
|
+
end
|
|
1683
|
+
|
|
1684
|
+
# @!attribute [rw] events
|
|
1685
|
+
# The matching event chunks, in the order `sort` requests, or most
|
|
1686
|
+
# relevant first when it has none. Empty when nothing matches. Each
|
|
1687
|
+
# result is the matching chunk of an event. Call `GetEvent` for the
|
|
1688
|
+
# whole event.
|
|
1689
|
+
# @return [Array<Types::EventSearchSummary>]
|
|
1690
|
+
#
|
|
1691
|
+
# @!attribute [rw] next_token
|
|
1692
|
+
# The token for the next set of results. Absent when there are no more
|
|
1693
|
+
# results.
|
|
1694
|
+
# @return [String]
|
|
1695
|
+
#
|
|
1696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/SearchEventsOutput AWS API Documentation
|
|
1697
|
+
#
|
|
1698
|
+
class SearchEventsOutput < Struct.new(
|
|
1699
|
+
:events,
|
|
1700
|
+
:next_token)
|
|
1701
|
+
SENSITIVE = []
|
|
1702
|
+
include Aws::Structure
|
|
1703
|
+
end
|
|
1704
|
+
|
|
1705
|
+
# @!attribute [rw] space_id
|
|
1706
|
+
# The space to search. Use `actorId` to narrow the search within it.
|
|
1707
|
+
# @return [String]
|
|
1708
|
+
#
|
|
1709
|
+
# @!attribute [rw] memory_strategies
|
|
1710
|
+
# The strategies to search, as a list of selectors. Each selector
|
|
1711
|
+
# names a memory type and, optionally, specific strategy names of that
|
|
1712
|
+
# type. A space can hold several strategies of the same type. A
|
|
1713
|
+
# selector without `memoryStrategyNames` searches every strategy of
|
|
1714
|
+
# its type, and omitting `memoryStrategies` searches every strategy in
|
|
1715
|
+
# the space. A name that is not a declared strategy of that type fails
|
|
1716
|
+
# with `ValidationException`.
|
|
1717
|
+
# @return [Array<Types::StrategySelector>]
|
|
1718
|
+
#
|
|
1719
|
+
# @!attribute [rw] actor_id
|
|
1720
|
+
# The actor whose memories to search (exact match). Required: every
|
|
1721
|
+
# search covers exactly one actor, and a memory stored without an
|
|
1722
|
+
# actor is never returned. This is the only way to filter by actor: a
|
|
1723
|
+
# query that references `system_metadata.actor_id` fails with
|
|
1724
|
+
# `ValidationException` (reason `nonFilterableField`).
|
|
1725
|
+
# @return [String]
|
|
1726
|
+
#
|
|
1727
|
+
# @!attribute [rw] query
|
|
1728
|
+
# The query: a subset of the OpenSearch Query DSL (see `SearchQuery`).
|
|
1729
|
+
# You can't use the actor and session fields
|
|
1730
|
+
# `system_metadata.actor_id` and `system_metadata.session_id` here.
|
|
1731
|
+
# Use the top-level `actorId` to filter by actor. Searching memories
|
|
1732
|
+
# doesn't filter by session.
|
|
1733
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1734
|
+
#
|
|
1735
|
+
# @!attribute [rw] sort
|
|
1736
|
+
# The sort order (see `SearchSort`). Omit to return the most relevant
|
|
1737
|
+
# memories first.
|
|
1738
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1739
|
+
#
|
|
1740
|
+
# @!attribute [rw] max_results
|
|
1741
|
+
# The maximum number of memories to return, from 1 to 100. The default
|
|
1742
|
+
# is 20.
|
|
1743
|
+
# @return [Integer]
|
|
1744
|
+
#
|
|
1745
|
+
# @!attribute [rw] next_token
|
|
1746
|
+
# The token for the next set of results. Use the value returned in the
|
|
1747
|
+
# previous response in the next request to retrieve the next set of
|
|
1748
|
+
# results.
|
|
1749
|
+
# @return [String]
|
|
1750
|
+
#
|
|
1751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/SearchMemoriesInput AWS API Documentation
|
|
1752
|
+
#
|
|
1753
|
+
class SearchMemoriesInput < Struct.new(
|
|
1754
|
+
:space_id,
|
|
1755
|
+
:memory_strategies,
|
|
1756
|
+
:actor_id,
|
|
1757
|
+
:query,
|
|
1758
|
+
:sort,
|
|
1759
|
+
:max_results,
|
|
1760
|
+
:next_token)
|
|
1761
|
+
SENSITIVE = [:query, :sort]
|
|
1762
|
+
include Aws::Structure
|
|
1763
|
+
end
|
|
1764
|
+
|
|
1765
|
+
# @!attribute [rw] memories
|
|
1766
|
+
# The matching memories, in the order `sort` requests, or most
|
|
1767
|
+
# relevant first when it has none. Empty when nothing matches.
|
|
1768
|
+
# @return [Array<Types::MemorySearchSummary>]
|
|
1769
|
+
#
|
|
1770
|
+
# @!attribute [rw] next_token
|
|
1771
|
+
# The token for the next set of results. Absent when there are no more
|
|
1772
|
+
# results.
|
|
1773
|
+
# @return [String]
|
|
1774
|
+
#
|
|
1775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/SearchMemoriesOutput AWS API Documentation
|
|
1776
|
+
#
|
|
1777
|
+
class SearchMemoriesOutput < Struct.new(
|
|
1778
|
+
:memories,
|
|
1779
|
+
:next_token)
|
|
1780
|
+
SENSITIVE = []
|
|
1781
|
+
include Aws::Structure
|
|
1782
|
+
end
|
|
1783
|
+
|
|
1784
|
+
# The request would exceed a quota, such as the number of spaces in your
|
|
1785
|
+
# account or the number of strategies in a space.
|
|
1786
|
+
#
|
|
1787
|
+
# @!attribute [rw] message
|
|
1788
|
+
# A message that describes which quota the request would exceed.
|
|
1789
|
+
# @return [String]
|
|
1790
|
+
#
|
|
1791
|
+
# @!attribute [rw] quota_code
|
|
1792
|
+
# The Service Quotas code of the quota that the request would exceed.
|
|
1793
|
+
# Not currently returned.
|
|
1794
|
+
# @return [String]
|
|
1795
|
+
#
|
|
1796
|
+
# @!attribute [rw] service_code
|
|
1797
|
+
# The Service Quotas code of the service. Not currently returned.
|
|
1798
|
+
# @return [String]
|
|
1799
|
+
#
|
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ServiceQuotaExceededException AWS API Documentation
|
|
1801
|
+
#
|
|
1802
|
+
class ServiceQuotaExceededException < Struct.new(
|
|
1803
|
+
:message,
|
|
1804
|
+
:quota_code,
|
|
1805
|
+
:service_code)
|
|
1806
|
+
SENSITIVE = []
|
|
1807
|
+
include Aws::Structure
|
|
1808
|
+
end
|
|
1809
|
+
|
|
1810
|
+
# A summary of a space, as returned by `ListSpaces`.
|
|
1811
|
+
#
|
|
1812
|
+
# @!attribute [rw] space_id
|
|
1813
|
+
# The ID of the space.
|
|
1814
|
+
# @return [String]
|
|
1815
|
+
#
|
|
1816
|
+
# @!attribute [rw] arn
|
|
1817
|
+
# The Amazon Resource Name (ARN) of the space.
|
|
1818
|
+
# @return [String]
|
|
1819
|
+
#
|
|
1820
|
+
# @!attribute [rw] name
|
|
1821
|
+
# The name of the space.
|
|
1822
|
+
# @return [String]
|
|
1823
|
+
#
|
|
1824
|
+
# @!attribute [rw] status
|
|
1825
|
+
# The status of the space.
|
|
1826
|
+
# @return [String]
|
|
1827
|
+
#
|
|
1828
|
+
# @!attribute [rw] created_at
|
|
1829
|
+
# When the space was created.
|
|
1830
|
+
# @return [Time]
|
|
1831
|
+
#
|
|
1832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/SpaceSummary AWS API Documentation
|
|
1833
|
+
#
|
|
1834
|
+
class SpaceSummary < Struct.new(
|
|
1835
|
+
:space_id,
|
|
1836
|
+
:arn,
|
|
1837
|
+
:name,
|
|
1838
|
+
:status,
|
|
1839
|
+
:created_at)
|
|
1840
|
+
SENSITIVE = []
|
|
1841
|
+
include Aws::Structure
|
|
1842
|
+
end
|
|
1843
|
+
|
|
1844
|
+
# A memory type and, optionally, specific strategy names of that type. A
|
|
1845
|
+
# space can hold several strategies of the same type, so the type and
|
|
1846
|
+
# its names are given together.
|
|
1847
|
+
#
|
|
1848
|
+
# @!attribute [rw] memory_type
|
|
1849
|
+
# The memory type to search or list.
|
|
1850
|
+
# @return [String]
|
|
1851
|
+
#
|
|
1852
|
+
# @!attribute [rw] memory_strategy_names
|
|
1853
|
+
# Specific strategy names of `memoryType`. Omit it to include every
|
|
1854
|
+
# strategy of that type.
|
|
1855
|
+
# @return [Array<String>]
|
|
1856
|
+
#
|
|
1857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/StrategySelector AWS API Documentation
|
|
1858
|
+
#
|
|
1859
|
+
class StrategySelector < Struct.new(
|
|
1860
|
+
:memory_type,
|
|
1861
|
+
:memory_strategy_names)
|
|
1862
|
+
SENSITIVE = []
|
|
1863
|
+
include Aws::Structure
|
|
1864
|
+
end
|
|
1865
|
+
|
|
1866
|
+
# Structured content, as a JSON object.
|
|
1867
|
+
#
|
|
1868
|
+
# @!attribute [rw] source
|
|
1869
|
+
# The structured content.
|
|
1870
|
+
# @return [Types::StructuredDataSource]
|
|
1871
|
+
#
|
|
1872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/StructuredDataPayload AWS API Documentation
|
|
1873
|
+
#
|
|
1874
|
+
class StructuredDataPayload < Struct.new(
|
|
1875
|
+
:source)
|
|
1876
|
+
SENSITIVE = [:source]
|
|
1877
|
+
include Aws::Structure
|
|
1878
|
+
end
|
|
1879
|
+
|
|
1880
|
+
# The source of structured content. Set exactly one member. Currently,
|
|
1881
|
+
# the only member is `json`.
|
|
1882
|
+
#
|
|
1883
|
+
# @note StructuredDataSource is a union - when making an API calls you must set exactly one of the members.
|
|
1884
|
+
#
|
|
1885
|
+
# @note StructuredDataSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of StructuredDataSource corresponding to the set member.
|
|
1886
|
+
#
|
|
1887
|
+
# @!attribute [rw] json
|
|
1888
|
+
# The structured content, as a JSON object of at most 1 MiB when
|
|
1889
|
+
# serialized as UTF-8, nested at most 10 levels deep.
|
|
1890
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1891
|
+
#
|
|
1892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/StructuredDataSource AWS API Documentation
|
|
1893
|
+
#
|
|
1894
|
+
class StructuredDataSource < Struct.new(
|
|
1895
|
+
:json,
|
|
1896
|
+
:unknown)
|
|
1897
|
+
SENSITIVE = []
|
|
1898
|
+
include Aws::Structure
|
|
1899
|
+
include Aws::Structure::Union
|
|
1900
|
+
|
|
1901
|
+
class Json < StructuredDataSource; end
|
|
1902
|
+
class Unknown < StructuredDataSource; end
|
|
1903
|
+
end
|
|
1904
|
+
|
|
1905
|
+
# System-generated provenance for a memory or event: the owning actor
|
|
1906
|
+
# and session, and the creation and last-update timestamps.
|
|
1907
|
+
# `SearchMemories`, `SearchEvents`, `ListMemories`, and `GetMemory`
|
|
1908
|
+
# return the same block.
|
|
1909
|
+
#
|
|
1910
|
+
# `ListMemories` and `GetMemory` always return `createdAt` and
|
|
1911
|
+
# `updatedAt`. The search operations return what is recorded and omit
|
|
1912
|
+
# the block when nothing is.
|
|
1913
|
+
#
|
|
1914
|
+
# In a query, the timestamps are `system_metadata.created_at` and
|
|
1915
|
+
# `system_metadata.updated_at`. Scope by owner with the top-level
|
|
1916
|
+
# parameters (`actorId` on the search operations, `actorIds` on
|
|
1917
|
+
# `ListMemories`) and `sessionIds` (`SearchEvents` and `ListMemories`).
|
|
1918
|
+
# The search operations reject actor and session fields inside the query
|
|
1919
|
+
# or sort.
|
|
1920
|
+
#
|
|
1921
|
+
# @!attribute [rw] actor_id
|
|
1922
|
+
# The owning actor. Absent when none was recorded.
|
|
1923
|
+
# @return [String]
|
|
1924
|
+
#
|
|
1925
|
+
# @!attribute [rw] session_id
|
|
1926
|
+
# The owning session. Absent when none was recorded.
|
|
1927
|
+
# @return [String]
|
|
1928
|
+
#
|
|
1929
|
+
# @!attribute [rw] created_at
|
|
1930
|
+
# When the record was created. Always present on `ListMemories` and
|
|
1931
|
+
# `GetMemory`. It can be absent from search results.
|
|
1932
|
+
# @return [Time]
|
|
1933
|
+
#
|
|
1934
|
+
# @!attribute [rw] updated_at
|
|
1935
|
+
# When the record was last updated. Equals `createdAt` for a record
|
|
1936
|
+
# that has never been updated, and always for a `SearchEvents` result.
|
|
1937
|
+
# @return [Time]
|
|
1938
|
+
#
|
|
1939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/SystemMetadata AWS API Documentation
|
|
1940
|
+
#
|
|
1941
|
+
class SystemMetadata < Struct.new(
|
|
1942
|
+
:actor_id,
|
|
1943
|
+
:session_id,
|
|
1944
|
+
:created_at,
|
|
1945
|
+
:updated_at)
|
|
1946
|
+
SENSITIVE = []
|
|
1947
|
+
include Aws::Structure
|
|
1948
|
+
end
|
|
1949
|
+
|
|
1950
|
+
# A tag: a key-value pair that you attach to a space.
|
|
1951
|
+
#
|
|
1952
|
+
# @!attribute [rw] key
|
|
1953
|
+
# The key of the tag.
|
|
1954
|
+
# @return [String]
|
|
1955
|
+
#
|
|
1956
|
+
# @!attribute [rw] value
|
|
1957
|
+
# The value of the tag.
|
|
1958
|
+
# @return [String]
|
|
1959
|
+
#
|
|
1960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/Tag AWS API Documentation
|
|
1961
|
+
#
|
|
1962
|
+
class Tag < Struct.new(
|
|
1963
|
+
:key,
|
|
1964
|
+
:value)
|
|
1965
|
+
SENSITIVE = []
|
|
1966
|
+
include Aws::Structure
|
|
1967
|
+
end
|
|
1968
|
+
|
|
1969
|
+
# @!attribute [rw] resource_arn
|
|
1970
|
+
# The Amazon Resource Name (ARN) of the space.
|
|
1971
|
+
# @return [String]
|
|
1972
|
+
#
|
|
1973
|
+
# @!attribute [rw] tags
|
|
1974
|
+
# The tags to add to the space.
|
|
1975
|
+
# @return [Array<Types::Tag>]
|
|
1976
|
+
#
|
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/TagResourceRequest AWS API Documentation
|
|
1978
|
+
#
|
|
1979
|
+
class TagResourceRequest < Struct.new(
|
|
1980
|
+
:resource_arn,
|
|
1981
|
+
:tags)
|
|
1982
|
+
SENSITIVE = []
|
|
1983
|
+
include Aws::Structure
|
|
1984
|
+
end
|
|
1985
|
+
|
|
1986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/TagResourceResponse AWS API Documentation
|
|
1987
|
+
#
|
|
1988
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
|
1989
|
+
|
|
1990
|
+
# The service throttled the request. Retry the request with exponential
|
|
1991
|
+
# backoff.
|
|
1992
|
+
#
|
|
1993
|
+
# @!attribute [rw] message
|
|
1994
|
+
# A message that describes the throttling.
|
|
1995
|
+
# @return [String]
|
|
1996
|
+
#
|
|
1997
|
+
# @!attribute [rw] retry_after_seconds
|
|
1998
|
+
# The number of seconds to wait before you retry the request.
|
|
1999
|
+
# @return [Integer]
|
|
2000
|
+
#
|
|
2001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ThrottlingException AWS API Documentation
|
|
2002
|
+
#
|
|
2003
|
+
class ThrottlingException < Struct.new(
|
|
2004
|
+
:message,
|
|
2005
|
+
:retry_after_seconds)
|
|
2006
|
+
SENSITIVE = []
|
|
2007
|
+
include Aws::Structure
|
|
2008
|
+
end
|
|
2009
|
+
|
|
2010
|
+
# Conversation turns in the service's own format.
|
|
2011
|
+
#
|
|
2012
|
+
# @!attribute [rw] source
|
|
2013
|
+
# The conversation.
|
|
2014
|
+
# @return [Types::UnifiedConversationalSource]
|
|
2015
|
+
#
|
|
2016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UnifiedConversational AWS API Documentation
|
|
2017
|
+
#
|
|
2018
|
+
class UnifiedConversational < Struct.new(
|
|
2019
|
+
:source)
|
|
2020
|
+
SENSITIVE = []
|
|
2021
|
+
include Aws::Structure
|
|
2022
|
+
end
|
|
2023
|
+
|
|
2024
|
+
# Conversation turns.
|
|
2025
|
+
#
|
|
2026
|
+
# @!attribute [rw] messages
|
|
2027
|
+
# The conversation turns, in order. The order matters for extraction.
|
|
2028
|
+
# @return [Array<Types::Message>]
|
|
2029
|
+
#
|
|
2030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UnifiedConversationalObject AWS API Documentation
|
|
2031
|
+
#
|
|
2032
|
+
class UnifiedConversationalObject < Struct.new(
|
|
2033
|
+
:messages)
|
|
2034
|
+
SENSITIVE = []
|
|
2035
|
+
include Aws::Structure
|
|
2036
|
+
end
|
|
2037
|
+
|
|
2038
|
+
# The source of a conversation. Set exactly one member. Currently, the
|
|
2039
|
+
# only member is `object`.
|
|
2040
|
+
#
|
|
2041
|
+
# @note UnifiedConversationalSource is a union - when making an API calls you must set exactly one of the members.
|
|
2042
|
+
#
|
|
2043
|
+
# @note UnifiedConversationalSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of UnifiedConversationalSource corresponding to the set member.
|
|
2044
|
+
#
|
|
2045
|
+
# @!attribute [rw] object
|
|
2046
|
+
# The conversation turns.
|
|
2047
|
+
# @return [Types::UnifiedConversationalObject]
|
|
2048
|
+
#
|
|
2049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UnifiedConversationalSource AWS API Documentation
|
|
2050
|
+
#
|
|
2051
|
+
class UnifiedConversationalSource < Struct.new(
|
|
2052
|
+
:object,
|
|
2053
|
+
:unknown)
|
|
2054
|
+
SENSITIVE = []
|
|
2055
|
+
include Aws::Structure
|
|
2056
|
+
include Aws::Structure::Union
|
|
2057
|
+
|
|
2058
|
+
class Object < UnifiedConversationalSource; end
|
|
2059
|
+
class Unknown < UnifiedConversationalSource; end
|
|
2060
|
+
end
|
|
2061
|
+
|
|
2062
|
+
# @!attribute [rw] resource_arn
|
|
2063
|
+
# The Amazon Resource Name (ARN) of the space.
|
|
2064
|
+
# @return [String]
|
|
2065
|
+
#
|
|
2066
|
+
# @!attribute [rw] tag_keys
|
|
2067
|
+
# The keys of the tags to remove from the space.
|
|
2068
|
+
# @return [Array<String>]
|
|
2069
|
+
#
|
|
2070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UntagResourceRequest AWS API Documentation
|
|
2071
|
+
#
|
|
2072
|
+
class UntagResourceRequest < Struct.new(
|
|
2073
|
+
:resource_arn,
|
|
2074
|
+
:tag_keys)
|
|
2075
|
+
SENSITIVE = []
|
|
2076
|
+
include Aws::Structure
|
|
2077
|
+
end
|
|
2078
|
+
|
|
2079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UntagResourceResponse AWS API Documentation
|
|
2080
|
+
#
|
|
2081
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
|
2082
|
+
|
|
2083
|
+
# @!attribute [rw] space_id
|
|
2084
|
+
# The ID of the space that owns the memory, for example
|
|
2085
|
+
# `sp-02864597b164`.
|
|
2086
|
+
# @return [String]
|
|
2087
|
+
#
|
|
2088
|
+
# @!attribute [rw] memory_id
|
|
2089
|
+
# The ID of the memory to update.
|
|
2090
|
+
# @return [String]
|
|
2091
|
+
#
|
|
2092
|
+
# @!attribute [rw] content
|
|
2093
|
+
# Replacement memory text. Supplying it re-embeds the memory. Omit to
|
|
2094
|
+
# leave the text unchanged.
|
|
2095
|
+
# @return [String]
|
|
2096
|
+
#
|
|
2097
|
+
# @!attribute [rw] metadata
|
|
2098
|
+
# The metadata tags to apply. By default this map replaces the stored
|
|
2099
|
+
# metadata, and any key not present is removed. Set `metadataMode` to
|
|
2100
|
+
# `MERGE` to keep the keys you don't supply. Limits apply to the
|
|
2101
|
+
# resulting metadata, not to the request. Keys that begin with
|
|
2102
|
+
# `x-amz-` and the key `documentS3Source` are reserved: a request that
|
|
2103
|
+
# sets one fails with `ValidationException`.
|
|
2104
|
+
#
|
|
2105
|
+
# A space can use at most 50 distinct metadata keys across all of its
|
|
2106
|
+
# events and memories. A request that would add a key beyond that
|
|
2107
|
+
# fails with `ValidationException`. Reuse an existing key instead.
|
|
2108
|
+
# @return [Hash<String,String>]
|
|
2109
|
+
#
|
|
2110
|
+
# @!attribute [rw] metadata_mode
|
|
2111
|
+
# How `metadata` combines with what is stored. The default is
|
|
2112
|
+
# `REPLACE`.
|
|
2113
|
+
# @return [String]
|
|
2114
|
+
#
|
|
2115
|
+
# @!attribute [rw] actor_id
|
|
2116
|
+
# The ID of the actor that the memory must belong to. Omit it to skip
|
|
2117
|
+
# this check. If it doesn't match the stored memory, the call fails
|
|
2118
|
+
# with `ResourceNotFoundException`, as if the memory did not exist.
|
|
2119
|
+
# @return [String]
|
|
2120
|
+
#
|
|
2121
|
+
# @!attribute [rw] strategy_name
|
|
2122
|
+
# The name of the strategy that the memory must belong to. Omit it to
|
|
2123
|
+
# skip this check. If it doesn't match the stored memory, the call
|
|
2124
|
+
# fails with `ResourceNotFoundException`, as if the memory did not
|
|
2125
|
+
# exist.
|
|
2126
|
+
# @return [String]
|
|
2127
|
+
#
|
|
2128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UpdateMemoryInput AWS API Documentation
|
|
2129
|
+
#
|
|
2130
|
+
class UpdateMemoryInput < Struct.new(
|
|
2131
|
+
:space_id,
|
|
2132
|
+
:memory_id,
|
|
2133
|
+
:content,
|
|
2134
|
+
:metadata,
|
|
2135
|
+
:metadata_mode,
|
|
2136
|
+
:actor_id,
|
|
2137
|
+
:strategy_name)
|
|
2138
|
+
SENSITIVE = [:content]
|
|
2139
|
+
include Aws::Structure
|
|
2140
|
+
end
|
|
2141
|
+
|
|
2142
|
+
# @!attribute [rw] memory
|
|
2143
|
+
# The updated memory, in the same shape that `GetMemory` returns.
|
|
2144
|
+
# @return [Types::Memory]
|
|
2145
|
+
#
|
|
2146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UpdateMemoryOutput AWS API Documentation
|
|
2147
|
+
#
|
|
2148
|
+
class UpdateMemoryOutput < Struct.new(
|
|
2149
|
+
:memory)
|
|
2150
|
+
SENSITIVE = []
|
|
2151
|
+
include Aws::Structure
|
|
2152
|
+
end
|
|
2153
|
+
|
|
2154
|
+
# @!attribute [rw] space_id
|
|
2155
|
+
# The ID of the space to update.
|
|
2156
|
+
# @return [String]
|
|
2157
|
+
#
|
|
2158
|
+
# @!attribute [rw] memory_strategies
|
|
2159
|
+
# The complete new list of memory strategies. The service removes
|
|
2160
|
+
# strategies that aren't in the list from the space. Removing a
|
|
2161
|
+
# strategy stops extraction for it but doesn't delete its memories:
|
|
2162
|
+
# they're kept, until they expire if the space sets
|
|
2163
|
+
# `memoryExpiryDays`, and they're available again if you later add a
|
|
2164
|
+
# strategy with the same `type` and `name`. To delete them, use
|
|
2165
|
+
# `DeleteMemory` before you remove the strategy, or delete the space.
|
|
2166
|
+
#
|
|
2167
|
+
# To keep a strategy, include it with the same `type` and `name` that
|
|
2168
|
+
# `GetSpace` returns. For a kept strategy, any `configuration` member
|
|
2169
|
+
# you omit keeps its current value. It doesn't return to the default,
|
|
2170
|
+
# and you can't clear a member once it's set. Omit this field to
|
|
2171
|
+
# leave the strategies unchanged. The list must name at least one
|
|
2172
|
+
# strategy. You can't remove every strategy from a space with
|
|
2173
|
+
# `UpdateSpace`.
|
|
2174
|
+
#
|
|
2175
|
+
# The serialized list can be at most 384 KiB.
|
|
2176
|
+
# @return [Array<Types::MemoryStrategy>]
|
|
2177
|
+
#
|
|
2178
|
+
# @!attribute [rw] event_expiry_days
|
|
2179
|
+
# How many days the space keeps each event, from 1 to 365. Omit it to
|
|
2180
|
+
# leave the current value unchanged. Events already stored keep the
|
|
2181
|
+
# expiry they were written with.
|
|
2182
|
+
# @return [Integer]
|
|
2183
|
+
#
|
|
2184
|
+
# @!attribute [rw] memory_expiry_days
|
|
2185
|
+
# How many days the space keeps each memory, from 0 to 3650. 0 means
|
|
2186
|
+
# memories never expire. Omit it to leave the current value unchanged.
|
|
2187
|
+
# You can't clear the setting. To make memories written from then on
|
|
2188
|
+
# never expire, send 0. `GetSpace` then returns 0.
|
|
2189
|
+
#
|
|
2190
|
+
# A change applies to memories written after it. Memories already
|
|
2191
|
+
# stored keep the expiry they were written with. A memory the service
|
|
2192
|
+
# rewrites later, such as a summary it keeps up to date, takes the
|
|
2193
|
+
# setting in force at that rewrite. A change moves the space to
|
|
2194
|
+
# `UPDATING`. Sending the value that the space has stored doesn't.
|
|
2195
|
+
# @return [Integer]
|
|
2196
|
+
#
|
|
2197
|
+
# @!attribute [rw] extraction_model_id
|
|
2198
|
+
# The model that extracts and consolidates memories for every strategy
|
|
2199
|
+
# in the space: `anthropic.claude-opus-5-5` or
|
|
2200
|
+
# `anthropic.claude-haiku-5-5`. Omit it to leave the current value
|
|
2201
|
+
# unchanged. Once set, it can't be cleared back to the service
|
|
2202
|
+
# default.
|
|
2203
|
+
# @return [String]
|
|
2204
|
+
#
|
|
2205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UpdateSpaceRequest AWS API Documentation
|
|
2206
|
+
#
|
|
2207
|
+
class UpdateSpaceRequest < Struct.new(
|
|
2208
|
+
:space_id,
|
|
2209
|
+
:memory_strategies,
|
|
2210
|
+
:event_expiry_days,
|
|
2211
|
+
:memory_expiry_days,
|
|
2212
|
+
:extraction_model_id)
|
|
2213
|
+
SENSITIVE = []
|
|
2214
|
+
include Aws::Structure
|
|
2215
|
+
end
|
|
2216
|
+
|
|
2217
|
+
# @!attribute [rw] space_id
|
|
2218
|
+
# The ID of the space.
|
|
2219
|
+
# @return [String]
|
|
2220
|
+
#
|
|
2221
|
+
# @!attribute [rw] status
|
|
2222
|
+
# The status of the space: `UPDATING` when the change has to be
|
|
2223
|
+
# applied to the space's strategies, retention, or extraction model.
|
|
2224
|
+
# Otherwise, the space's current status.
|
|
2225
|
+
# @return [String]
|
|
2226
|
+
#
|
|
2227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/UpdateSpaceResponse AWS API Documentation
|
|
2228
|
+
#
|
|
2229
|
+
class UpdateSpaceResponse < Struct.new(
|
|
2230
|
+
:space_id,
|
|
2231
|
+
:status)
|
|
2232
|
+
SENSITIVE = []
|
|
2233
|
+
include Aws::Structure
|
|
2234
|
+
end
|
|
2235
|
+
|
|
2236
|
+
# The request isn't valid. The `reason`, `message`, and `fieldList`
|
|
2237
|
+
# members describe the problem. Fix the request, and then try again.
|
|
2238
|
+
#
|
|
2239
|
+
# @!attribute [rw] message
|
|
2240
|
+
# A message that describes why the request failed validation, such as
|
|
2241
|
+
# the field, key, or limit involved.
|
|
2242
|
+
# @return [String]
|
|
2243
|
+
#
|
|
2244
|
+
# @!attribute [rw] reason
|
|
2245
|
+
# The reason that the request failed validation.
|
|
2246
|
+
# @return [String]
|
|
2247
|
+
#
|
|
2248
|
+
# @!attribute [rw] field_list
|
|
2249
|
+
# The fields that failed validation, if any.
|
|
2250
|
+
# @return [Array<Types::ValidationExceptionField>]
|
|
2251
|
+
#
|
|
2252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ValidationException AWS API Documentation
|
|
2253
|
+
#
|
|
2254
|
+
class ValidationException < Struct.new(
|
|
2255
|
+
:message,
|
|
2256
|
+
:reason,
|
|
2257
|
+
:field_list)
|
|
2258
|
+
SENSITIVE = []
|
|
2259
|
+
include Aws::Structure
|
|
2260
|
+
end
|
|
2261
|
+
|
|
2262
|
+
# Information about a request field that failed validation.
|
|
2263
|
+
#
|
|
2264
|
+
# @!attribute [rw] name
|
|
2265
|
+
# The field name.
|
|
2266
|
+
# @return [String]
|
|
2267
|
+
#
|
|
2268
|
+
# @!attribute [rw] message
|
|
2269
|
+
# A message that describes why the field failed validation.
|
|
2270
|
+
# @return [String]
|
|
2271
|
+
#
|
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/ValidationExceptionField AWS API Documentation
|
|
2273
|
+
#
|
|
2274
|
+
class ValidationExceptionField < Struct.new(
|
|
2275
|
+
:name,
|
|
2276
|
+
:message)
|
|
2277
|
+
SENSITIVE = []
|
|
2278
|
+
include Aws::Structure
|
|
2279
|
+
end
|
|
2280
|
+
|
|
2281
|
+
end
|
|
2282
|
+
end
|
|
2283
|
+
|