AWS CLI Command Reference

[ aws . opensearchserverless ]

create-ingestion-stream

Description

Creates an ingestion stream that continuously ingests data from an Amazon S3 bucket into an index in an OpenSearch Serverless collection. An ingestion stream processes Amazon S3 event notifications delivered to an Amazon SQS queue and ingests new objects as they arrive. The stream continues to ingest data until you delete it. To perform a one-time bulk ingestion instead, use CreateIngestionJob .

See also: AWS API Documentation

Synopsis

  create-ingestion-stream
--collection-id <value>
--ingestion-stream-name <value>
--index-name <value>
[--failure-index-name <value>]
--source <value>
--role-arn <value>
[--tags <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>]

Options

--collection-id (string) [required]

The unique identifier of the collection to ingest data into.

Constraints:

  • min: 3
  • max: 40
  • pattern: [a-z0-9]{3,40}

--ingestion-stream-name (string) [required]

The name of the ingestion stream. The name must be unique within the collection.

Constraints:

  • min: 3
  • max: 32
  • pattern: [a-z][a-z0-9-]*

--index-name (string) [required]

The name of the index to ingest documents into.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-z0-9.][a-z0-9._-]*

--failure-index-name (string)

The name of the index where documents that fail to be ingested are recorded.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-z0-9.][a-z0-9._-]*

--source (structure) [required]

The Amazon S3 source to ingest data from, including the Amazon SQS queue that receives S3 event notifications.

s3 -> (structure) [required]

The Amazon S3 source configuration for the ingestion stream.

sqsArn -> (string) [required]

The Amazon Resource Name (ARN) of the Amazon SQS queue that receives Amazon S3 event notifications for the source buckets.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):sqs:[a-z0-9-]+:\d{12}:.+

buckets -> (list)

The configuration for each Amazon S3 bucket that the ingestion stream ingests data from.

Constraints:

  • min: 0
  • max: 5

(structure)

S3 bucket configuration for SQS-driven ingestion. The scan mode controls only the optional one-time delta scan of existing objects in this bucket.

bucket -> (string) [required]

The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.

Constraints:

  • min: 3
  • max: 2048
  • pattern: (arn:[a-z0-9\-]+:s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]|[a-z0-9][a-z0-9.-]{1,61}[a-z0-9])

bucketOwnerAccountId -> (string)

The AWS account ID that owns the S3 bucket. Optional. If omitted, the control plane derives it from the account segment of sqsArn.

Constraints:

  • min: 12
  • max: 12
  • pattern: [0-9]{12}

initialScan -> (string)

Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED , only new objects are ingested.

Possible values:

  • ENABLED
  • DISABLED

JSON Syntax:

{
  "s3": {
    "sqsArn": "string",
    "buckets": [
      {
        "bucket": "string",
        "bucketOwnerAccountId": "string",
        "initialScan": "ENABLED"|"DISABLED"
      }
      ...
    ]
  }
}

--role-arn (string) [required]

The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source. The role must be in the same account as the collection.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):iam::\d{12}:role/.+

--tags (list)

An arbitrary set of tags (key–value pairs) to associate with the ingestion stream.

Constraints:

  • min: 0
  • max: 50

(structure)

A map of key-value pairs associated to an OpenSearch Serverless resource.

key -> (string) [required]

The key to use in the tag.

Constraints:

  • min: 1
  • max: 128

value -> (string) [required]

The value of the tag.

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--client-token (string)

Unique, case-sensitive identifier to ensure idempotency of the request.

Constraints:

  • min: 1
  • max: 512

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

ingestionStreamDetail -> (structure)

Details about the created ingestion stream.

ingestionStreamId -> (string)

The unique identifier of the ingestion stream.

Constraints:

  • min: 20
  • max: 64
  • pattern: [a-z0-9]+

arn -> (string)

The Amazon Resource Name (ARN) of the ingestion stream.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):aoss:[a-z0-9-]+:\d{12}:collection/[a-z0-9]{3,40}/ingestion-stream/[a-z0-9]{20,64}

collectionId -> (string)

The unique identifier of the collection that the ingestion stream belongs to.

Constraints:

  • min: 3
  • max: 40
  • pattern: [a-z0-9]{3,40}

ingestionStreamName -> (string)

The name of the ingestion stream.

