ListIngestionJobs
Lists the data ingestion jobs for a data source. The list also includes information about each job.
Request Syntax
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"attribute": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- dataSourceId
-
The unique identifier of the data source for the list of data ingestion jobs.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- knowledgeBaseId
-
The unique identifier of the knowledge base for the list of data ingestion jobs.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- filters
-
Contains information about the filters for filtering the data.
Type: Array of IngestionJobFilter objects
Array Members: Fixed number of 1 item.
Required: No
- maxResults
-
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- nextToken
-
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$Required: No
- sortBy
-
Contains details about how to sort the data.
Type: IngestionJobSortBy object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ingestionJobSummaries": [
{
"dataSourceId": "string",
"description": "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"
}
],
"nextToken": "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.
- ingestionJobSummaries
-
A list of data ingestion jobs with information about each job.
Type: Array of IngestionJobSummary objects
- nextToken
-
If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$
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:
