GetBatchImportJobs
Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null maxResults,
this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50.
To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request.
A null pagination token fetches the records from the beginning.
Request Syntax
{
"jobId": "string",
"maxResults": number,
"nextToken": "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.
- jobId
-
The ID of the batch import job to get.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[0-9a-z_-]+$Required: No
- maxResults
-
The maximum number of objects to return for request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- nextToken
-
The next token from the previous request.
Type: String
Required: No
Response Syntax
{
"batchImports": [
{
"arn": "string",
"completionTime": "string",
"eventTypeName": "string",
"failedRecordsCount": number,
"failureReason": "string",
"iamRoleArn": "string",
"inputPath": "string",
"jobId": "string",
"outputPath": "string",
"processedRecordsCount": number,
"startTime": "string",
"status": "string",
"totalRecordsCount": number
}
],
"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.
- batchImports
-
An array containing the details of each batch import job.
Type: Array of BatchImport objects
- nextToken
-
The next token for the subsequent resquest.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as
PutExternalModel, that specifies a role that is not in your account.HTTP Status Code: 400
- InternalServerException
-
An exception indicating an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
An exception indicating the specified resource was not found.
HTTP Status Code: 400
- ThrottlingException
-
An exception indicating a throttling error.
HTTP Status Code: 400
- ValidationException
-
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
