Class: Aws::FraudDetector::Types::GetEventPredictionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-frauddetector/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:entities, :event_variables, :external_model_endpoint_data_blobs]

Instance Attribute Summary collapse

Instance Attribute Details

#detector_id ⇒ String

The detector ID.

Returns:

  • (String) 


2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#detector_version_id ⇒ String

The detector version ID.

Returns:

  • (String) 


2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#entities ⇒ Array<Types::Entity>

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

Returns:



2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#event_id ⇒ String

The unique ID used to identify the event.

Returns:

  • (String) 


2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#event_timestamp ⇒ String

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

Returns:

  • (String) 


2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#event_type_name ⇒ String

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

Returns:

  • (String) 


2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#event_variables ⇒ Hash<String,String>

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.

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.

Returns:

  • (Hash<String,String>) 


2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end

#external_model_endpoint_data_blobs ⇒ Hash<String,Types::ModelEndpointDataBlob>

The Amazon SageMaker model endpoint input data blobs.

Returns:



2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/aws-sdk-frauddetector/types.rb', line 2503

class GetEventPredictionRequest < Struct.new(
  :detector_id,
  :detector_version_id,
  :event_id,
  :event_type_name,
  :entities,
  :event_timestamp,
  :event_variables,
  :external_model_endpoint_data_blobs)
  SENSITIVE = [:entities, :event_variables, :external_model_endpoint_data_blobs]
  include Aws::Structure
end