Class GetBatchPredictionJobsCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { FraudDetectorClient, GetBatchPredictionJobsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, GetBatchPredictionJobsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // GetBatchPredictionJobsRequest
  jobId: "STRING_VALUE",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new GetBatchPredictionJobsCommand(input);
const response = await client.send(command);
// { // GetBatchPredictionJobsResult
//   batchPredictions: [ // BatchPredictionList
//     { // BatchPrediction
//       jobId: "STRING_VALUE",
//       status: "IN_PROGRESS_INITIALIZING" || "IN_PROGRESS" || "CANCEL_IN_PROGRESS" || "CANCELED" || "COMPLETE" || "FAILED",
//       failureReason: "STRING_VALUE",
//       startTime: "STRING_VALUE",
//       completionTime: "STRING_VALUE",
//       lastHeartbeatTime: "STRING_VALUE",
//       inputPath: "STRING_VALUE",
//       outputPath: "STRING_VALUE",
//       eventTypeName: "STRING_VALUE",
//       detectorName: "STRING_VALUE",
//       detectorVersion: "STRING_VALUE",
//       iamRoleArn: "STRING_VALUE",
//       arn: "STRING_VALUE",
//       processedRecordsCount: Number("int"),
//       totalRecordsCount: Number("int"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

GetBatchPredictionJobsCommandInput

Returns

GetBatchPredictionJobsCommandOutput

See

• GetBatchPredictionJobsCommandInput for command's input shape.
• GetBatchPredictionJobsCommandOutput for command's response shape.
• config for FraudDetectorClient's config shape.

Throws

AccessDeniedException (client fault)

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.

Throws

InternalServerException (server fault)

An exception indicating an internal server error.

Throws

ResourceNotFoundException (client fault)

An exception indicating the specified resource was not found.

Throws

ThrottlingException (client fault)

An exception indicating a throttling error.

Throws

ValidationException (client fault)

An exception indicating a specified value is not allowed.

Throws

FraudDetectorServiceException

Base exception class for all service exceptions from FraudDetector service.