[ aws . opensearchmemory ]

create-event

Description

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.

See also: AWS API Documentation

create-event uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  create-event
--space-id <value>
--actor-id <value>
[--session-id <value>]
[--event-timestamp <value>]
--payload <value>
[--metadata <value>]
[--client-token <value>]
[--infer | --no-infer]
[--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 event, for example sp-02864597b164 .

Constraints:

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

--actor-id (string) [required]

The ID of the actor (end user or agent) that the event belongs to.

Constraints:

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

--session-id (string)

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.

Constraints:

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

--event-timestamp (timestamp)

When the event occurred. The default is the time that the service receives the request.

--payload (tagged union structure) [required]

The event content. Set exactly one union member.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: conversational, structuredData, blob.

conversational -> (tagged union structure)

Conversation turns.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: unified.

unified -> (structure)

Conversation turns in the service’s own format.

source -> (tagged union structure) [required]

The conversation.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: object.

object -> (structure)

The conversation turns.

messages -> (list) [required]

The conversation turns, in order. The order matters for extraction.

Constraints:

  • min: 1
  • max: 100

(structure)

A conversation turn.

role -> (string) [required]

The author of the turn.

Possible values:

  • USER
  • ASSISTANT
  • SYSTEM

content -> (structure) [required]

The content of the turn.

text -> (string) [required]

The text of the turn.

Constraints:

  • min: 1
  • max: 5242880

structuredData -> (structure)

Structured (non-conversational) content, for example a deployment result that an agent should remember.

source -> (tagged union structure) [required]

The structured content.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: json.

json -> (document)

The structured content, as a JSON object of at most 1 MiB when serialized as UTF-8, nested at most 10 levels deep.

blob -> (structure)

A document stored in Amazon S3, such as a PDF.

contentType -> (string) [required]

The document’s media type. Only application/pdf is supported. Any other value fails with ValidationException .

Possible values:

  • application/pdf
  • image/png
  • image/jpeg

source -> (tagged union structure) [required]

The location of the document.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3Location.

s3Location -> (structure)

The S3 object holding the document.

uri -> (string) [required]

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.

Constraints:

  • min: 5
  • max: 1024
  • pattern: s3://[a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]/.+

JSON Syntax:

{
  "conversational": {
    "unified": {
      "source": {
        "object": {
          "messages": [
            {
              "role": "USER"|"ASSISTANT"|"SYSTEM",
              "content": {
                "text": "string"
              }
            }
            ...
          ]
        }
      }
    }
  },
  "structuredData": {
    "source": {
      "json": {...}
    }
  },
  "blob": {
    "contentType": "application/pdf"|"image/png"|"image/jpeg",
    "source": {
      "s3Location": {
        "uri": "string"
      }
    }
  }
}

--metadata (map)

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.

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"
  ...}

--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 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.

Constraints:

  • min: 1
  • max: 512
  • pattern: [!-~]+

--infer | --no-infer (boolean)

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.

--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

event -> (structure)

The stored event’s identifiers: its ID, session, and timestamp.

eventId -> (string) [required]

The event’s ID, assigned by the service. Use it with GetEvent and DeleteEvent .

Constraints:

  • min: 1
  • max: 128

spaceId -> (string) [required]

The ID of the space.

Constraints:

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

actorId -> (string) [required]

The ID of the actor the event 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 event belongs to, including one the service generated.

Constraints:

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

eventTimestamp -> (timestamp) [required]

When the event occurred: the value supplied, or the time the request was received.