Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . frauddetector ]

get-batch-prediction-jobs

Description

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.

Synopsis

  get-batch-prediction-jobs
[--job-id <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

Output

batchPredictions -> (list)

An array containing the details of each batch prediction job.

(structure)

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.