ListEventPredictions
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.
Request Syntax
{
"detectorId": {
"value": "string"
},
"detectorVersionId": {
"value": "string"
},
"eventId": {
"value": "string"
},
"eventType": {
"value": "string"
},
"maxResults": number,
"nextToken": "string",
"predictionTimeRange": {
"endTime": "string",
"startTime": "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- detectorId
-
The detector ID.
Type: FilterCondition object
Required: No
- detectorVersionId
-
The detector version ID.
Type: FilterCondition object
Required: No
- eventId
-
The event ID.
Type: FilterCondition object
Required: No
- eventType
-
The event type associated with the detector.
Type: FilterCondition object
Required: No
- maxResults
-
The maximum number of predictions to return for the request.
Type: Integer
Valid Range: Minimum value of 50. Maximum value of 100.
Required: No
- nextToken
-
Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
Type: String
Required: No
- predictionTimeRange
-
The time period for when the predictions were generated.
Type: PredictionTimeRange object
Required: No
Response Syntax
{
"eventPredictionSummaries": [
{
"detectorId": "string",
"detectorVersionId": "string",
"eventId": "string",
"eventTimestamp": "string",
"eventTypeName": "string",
"predictionTimestamp": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- eventPredictionSummaries
-
The summary of the past predictions.
Type: Array of EventPredictionSummary objects
- nextToken
-
Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
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.HTTP Status Code: 400
- InternalServerException
-
An exception indicating an internal server error.
HTTP Status Code: 500
- ThrottlingException
-
An exception indicating a throttling error.
HTTP Status Code: 400
- ValidationException
-
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
