Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetIngestionJob

Returns information about an ingestion job, including its configuration, status, and processing state.

Request Syntax


{
   "collectionId": "string",
   "ingestionJobId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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

ingestionJobId

The unique identifier of the ingestion job to retrieve.

Type: String

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

Pattern: [a-z0-9]+

Required: Yes

Response Syntax


{
   "ingestionJobDetail": { 
      "activeAlerts": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "arn": "string",
      "collectionId": "string",
      "createdAt": number,
      "failureIndexName": "string",
      "failureReasons": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "indexName": "string",
      "ingestionJobId": "string",
      "ingestionJobName": "string",
      "revision": number,
      "source": { 
         "s3": { 
            "bucket": "string",
            "bucketOwnerAccountId": "string",
            "keyPrefix": "string"
         }
      },
      "state": "string",
      "statistics": { 
         "s3": { 
            "objectsDiscovered": number,
            "objectsFailed": number,
            "objectsIngested": number
         }
      },
      "status": "string",
      "updatedAt": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ingestionJobDetail

Details about the requested ingestion job.

Type: IngestionJobDetail object

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Thrown when accessing or deleting a resource that does not exist.

HTTP Status Code: 400

ValidationException

Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400