Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . frauddetector ]
list-event-predictions¶
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.
See also: AWS API Documentation
Synopsis¶
list-event-predictions
[--event-id <value>]
[--event-type <value>]
[--detector-id <value>]
[--detector-version-id <value>]
[--prediction-time-range <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--event-id (structure)
The event ID.
value -> (string)
A statement containing a resource property and a value to specify filter condition.
Shorthand Syntax:
value=string
JSON Syntax:
{
"value": "string"
}
--event-type (structure)
The event type associated with the detector.
value -> (string)
A statement containing a resource property and a value to specify filter condition.
Shorthand Syntax:
value=string
JSON Syntax:
{
"value": "string"
}
--detector-id (structure)
The detector ID.
value -> (string)
A statement containing a resource property and a value to specify filter condition.
Shorthand Syntax:
value=string
JSON Syntax:
{
"value": "string"
}
--detector-version-id (structure)
The detector version ID.
value -> (string)
A statement containing a resource property and a value to specify filter condition.
Shorthand Syntax:
value=string
JSON Syntax:
{
"value": "string"
}
--prediction-time-range (structure)
The time period for when the predictions were generated.
startTime -> (string)
The start time of the time period for when the predictions were generated.endTime -> (string)
The end time of the time period for when the predictions were generated.
Shorthand Syntax:
startTime=string,endTime=string
JSON Syntax:
{
"startTime": "string",
"endTime": "string"
}
--next-token (string)
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.
--max-results (integer)
The maximum number of predictions to return for the request.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
eventPredictionSummaries -> (list)
The summary of the past predictions.
(structure)
Information about the summary of an event prediction.
eventId -> (string)
The event ID.eventTypeName -> (string)
The event type.eventTimestamp -> (string)
The timestamp of the event.predictionTimestamp -> (string)
The timestamp when the prediction was generated.detectorId -> (string)
The detector ID.detectorVersionId -> (string)
The detector version ID.
nextToken -> (string)
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.