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 ]

get-event-prediction¶

Description¶

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE ) version is used.

Synopsis¶

  get-event-prediction
--detector-id <value>
[--detector-version-id <value>]
--event-id <value>
--event-type-name <value>
--entities <value>
--event-timestamp <value>
--event-variables <value>
[--external-model-endpoint-data-blobs <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¶

--detector-id (string)

The detector ID.

--detector-version-id (string)

The detector version ID.

--event-id (string)

The unique ID used to identify the event.

--event-type-name (string)

The event type associated with the detector specified for the prediction.

--entities (list)

The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."

(structure)

The entity details.

entityType -> (string)

The entity type.

entityId -> (string)

The entity ID. If you do not know the entityId , you can pass unknown , which is areserved string literal.

Shorthand Syntax:

entityType=string,entityId=string ...

JSON Syntax:

[
  {
    "entityType": "string",
    "entityId": "string"
  }
  ...
]

--event-timestamp (string)

Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

--event-variables (map)

Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

Warning
You must provide at least one eventVariable

To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:

For Amazon Fraud Detector trained models:

If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) with calculated default mean/medians for numeric variables and with special values for categorical variables.

For imported SageMaker models:

If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules will use the default value that is provided for the variable.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--external-model-endpoint-data-blobs (map)

The Amazon SageMaker model endpoint input data blobs.

key -> (string)

value -> (structure)

A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.

byteBuffer -> (blob)

The byte buffer of the Amazon SageMaker model endpoint input data blob.

contentType -> (string)

The content type of the Amazon SageMaker model endpoint input data blob.

Shorthand Syntax:

KeyName1=byteBuffer=blob,contentType=string,KeyName2=byteBuffer=blob,contentType=string

JSON Syntax:

{"string": {
      "byteBuffer": blob,
      "contentType": "string"
    }
  ...}

--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¶

modelScores -> (list)

The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.

(structure)

The fraud prediction scores.

modelVersion -> (structure)

The model version.

modelId -> (string)

The model ID.

modelType -> (string)

The model type.

modelVersionNumber -> (string)

The model version number.

arn -> (string)

The model version ARN.

scores -> (map)

The model's fraud prediction scores.

key -> (string)

value -> (float)

ruleResults -> (list)

The results from the rules.

(structure)

The rule results.

ruleId -> (string)

The rule ID that was matched, based on the rule execution mode.

outcomes -> (list)

The outcomes of the matched rule, based on the rule execution mode.

(string)

externalModelOutputs -> (list)

The model scores for Amazon SageMaker models.

(structure)

The fraud prediction scores from Amazon SageMaker model.

externalModel -> (structure)

The Amazon SageMaker model.

modelEndpoint -> (string)

The endpoint of the Amazon SageMaker model.

modelSource -> (string)

The source of the model.

outputs -> (map)

The fraud prediction scores from Amazon SageMaker model.

key -> (string)

value -> (string)

Table Of Contents

Feedback

User Guide

Note:

get-event-prediction¶

Description¶

Synopsis¶

Options¶

Warning

Global Options¶

Output¶