[ aws . opensearchmemory ]

update-memory

Description

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.

See also: AWS API Documentation

Synopsis

  update-memory
--space-id <value>
--memory-id <value>
[--content <value>]
[--metadata <value>]
[--metadata-mode <value>]
[--actor-id <value>]
[--strategy-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--space-id (string) [required]

The ID of the space that owns the memory, for example sp-02864597b164 .

Constraints:

  • min: 1
  • max: 64
  • pattern: sp-[a-f0-9]{12}

--memory-id (string) [required]

The ID of the memory to update.

Constraints:

  • min: 1
  • max: 128

--content (string)

Replacement memory text. Supplying it re-embeds the memory. Omit to leave the text unchanged.

Constraints:

  • min: 1
  • max: 16000

--metadata (map)

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.

Constraints:

  • min: 0
  • max: 15

key -> (string)

A metadata key: letters, digits, hyphens (- ), and underscores (_ ). Dots are not allowed, because a query uses dots to separate nested field names.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

value -> (string)

The value of a metadata entry.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9\s._:\/=+@-]*

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--metadata-mode (string)

How metadata combines with what is stored. The default is REPLACE .

Possible values:

  • REPLACE
  • MERGE

--actor-id (string)

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.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

--strategy-name (string)

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.

Constraints:

  • min: 1
  • max: 255

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

memory -> (structure)

The updated memory, in the same shape that GetMemory returns.

memoryId -> (string) [required]

The memory’s ID, assigned by the service.

Constraints:

  • min: 1
  • max: 128

memoryType -> (string) [required]

The memory type.

Possible values:

  • SEMANTIC
  • SUMMARY
  • CUSTOM

strategyName -> (string)

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.

Constraints:

  • min: 1
  • max: 255

content -> (string) [required]

The memory text.

Constraints:

  • min: 0
  • max: 40000

systemMetadata -> (structure) [required]

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.

actorId -> (string)

The owning actor. Absent when none was recorded.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

sessionId -> (string)

The owning session. Absent when none was recorded.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9][a-zA-Z0-9-_]*

createdAt -> (timestamp)

When the record was created. Always present on ListMemories and GetMemory . It can be absent from search results.

updatedAt -> (timestamp)

When the record was last updated. Equals createdAt for a record that has never been updated, and always for a SearchEvents result.

metadata -> (map)

The memory’s metadata tags. All values are strings. May be empty.

Constraints:

  • min: 0
  • max: 15

key -> (string)

A metadata key: letters, digits, hyphens (- ), and underscores (_ ). Dots are not allowed, because a query uses dots to separate nested field names.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9_-]+

value -> (string)

The value of a metadata entry.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9\s._:\/=+@-]*