IngestionStreamDetail

Details about an ingestion stream.

activeAlerts

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

Type: Array of IngestionAlert objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

arn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 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}

Required: No

collectionId

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: [a-z0-9]{3,40}

Required: No

createdAt

The date and time when the ingestion stream was created.

Type: Timestamp

Required: No

failureIndexName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-z0-9.][a-z0-9._-]*

Required: No

failureReasons

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

Type: Array of IngestionFailureReason objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

indexName

The name of the index that documents are ingested into.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-z0-9.][a-z0-9._-]*

Required: No

ingestionStreamId

The unique identifier of the ingestion stream.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 64.

Pattern: [a-z0-9]+

Required: No

ingestionStreamName

The name of the ingestion stream.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: [a-z][a-z0-9-]*

Required: No

revision

The revision number of the ingestion stream.

Type: Long

Required: No

roleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 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/.+

Required: No

source

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

Type: IngestionStreamSource object

Required: No

state

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

Type: String

Required: No

statistics

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

Type: IngestionStatistics object

Required: No

status

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

Type: String

Required: No

updatedAt

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

Type: Timestamp

Required: No

IngestionStreamDetail

Contents

See Also