IngestionJobDetail
Details about an ingestion job.
Contents
- activeAlerts
-
Active alerts about operational issues that currently affect the ingestion job. 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 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
- collectionId
-
The unique identifier of the collection that the ingestion job 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 job 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 job 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
- 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
- revision
-
The revision number of the ingestion job.
Type: Long
Required: No
- source
-
The Amazon S3 source that the ingestion job ingests data from.
Type: IngestionJobSource object
Required: No
- state
-
The current processing state of the ingestion job. For example,
SCANNING,INGESTION_IN_PROGRESS, orINGESTION_COMPLETE.Type: String
Valid Values:
STARTING | SCANNING | INGESTION_IN_PROGRESS | INGESTION_COMPLETE | STOPPED | FAILEDRequired: No
- statistics
-
Processing statistics for the ingestion job, 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 job. For example,
CREATING,ACTIVE,COMPLETED, orCANCELLED.Type: String
Valid Values:
CREATING | ACTIVE | COMPLETED | CANCELLING | CANCELLED | FAILED | CREATE_FAILED | CANCEL_FAILEDRequired: 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: