[ aws . frauddetector ]

get-event

Description

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-event
--event-id <value>
--event-type-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--event-id (string)

The ID of the event to retrieve.

--event-type-name (string)

The event type of the event to retrieve.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

event -> (structure)

The details of the event.

eventId -> (string)

The event ID.

eventTypeName -> (string)

The event type.

eventTimestamp -> (string)

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

eventVariables -> (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.

key -> (string)

value -> (string)

currentLabel -> (string)

The label associated with the event.

labelTimestamp -> (string)

The timestamp associated with the label to update. The timestamp must be specified using ISO 8601 standard in UTC.

entities -> (list)

The event entities.

(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.