Get Batch Prediction Jobs

frauddetector_get_batch_prediction_jobs

R Documentation

Gets all batch prediction jobs or a specific job if you specify a job ID

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.

Usage

frauddetector_get_batch_prediction_jobs(jobId, maxResults, nextToken)

Arguments

jobId

The batch prediction job for which to get the details.

maxResults

The maximum number of objects to return for the request.

nextToken

The next token from the previous request.

Value

A list with the following syntax:

list(
  batchPredictions = list(
    list(
      jobId = "string",
      status = "IN_PROGRESS_INITIALIZING"|"IN_PROGRESS"|"CANCEL_IN_PROGRESS"|"CANCELED"|"COMPLETE"|"FAILED",
      failureReason = "string",
      startTime = "string",
      completionTime = "string",
      lastHeartbeatTime = "string",
      inputPath = "string",
      outputPath = "string",
      eventTypeName = "string",
      detectorName = "string",
      detectorVersion = "string",
      iamRoleArn = "string",
      arn = "string",
      processedRecordsCount = 123,
      totalRecordsCount = 123
    )
  ),
  nextToken = "string"
)

Request syntax

svc$get_batch_prediction_jobs(
  jobId = "string",
  maxResults = 123,
  nextToken = "string"
)