[ aws . frauddetector ]

get-event-types

Description

Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults , this action retrieves a maximum of 10 records per page. If you provide a maxResults , the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-event-types
[--name <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name.

--next-token (string)

The next token for the subsequent request.

--max-results (integer)

The maximum number of objects to return for the request.

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

eventTypes -> (list)

An array of event types.

(structure)

The event type details.

name -> (string)

The event type name.

description -> (string)

The event type description.

eventVariables -> (list)

The event type event variables.

(string)

labels -> (list)

The event type labels.

(string)

entityTypes -> (list)

The event type entity types.

(string)

eventIngestion -> (string)

If Enabled , Amazon Fraud Detector stores event data when you generate a prediction and uses that data to update calculated variables in near real-time. Amazon Fraud Detector uses this data, known as INGESTED_EVENTS , to train your model and improve fraud predictions.

ingestedEventStatistics -> (structure)

Data about the stored events.

numberOfEvents -> (long)

The number of stored events.

eventDataSizeInBytes -> (long)

The total size of the stored events.

leastRecentEvent -> (string)

The oldest stored event.

mostRecentEvent -> (string)

The newest stored event.

lastUpdatedTime -> (string)

Timestamp of when the stored event was last updated.

lastUpdatedTime -> (string)

Timestamp of when the event type was last updated.

createdTime -> (string)

Timestamp of when the event type was created.

arn -> (string)

The entity type ARN.

nextToken -> (string)

The next page token.