| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.FraudDetector.ListEventPredictions
Description
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.
Synopsis
- data ListEventPredictions = ListEventPredictions' {}
- newListEventPredictions :: ListEventPredictions
- listEventPredictions_detectorId :: Lens' ListEventPredictions (Maybe FilterCondition)
- listEventPredictions_detectorVersionId :: Lens' ListEventPredictions (Maybe FilterCondition)
- listEventPredictions_eventId :: Lens' ListEventPredictions (Maybe FilterCondition)
- listEventPredictions_eventType :: Lens' ListEventPredictions (Maybe FilterCondition)
- listEventPredictions_maxResults :: Lens' ListEventPredictions (Maybe Natural)
- listEventPredictions_nextToken :: Lens' ListEventPredictions (Maybe Text)
- listEventPredictions_predictionTimeRange :: Lens' ListEventPredictions (Maybe PredictionTimeRange)
- data ListEventPredictionsResponse = ListEventPredictionsResponse' {}
- newListEventPredictionsResponse :: Int -> ListEventPredictionsResponse
- listEventPredictionsResponse_eventPredictionSummaries :: Lens' ListEventPredictionsResponse (Maybe [EventPredictionSummary])
- listEventPredictionsResponse_nextToken :: Lens' ListEventPredictionsResponse (Maybe Text)
- listEventPredictionsResponse_httpStatus :: Lens' ListEventPredictionsResponse Int
Creating a Request
data ListEventPredictions Source #
See: newListEventPredictions smart constructor.
Constructors
| ListEventPredictions' | |
Fields
| |
Instances
newListEventPredictions :: ListEventPredictions Source #
Create a value of ListEventPredictions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListEventPredictions, listEventPredictions_detectorId - The detector ID.
ListEventPredictions, listEventPredictions_detectorVersionId - The detector version ID.
ListEventPredictions, listEventPredictions_eventId - The event ID.
$sel:eventType:ListEventPredictions', listEventPredictions_eventType - The event type associated with the detector.
$sel:maxResults:ListEventPredictions', listEventPredictions_maxResults - The maximum number of predictions to return for the request.
ListEventPredictions, listEventPredictions_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.
$sel:predictionTimeRange:ListEventPredictions', listEventPredictions_predictionTimeRange - The time period for when the predictions were generated.
Request Lenses
listEventPredictions_detectorId :: Lens' ListEventPredictions (Maybe FilterCondition) Source #
The detector ID.
listEventPredictions_detectorVersionId :: Lens' ListEventPredictions (Maybe FilterCondition) Source #
The detector version ID.
listEventPredictions_eventId :: Lens' ListEventPredictions (Maybe FilterCondition) Source #
The event ID.
listEventPredictions_eventType :: Lens' ListEventPredictions (Maybe FilterCondition) Source #
The event type associated with the detector.
listEventPredictions_maxResults :: Lens' ListEventPredictions (Maybe Natural) Source #
The maximum number of predictions to return for the request.
listEventPredictions_nextToken :: Lens' ListEventPredictions (Maybe Text) Source #
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.
listEventPredictions_predictionTimeRange :: Lens' ListEventPredictions (Maybe PredictionTimeRange) Source #
The time period for when the predictions were generated.
Destructuring the Response
data ListEventPredictionsResponse Source #
See: newListEventPredictionsResponse smart constructor.
Constructors
| ListEventPredictionsResponse' | |
Fields
| |
Instances
newListEventPredictionsResponse Source #
Create a value of ListEventPredictionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventPredictionSummaries:ListEventPredictionsResponse', listEventPredictionsResponse_eventPredictionSummaries - The summary of the past predictions.
ListEventPredictions, listEventPredictionsResponse_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.
$sel:httpStatus:ListEventPredictionsResponse', listEventPredictionsResponse_httpStatus - The response's http status code.
Response Lenses
listEventPredictionsResponse_eventPredictionSummaries :: Lens' ListEventPredictionsResponse (Maybe [EventPredictionSummary]) Source #
The summary of the past predictions.
listEventPredictionsResponse_nextToken :: Lens' ListEventPredictionsResponse (Maybe Text) Source #
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.
listEventPredictionsResponse_httpStatus :: Lens' ListEventPredictionsResponse Int Source #
The response's http status code.