AWS CLI Command Reference

[ aws . eventsv2 ]

put-raw-events

Description

Publishes pre-shaped events to an event bus.

See also: AWS API Documentation

Synopsis

  put-raw-events
--event-bus-arn <value>
--entries <value>
[--schema-registry-configuration <value>]
[--deduplication-configuration <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>]

Options

--event-bus-arn (string) [required]

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-busv2\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

--entries (list) [required]

List of event entries to publish. Must contain at least one entry.

Constraints:

  • min: 1
  • max: 100

(structure)

A single event entry in a raw publish request.

Data -> (blob) [required]

The event data as a base64-encoded blob. Supports binary formats.

Metadata -> (map)

Metadata key-value pairs you define. Keys must be 1-128 characters and must not contain “/”.

Constraints:

  • min: 0
  • max: 100

key -> (string)

Customer-defined metadata field name. Must be 1-128 characters and must not contain “/”.

Constraints:

  • min: 1
  • max: 128
  • pattern: [^/]+

value -> (string)

Customer-defined metadata field value.

Constraints:

  • min: 1

SystemMetadata -> (structure) [required]

Structured system metadata with defined properties.

ContentType -> (string) [required]

Content type of the event data (e.g., “application/cloudevents+json”).

Constraints:

  • min: 1
  • max: 256
  • pattern: application/.*

DeduplicationId -> (string)

Deduplication ID for FIFO deduplication.

Constraints:

  • min: 1
  • max: 128
  • pattern: [\s\S]*[^\u0009-\u000D\u001C-\u0020\u1680\u2000-\u2006\u2008-\u200A\u2028\u2029\u205F\u3000][\s\S]*

EventGroupId -> (string)

Event group ID for FIFO ordering.

Constraints:

  • min: 1
  • max: 128

Shorthand Syntax:

Data=blob,Metadata={KeyName1=string,KeyName2=string},SystemMetadata={ContentType=string,DeduplicationId=string,EventGroupId=string} ...

JSON Syntax:

[
  {
    "Data": blob,
    "Metadata": {"string": "string"
      ...},
    "SystemMetadata": {
      "ContentType": "string",
      "DeduplicationId": "string",
      "EventGroupId": "string"
    }
  }
  ...
]

--schema-registry-configuration (structure)

Schema-registry settings for encoding open-format (Avro/Protobuf) events. Required for open-format entries; ignored for JSON entries. The registry is read with the caller’s credentials, so the caller needs read access to the registry it references.

RegistryUri -> (string) [required]

Glue Schema Registry ARN, or Confluent Cloud HTTPS URL.

Constraints:

  • min: 1
  • max: 2048
  • pattern: (arn:[a-z0-9-]+:glue:[a-z0-9-]+:[0-9]{12}:registry/[-_$#A-Za-z0-9]{1,255}|https://((([A-Za-z0-9]+-)*[A-Za-z0-9]+)\.)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)(:[0-9]{1,5})?)(?![\s\S]).*

ConfluentPublicRegistryConfiguration -> (structure)

Required when RegistryUri is an HTTPS URL. Provides Connection-based auth for Confluent Cloud.

ConnectionArn -> (string) [required]

EventBridge Connection ARN that provides API Key or OAuth credentials for the registry.

Constraints:

  • min: 1
  • max: 1600
  • pattern: arn:aws(-[a-z0-9]+)*:events:[a-z0-9-]+:\d{12}:connection/.+

Shorthand Syntax:

RegistryUri=string,ConfluentPublicRegistryConfiguration={ConnectionArn=string}

JSON Syntax:

{
  "RegistryUri": "string",
  "ConfluentPublicRegistryConfiguration": {
    "ConnectionArn": "string"
  }
}

--deduplication-configuration (structure)

Request-level deduplication settings, applied to every entry in the batch.

DeduplicationType -> (string) [required]

How duplicate events are detected: by a hash of the event content (CONTENT_BASED). To deduplicate by a caller-supplied token instead, omit DeduplicationConfiguration and set DeduplicationId on each entry.

Possible values:

  • CONTENT_BASED

Shorthand Syntax:

DeduplicationType=string

JSON Syntax:

{
  "DeduplicationType": "CONTENT_BASED"
}

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

Output

FailedEntryCount -> (integer)

The number of entries in the batch that failed to be published.

Entries -> (list)

List of per-entry publish results, in the same order as the request entries.

(structure)

Result entry for a published event. The position of each entry in the response list aligns 1:1 with the corresponding request entry, enabling co-location by index.

EventId -> (string)

Unique event ID assigned by the service. Present on successful entries.

Constraints:

  • min: 1
  • max: 128

SequenceNumber -> (string)

Sequence number for ordering within the event group.

Constraints:

  • min: 1
  • max: 128

SuccessCode -> (string)

Indicates how the entry was processed. Present only on successful entries.

Possible values:

  • PUBLISHED
  • DEDUPLICATED

ErrorCode -> (string)

Error code if the entry failed.

Constraints:

  • min: 1
  • max: 256

ErrorMessage -> (string)

Error message if the entry failed.

Constraints:

  • min: 1
  • max: 2048
© Copyright 2026, Amazon Web Services. Created using Sphinx.