View a markdown version of this page

IngestionJobSummary - Amazon OpenSearch Serverless

IngestionJobSummary

Summary information about an ingestion job.

Contents

arn

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

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-job/[a-z0-9]{20,64}

Required: No

createdAt

The date and time when the ingestion job was created.

Type: Timestamp

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

ingestionJobId

The unique identifier of the ingestion job.

Type: String

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

Pattern: [a-z0-9]+

Required: No

ingestionJobName

The name of the ingestion job.

Type: String

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

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

Required: No

status

The current lifecycle status of the ingestion job.

Type: String

Valid Values: CREATING | ACTIVE | COMPLETED | CANCELLING | CANCELLED | FAILED | CREATE_FAILED | CANCEL_FAILED

Required: No

updatedAt

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

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: