[ aws . opensearchmemory ]
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.
See also: AWS API Documentation
create-memory
--space-id <value>
--name <value>
--content <value>
--actor-id <value>
[--session-id <value>]
[--metadata <value>]
[--client-token <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]
--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}
--name (string) [required]
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.
Constraints:
- min:
1- max:
255
--content (string) [required]
The memory text, stored and embedded as provided.
Constraints:
- min:
1- max:
16000
--actor-id (string) [required]
The actor (end user or agent) that owns the memory.
Constraints:
- min:
1- max:
255- pattern:
[a-zA-Z0-9][a-zA-Z0-9-_]*
--session-id (string)
The session that the memory belongs to. If you omit it, the service generates a session ID and returns it.
Constraints:
- min:
1- max:
255- pattern:
[a-zA-Z0-9][a-zA-Z0-9-_]*
--metadata (map)
Metadata tags to store with the memory. Keys that begin with
x-amz-, the keydocumentS3Source, and other keys that the service uses internally are reserved: a request that sets one fails withValidationException, 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.Constraints:
- min:
0- max:
15key -> (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"
...}
--client-token (string)
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
memoryIdinstead of creating a second memory. Reusing the token with a differentname,content,metadata,actorId, orsessionIdfails withConflictException. If you omitsessionId, a retry with the same token gets the same session. If you omit the token, each call creates a new memory.Constraints:
- min:
1- max:
512- pattern:
[!-~]+
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
memory -> (structure)
The memory, identified but not yet indexed.
memoryId -> (string) [required]
The final ID of the memory. Until the memory is indexed,
GetMemory,UpdateMemory, andDeleteMemoryreturnResourceNotFoundExceptionfor it.Constraints:
- min:
1- max:
128spaceId -> (string) [required]
The ID of the space.
Constraints:
- min:
1- max:
64- pattern:
sp-[a-f0-9]{12}name -> (string) [required]
The name of the strategy the memory belongs to.
Constraints:
- min:
1- max:
255actorId -> (string) [required]
The ID of the actor the memory belongs to.
Constraints:
- min:
1- max:
255- pattern:
[a-zA-Z0-9][a-zA-Z0-9-_]*sessionId -> (string) [required]
The ID of the session the memory belongs to, including one the service generated.
Constraints:
- min:
1- max:
255- pattern:
[a-zA-Z0-9][a-zA-Z0-9-_]*