GetIngestionJob
Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
Request Syntax
GET /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ingestionJobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- dataSourceId
-
The unique identifier of the data source for the data ingestion job you want to get information on.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- ingestionJobId
-
The unique identifier of the data ingestion job you want to get information on.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- knowledgeBaseId
-
The unique identifier of the knowledge base for the data ingestion job you want to get information on.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ingestionJob": {
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"ingestionJobId": "string",
"knowledgeBaseId": "string",
"startedAt": "string",
"statistics": {
"numberOfDocumentsDeleted": number,
"numberOfDocumentsFailed": number,
"numberOfDocumentsScanned": number,
"numberOfMetadataDocumentsModified": number,
"numberOfMetadataDocumentsScanned": number,
"numberOfModifiedDocumentsIndexed": number,
"numberOfNewDocumentsIndexed": number
},
"status": "string",
"updatedAt": "string"
}
}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.
- ingestionJob
-
Contains details about the data ingestion job.
Type: IngestionJob object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
