Class ListEventPredictionsCommandProtected

Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.

For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” }

This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.

Example

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

import { FraudDetectorClient, ListEventPredictionsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, ListEventPredictionsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // ListEventPredictionsRequest
  eventId: { // FilterCondition
    value: "STRING_VALUE",
  },
  eventType: {
    value: "STRING_VALUE",
  },
  detectorId: {
    value: "STRING_VALUE",
  },
  detectorVersionId: {
    value: "STRING_VALUE",
  },
  predictionTimeRange: { // PredictionTimeRange
    startTime: "STRING_VALUE", // required
    endTime: "STRING_VALUE", // required
  },
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListEventPredictionsCommand(input);
const response = await client.send(command);

Param

ListEventPredictionsCommandInput

Returns

ListEventPredictionsCommandOutput

See

• ListEventPredictionsCommandInput for command's input shape.
• ListEventPredictionsCommandOutput 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

ThrottlingException (client fault)

An exception indicating a throttling error.

Throws

ValidationException (client fault)

An exception indicating a specified value is not allowed.