[ aws . frauddetector ]



Gets all batch prediction jobs or a specific job if you specify a job 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 GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--job-id <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--job-id (string)

The batch prediction job for which to get the details.

--max-results (integer)

The maximum number of objects to return for the request.

--next-token (string)

The next token from the previous request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


batchPredictions -> (list)

An array containing the details of each batch prediction job.


The batch prediction details.

jobId -> (string)

The job ID for the batch prediction.

status -> (string)

The batch prediction status.

failureReason -> (string)

The reason a batch prediction job failed.

startTime -> (string)

Timestamp of when the batch prediction job started.

completionTime -> (string)

Timestamp of when the batch prediction job completed.

lastHeartbeatTime -> (string)

Timestamp of most recent heartbeat indicating the batch prediction job was making progress.

inputPath -> (string)

The Amazon S3 location of your training file.

outputPath -> (string)

The Amazon S3 location of your output file.

eventTypeName -> (string)

The name of the event type.

detectorName -> (string)

The name of the detector.

detectorVersion -> (string)

The detector version.

iamRoleArn -> (string)

The ARN of the IAM role to use for this job request.

arn -> (string)

The ARN of batch prediction job.

processedRecordsCount -> (integer)

The number of records processed by the batch prediction job.

totalRecordsCount -> (integer)

The total number of records in the batch prediction job.

nextToken -> (string)

The next token for the subsequent request.