UpdateMemory
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.
Request Syntax
{
"actorId": "string",
"content": "string",
"memoryId": "string",
"metadata": {
"string" : "string"
},
"metadataMode": "string",
"spaceId": "string",
"strategyName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- actorId
-
The identifier of the actor associated with the memory. This value is intended for authorization: IAM policies can reference it in condition keys to allow or deny the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-_]*Required: No
- content
-
Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16000.
Required: No
- memoryId
-
The ID of the memory to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- metadata
-
The metadata tags to apply. By default this map replaces the stored metadata, and any key not present is removed. Set
metadataModetoMERGEto keep the keys you don't supply. Limits apply to the resulting metadata, not to the request. Keys that begin withx-amz-and the keydocumentS3Sourceare reserved: a request that sets one fails withValidationException.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.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 15 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
[a-zA-Z0-9_-]+Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
[a-zA-Z0-9\s._:\/=+@-]*Required: No
- metadataMode
-
How
metadatacombines with what is stored. The default isREPLACE.Type: String
Valid Values:
REPLACE | MERGERequired: No
- spaceId
-
The ID of the space that owns the memory, for example
sp-02864597b164.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
sp-[a-f0-9]{12}Required: Yes
- strategyName
-
The name of the memory extraction strategy associated with the memory. This value is intended for authorization: IAM policies can reference it in condition keys to allow or deny the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
Response Syntax
{
"memory": {
"content": "string",
"memoryId": "string",
"memoryType": "string",
"metadata": {
"string" : "string"
},
"strategyName": "string",
"systemMetadata": {
"actorId": "string",
"createdAt": "string",
"sessionId": "string",
"updatedAt": "string"
}
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
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.
- message
-
A message that describes which access the request is missing.
HTTP Status Code: 403
- ConflictException
-
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.
- message
-
A message that describes the conflict.
- resourceId
-
The ID of the resource that caused the conflict.
- resourceType
-
The type of the resource that caused the conflict.
HTTP Status Code: 409
- InternalServerException
-
The service couldn't process the request because of an internal error. Retry the request.
- message
-
A message that describes the internal error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource doesn't exist. Check the IDs in the request.
- message
-
A message that describes which resource wasn't found.
- resourceId
-
The ID of the resource that wasn't found.
- resourceType
-
The type of the resource that wasn't found.
HTTP Status Code: 404
- ThrottlingException
-
The service throttled the request. Retry the request with exponential backoff.
- message
-
A message that describes the throttling.
- retryAfterSeconds
-
The number of seconds to wait before you retry the request.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. The
reason,message, andfieldListmembers describe the problem. Fix the request, and then try again.- fieldList
-
The fields that failed validation, if any.
- message
-
A message that describes why the request failed validation, such as the field, key, or limit involved.
- reason
-
The reason that the request failed validation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: