String jobId
The job ID for the batch prediction.
String status
The batch prediction status.
String failureReason
The reason a batch prediction job failed.
String startTime
Timestamp of when the batch prediction job started.
String completionTime
Timestamp of when the batch prediction job comleted.
String lastHeartbeatTime
Timestamp of most recent heartbeat indicating the batch prediction job was making progress.
String inputPath
The Amazon S3 location of your training file.
String outputPath
The Amazon S3 location of your output file.
String eventTypeName
The name of the event type.
String detectorName
The name of the detector.
String detectorVersion
The detector version.
String iamRoleArn
The ARN of the IAM role to use for this job request.
String arn
The ARN of batch prediction job.
Integer processedRecordsCount
The number of records processed by the batch prediction job.
Integer totalRecordsCount
The total number of records in the batch prediction job.
String jobId
The ID of the batch prediction job to cancel.
String jobId
The ID of the batch prediction job.
String inputPath
The Amazon S3 location of your training file.
String outputPath
The Amazon S3 location of your output file.
String eventTypeName
The name of the event type.
String detectorName
The name of the detector.
String detectorVersion
The detector version.
String iamRoleArn
The ARN of the IAM role to use for this job request.
List<E> tags
A collection of key and value pairs.
String detectorId
The ID of the detector under which you want to create a new version.
String description
The description of the detector version.
List<E> externalModelEndpoints
The Amazon Sagemaker model endpoints to include in the detector version.
List<E> rules
The rules to include in the detector version.
List<E> modelVersions
The model versions to include in the detector version.
String ruleExecutionMode
The rule execution mode for the rules included in the detector version.
You can define and edit the rule mode at the detector version level, when it is in draft status.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last,
stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for
all matched rules.
The default behavior is FIRST_MATCHED.
List<E> tags
A collection of key and value pairs.
String modelId
The model ID.
String modelType
The model type.
String trainingDataSource
The training data source location in Amazon S3.
TrainingDataSchema trainingDataSchema
The training data schema.
ExternalEventsDetail externalEventsDetail
Details for the external events data used for model version training. Required if trainingDataSource
is EXTERNAL_EVENTS.
List<E> tags
A collection of key and value pairs.
String ruleId
The rule ID.
String detectorId
The detector ID for the rule's parent detector.
String description
The rule description.
String expression
The rule expression.
String language
The language of the rule.
List<E> outcomes
The outcome or outcomes returned when the rule expression matches.
List<E> tags
A collection of key and value pairs.
Rule rule
The created rule.
String name
The name of the variable.
String dataType
The data type.
String dataSource
The source of the data.
String defaultValue
The default value for the variable when no value is received.
String description
The description.
String variableType
The variable type. For more information see Variable types.
Valid Values:
AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
List<E> tags
A collection of key and value pairs.
String jobId
The ID of the batch prediction job to delete.
String detectorId
The ID of the detector to delete.
String name
The name of the entity type to delete.
String name
The name of the event type to delete.
String modelEndpoint
The endpoint of the Amazon Sagemaker model to delete.
String name
The name of the label to delete.
String name
The name of the outcome to delete.
Rule rule
String name
The name of the variable to delete.
String detectorId
The detector ID.
String description
The detector description.
String eventTypeName
The name of the event type.
String lastUpdatedTime
Timestamp of when the detector was last updated.
String createdTime
Timestamp of when the detector was created.
String arn
The detector ARN.
String name
The entity type name.
String description
The entity type description.
String lastUpdatedTime
Timestamp of when the entity type was last updated.
String createdTime
Timestamp of when the entity type was created.
String arn
The entity type ARN.
String name
The event type name.
String description
The event type description.
List<E> eventVariables
The event type event variables.
List<E> labels
The event type labels.
List<E> entityTypes
The event type entity types.
String lastUpdatedTime
Timestamp of when the event type was last updated.
String createdTime
Timestamp of when the event type was created.
String arn
The entity type ARN.
String modelEndpoint
The Amazon SageMaker model endpoints.
String modelSource
The source of the model.
String invokeModelEndpointRoleArn
The role used to invoke the model.
ModelInputConfiguration inputConfiguration
The input configuration.
ModelOutputConfiguration outputConfiguration
The output configuration.
String modelEndpointStatus
The Amazon Fraud Detector status for the external model endpoint
String lastUpdatedTime
Timestamp of when the model was last updated.
String createdTime
Timestamp of when the model was last created.
String arn
The model ARN.
String detectorId
The detector ID.
String detectorVersionId
The detector version ID.
String description
The detector version description.
List<E> externalModelEndpoints
The Amazon SageMaker model endpoints included in the detector version.
List<E> modelVersions
The model versions included in the detector version.
List<E> rules
The rules included in the detector version.
String status
The status of the detector version.
String lastUpdatedTime
The timestamp when the detector version was last updated.
String createdTime
The timestamp when the detector version was created.
String ruleExecutionMode
The execution mode of the rule in the dectector
FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last,
stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for
all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft
status.
String arn
The detector version ARN.
String detectorId
The detector ID.
String detectorVersionId
The detector version ID.
String eventId
The unique ID used to identify the event.
String eventTypeName
The event type associated with the detector specified for the prediction.
List<E> entities
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."
String eventTimestamp
Timestamp that defines when the event under evaluation occurred.
Map<K,V> eventVariables
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.
Map<K,V> externalModelEndpointDataBlobs
The Amazon SageMaker model endpoint input data blobs.
List<E> modelScores
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.
List<E> ruleResults
The results.
KMSKey kmsKey
The KMS encryption key.
String modelId
The model ID.
String modelType
The model type.
String modelVersionNumber
The model version number.
String trainingDataSource
The training data source.
TrainingDataSchema trainingDataSchema
The training data schema.
ExternalEventsDetail externalEventsDetail
The event details.
String status
The model version status.
Possible values are:
TRAINING_IN_PROGRESS
TRAINING_COMPLETE
ACTIVATE_REQUESTED
ACTIVATE_IN_PROGRESS
ACTIVE
INACTIVATE_REQUESTED
INACTIVATE_IN_PROGRESS
INACTIVE
ERROR
String arn
The model version ARN.
String kmsEncryptionKeyArn
The encryption key ARN.
Map<K,V> labelMapper
The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD,
LEGIT) to the appropriate event type labels. For example, if "FRAUD" and "
LEGIT" are Amazon Fraud Detector supported labels, this mapper could be:
{"FRAUD" => ["0"], "LEGIT" => ["1"]} or {"FRAUD" => ["false"],
"LEGIT" => ["true"]} or {"FRAUD" => ["fraud", "abuse"],
"LEGIT" => ["legit", "safe"]}. The value part of the mapper is a list, because you may have
multiple label variants from your event type for a single Amazon Fraud Detector label.
Float fpr
The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
Float precision
The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
Float tpr
The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
Float threshold
The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
String modelId
The model ID.
String modelType
The model type.
String description
The model description.
String eventTypeName
The name of the event type.
String createdTime
Timestamp of when the model was created.
String lastUpdatedTime
Timestamp of last time the model was updated.
String arn
The ARN of the model.
ByteBuffer byteBuffer
The byte buffer of the Amazon SageMaker model endpoint input data blob.
String contentType
The content type of the Amazon SageMaker model endpoint input data blob.
String eventTypeName
The event type name.
String format
The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.
Boolean useEventVariables
The event variables.
String jsonInputTemplate
Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.
String csvInputTemplate
Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.
String format
The format of the model output configuration.
Map<K,V> jsonKeyToVariableMap
A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
Map<K,V> csvIndexToVariableMap
A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
ModelVersion modelVersion
The model version.
Map<K,V> scores
The model's fraud prediction scores.
String modelId
The model ID.
String modelType
The model type.
String modelVersionNumber
The model version number.
String status
The status of the model version.
String trainingDataSource
The model version training data source.
TrainingDataSchema trainingDataSchema
The training data schema.
ExternalEventsDetail externalEventsDetail
The event details.
TrainingResult trainingResult
The training results.
String lastUpdatedTime
The timestamp when the model was last updated.
String createdTime
The timestamp when the model was created.
String arn
The model version ARN.
String name
The name.
String description
The description of the event type.
List<E> eventVariables
The event type variables.
List<E> labels
The event type labels.
List<E> entityTypes
The entity type for the event type. Example entity types: customer, merchant, account.
List<E> tags
A collection of key and value pairs.
String modelEndpoint
The model endpoints name.
String modelSource
The source of the model.
String invokeModelEndpointRoleArn
The IAM role used to invoke the model endpoint.
ModelInputConfiguration inputConfiguration
The model endpoint input configuration.
ModelOutputConfiguration outputConfiguration
The model endpoint output configuration.
String modelEndpointStatus
The model endpoint’s status in Amazon Fraud Detector.
List<E> tags
A collection of key and value pairs.
String kmsEncryptionKeyArn
The KMS encryption key ARN.
String ruleId
The rule ID.
String description
The rule description.
String detectorId
The detector for which the rule is associated.
String ruleVersion
The rule version.
String expression
The rule expression.
String language
The rule language.
List<E> outcomes
The rule outcomes.
String lastUpdatedTime
Timestamp of the last time the rule was updated.
String createdTime
The timestamp of when the rule was created.
String arn
The rule ARN.
List<E> modelVariables
The training data schema variables.
LabelSchema labelSchema
Float auc
The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.
List<E> metricDataPoints
The data points details.
DataValidationMetrics dataValidationMetrics
The validation metrics.
TrainingMetrics trainingMetrics
The training metric details.
String detectorId
The parent detector ID for the detector version you want to update.
String detectorVersionId
The detector version ID.
List<E> externalModelEndpoints
The Amazon SageMaker model endpoints to include in the detector version.
List<E> rules
The rules to include in the detector version.
String description
The detector version description.
List<E> modelVersions
The model versions to include in the detector version.
String ruleExecutionMode
The rule execution mode to add to the detector.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last,
stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for
all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft
status.
The default behavior is FIRST_MATCHED.
Rule rule
The new rule version that was created.
String name
The name of the variable.
String defaultValue
The new default value of the variable.
String description
The new description.
String variableType
The variable type. For more information see Variable types.
String name
The name of the variable.
String dataType
The data type of the variable. For more information see Variable types.
String dataSource
The data source of the variable.
String defaultValue
The default value of the variable.
String description
The description of the variable.
String variableType
The variable type of the variable.
Valid Values:
AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
String lastUpdatedTime
The time when variable was last updated.
String createdTime
The time when the variable was created.
String arn
The ARN of the variable.
String name
The name of the variable.
String dataType
The data type of the variable.
String dataSource
The data source of the variable.
String defaultValue
The default value of the variable.
String description
The description of the variable.
String variableType
The type of the variable. For more information see Variable types.
Valid Values:
AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
Copyright © 2021. All rights reserved.