GetBatchPredictionJobsCommand

Suggest an Edit

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 Syntax

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",
// };

GetBatchPredictionJobsCommand Input

See GetBatchPredictionJobsCommandInput for more details

Parameter
Type
Description
jobId
string | undefined

The batch prediction job for which to get the details.

maxResults
number | undefined

The maximum number of objects to return for the request.

nextToken
string | undefined

The next token from the previous request.

GetBatchPredictionJobsCommand Output

See GetBatchPredictionJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
batchPredictions
BatchPrediction[] | undefined

An array containing the details of each batch prediction job.

nextToken
string | undefined

The next token for the subsequent request.

Throws

Name
Fault
Details
AccessDeniedException
client

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.

InternalServerException
server

An exception indicating an internal server error.

ResourceNotFoundException
client

An exception indicating the specified resource was not found.

ThrottlingException
client

An exception indicating a throttling error.

ValidationException
client

An exception indicating a specified value is not allowed.

FraudDetectorServiceException
Base exception class for all service exceptions from FraudDetector service.