{ "smithy": "2.0", "shapes": { "com.amazonaws.opensearchmemory#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "
A message that describes which access the request is missing.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.opensearchmemory#ActorId": { "type": "string", "traits": { "smithy.api#documentation": "The ID of an actor: the end user or agent that events and memories belong to.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" } }, "com.amazonaws.opensearchmemory#ActorIdList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#ActorId" }, "traits": { "smithy.api#documentation": "A list of 1 to 10 actor IDs. A memory or event matches when it belongs to any of them.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.opensearchmemory#BatchGetEvent": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#BatchGetEventInput" }, "output": { "target": "com.amazonaws.opensearchmemory#BatchGetEventOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets up to 10 events by ID, each as GetEvent returns it, including its payload.
If you supply actorId or sessionId, every requested event must match it. Each event has its own outcome. The operation reports an event that it can't return in errors instead of failing, with an error code named for the exception that GetEvent would return for it. The operation reports both an event that doesn't exist and an event outside the supplied scope as RESOURCE_NOT_FOUND.
The exception is the space's customer managed AWS KMS key: if it is disabled, pending deletion, can't be used for decryption, or was deleted, the whole call fails with ValidationException, as GetEvent does.
The ID of the requested event.
", "smithy.api#required": {} } }, "errorCode": { "target": "com.amazonaws.opensearchmemory#BatchGetEventErrorCode", "traits": { "smithy.api#documentation": "The reason that the call didn't return the event.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable description.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A requested event that the call didn't return, and the reason.
" } }, "com.amazonaws.opensearchmemory#BatchGetEventErrorCode": { "type": "enum", "members": { "RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "No such event: it doesn't exist, was deleted, or belongs to another actor or session than the one you supplied. Corresponds to ResourceNotFoundException.
AWS KMS throttled the use of the space's customer managed AWS KMS key to decrypt the event. Retry the event with backoff. Corresponds to ThrottlingException.
You don't have permission to use the space's customer managed AWS KMS key to decrypt the event. To fix it, give the caller kms:Decrypt permission on the key, and then retry the event. Corresponds to AccessDeniedException.
The service couldn't read the event. Retry it. Corresponds to InternalServerException.
Why an event was not returned, named for the exception GetEvent would return for it.
A list of requested events that the call didn't return, each with the reason.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.opensearchmemory#BatchGetEventIdList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#EventId" }, "traits": { "smithy.api#documentation": "A list of event IDs to get.
", "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.opensearchmemory#BatchGetEventInput": { "type": "structure", "members": { "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId", "traits": { "smithy.api#documentation": "The ID of the space.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The actor that every requested event must belong to. Omit it to skip this check. The operation reports an event that doesn't match in errors as RESOURCE_NOT_FOUND.
The session that every requested event must belong to. Omit it to skip this check. The operation reports an event that doesn't match in errors as RESOURCE_NOT_FOUND.
The IDs of the events to get: 1 to 10, without duplicates.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#BatchGetEventOutput": { "type": "structure", "members": { "events": { "target": "com.amazonaws.opensearchmemory#EventList", "traits": { "smithy.api#documentation": "The events found, in the order that you requested their IDs.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.opensearchmemory#BatchGetEventErrorList", "traits": { "smithy.api#documentation": "An entry for each requested event that the call didn't return. Empty when the call returned every event.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#BlobContentType": { "type": "enum", "members": { "PDF": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A PDF document (application/pdf).
The media type of a document submitted as a blob. Only PDF is supported.
The document's media type. Only application/pdf is supported. Any other value fails with ValidationException.
The location of the document.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A document stored in Amazon S3, such as a PDF, and its media type.
" } }, "com.amazonaws.opensearchmemory#BlobSource": { "type": "union", "members": { "s3Location": { "target": "com.amazonaws.opensearchmemory#S3Location", "traits": { "smithy.api#documentation": "The S3 object holding the document.
" } } }, "traits": { "smithy.api#documentation": "The source of a blob's content. Set exactly one member. Currently, the only member is s3Location.
A unique, case-sensitive identifier that makes a request idempotent. It consists of printable ASCII characters, without spaces or control characters.
", "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[!-~]+$" } }, "com.amazonaws.opensearchmemory#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes the conflict.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the resource that caused the conflict.
" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that caused the conflict.
" } } }, "traits": { "smithy.api#documentation": "The request conflicts with the current state of the resource. For example, the space is being created, updated, or deleted, a space with the same name already exists, or you reused a client token with different parameters. Wait for the space to finish being created, updated, or deleted, or use a different name or client token, and then retry.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.opensearchmemory#ConversationalPayload": { "type": "union", "members": { "unified": { "target": "com.amazonaws.opensearchmemory#UnifiedConversational", "traits": { "smithy.api#documentation": "Conversation turns in the service's own format.
" } } }, "traits": { "smithy.api#documentation": "Conversational content. Exactly one member is set.
" } }, "com.amazonaws.opensearchmemory#CreateEvent": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#CreateEventInput" }, "output": { "target": "com.amazonaws.opensearchmemory#CreateEventOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#ConflictException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Submits an event (conversation turns, structured data, or a PDF document stored in Amazon S3) to a session in a space.
The operation returns as soon as the event is saved. GetEvent and ListEvents return it immediately. SearchEvents returns it after it's indexed. SearchMemories returns memories extracted from it only after a strategy's extraction trigger fires and the memories are indexed.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space that owns the event, for example sp-02864597b164.
The ID of the actor (end user or agent) that the event belongs to.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The session the event belongs to. Send every event of one conversation with the same session ID, so that SUMMARY strategies summarize the conversation as one session. If you omit it, the service generates a session ID and returns it.
When the event occurred. The default is the time that the service receives the request.
" } }, "payload": { "target": "com.amazonaws.opensearchmemory#EventPayload", "traits": { "smithy.api#documentation": "The event content. Set exactly one union member.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "Metadata tags to store with the event. Memories derived from the event carry the same tags. Keys that begin with x-amz-, the keys documentS3Source and documentS3Url, and other keys that the service uses internally are reserved: a request that sets one fails with ValidationException, and the message names the key.
A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.
A unique, case-sensitive identifier that makes the request idempotent. Within 2 hours of the first request, a retry with the same token and the same request, including the same sessionId, returns the same event. If you omit sessionId, the service generates a new one on each attempt, so a retry fails with ConflictException. Reusing the token with different request content also fails with ConflictException. eventTimestamp isn't compared. After 2 hours, the token starts a new event.
Specifies whether to extract memories from this event. The default is true. Set it to false to store the event without extraction: the service skips strategies that infer memories, and still indexes the event's turns for SearchEvents. A document submitted as a blob is still extracted.
The stored event's identifiers: its ID, session, and timestamp.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#CreateMemory": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#CreateMemoryInput" }, "output": { "target": "com.amazonaws.opensearchmemory#CreateMemoryOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#ConflictException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Writes a memory that you have already formed, without extracting it from events. The service embeds the text as given and stores it as a memory of the named strategy. To have the service extract memories from conversation turns, use CreateEvent instead.
The operation returns before the memory is searchable. The returned memoryId is final, but until the memory is indexed, GetMemory, UpdateMemory, and DeleteMemory return ResourceNotFoundException for it.
If the request would exceed the service's rate for embedding requests, it fails with ThrottlingException. Retry with exponential backoff.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The memory text for CreateMemory: 1 to 16,000 characters and at most about 6,000 tokens, not blank, and well-formed Unicode. Longer text fails with ValidationException.
The final ID of the memory. Until the memory is indexed, GetMemory, UpdateMemory, and DeleteMemory return ResourceNotFoundException for it.
The ID of the space.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchmemory#StrategyName", "traits": { "smithy.api#documentation": "The name of the strategy the memory belongs to.
", "smithy.api#required": {} } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The ID of the actor the memory belongs to.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The ID of the session the memory belongs to, including one the service generated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The memory as CreateMemory acknowledges it: its identifiers. The memory isn't searchable yet when the call returns.
The ID of the space that owns the memory, for example sp-02864597b164.
The name of the strategy that the memory belongs to. The space must already declare the strategy, and the memory's type comes from that strategy. The name must be 1 to 64 characters: letters, digits, periods, hyphens, and underscores, starting with a letter or digit.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.opensearchmemory#CreateMemoryContent", "traits": { "smithy.api#documentation": "The memory text, stored and embedded as provided.
", "smithy.api#required": {} } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The actor (end user or agent) that owns the memory.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The session that the memory belongs to. If you omit it, the service generates a session ID and returns it.
" } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "Metadata tags to store with the memory. Keys that begin with x-amz-, the key documentS3Source, and other keys that the service uses internally are reserved: a request that sets one fails with ValidationException, and the message names the key.
A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.
A unique, case-sensitive identifier that makes the request idempotent. Within 2 hours of the first request, a retry with the same token returns the same memoryId instead of creating a second memory. Reusing the token with a different name, content, metadata, actorId, or sessionId fails with ConflictException. If you omit sessionId, a retry with the same token gets the same session. If you omit the token, each call creates a new memory.
The request for CreateMemory.
The memory, identified but not yet indexed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The acknowledged memory. It isn't searchable yet when the call returns.
", "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#CreateSpace": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#CreateSpaceRequest" }, "output": { "target": "com.amazonaws.opensearchmemory#CreateSpaceResponse" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#ConflictException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ServiceQuotaExceededException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a space. A space is an AWS resource that stores the events you send and the memories extracted from them, and defines the memory strategies that extract those memories.
The operation returns before provisioning finishes, with status CREATING. Call GetSpace until the status is ACTIVE, and then use the space. If provisioning fails, the status becomes FAILED and statusReason says why.
A name for the space, unique within your account in the Region. If another space already has the name, the request fails with ConflictException.
The memory strategies that extract memories from the space's events: up to 10 strategies, each with a name that is unique within the space.
Optional. Omit it, or send an empty list, to create a space with no memory strategies. Such a space stores the conversation events you send it and returns them through SearchEvents and ListEvents, but extracts no memories and has none to search. You can add strategies later with UpdateSpace.
The serialized list can be at most 384 KiB.
" } }, "eventExpiryDays": { "target": "com.amazonaws.opensearchmemory#EventExpiryDays", "traits": { "smithy.api#documentation": "How many days the space keeps each event, from 1 to 365. The default is 90.
" } }, "memoryExpiryDays": { "target": "com.amazonaws.opensearchmemory#MemoryExpiryDays", "traits": { "smithy.api#documentation": "How many days the space keeps each memory, from 0 to 3650, counted from when the service writes the memory. Updating a memory with UpdateMemory doesn't restart the count. 0 means memories never expire. If you omit it, memories never expire.
Searches and lists leave out a memory past its expiry, and reading, updating, or deleting it returns ResourceNotFoundException.
The model that extracts and consolidates memories for every strategy in the space, as an Amazon Bedrock model ID without an inference-profile prefix: anthropic.claude-opus-5-5 or anthropic.claude-haiku-5-5. Another value fails with ValidationException, and the message lists the supported IDs. Omit it to use the service default, which can change over time and isn't returned by GetSpace. Setting a value pins the model.
The AWS KMS key that encrypts the space's data. Omit it, or omit its kmsKeyArn, to use an AWS owned key. You can't change the key after you create the space.
The tags to add to the space.
" } }, "clientToken": { "target": "com.amazonaws.opensearchmemory#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that makes the request idempotent. A retry with the same token and the same parameters within 2 hours returns the space that the first request created, instead of creating another. Reusing the token with different parameters, or while the first request is still in progress, fails with ConflictException.
The ID of the space.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.opensearchmemory#SpaceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the space.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchmemory#SpaceName", "traits": { "smithy.api#documentation": "The name of the space.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.opensearchmemory#SpaceStatus", "traits": { "smithy.api#documentation": "The status of the space: CREATING.
When the space was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#DeleteEvent": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#DeleteEventInput" }, "output": { "target": "com.amazonaws.opensearchmemory#DeleteEventOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an event. Deletion can't be undone. The event stops appearing in SearchEvents results shortly after you delete it. Deleting an event that doesn't exist returns ResourceNotFoundException.
Deleting an event doesn't delete the memories derived from it, because a memory can combine content from several events. To remove them, use DeleteMemory.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "eventId": { "target": "com.amazonaws.opensearchmemory#EventId", "traits": { "smithy.api#documentation": "The ID of the event to delete.
", "smithy.api#required": {} } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The actor that the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with ResourceNotFoundException, as if the event did not exist.
The session that the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with ResourceNotFoundException, as if the event did not exist.
The ID of the deleted event.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#DeleteMemory": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#DeleteMemoryInput" }, "output": { "target": "com.amazonaws.opensearchmemory#DeleteMemoryOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a memory, including its content and embedding. Deletion can't be undone. Searches stop returning the memory shortly after you delete it.
Deleting a memory that no longer exists returns ResourceNotFoundException, so the operation is not idempotent. If you retry deletes, treat that error as success.
A memory past its expiry (set from the space's memoryExpiryDays when the memory is written) reads as not found: the operation returns ResourceNotFoundException, as for a memory that was already deleted.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space that owns the memory.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "memoryId": { "target": "com.amazonaws.opensearchmemory#MemoryId", "traits": { "smithy.api#documentation": "The ID of the memory to delete.
", "smithy.api#required": {} } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The ID of the actor that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
The name of the strategy that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
The ID of the deleted memory.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#DeleteSpace": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#DeleteSpaceRequest" }, "output": { "target": "com.amazonaws.opensearchmemory#DeleteSpaceResponse" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#ConflictException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a space and its memories. Deletion can't be undone. After you delete the space, you can't retrieve its events, and the service removes them when they reach their expiry.
The operation returns with status DELETING. When deletion finishes, GetSpace returns ResourceNotFoundException. If deletion fails, the status becomes FAILED. A space that is CREATING or UPDATING can't be deleted until that finishes: the request fails with ConflictException. Deleting a space that is already DELETING returns DELETING again.
The ID of the space to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#DeleteSpaceResponse": { "type": "structure", "members": { "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId", "traits": { "smithy.api#documentation": "The ID of the space.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.opensearchmemory#SpaceStatus", "traits": { "smithy.api#documentation": "The status of the space: DELETING.
The ARN of a customer managed AWS KMS key that encrypts the space's data. The key must be an enabled symmetric encryption key in the space's Region, and you need permission to create grants on it (kms:CreateGrant). Otherwise, the request fails with ValidationException or AccessDeniedException.
Encryption settings for a space.
" } }, "com.amazonaws.opensearchmemory#Event": { "type": "structure", "members": { "eventId": { "target": "com.amazonaws.opensearchmemory#EventId", "traits": { "smithy.api#documentation": "The event's ID.
", "smithy.api#required": {} } }, "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId", "traits": { "smithy.api#documentation": "The ID of the space.
", "smithy.api#required": {} } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The ID of the actor the event belongs to.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The ID of the session the event belongs to.
", "smithy.api#required": {} } }, "payload": { "target": "com.amazonaws.opensearchmemory#EventPayload", "traits": { "smithy.api#documentation": "The event's content, as submitted to CreateEvent.
The event's metadata tags, as supplied to CreateEvent. May be empty.
The time the event occurred.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An event, including its payload.
" } }, "com.amazonaws.opensearchmemory#EventDetail": { "type": "structure", "members": { "eventId": { "target": "com.amazonaws.opensearchmemory#EventId", "traits": { "smithy.api#documentation": "The event's ID, assigned by the service. Use it with GetEvent and DeleteEvent.
The ID of the space.
", "smithy.api#required": {} } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The ID of the actor the event belongs to.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The ID of the session the event belongs to, including one the service generated.
", "smithy.api#required": {} } }, "eventTimestamp": { "target": "com.amazonaws.opensearchmemory#EventTimestamp", "traits": { "smithy.api#documentation": "When the event occurred: the value supplied, or the time the request was received.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The stored event's identifiers. Call GetEvent for the payload.
An event ID, assigned by the service.
", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.opensearchmemory#EventList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#Event" }, "traits": { "smithy.api#documentation": "A list of events.
", "smithy.api#length": { "max": 10 } } }, "com.amazonaws.opensearchmemory#EventPayload": { "type": "union", "members": { "conversational": { "target": "com.amazonaws.opensearchmemory#ConversationalPayload", "traits": { "smithy.api#documentation": "Conversation turns.
" } }, "structuredData": { "target": "com.amazonaws.opensearchmemory#StructuredDataPayload", "traits": { "smithy.api#documentation": "Structured (non-conversational) content, for example a deployment result that an agent should remember.
" } }, "blob": { "target": "com.amazonaws.opensearchmemory#BlobPayload", "traits": { "smithy.api#documentation": "A document stored in Amazon S3, such as a PDF.
" } } }, "traits": { "smithy.api#documentation": "The event content. Exactly one member must be set.
" } }, "com.amazonaws.opensearchmemory#EventSearchSummary": { "type": "structure", "members": { "eventId": { "target": "com.amazonaws.opensearchmemory#EventId", "traits": { "smithy.api#documentation": "The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent.
The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.
" } }, "systemMetadata": { "target": "com.amazonaws.opensearchmemory#SystemMetadata", "traits": { "smithy.api#documentation": "Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.
Absent when the service has no provenance for the chunk.
" } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "The event's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.
The text of the matching chunk.
" } } }, "traits": { "smithy.api#documentation": "A SearchEvents result: the matching chunk of an event and its provenance. Unlike EventSummary from ListEvents, it has a relevance score and the matched content, but not the full payload.
A list of SearchEvents results.
The event's ID.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "The event's metadata tags, as supplied to CreateEvent. May be empty.
The time the event occurred.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of an event, as returned by ListEvents. It doesn't include the payload.
A list of event summaries.
" } }, "com.amazonaws.opensearchmemory#EventTimestamp": { "type": "timestamp", "traits": { "smithy.api#documentation": "The time of an event or memory.
", "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.opensearchmemory#ExtractionModelId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9._:-]*$" } }, "com.amazonaws.opensearchmemory#ExtractionPrompt": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 30720 }, "smithy.api#sensitive": {} } }, "com.amazonaws.opensearchmemory#GetEvent": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#GetEventInput" }, "output": { "target": "com.amazonaws.opensearchmemory#GetEventOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets an event by ID, including its payload.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "eventId": { "target": "com.amazonaws.opensearchmemory#EventId", "traits": { "smithy.api#documentation": "The event's ID, as returned by CreateEvent, ListEvents, or SearchEvents.
The actor the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with ResourceNotFoundException, as if the event did not exist.
The session the event must belong to. Omit it to skip this check. If it doesn't match the stored event, the call fails with ResourceNotFoundException, as if the event did not exist.
The event, including its payload.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#GetMemory": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#GetMemoryInput" }, "output": { "target": "com.amazonaws.opensearchmemory#GetMemoryOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets a memory by ID, as returned by SearchMemories or ListMemories. A memory that doesn't exist returns ResourceNotFoundException. Unlike SearchMemories, this operation also returns memories that consolidation has superseded.
A memory past its expiry (set from the space's memoryExpiryDays when the memory is written) reads as not found: ResourceNotFoundException, the same answer as for an ID that does not exist.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space that holds the memory.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "memoryId": { "target": "com.amazonaws.opensearchmemory#MemoryId", "traits": { "smithy.api#documentation": "The memory's ID, as returned by SearchMemories or ListMemories.
The ID of the actor the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
The name of the strategy the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
The memory. Always present: a memory that doesn't exist returns ResourceNotFoundException.
Returns a space's configuration and status.
", "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetSpaceNotFound", "params": { "spaceId": "sp-000000000000" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "failure": { "errorId": "com.amazonaws.opensearchmemory#ResourceNotFoundException" } } } ], "smithy.waiters#waitable": { "SpaceActive": { "documentation": "Waits until the space is `ACTIVE`.", "minDelay": 10, "maxDelay": 600, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "retry", "matcher": { "output": { "path": "status", "expected": "CREATING", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "status", "expected": "UPDATING", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } }, "message": "'The space is FAILED; call GetSpace for statusReason'" }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETING", "comparator": "stringEquals" } }, "message": "'The space is being deleted (DELETING)'" }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } }, "message": "'The space was deleted (DELETED)'" } ] }, "SpaceDeleted": { "documentation": "Waits until the space is deleted.", "minDelay": 10, "maxDelay": 600, "acceptors": [ { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "status", "expected": "DELETING", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } }, "message": "'The space failed to delete (FAILED); call GetSpace for statusReason'" } ] } } } }, "com.amazonaws.opensearchmemory#GetSpaceRequest": { "type": "structure", "members": { "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId", "traits": { "smithy.api#documentation": "The ID of the space.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#GetSpaceResponse": { "type": "structure", "members": { "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId", "traits": { "smithy.api#documentation": "The ID of the space.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.opensearchmemory#SpaceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the space.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchmemory#SpaceName", "traits": { "smithy.api#documentation": "The name of the space.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.opensearchmemory#SpaceStatus", "traits": { "smithy.api#documentation": "The status of the space.
", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Details about why the space is FAILED. Read it only when status is FAILED: it can still hold the reason for an earlier failure.
When the space was created.
", "smithy.api#required": {} } }, "memoryStrategies": { "target": "com.amazonaws.opensearchmemory#MemoryStrategyList", "traits": { "smithy.api#documentation": "The space's memory strategies, including the names the service generated for strategies created without one. Empty for a space that has no memory strategies.
" } }, "eventExpiryDays": { "target": "com.amazonaws.opensearchmemory#EventExpiryDays", "traits": { "smithy.api#documentation": "How many days the space keeps each event. Absent when it was never set, in which case the default of 90 days applies.
" } }, "memoryExpiryDays": { "target": "com.amazonaws.opensearchmemory#MemoryExpiryDays", "traits": { "smithy.api#documentation": "How many days the space keeps each memory. 0 means memories never expire. Absent when it was never set, in which case memories never expire.
" } }, "extractionModelId": { "target": "com.amazonaws.opensearchmemory#ExtractionModelId", "traits": { "smithy.api#documentation": "The model that extracts and consolidates memories for the space. Absent when it was never set, in which case the service default applies.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.opensearchmemory#EncryptionConfiguration", "traits": { "smithy.api#documentation": "The AWS KMS key the space was created with. Absent when the space uses an AWS owned key.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#IdleTimeoutSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 86400 } } }, "com.amazonaws.opensearchmemory#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes the internal error.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The service couldn't process the request because of an internal error. Retry the request.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.opensearchmemory#ListEvents": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#ListEventsInput" }, "output": { "target": "com.amazonaws.opensearchmemory#ListEventsOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the events in a session, sorted by time. Optionally limit the results to events whose eventTimestamp falls between eventTimestampAfter and eventTimestampBefore. Returns event metadata only. Call GetEvent for the payload. For full-text or relevance search, use SearchEvents.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "actorId": { "target": "com.amazonaws.opensearchmemory#ActorId", "traits": { "smithy.api#documentation": "The actor whose events to list.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The session whose events to list. To find events across sessions, use SearchEvents.
Inclusive upper bound on eventTimestamp: only events at or before this time are returned. Omit for no upper bound.
Inclusive lower bound on eventTimestamp: only events at or after this time are returned. Omit for no lower bound.
If it's later than eventTimestampBefore, the request fails with ValidationException.
The order of the results by eventTimestamp: ASC or DESC. The default is DESC, most recent first.
Returns only events whose metadata contains every one of these key-value pairs. Omit, or leave empty, for no metadata filter. The service applies the filter after it reads events, so a page can hold fewer than maxResults events, or none, and still return a nextToken. Keep paging until nextToken is absent.
The maximum number of events to return, from 1 to 100. The default is 20.
" } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#ListEventsOutput": { "type": "structure", "members": { "events": { "target": "com.amazonaws.opensearchmemory#EventSummaryList", "traits": { "smithy.api#documentation": "The events, without their payloads. Call GetEvent for an event's payload.
The token for the next set of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#ListMemories": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#ListMemoriesInput" }, "output": { "target": "com.amazonaws.opensearchmemory#ListMemoriesOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists a space's memories without a query, for example the most recent memories or the memories of one strategy. Filter by strategy and optionally by owning actor or session, sort by creation or update time, and page through the results. Results have no relevance score. To query or filter by metadata, use SearchMemories.
If memories are written or deleted while you page, the results can skip a memory or return it twice. You can page through only a limited number of results. A request past that limit fails with ValidationException (reason invalidNextToken), and the message gives the limit.
Memories past their expiry (set from the space's memoryExpiryDays when each memory is written) are left out. Unlike SearchMemories, this operation also returns memories that consolidation has superseded.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The space whose memories to list.
", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "SpaceId" } } }, "memoryStrategies": { "target": "com.amazonaws.opensearchmemory#StrategySelectorList", "traits": { "smithy.api#documentation": "The strategies to list, as selectors. A selector without memoryStrategyNames lists every strategy of its type, and omitting memoryStrategies lists every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.
Lists only memories owned by one of these actors. Combined with sessionIds by AND: a memory must match both filters when both are given. Omit for no actor filter. An empty list fails validation. A memory stored without an actor never matches an actor filter.
Lists only memories from one of these sessions. Combined with actorIds by AND. Omit for no session filter. An empty list fails validation. A memory stored without a session never matches a session filter.
The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_AT.
The sort order: ASC or DESC. The default is DESC, most recent first.
The maximum number of memories to return, from 1 to 100. The default is 20.
" } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#ListMemoriesOutput": { "type": "structure", "members": { "memories": { "target": "com.amazonaws.opensearchmemory#MemoryListSummaryList", "traits": { "smithy.api#documentation": "The memories, in the requested order. Empty when there are none.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#ListSpaces": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#ListSpacesRequest" }, "output": { "target": "com.amazonaws.opensearchmemory#ListSpacesResponse" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the spaces in your account in the current Region.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "spaces" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListSpacesSuccess", "params": { "maxResults": 1 }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.opensearchmemory#ListSpacesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.opensearchmemory#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of spaces to return, from 1 to 100. The default is 100.
" } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#ListSpacesResponse": { "type": "structure", "members": { "spaces": { "target": "com.amazonaws.opensearchmemory#SpaceSummaryList", "traits": { "smithy.api#documentation": "The spaces.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.opensearchmemory#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the tags for the specified space.
", "smithy.api#readonly": {} } }, "com.amazonaws.opensearchmemory#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.opensearchmemory#SpaceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the space.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.opensearchmemory#Space", "ids": { "spaceId": "resourceArn" } } ] } }, "com.amazonaws.opensearchmemory#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.opensearchmemory#TagList", "traits": { "smithy.api#documentation": "The tags for the space.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchmemory#Memory": { "type": "structure", "members": { "memoryId": { "target": "com.amazonaws.opensearchmemory#MemoryId", "traits": { "smithy.api#documentation": "The memory's ID, assigned by the service.
", "smithy.api#required": {} } }, "memoryType": { "target": "com.amazonaws.opensearchmemory#MemoryType", "traits": { "smithy.api#documentation": "The memory type.
", "smithy.api#required": {} } }, "strategyName": { "target": "com.amazonaws.opensearchmemory#StrategyName", "traits": { "smithy.api#documentation": "The name of the strategy the memory belongs to, for example user-facts. A space can hold several strategies of the same type, so this tells them apart. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.
The memory text.
", "smithy.api#required": {} } }, "systemMetadata": { "target": "com.amazonaws.opensearchmemory#SystemMetadata", "traits": { "smithy.api#documentation": "Provenance for the memory: the owning actor and session, and when it was created and last updated. Always present. updatedAt equals createdAt for a memory that has never been updated.
The memory's metadata tags. All values are strings. May be empty.
" } } }, "traits": { "smithy.api#documentation": "A memory, as returned by GetMemory and UpdateMemory. Unlike MemoryListSummary it includes content, and unlike MemorySearchSummary it has no relevance score.
A memory ID assigned by the service, for example mem-<uuid>. IDs are opaque and can contain hyphens (-) and underscores (_).
The memory's ID, assigned by the service. IDs are opaque, can contain hyphens and underscores, and can be up to 512 characters long.
", "smithy.api#required": {} } }, "memoryType": { "target": "com.amazonaws.opensearchmemory#MemoryType", "traits": { "smithy.api#documentation": "The memory type.
", "smithy.api#required": {} } }, "strategyName": { "target": "com.amazonaws.opensearchmemory#StrategyName", "traits": { "smithy.api#documentation": "The name of the strategy the memory belongs to, for example user-facts: the strategy memoryStrategies selects on in ListMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.
Provenance for the memory: the owning actor and session, and when it was created and last updated. Always present, with both timestamps.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "The memory's metadata tags. All values are strings.
" } } }, "traits": { "smithy.api#documentation": "A summary of a memory, as returned by ListMemories: its ID, type, provenance, and tags. It doesn't include content. Call GetMemory for the full memory.
A list of memory summaries.
" } }, "com.amazonaws.opensearchmemory#MemorySearchSummary": { "type": "structure", "members": { "memoryId": { "target": "com.amazonaws.opensearchmemory#MemoryId", "traits": { "smithy.api#documentation": "The memory's ID, assigned by the service. Always present.
", "smithy.api#required": {} } }, "memoryType": { "target": "com.amazonaws.opensearchmemory#MemoryType", "traits": { "smithy.api#documentation": "The memory type of the result.
" } }, "strategyName": { "target": "com.amazonaws.opensearchmemory#StrategyName", "traits": { "smithy.api#documentation": "The name of the strategy the memory belongs to, for example user-facts: the strategy memoryStrategies selects on in SearchMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.
The memory text.
" } }, "score": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.
" } }, "systemMetadata": { "target": "com.amazonaws.opensearchmemory#SystemMetadata", "traits": { "smithy.api#documentation": "Provenance for the memory: the actor and session that own it, and when it was created and last updated. It is the same block that ListMemories, GetMemory, and SearchEvents return.
In a query, filter or sort on the timestamps as system_metadata.created_at and system_metadata.updated_at. Scope by owner with the top-level actorId, not in the query. Searching memories doesn't filter by session.
Absent when the service has no provenance for the memory.
" } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "The memory's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.
The IDs of the events the memory was derived from, without duplicates. Use them with GetEvent or BatchGetEvent, or to search those events' content with SearchEvents by filtering on event_ids in the query. Absent for a memory created directly with CreateMemory. A memory can be derived from several events. The service sets this value.
A SearchMemories result: a matching memory and its relevance score.
A list of SearchMemories results.
Sort by systemMetadata.createdAt.
Sort by systemMetadata.updatedAt.
The timestamp that ListMemories sorts by.
The type of memory the strategy extracts.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchmemory#MemoryStrategyName", "traits": { "smithy.api#documentation": "A name for the strategy, unique within the space. Omit it to have the service generate one from the type, for example semantic_1. The name must be 1 to 64 characters: letters, digits, periods, hyphens, and underscores, starting with a letter or digit. A strategy's name can't be changed, and the strategy's memories are stored under it: a strategy added under a new name starts with no memories.
A description of the strategy.
" } }, "configuration": { "target": "com.amazonaws.opensearchmemory#MemoryStrategyConfiguration", "traits": { "smithy.api#documentation": "Settings for the strategy. When you create a strategy, omit it to use the defaults for the strategy's type.
A CUSTOM strategy must set extractionPrompt.
A memory strategy: how a space extracts one kind of memory from its events.
" } }, "com.amazonaws.opensearchmemory#MemoryStrategyConfiguration": { "type": "structure", "members": { "extractionPrompt": { "target": "com.amazonaws.opensearchmemory#ExtractionPrompt", "traits": { "smithy.api#documentation": "Instructions that define what a CUSTOM strategy extracts, up to 30,720 characters. Required for a CUSTOM strategy: CreateSpace and UpdateSpace fail with ValidationException if a CUSTOM strategy has none.
Only CUSTOM strategies use it. SEMANTIC and SUMMARY strategies always extract with the service's built-in instructions: the service accepts and stores a prompt on them, and GetSpace returns it, but extraction doesn't use it.
Extract once this many messages have accumulated, from 1 to 1000. Lower values extract more often, in smaller batches. The default is 12.
Messages accumulate until the first of extractEveryNMessages, extractEveryNTokens, and idleTimeoutSeconds is reached. The service then extracts them together in one pass.
Extract once this many tokens of conversation have accumulated, from 1 to 80,000, however few messages that takes. Use it to bound how much text one extraction call carries when message sizes vary widely. Omit it to bound a batch only by extractEveryNMessages, idleTimeoutSeconds, and the service's maximum batch size.
Extract what has accumulated once the conversation has been idle for this many seconds, from 1 to 86,400. The default is 60. This is what extracts the end of a conversation that stops. Raise it when the pauses in your conversations are longer than that, so that one exchange isn't split across several extraction passes.
" } }, "extractionSeedTopK": { "target": "com.amazonaws.opensearchmemory#SeedMemoryCount", "traits": { "smithy.api#documentation": "How many of the strategy's stored memories that are most relevant to the conversation to include in the extraction prompt, from 0 to 20, to improve extraction and reduce duplicates. If you omit this or set it to 0, the service uses its default (see extractionSeedRecentN). When this and extractionSeedRecentN are both set, the two sets of memories are combined without duplicates.
How many of the strategy's most recent stored memories to include in the extraction prompt, from 0 to 20. If you omit this or set it to 0, the service uses its default: no seeding for most strategy types, and the 10 most recent memories for a SUMMARY strategy when neither seed setting is given. When this and extractionSeedTopK are both set, the two sets of memories are combined without duplicates.
Specifies whether the strategy consolidates memories. With consolidation, each new memory is compared with similar stored memories, and the service adds it, updates a stored memory, or skips it, so duplicate or contradicting facts don't accumulate. Without it, every extracted memory is stored as a new memory, which costs less and keeps a full history.
When omitted, the default depends on the strategy's type: on for SEMANTIC and SUMMARY, off for CUSTOM.
Settings for a memory strategy. The defaults described here apply when you create a strategy. In UpdateSpace, a member you omit for a kept strategy keeps its current value.
A list of up to 10 memory strategies. CreateSpace accepts an empty list. UpdateSpace doesn't.
Facts extracted from conversations.
", "smithy.api#enumValue": "SEMANTIC" } }, "SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Summaries of conversations.
", "smithy.api#enumValue": "SUMMARY" } }, "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Memories extracted with the instructions in the strategy's extractionPrompt.
Requires extractionPrompt.
The type of memory a strategy extracts.
" } }, "com.amazonaws.opensearchmemory#MemoryType": { "type": "enum", "members": { "SEMANTIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Facts extracted from conversations.
", "smithy.api#enumValue": "SEMANTIC" } }, "SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Summaries of conversations.
", "smithy.api#enumValue": "SUMMARY" } }, "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Memories extracted with a custom strategy's instructions.
", "smithy.api#enumValue": "CUSTOM" } } }, "traits": { "smithy.api#documentation": "The type of a memory. Matches the type of the memory strategy that produced it.
" } }, "com.amazonaws.opensearchmemory#MemoryUpdateContent": { "type": "string", "traits": { "smithy.api#documentation": "Replacement text for a memory, at most about 6,000 tokens. It must not be blank and must be well-formed Unicode. Longer text fails with ValidationException.
The author of the turn.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.opensearchmemory#MessageContent", "traits": { "smithy.api#documentation": "The content of the turn.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A conversation turn.
" } }, "com.amazonaws.opensearchmemory#MessageContent": { "type": "structure", "members": { "text": { "target": "com.amazonaws.opensearchmemory#MessageText", "traits": { "smithy.api#documentation": "The text of the turn.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The content of a conversation turn.
" } }, "com.amazonaws.opensearchmemory#MessageList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#Message" }, "traits": { "smithy.api#documentation": "Ordered conversation turns for a single event.
", "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.opensearchmemory#MessageRole": { "type": "enum", "members": { "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The end user.
", "smithy.api#enumValue": "USER" } }, "ASSISTANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The agent or model.
", "smithy.api#enumValue": "ASSISTANT" } }, "SYSTEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "System instructions.
", "smithy.api#enumValue": "SYSTEM" } } }, "traits": { "smithy.api#documentation": "The author of a turn.
" } }, "com.amazonaws.opensearchmemory#MessageText": { "type": "string", "traits": { "smithy.api#documentation": "The text of a single turn. It must be well-formed Unicode: text that contains an unpaired UTF-16 surrogate fails with ValidationException.
There is no separate limit for one turn. A single turn can use the whole event limit of 5 MiB of UTF-8 text across all turns, and the service splits long turns itself.
", "smithy.api#length": { "min": 1, "max": 5242880 }, "smithy.api#sensitive": {} } }, "com.amazonaws.opensearchmemory#MetadataKey": { "type": "string", "traits": { "smithy.api#documentation": "A metadata key: letters, digits, hyphens (-), and underscores (_). Dots are not allowed, because a query uses dots to separate nested field names.
Metadata tags: key-value pairs that you attach to an event or memory.
A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.
Replace the stored metadata with exactly the entries supplied, removing any key not present. The default.
", "smithy.api#enumValue": "REPLACE" } }, "MERGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Merges the supplied entries into the stored metadata. Keys that you don't supply keep their values. An entry whose value is the empty string removes that key.
", "smithy.api#enumValue": "MERGE" } } }, "traits": { "smithy.api#documentation": "How an UpdateMemory request's metadata combines with the stored metadata. The default is REPLACE.
The value of a metadata entry.
", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s._:\\/=+@-]*$" } }, "com.amazonaws.opensearchmemory#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.opensearchmemory#OpenSearchMemory": { "type": "service", "version": "2026-08-24", "operations": [ { "target": "com.amazonaws.opensearchmemory#ListTagsForResource" }, { "target": "com.amazonaws.opensearchmemory#TagResource" }, { "target": "com.amazonaws.opensearchmemory#UntagResource" } ], "resources": [ { "target": "com.amazonaws.opensearchmemory#Space" } ], "traits": { "aws.api#service": { "sdkId": "OpenSearchMemory", "arnNamespace": "osm", "endpointPrefix": "osm" }, "aws.auth#sigv4": { "name": "osm" }, "aws.iam#defineConditionKeys": { "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by a list of tag keys that are allowed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "Amazon OpenSearch Memory lets your AI agents and applications recall facts and summaries across sessions. Your agents send events, such as conversation turns, and search the memories derived from them.
A space groups related events and memories, and holds the memory strategies that you configure for them. Use the space operations to create, get, list, update, and delete spaces. Use the event and memory operations to write, read, list, search, update, and delete a space's events and memories.
", "smithy.api#title": "Amazon OpenSearch Memory", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": true, "documentation": "The AWS Region to send the request to.", "type": "string" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "An endpoint URL to use instead of the one the rules resolve.", "type": "string" }, "SpaceId": { "required": false, "documentation": "The ID of the space the request targets. When set, the request goes to that space's endpoint.", "type": "string" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send the request to a FIPS endpoint. The service has no FIPS endpoint, so the request fails.", "type": "boolean" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "Region" }, true ] }, { "fn": "isSet", "argv": [ { "ref": "SpaceId" } ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "SpaceId" }, false ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": "{Endpoint}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: FIPS is not supported with OpenSearch Memory.", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Region must be a valid host label", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{SpaceId}.osm.{Region}.on.aws", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid SpaceId: must be a valid host label", "type": "error" }, { "documentation": "Space and tagging operations: the regional endpoint.", "conditions": [], "endpoint": { "url": "https://osm.{Region}.api.aws", "properties": {}, "headers": {} }, "type": "endpoint" } ], "root": 2, "nodeCount": 7, "nodes": "/////wAAAAH/////AAAAAAAAAAcAAAADAAAAAQX14QMAAAAEAAAAAgAAAAUF9eEEAAAAAwAAAAYF9eEHAAAABAX14QUF9eEGAAAAAQX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "type": "string", "builtIn": "AWS::Region", "required": true, "documentation": "The AWS Region to send the request to." }, "Endpoint": { "type": "string", "builtIn": "SDK::Endpoint", "required": false, "documentation": "An endpoint URL to use instead of the one the rules resolve." }, "SpaceId": { "type": "string", "required": false, "documentation": "The ID of the space the request targets. When set, the request goes to that space's endpoint." }, "UseFIPS": { "type": "boolean", "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send the request to a FIPS endpoint. The service has no FIPS endpoint, so the request fails." } }, "rules": [ { "documentation": "FIPS with an endpoint override.", "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "documentation": "Endpoint override.", "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "endpoint": { "url": "{Endpoint}" }, "type": "endpoint" }, { "documentation": "The service has no FIPS endpoint.", "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS is not supported with OpenSearch Memory.", "type": "error" }, { "documentation": "The Region is part of the host name, so it must be a valid host label.", "conditions": [ { "fn": "not", "argv": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "Region" }, true ] } ] } ], "error": "Invalid Configuration: Region must be a valid host label", "type": "error" }, { "documentation": "Event and memory operations: the space's own endpoint.", "conditions": [ { "fn": "isSet", "argv": [ { "ref": "SpaceId" } ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "SpaceId" }, false ] } ], "endpoint": { "url": "https://{SpaceId}.osm.{Region}.on.aws" }, "type": "endpoint" }, { "documentation": "A space ID that is not a single host label is not put in the host name.", "conditions": [ { "fn": "isSet", "argv": [ { "ref": "SpaceId" } ] } ], "error": "Invalid SpaceId: must be a valid host label", "type": "error" }, { "documentation": "Space and tagging operations: the regional endpoint.", "conditions": [], "endpoint": { "url": "https://osm.{Region}.api.aws" }, "type": "endpoint" } ] }, "smithy.rules#endpointTests": { "version": "1.0", "testCases": [ { "documentation": "A space ID that is not a host label is rejected rather than put in the host name.", "params": { "Region": "us-east-1", "SpaceId": "evil.example/#" }, "expect": { "error": "Invalid SpaceId: must be a valid host label" } }, { "documentation": "A Region that is not a host label is rejected.", "params": { "Region": "us-east-1/#" }, "expect": { "error": "Invalid Configuration: Region must be a valid host label" } }, { "documentation": "A space ID containing a dot is rejected rather than split across host labels.", "params": { "Region": "us-east-1", "SpaceId": "sp-abc.def123" }, "expect": { "error": "Invalid SpaceId: must be a valid host label" } }, { "documentation": "GetMemory goes to the endpoint of the space in its input.", "params": { "Region": "us-east-1", "SpaceId": "sp-abc123def456" }, "operationInputs": [ { "operationName": "GetMemory", "operationParams": { "spaceId": "sp-abc123def456", "memoryId": "mem-0123456789abcdef" }, "builtInParams": { "AWS::Region": "us-east-1" } } ], "expect": { "endpoint": { "url": "https://sp-abc123def456.osm.us-east-1.on.aws" } } }, { "documentation": "ListSpaces goes to the regional endpoint.", "params": { "Region": "us-east-1" }, "operationInputs": [ { "operationName": "ListSpaces", "builtInParams": { "AWS::Region": "us-east-1" } } ], "expect": { "endpoint": { "url": "https://osm.us-east-1.api.aws" } } }, { "documentation": "With a space ID: the space's endpoint.", "params": { "Region": "us-east-1", "SpaceId": "sp-abc123def456" }, "expect": { "endpoint": { "url": "https://sp-abc123def456.osm.us-east-1.on.aws" } } }, { "documentation": "Without a space ID: the regional endpoint.", "params": { "Region": "us-east-1" }, "expect": { "endpoint": { "url": "https://osm.us-east-1.api.aws" } } }, { "documentation": "Endpoint override with a space ID: the override URL.", "params": { "Region": "us-east-1", "SpaceId": "sp-000000000000", "Endpoint": "https://example.com" }, "expect": { "endpoint": { "url": "https://example.com" } } }, { "documentation": "Endpoint override without a space ID: the override URL.", "params": { "Region": "us-east-1", "Endpoint": "https://example.com" }, "expect": { "endpoint": { "url": "https://example.com" } } }, { "documentation": "FIPS without a space ID fails: the service has no FIPS endpoint.", "params": { "Region": "us-east-1", "UseFIPS": true }, "expect": { "error": "Invalid Configuration: FIPS is not supported with OpenSearch Memory." } }, { "documentation": "FIPS with a space ID fails: the service has no FIPS endpoint.", "params": { "Region": "us-east-1", "SpaceId": "sp-abc123def456", "UseFIPS": true }, "expect": { "error": "Invalid Configuration: FIPS is not supported with OpenSearch Memory." } }, { "documentation": "FIPS with an endpoint override fails.", "params": { "Region": "us-east-1", "Endpoint": "https://example.com", "UseFIPS": true }, "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" } }, { "documentation": "GetMemory with FIPS on fails rather than going to the space's endpoint.", "params": { "Region": "us-east-1", "SpaceId": "sp-abc123def456", "UseFIPS": true }, "operationInputs": [ { "operationName": "GetMemory", "operationParams": { "spaceId": "sp-abc123def456", "memoryId": "mem-0123456789abcdef" }, "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true } } ], "expect": { "error": "Invalid Configuration: FIPS is not supported with OpenSearch Memory." } }, { "documentation": "ListSpaces with FIPS on fails rather than going to the regional endpoint.", "params": { "Region": "us-east-1", "UseFIPS": true }, "operationInputs": [ { "operationName": "ListSpaces", "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true } } ], "expect": { "error": "Invalid Configuration: FIPS is not supported with OpenSearch Memory." } } ] } } }, "com.amazonaws.opensearchmemory#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.opensearchmemory#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes which resource wasn't found.
", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the resource that wasn't found.
" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that wasn't found.
" } } }, "traits": { "smithy.api#documentation": "The specified resource doesn't exist. Check the IDs in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.opensearchmemory#S3Location": { "type": "structure", "members": { "uri": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The object's S3 URI, for example s3://bucket/key. The bucket must be in the space's Region. You need s3:GetObject on the object, and kms:Decrypt on its key if the object uses SSE-KMS. The event doesn't store the object itself.
An object in Amazon S3.
" } }, "com.amazonaws.opensearchmemory#SearchEvents": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#SearchEventsInput" }, "output": { "target": "com.amazonaws.opensearchmemory#SearchEventsOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Searches a space's events by relevance. It works like SearchMemories without the memory type and strategy selector. The query is a subset of the OpenSearch Query DSL. The service validates it, limits the search to the actor in actorId and the sessions in sessionIds, and returns ranked results. Each result is the matching chunk of an event, not the whole event. You can page through only a limited number of results. A request past that limit fails with ValidationException (reason invalidNextToken), and the message gives the limit.
If the results are larger than 5 MiB, the request fails with ValidationException (reason queryBodyTooLarge). Lower maxResults.
If the request would exceed the service's rate for embedding requests, it fails with ThrottlingException. Retry with exponential backoff.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The space whose events to search. Use actorId and sessionIds to narrow the search within it.
The actor whose events to search (exact match). Required: every search covers exactly one actor, and an event stored without an actor is never returned. Narrow the search further with sessionIds, combined by AND. This is the only way to filter by actor: a query that references system_metadata.actor_id fails with ValidationException (reason nonFilterableField).
Returns only events from one of these sessions (exact match). Combined with actorId by AND. Omit for no session filter. An empty list fails validation. An event stored without a session never matches a session filter. This is the only way to filter by session: a query that references system_metadata.session_id fails with ValidationException (reason nonFilterableField).
The query: a subset of the OpenSearch Query DSL (see SearchQuery), validated by the same rules as on SearchMemories. Query event text as text and embeddings as vector. A search covers both conversation turns and chunks of documents submitted as a blob. You can't use actor and session fields here. Use the top-level actorId and sessionIds.
To search only the content of particular events, filter on event_ids with term or terms, for example with the sourceEventIds that a SearchMemories result returns. A terms clause on event_ids can list up to 10 event IDs. More IDs fail with ValidationException (reason queryBodyTooLarge). You can use event_ids only in term, terms, and exists queries.
The sort order (see SearchSort). Omit to return the most relevant events first.
The maximum number of events to return, from 1 to 100. The default is 20.
" } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#SearchEventsOutput": { "type": "structure", "members": { "events": { "target": "com.amazonaws.opensearchmemory#EventSearchSummaryList", "traits": { "smithy.api#documentation": "The matching event chunks, in the order sort requests, or most relevant first when it has none. Empty when nothing matches. Each result is the matching chunk of an event. Call GetEvent for the whole event.
The token for the next set of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#SearchMemories": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#SearchMemoriesInput" }, "output": { "target": "com.amazonaws.opensearchmemory#SearchMemoriesOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Searches a space's memories by relevance. The query is a subset of the OpenSearch Query DSL. The service validates it, limits the search to the requested strategies and to the actor in actorId, and returns one ranked list of memories. You can page through only a limited number of results. A request past that limit fails with ValidationException (reason invalidNextToken), and the message gives the limit.
Memories past their expiry (set from the space's memoryExpiryDays when each memory is written) are left out of the results. Only current memories are returned: a memory that consolidation has superseded (an older version of a fact that a newer memory replaced) is left out.
If the results are larger than 5 MiB, the request fails with ValidationException (reason queryBodyTooLarge). Lower maxResults.
If the request would exceed the service's rate for embedding requests, it fails with ThrottlingException. Retry with exponential backoff.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The space to search. Use actorId to narrow the search within it.
The strategies to search, as a list of selectors. Each selector names a memory type and, optionally, specific strategy names of that type. A space can hold several strategies of the same type. A selector without memoryStrategyNames searches every strategy of its type, and omitting memoryStrategies searches every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.
The actor whose memories to search (exact match). Required: every search covers exactly one actor, and a memory stored without an actor is never returned. This is the only way to filter by actor: a query that references system_metadata.actor_id fails with ValidationException (reason nonFilterableField).
The query: a subset of the OpenSearch Query DSL (see SearchQuery). You can't use the actor and session fields system_metadata.actor_id and system_metadata.session_id here. Use the top-level actorId to filter by actor. Searching memories doesn't filter by session.
The sort order (see SearchSort). Omit to return the most relevant memories first.
The maximum number of memories to return, from 1 to 100. The default is 20.
" } }, "nextToken": { "target": "com.amazonaws.opensearchmemory#PaginationToken", "traits": { "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.opensearchmemory#SearchMemoriesOutput": { "type": "structure", "members": { "memories": { "target": "com.amazonaws.opensearchmemory#MemorySearchSummaryList", "traits": { "smithy.api#documentation": "The matching memories, in the order sort requests, or most relevant first when it has none. Empty when nothing matches.
The token for the next set of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#SearchQuery": { "type": "document", "traits": { "smithy.api#documentation": "A query clause in OpenSearch Query DSL (the value of an OpenSearch query). The service accepts a subset of query types whose cost is bounded and rejects anything else with ValidationException. In SearchMemories, query memory text as memory_text and embeddings as memory_vector. In SearchEvents, use text and vector. Supported: match, match_phrase, match_all, term, terms, ids, exists, range (on system_metadata.created_at and system_metadata.updated_at only), neural, hybrid, bool, constant_score, boosting, and function_score (decay functions on the time fields only). The service doesn't support aggregations, highlight, or rescore. If query and sort together are larger than 64 KB, the request fails with ValidationException (reason queryBodyTooLarge).
A query can use at most one distinct neural query_text. Repeating the same text is allowed. A bool query can nest at most 5 levels. The whole query can contain at most 32 clauses, counting function_score functions. terms and ids take at most 100 values, and function_score takes at most 3 decay functions. A second distinct neural query_text, more than 32 clauses, too many values, or too many decay functions fails with ValidationException (reason queryBodyTooLarge). A query text longer than 2,048 characters, or a neural k over 100, fails with reason fieldValidationFailed. A bool query nested more than 5 levels fails with reason queryNestingTooDeep.
In range and decay functions, give system_metadata.created_at and system_metadata.updated_at values as ISO 8601 strings such as 2026-06-01T00:00:00Z, as epoch milliseconds, or as date math such as now-30d.
A sort clause in OpenSearch Query DSL (the value of an OpenSearch sort): a field name, {\"field\": \"asc\"|\"desc\"}, {\"field\": {\"order\": \"asc\"|\"desc\"}}, or an array of these. Sorting is supported on _score, system_metadata.created_at, and system_metadata.updated_at.
Free-text memory content.
", "smithy.api#length": { "max": 40000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.opensearchmemory#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes which quota the request would exceed.
", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Service Quotas code of the quota that the request would exceed. Not currently returned.
" } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Service Quotas code of the service. Not currently returned.
" } } }, "traits": { "smithy.api#documentation": "The request would exceed a quota, such as the number of spaces in your account or the number of strategies in a space.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.opensearchmemory#SessionId": { "type": "string", "traits": { "smithy.api#documentation": "The ID of a session, which groups an actor's events.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$" } }, "com.amazonaws.opensearchmemory#SessionIdList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#SessionId" }, "traits": { "smithy.api#documentation": "A list of 1 to 10 session IDs. A memory or event matches when it belongs to any of them.
", "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.opensearchmemory#SortOrder": { "type": "enum", "members": { "ASC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Oldest first.
", "smithy.api#enumValue": "ASC" } }, "DESC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Most recent first.
", "smithy.api#enumValue": "DESC" } } }, "traits": { "smithy.api#documentation": "Sort direction for time-ordered listings.
" } }, "com.amazonaws.opensearchmemory#SourceEventIdList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#EventId" }, "traits": { "smithy.api#documentation": "The IDs of the events a memory was derived from.
", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.opensearchmemory#Space": { "type": "resource", "identifiers": { "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId" } }, "create": { "target": "com.amazonaws.opensearchmemory#CreateSpace" }, "read": { "target": "com.amazonaws.opensearchmemory#GetSpace" }, "update": { "target": "com.amazonaws.opensearchmemory#UpdateSpace" }, "delete": { "target": "com.amazonaws.opensearchmemory#DeleteSpace" }, "list": { "target": "com.amazonaws.opensearchmemory#ListSpaces" }, "operations": [ { "target": "com.amazonaws.opensearchmemory#BatchGetEvent" }, { "target": "com.amazonaws.opensearchmemory#CreateEvent" }, { "target": "com.amazonaws.opensearchmemory#CreateMemory" }, { "target": "com.amazonaws.opensearchmemory#DeleteEvent" }, { "target": "com.amazonaws.opensearchmemory#DeleteMemory" }, { "target": "com.amazonaws.opensearchmemory#GetEvent" }, { "target": "com.amazonaws.opensearchmemory#GetMemory" }, { "target": "com.amazonaws.opensearchmemory#ListEvents" }, { "target": "com.amazonaws.opensearchmemory#ListMemories" }, { "target": "com.amazonaws.opensearchmemory#SearchEvents" }, { "target": "com.amazonaws.opensearchmemory#SearchMemories" }, { "target": "com.amazonaws.opensearchmemory#UpdateMemory" } ], "traits": { "aws.api#arn": { "template": "space/{spaceId}" } } }, "com.amazonaws.opensearchmemory#SpaceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws:osm:[a-z0-9-]+:[0-9]{12}:space/sp-[a-f0-9]{12}$" } }, "com.amazonaws.opensearchmemory#SpaceId": { "type": "string", "traits": { "smithy.api#documentation": "The ID of a space: sp- followed by 12 lowercase hexadecimal characters.
The space is being created.
", "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The space is ready to use.
", "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A change to the space is being applied.
", "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The space is being deleted.
", "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Not returned: after a space is deleted, GetSpace returns ResourceNotFoundException.
Creating, updating, or deleting the space failed. statusReason says why. If creating or updating the space failed, you can delete it. If an update failed, you can also update it again. If deleting it failed, contact AWS Support.
The status of a space.
" } }, "com.amazonaws.opensearchmemory#SpaceSummary": { "type": "structure", "members": { "spaceId": { "target": "com.amazonaws.opensearchmemory#SpaceId", "traits": { "smithy.api#documentation": "The ID of the space.
", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.opensearchmemory#SpaceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the space.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.opensearchmemory#SpaceName", "traits": { "smithy.api#documentation": "The name of the space.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.opensearchmemory#SpaceStatus", "traits": { "smithy.api#documentation": "The status of the space.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.opensearchmemory#Timestamp", "traits": { "smithy.api#documentation": "When the space was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of a space, as returned by ListSpaces.
A list of space summaries.
" } }, "com.amazonaws.opensearchmemory#StrategyName": { "type": "string", "traits": { "smithy.api#documentation": "The name of a strategy declared on a space, for example user-facts. Names are case-sensitive and must match the declared name exactly.
A list of 1 to 20 strategy names.
", "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.opensearchmemory#StrategySelector": { "type": "structure", "members": { "memoryType": { "target": "com.amazonaws.opensearchmemory#MemoryType", "traits": { "smithy.api#documentation": "The memory type to search or list.
", "smithy.api#required": {} } }, "memoryStrategyNames": { "target": "com.amazonaws.opensearchmemory#StrategyNameList", "traits": { "smithy.api#documentation": "Specific strategy names of memoryType. Omit it to include every strategy of that type.
A memory type and, optionally, specific strategy names of that type. A space can hold several strategies of the same type, so the type and its names are given together.
" } }, "com.amazonaws.opensearchmemory#StrategySelectorList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#StrategySelector" }, "traits": { "smithy.api#documentation": "A list of 1 to 5 strategy selectors. Omit the list to use every strategy in the space. An empty list fails validation.
", "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.opensearchmemory#StructuredDataPayload": { "type": "structure", "members": { "source": { "target": "com.amazonaws.opensearchmemory#StructuredDataSource", "traits": { "smithy.api#documentation": "The structured content.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Structured content, as a JSON object.
" } }, "com.amazonaws.opensearchmemory#StructuredDataSource": { "type": "union", "members": { "json": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The structured content, as a JSON object of at most 1 MiB when serialized as UTF-8, nested at most 10 levels deep.
" } } }, "traits": { "smithy.api#documentation": "The source of structured content. Set exactly one member. Currently, the only member is json.
The owning actor. Absent when none was recorded.
" } }, "sessionId": { "target": "com.amazonaws.opensearchmemory#SessionId", "traits": { "smithy.api#documentation": "The owning session. Absent when none was recorded.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "When the record was created. Always present on ListMemories and GetMemory. It can be absent from search results.
When the record was last updated. Equals createdAt for a record that has never been updated, and always for a SearchEvents result.
System-generated provenance for a memory or event: the owning actor and session, and the creation and last-update timestamps. SearchMemories, SearchEvents, ListMemories, and GetMemory return the same block.
ListMemories and GetMemory always return createdAt and updatedAt. The search operations return what is recorded and omit the block when nothing is.
In a query, the timestamps are system_metadata.created_at and system_metadata.updated_at. Scope by owner with the top-level parameters (actorId on the search operations, actorIds on ListMemories) and sessionIds (SearchEvents and ListMemories). The search operations reject actor and session fields inside the query or sort.
The key of the tag.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.opensearchmemory#TagValue", "traits": { "smithy.api#documentation": "The value of the tag.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A tag: a key-value pair that you attach to a space.
" } }, "com.amazonaws.opensearchmemory#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.opensearchmemory#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#TagKey" }, "traits": { "smithy.api#documentation": "A list of tag keys.
", "smithy.api#length": { "max": 200 } } }, "com.amazonaws.opensearchmemory#TagList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#Tag" }, "traits": { "smithy.api#documentation": "A list of tags.
", "smithy.api#length": { "max": 200 } } }, "com.amazonaws.opensearchmemory#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#TagResourceRequest" }, "output": { "target": "com.amazonaws.opensearchmemory#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds the specified tags to the specified space.
", "smithy.api#idempotent": {}, "smithy.api#suppress": [ "TaggingService.Members.LegacyTagListShape" ] } }, "com.amazonaws.opensearchmemory#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.opensearchmemory#SpaceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the space.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.opensearchmemory#TagList", "traits": { "smithy.api#documentation": "The tags to add to the space.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.opensearchmemory#Space", "ids": { "spaceId": "resourceArn" } } ] } }, "com.amazonaws.opensearchmemory#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.opensearchmemory#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes the throttling.
", "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds to wait before you retry the request.
" } } }, "traits": { "smithy.api#documentation": "The service throttled the request. Retry the request with exponential backoff.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.opensearchmemory#Timestamp": { "type": "timestamp" }, "com.amazonaws.opensearchmemory#TokenCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 80000 } } }, "com.amazonaws.opensearchmemory#TriggerEveryNMessages": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.opensearchmemory#UnifiedConversational": { "type": "structure", "members": { "source": { "target": "com.amazonaws.opensearchmemory#UnifiedConversationalSource", "traits": { "smithy.api#documentation": "The conversation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Conversation turns in the service's own format.
" } }, "com.amazonaws.opensearchmemory#UnifiedConversationalObject": { "type": "structure", "members": { "messages": { "target": "com.amazonaws.opensearchmemory#MessageList", "traits": { "smithy.api#documentation": "The conversation turns, in order. The order matters for extraction.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Conversation turns.
" } }, "com.amazonaws.opensearchmemory#UnifiedConversationalSource": { "type": "union", "members": { "object": { "target": "com.amazonaws.opensearchmemory#UnifiedConversationalObject", "traits": { "smithy.api#documentation": "The conversation turns.
" } } }, "traits": { "smithy.api#documentation": "The source of a conversation. Set exactly one member. Currently, the only member is object.
Removes the specified tags from the specified space.
", "smithy.api#idempotent": {} } }, "com.amazonaws.opensearchmemory#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.opensearchmemory#SpaceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the space.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.opensearchmemory#TagKeyList", "traits": { "aws.iam#conditionKeyValue": "aws:TagKeys", "smithy.api#documentation": "The keys of the tags to remove from the space.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.opensearchmemory#Space", "ids": { "spaceId": "resourceArn" } } ] } }, "com.amazonaws.opensearchmemory#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.opensearchmemory#UpdateMemory": { "type": "operation", "input": { "target": "com.amazonaws.opensearchmemory#UpdateMemoryInput" }, "output": { "target": "com.amazonaws.opensearchmemory#UpdateMemoryOutput" }, "errors": [ { "target": "com.amazonaws.opensearchmemory#AccessDeniedException" }, { "target": "com.amazonaws.opensearchmemory#ConflictException" }, { "target": "com.amazonaws.opensearchmemory#InternalServerException" }, { "target": "com.amazonaws.opensearchmemory#ResourceNotFoundException" }, { "target": "com.amazonaws.opensearchmemory#ThrottlingException" }, { "target": "com.amazonaws.opensearchmemory#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a memory in place. Supply only the fields to change. Omitted fields keep their stored values. A request must supply content or metadata, or it fails with ValidationException. Supplying content re-embeds the memory. A change to metadata alone doesn't.
The memory keeps its memoryId across updates. Shortly after an update, searches stop returning the previous content.
memoryType can't be changed. To change it, delete the memory and create a new one.
A memory past its expiry (set from the space's memoryExpiryDays when the memory is written) reads as not found: the operation fails with ResourceNotFoundException and changes nothing. An update does not move the expiry.
Concurrent updates to one memory are last-writer-wins. There is no version check. To avoid lost updates, serialize your updates to a memory.
If you supply content and the request would exceed the service's rate for embedding requests, it fails with ThrottlingException. Retry with exponential backoff.
If the space uses a customer managed AWS KMS key, the call can also fail because of the key. It fails with AccessDeniedException if you aren't allowed to use the key, and with ThrottlingException if AWS KMS throttles the request. It fails with ValidationException if the key is disabled, pending deletion, or deleted.
The ID of the space that owns the memory, for example sp-02864597b164.
The ID of the memory to update.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.opensearchmemory#MemoryUpdateContent", "traits": { "smithy.api#documentation": "Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.
" } }, "metadata": { "target": "com.amazonaws.opensearchmemory#MetadataMap", "traits": { "smithy.api#documentation": "The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set metadataMode to MERGE to keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin with x-amz- and the key documentS3Source are reserved: a request that sets one fails with ValidationException.
A space can use at most 50 distinct metadata keys across all of its events and memories. A request that would add a key beyond that fails with ValidationException. Reuse an existing key instead.
How metadata combines with what is stored. The default is REPLACE.
The ID of the actor that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
The name of the strategy that the memory must belong to. Omit it to skip this check. If it doesn't match the stored memory, the call fails with ResourceNotFoundException, as if the memory did not exist.
The updated memory, in the same shape that GetMemory returns.
Updates a space's memory strategies, retention settings, or extraction model. Supply only the fields to change. Omitted fields keep their current values.
If the request changes the set of strategies, a strategy's configuration, a retention setting, or the extraction model, the space moves to UPDATING. When the change is complete, the space returns to ACTIVE, or moves to FAILED if the change can't be applied. While the space is UPDATING, GetSpace returns the previous configuration. A request that only changes strategy descriptions or repeats the values the space has stored is applied immediately and doesn't change the status. Sending a retention value that the space never set also moves the space to UPDATING, even one that matches the behavior without it, such as 90 for eventExpiryDays or 0 for memoryExpiryDays. A space that is CREATING, UPDATING, or DELETING can't be updated: the request fails with ConflictException.
The ID of the space to update.
", "smithy.api#required": {} } }, "memoryStrategies": { "target": "com.amazonaws.opensearchmemory#MemoryStrategyList", "traits": { "smithy.api#documentation": "The complete new list of memory strategies. The service removes strategies that aren't in the list from the space. Removing a strategy stops extraction for it but doesn't delete its memories: they're kept, until they expire if the space sets memoryExpiryDays, and they're available again if you later add a strategy with the same type and name. To delete them, use DeleteMemory before you remove the strategy, or delete the space.
To keep a strategy, include it with the same type and name that GetSpace returns. For a kept strategy, any configuration member you omit keeps its current value. It doesn't return to the default, and you can't clear a member once it's set. Omit this field to leave the strategies unchanged. The list must name at least one strategy. You can't remove every strategy from a space with UpdateSpace.
The serialized list can be at most 384 KiB.
" } }, "eventExpiryDays": { "target": "com.amazonaws.opensearchmemory#EventExpiryDays", "traits": { "smithy.api#documentation": "How many days the space keeps each event, from 1 to 365. Omit it to leave the current value unchanged. Events already stored keep the expiry they were written with.
" } }, "memoryExpiryDays": { "target": "com.amazonaws.opensearchmemory#MemoryExpiryDays", "traits": { "smithy.api#documentation": "How many days the space keeps each memory, from 0 to 3650. 0 means memories never expire. Omit it to leave the current value unchanged. You can't clear the setting. To make memories written from then on never expire, send 0. GetSpace then returns 0.
A change applies to memories written after it. Memories already stored keep the expiry they were written with. A memory the service rewrites later, such as a summary it keeps up to date, takes the setting in force at that rewrite. A change moves the space to UPDATING. Sending the value that the space has stored doesn't.
The model that extracts and consolidates memories for every strategy in the space: anthropic.claude-opus-5-5 or anthropic.claude-haiku-5-5. Omit it to leave the current value unchanged. Once set, it can't be cleared back to the service default.
The ID of the space.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.opensearchmemory#SpaceStatus", "traits": { "smithy.api#documentation": "The status of the space: UPDATING when the change has to be applied to the space's strategies, retention, or extraction model. Otherwise, the space's current status.
A message that describes why the request failed validation, such as the field, key, or limit involved.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.opensearchmemory#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason that the request failed validation.
" } }, "fieldList": { "target": "com.amazonaws.opensearchmemory#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The fields that failed validation, if any.
" } } }, "traits": { "smithy.api#documentation": "The request isn't valid. The reason, message, and fieldList members describe the problem. Fix the request, and then try again.
The field name.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message that describes why the field failed validation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about a request field that failed validation.
" } }, "com.amazonaws.opensearchmemory#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.opensearchmemory#ValidationExceptionField" }, "traits": { "smithy.api#documentation": "A list of fields.
" } }, "com.amazonaws.opensearchmemory#ValidationExceptionReason": { "type": "enum", "members": { "DISALLOWED_QUERY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The query uses a query type that isn't supported.
", "smithy.api#enumValue": "disallowedQueryType" } }, "NON_FILTERABLE_FIELD": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The query or sort uses a field that can't be used there, such as an actor or session field.
", "smithy.api#enumValue": "nonFilterableField" } }, "UNKNOWN_FIELD": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The query uses a field that doesn't exist.
", "smithy.api#enumValue": "unknownField" } }, "FIELD_INDEX_MISMATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The field can't be used with this query type.
", "smithy.api#enumValue": "fieldIndexMismatch" } }, "QUERY_NESTING_TOO_DEEP": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A bool query nests more than 5 levels deep, or OpenSearch rejects the query for having too many clauses.
Reserved. The service doesn't currently return this reason.
", "smithy.api#enumValue": "unboundedPattern" } }, "QUERY_BODY_TOO_LARGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The query exceeds a size or count limit: query and sort together are larger than 64 KB, the query has more than 32 clauses, a value list has more than 100 values, function_score has more than 3 decay functions, the query uses more than one distinct neural query_text, or the response is too large.
The query or sort can't be parsed.
", "smithy.api#enumValue": "malformedQueryBody" } }, "INVALID_NEXT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The pagination token is invalid or past the paging limit.
", "smithy.api#enumValue": "invalidNextToken" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A field failed validation.
", "smithy.api#enumValue": "fieldValidationFailed" } }, "UNSUPPORTED_PARAMETER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The request uses a parameter that isn't supported.
", "smithy.api#enumValue": "unsupportedParameter" } }, "UNSUPPORTED_FIELD": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Reserved. The service doesn't currently return this reason.
", "smithy.api#enumValue": "unsupportedField" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Another validation failure, such as an unusable customer managed AWS KMS key.
", "smithy.api#enumValue": "other" } } }, "traits": { "smithy.api#documentation": "Possible reasons a request failed validation. New values can be added, so treat an unknown value as a general validation failure.
" } } } }