<a id="cli-aws-opensearchmemory-batch-get-event"></a>

# batch-get-event

## Description

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.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/opensearchmemory-2026-08-24/BatchGetEvent)

`batch-get-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

```
  batch-get-event
--space-id <value>
[--actor-id <value>]
[--session-id <value>]
--event-ids <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.

> Constraints:

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

`--actor-id` (string)

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

> Constraints:

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

`--session-id` (string)

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

> Constraints:

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

`--event-ids` (list) [required]

> The IDs of the events to get: 1 to 10, without duplicates.

> Constraints:

> * min: `1`
> * max: `10`

> (string)

> > An event ID, assigned by the service.

> > Constraints:

> > * min: `1`
> > * max: `128`

Syntax:

```
"string" "string" ...
```

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

events -> (list)

> The events found, in the order that you requested their IDs.

> Constraints:

> * min: `0`
> * max: `10`

> (structure)

> > An event, including its payload.

> > eventId -> (string) [required]

> > > The event’s ID.

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

> > > Constraints:

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

> > payload -> (tagged union structure) [required]

> > > The event’s content, as submitted to `CreateEvent` .

> > > #### 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]/.+`

> > metadata -> (map)

> > > The event’s metadata tags, as supplied to `CreateEvent` . 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._:\/=+@-]*`

> > eventTimestamp -> (timestamp) [required]

> > > The time the event occurred.

errors -> (list)

> An entry for each requested event that the call didn’t return. Empty when the call returned every event.

> Constraints:

> * min: `0`
> * max: `10`

> (structure)

> > A requested event that the call didn’t return, and the reason.

> > eventId -> (string) [required]

> > > The ID of the requested event.

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > errorCode -> (string) [required]

> > > The reason that the call didn’t return the event.

> > > Possible values:

> > > * `RESOURCE_NOT_FOUND`
> > > * `THROTTLING`
> > > * `ACCESS_DENIED`
> > > * `INTERNAL_SERVER`

> > message -> (string) [required]

> > > A human-readable description.