Constraints:

  • min: 3
  • max: 32
  • pattern: [a-z][a-z0-9-]*

indexName -> (string)

The name of the index that documents are ingested into.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-z0-9.][a-z0-9._-]*

failureIndexName -> (string)

The name of the index where documents that fail to be ingested are recorded.

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-z0-9.][a-z0-9._-]*

source -> (structure)

The Amazon S3 source that the ingestion stream ingests data from.

s3 -> (structure) [required]

The Amazon S3 source configuration for the ingestion stream.

sqsArn -> (string) [required]

The Amazon Resource Name (ARN) of the Amazon SQS queue that receives Amazon S3 event notifications for the source buckets.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):sqs:[a-z0-9-]+:\d{12}:.+

buckets -> (list)

The configuration for each Amazon S3 bucket that the ingestion stream ingests data from.

Constraints:

  • min: 0
  • max: 5

(structure)

S3 bucket configuration for SQS-driven ingestion. The scan mode controls only the optional one-time delta scan of existing objects in this bucket.

bucket -> (string) [required]

The name or Amazon Resource Name (ARN) of the Amazon S3 bucket to ingest data from.

Constraints:

  • min: 3
  • max: 2048
  • pattern: (arn:[a-z0-9\-]+:s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]|[a-z0-9][a-z0-9.-]{1,61}[a-z0-9])

bucketOwnerAccountId -> (string)

The AWS account ID that owns the S3 bucket. Optional. If omitted, the control plane derives it from the account segment of sqsArn.

Constraints:

  • min: 12
  • max: 12
  • pattern: [0-9]{12}

initialScan -> (string)

Specifies whether to perform a one-time scan of the objects that already exist in the bucket before the stream begins processing Amazon S3 event notifications. If DISABLED , only new objects are ingested.

Possible values:

  • ENABLED
  • DISABLED

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:(?:aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b|aws-iso-c|aws-iso-d|aws-iso-e):iam::\d{12}:role/.+

status -> (string)

The current lifecycle status of the ingestion stream. For example, CREATING , ACTIVE , or DELETING .

Possible values:

  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • CREATE_FAILED
  • DELETE_FAILED

state -> (string)

The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS .

Possible values:

  • STARTING
  • SCANNING
  • INGESTION_IN_PROGRESS
  • INGESTION_COMPLETE
  • STOPPED
  • FAILED

statistics -> (structure)

Processing statistics for the ingestion stream, such as the number of Amazon S3 objects discovered, ingested, and failed.

s3 -> (structure)

Processing statistics for the Amazon S3 source.

objectsDiscovered -> (long)

The number of Amazon S3 objects discovered for ingestion.

objectsIngested -> (long)

The number of Amazon S3 objects successfully ingested.

objectsFailed -> (long)

The number of Amazon S3 objects that failed to be ingested.

revision -> (long)

The revision number of the ingestion stream.

createdAt -> (timestamp)

The date and time when the ingestion stream was created.

updatedAt -> (timestamp)

The date and time when the ingestion stream was last updated.

failureReasons -> (list)

The reasons that the ingestion stream reached a terminal failure state, if applicable.

Constraints:

  • min: 0
  • max: 10

(structure)

A terminal failure reason explaining why an ingestion stopped.

code -> (string)

The code that identifies the reason for the failure.

Possible values:

  • SOURCE_ACCESS_DENIED
  • SOURCE_RESOURCE_NOT_FOUND
  • DESTINATION_ACCESS_DENIED
  • DESTINATION_RESOURCE_NOT_FOUND
  • INTERNAL_SERVER_ERROR

message -> (string)

A description of the reason for the failure.

activeAlerts -> (list)

Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared when the issue is resolved.

Constraints:

  • min: 0
  • max: 10

(structure)

An active alert about a running ingestion — operational issues or updates to processing state. Cleared when the issue resolves.

code -> (string)

The code that identifies the alert.

Possible values:

  • SOURCE_ACCESS_DENIED
  • SOURCE_RESOURCE_NOT_FOUND
  • DESTINATION_ACCESS_DENIED
  • DESTINATION_RESOURCE_NOT_FOUND
  • INTERNAL_SERVER_ERROR

message -> (string)

A description of the alert.
© Copyright 2026, Amazon Web Services. Created using Sphinx.