amazonka-frauddetector-2.0: Amazon Fraud Detector SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FraudDetector.Lens

Contents

Description

 
Synopsis

Operations

BatchCreateVariable

batchCreateVariable_tags :: Lens' BatchCreateVariable (Maybe [Tag]) Source #

A collection of key and value pairs.

batchCreateVariable_variableEntries :: Lens' BatchCreateVariable (NonEmpty VariableEntry) Source #

The list of variables for the batch create variable request.

batchCreateVariableResponse_errors :: Lens' BatchCreateVariableResponse (Maybe [BatchCreateVariableError]) Source #

Provides the errors for the BatchCreateVariable request.

BatchGetVariable

batchGetVariable_names :: Lens' BatchGetVariable (NonEmpty Text) Source #

The list of variable names to get.

CancelBatchImportJob

cancelBatchImportJob_jobId :: Lens' CancelBatchImportJob Text Source #

The ID of an in-progress batch import job to cancel.

Amazon Fraud Detector will throw an error if the batch import job is in FAILED, CANCELED, or COMPLETED state.

CancelBatchPredictionJob

cancelBatchPredictionJob_jobId :: Lens' CancelBatchPredictionJob Text Source #

The ID of the batch prediction job to cancel.

CreateBatchImportJob

createBatchImportJob_tags :: Lens' CreateBatchImportJob (Maybe [Tag]) Source #

A collection of key-value pairs associated with this request.

createBatchImportJob_jobId :: Lens' CreateBatchImportJob Text Source #

The ID of the batch import job. The ID cannot be of a past job, unless the job exists in CREATE_FAILED state.

createBatchImportJob_inputPath :: Lens' CreateBatchImportJob Text Source #

The URI that points to the Amazon S3 location of your data file.

createBatchImportJob_outputPath :: Lens' CreateBatchImportJob Text Source #

The URI that points to the Amazon S3 location for storing your results.

createBatchImportJob_iamRoleArn :: Lens' CreateBatchImportJob Text Source #

The ARN of the IAM role created for Amazon S3 bucket that holds your data file.

The IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.

CreateBatchPredictionJob

createBatchPredictionJob_tags :: Lens' CreateBatchPredictionJob (Maybe [Tag]) Source #

A collection of key and value pairs.

createBatchPredictionJob_inputPath :: Lens' CreateBatchPredictionJob Text Source #

The Amazon S3 location of your training file.

createBatchPredictionJob_outputPath :: Lens' CreateBatchPredictionJob Text Source #

The Amazon S3 location of your output file.

createBatchPredictionJob_iamRoleArn :: Lens' CreateBatchPredictionJob Text Source #

The ARN of the IAM role to use for this job request.

The IAM Role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.

CreateDetectorVersion

createDetectorVersion_description :: Lens' CreateDetectorVersion (Maybe Text) Source #

The description of the detector version.

createDetectorVersion_externalModelEndpoints :: Lens' CreateDetectorVersion (Maybe [Text]) Source #

The Amazon Sagemaker model endpoints to include in the detector version.

createDetectorVersion_modelVersions :: Lens' CreateDetectorVersion (Maybe [ModelVersion]) Source #

The model versions to include in the detector version.

createDetectorVersion_ruleExecutionMode :: Lens' CreateDetectorVersion (Maybe RuleExecutionMode) Source #

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.

createDetectorVersion_tags :: Lens' CreateDetectorVersion (Maybe [Tag]) Source #

A collection of key and value pairs.

createDetectorVersion_detectorId :: Lens' CreateDetectorVersion Text Source #

The ID of the detector under which you want to create a new version.

createDetectorVersion_rules :: Lens' CreateDetectorVersion [Rule] Source #

The rules to include in the detector version.

createDetectorVersionResponse_detectorId :: Lens' CreateDetectorVersionResponse (Maybe Text) Source #

The ID for the created version's parent detector.

CreateModel

createModel_tags :: Lens' CreateModel (Maybe [Tag]) Source #

A collection of key and value pairs.

createModel_eventTypeName :: Lens' CreateModel Text Source #

The name of the event type.

CreateModelVersion

createModelVersion_externalEventsDetail :: Lens' CreateModelVersion (Maybe ExternalEventsDetail) Source #

Details of the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.

createModelVersion_ingestedEventsDetail :: Lens' CreateModelVersion (Maybe IngestedEventsDetail) Source #

Details of the ingested events data used for model version training. Required if trainingDataSource is INGESTED_EVENTS.

createModelVersion_tags :: Lens' CreateModelVersion (Maybe [Tag]) Source #

A collection of key and value pairs.

createModelVersionResponse_modelVersionNumber :: Lens' CreateModelVersionResponse (Maybe Text) Source #

The model version number of the model version created.

CreateRule

createRule_tags :: Lens' CreateRule (Maybe [Tag]) Source #

A collection of key and value pairs.

createRule_detectorId :: Lens' CreateRule Text Source #

The detector ID for the rule's parent detector.

createRule_language :: Lens' CreateRule Language Source #

The language of the rule.

createRule_outcomes :: Lens' CreateRule (NonEmpty Text) Source #

The outcome or outcomes returned when the rule expression matches.

CreateVariable

createVariable_tags :: Lens' CreateVariable (Maybe [Tag]) Source #

A collection of key and value pairs.

createVariable_variableType :: Lens' CreateVariable (Maybe Text) Source #

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

createVariable_name :: Lens' CreateVariable Text Source #

The name of the variable.

createVariable_defaultValue :: Lens' CreateVariable Text Source #

The default value for the variable when no value is received.

DeleteBatchImportJob

deleteBatchImportJob_jobId :: Lens' DeleteBatchImportJob Text Source #

The ID of the batch import job to delete.

DeleteBatchPredictionJob

deleteBatchPredictionJob_jobId :: Lens' DeleteBatchPredictionJob Text Source #

The ID of the batch prediction job to delete.

DeleteDetector

deleteDetector_detectorId :: Lens' DeleteDetector Text Source #

The ID of the detector to delete.

DeleteDetectorVersion

deleteDetectorVersion_detectorId :: Lens' DeleteDetectorVersion Text Source #

The ID of the parent detector for the detector version to delete.

DeleteEntityType

deleteEntityType_name :: Lens' DeleteEntityType Text Source #

The name of the entity type to delete.

DeleteEvent

deleteEvent_deleteAuditHistory :: Lens' DeleteEvent (Maybe Bool) Source #

Specifies whether or not to delete any predictions associated with the event.

deleteEvent_eventId :: Lens' DeleteEvent Text Source #

The ID of the event to delete.

deleteEvent_eventTypeName :: Lens' DeleteEvent Text Source #

The name of the event type.

DeleteEventType

deleteEventType_name :: Lens' DeleteEventType Text Source #

The name of the event type to delete.

DeleteEventsByEventType

DeleteExternalModel

deleteExternalModel_modelEndpoint :: Lens' DeleteExternalModel Text Source #

The endpoint of the Amazon Sagemaker model to delete.

DeleteLabel

deleteLabel_name :: Lens' DeleteLabel Text Source #

The name of the label to delete.

DeleteModel

deleteModel_modelId :: Lens' DeleteModel Text Source #

The model ID of the model to delete.

deleteModel_modelType :: Lens' DeleteModel ModelTypeEnum Source #

The model type of the model to delete.

DeleteModelVersion

deleteModelVersion_modelId :: Lens' DeleteModelVersion Text Source #

The model ID of the model version to delete.

deleteModelVersion_modelType :: Lens' DeleteModelVersion ModelTypeEnum Source #

The model type of the model version to delete.

deleteModelVersion_modelVersionNumber :: Lens' DeleteModelVersion Text Source #

The model version number of the model version to delete.

DeleteOutcome

deleteOutcome_name :: Lens' DeleteOutcome Text Source #

The name of the outcome to delete.

DeleteRule

deleteRule_rule :: Lens' DeleteRule Rule Source #

Undocumented member.

DeleteVariable

deleteVariable_name :: Lens' DeleteVariable Text Source #

The name of the variable to delete.

DescribeDetector

describeDetector_maxResults :: Lens' DescribeDetector (Maybe Natural) Source #

The maximum number of results to return for the request.

describeDetector_nextToken :: Lens' DescribeDetector (Maybe Text) Source #

The next token from the previous response.

describeDetectorResponse_nextToken :: Lens' DescribeDetectorResponse (Maybe Text) Source #

The next token to be used for subsequent requests.

DescribeModelVersions

describeModelVersions_nextToken :: Lens' DescribeModelVersions (Maybe Text) Source #

The next token from the previous results.

GetBatchImportJobs

getBatchImportJobs_jobId :: Lens' GetBatchImportJobs (Maybe Text) Source #

The ID of the batch import job to get.

getBatchImportJobs_maxResults :: Lens' GetBatchImportJobs (Maybe Natural) Source #

The maximum number of objects to return for request.

getBatchImportJobs_nextToken :: Lens' GetBatchImportJobs (Maybe Text) Source #

The next token from the previous request.

getBatchImportJobsResponse_batchImports :: Lens' GetBatchImportJobsResponse (Maybe [BatchImport]) Source #

An array containing the details of each batch import job.

GetBatchPredictionJobs

getBatchPredictionJobs_jobId :: Lens' GetBatchPredictionJobs (Maybe Text) Source #

The batch prediction job for which to get the details.

getBatchPredictionJobs_maxResults :: Lens' GetBatchPredictionJobs (Maybe Natural) Source #

The maximum number of objects to return for the request.

getBatchPredictionJobs_nextToken :: Lens' GetBatchPredictionJobs (Maybe Text) Source #

The next token from the previous request.

getBatchPredictionJobsResponse_batchPredictions :: Lens' GetBatchPredictionJobsResponse (Maybe [BatchPrediction]) Source #

An array containing the details of each batch prediction job.

GetDeleteEventsByEventTypeStatus

getDeleteEventsByEventTypeStatus_eventTypeName :: Lens' GetDeleteEventsByEventTypeStatus Text Source #

Name of event type for which to get the deletion status.

GetDetectorVersion

getDetectorVersionResponse_createdTime :: Lens' GetDetectorVersionResponse (Maybe Text) Source #

The timestamp when the detector version was created.

getDetectorVersionResponse_externalModelEndpoints :: Lens' GetDetectorVersionResponse (Maybe [Text]) Source #

The Amazon SageMaker model endpoints included in the detector version.

getDetectorVersionResponse_lastUpdatedTime :: Lens' GetDetectorVersionResponse (Maybe Text) Source #

The timestamp when the detector version was last updated.

getDetectorVersionResponse_modelVersions :: Lens' GetDetectorVersionResponse (Maybe [ModelVersion]) Source #

The model versions included in the detector version.

getDetectorVersionResponse_ruleExecutionMode :: Lens' GetDetectorVersionResponse (Maybe RuleExecutionMode) Source #

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.

getDetectorVersionResponse_rules :: Lens' GetDetectorVersionResponse (Maybe [Rule]) Source #

The rules included in the detector version.

GetDetectors

getDetectors_maxResults :: Lens' GetDetectors (Maybe Natural) Source #

The maximum number of objects to return for the request.

getDetectors_nextToken :: Lens' GetDetectors (Maybe Text) Source #

The next token for the subsequent request.

GetEntityTypes

getEntityTypes_maxResults :: Lens' GetEntityTypes (Maybe Natural) Source #

The maximum number of objects to return for the request.

getEntityTypes_nextToken :: Lens' GetEntityTypes (Maybe Text) Source #

The next token for the subsequent request.

GetEvent

getEvent_eventId :: Lens' GetEvent Text Source #

The ID of the event to retrieve.

getEvent_eventTypeName :: Lens' GetEvent Text Source #

The event type of the event to retrieve.

getEventResponse_httpStatus :: Lens' GetEventResponse Int Source #

The response's http status code.

GetEventPrediction

getEventPrediction_eventId :: Lens' GetEventPrediction Text Source #

The unique ID used to identify the event.

getEventPrediction_eventTypeName :: Lens' GetEventPrediction Text Source #

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

getEventPrediction_entities :: Lens' GetEventPrediction [Entity] Source #

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

getEventPrediction_eventTimestamp :: Lens' GetEventPrediction Text Source #

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

getEventPrediction_eventVariables :: Lens' GetEventPrediction (HashMap Text Text) Source #

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.

getEventPredictionResponse_modelScores :: Lens' GetEventPredictionResponse (Maybe [ModelScores]) Source #

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.

GetEventPredictionMetadata

getEventPredictionMetadata_eventTypeName :: Lens' GetEventPredictionMetadata Text Source #

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

getEventPredictionMetadata_predictionTimestamp :: Lens' GetEventPredictionMetadata Text Source #

The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.

We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.

getEventPredictionMetadataResponse_evaluatedExternalModels :: Lens' GetEventPredictionMetadataResponse (Maybe [EvaluatedExternalModel]) Source #

External (Amazon SageMaker) models that were evaluated for generating predictions.

getEventPredictionMetadataResponse_eventTimestamp :: Lens' GetEventPredictionMetadataResponse (Maybe Text) Source #

The timestamp for when the prediction was generated for the associated event ID.

getEventPredictionMetadataResponse_eventTypeName :: Lens' GetEventPredictionMetadataResponse (Maybe Text) Source #

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

getEventPredictionMetadataResponse_outcomes :: Lens' GetEventPredictionMetadataResponse (Maybe [Text]) Source #

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

getEventPredictionMetadataResponse_rules :: Lens' GetEventPredictionMetadataResponse (Maybe [EvaluatedRule]) Source #

List of rules associated with the detector version that were used for evaluating variable values.

GetEventTypes

getEventTypes_maxResults :: Lens' GetEventTypes (Maybe Natural) Source #

The maximum number of objects to return for the request.

getEventTypes_nextToken :: Lens' GetEventTypes (Maybe Text) Source #

The next token for the subsequent request.

GetExternalModels

getExternalModels_maxResults :: Lens' GetExternalModels (Maybe Natural) Source #

The maximum number of objects to return for the request.

getExternalModels_modelEndpoint :: Lens' GetExternalModels (Maybe Text) Source #

The Amazon SageMaker model endpoint.

getExternalModels_nextToken :: Lens' GetExternalModels (Maybe Text) Source #

The next page token for the request.

getExternalModelsResponse_nextToken :: Lens' GetExternalModelsResponse (Maybe Text) Source #

The next page token to be used in subsequent requests.

GetKMSEncryptionKey

GetLabels

getLabels_maxResults :: Lens' GetLabels (Maybe Natural) Source #

The maximum number of objects to return for the request.

getLabels_name :: Lens' GetLabels (Maybe Text) Source #

The name of the label or labels to get.

getLabels_nextToken :: Lens' GetLabels (Maybe Text) Source #

The next token for the subsequent request.

getLabelsResponse_httpStatus :: Lens' GetLabelsResponse Int Source #

The response's http status code.

GetModelVersion

getModelVersionResponse_externalEventsDetail :: Lens' GetModelVersionResponse (Maybe ExternalEventsDetail) Source #

The details of the external events data used for training the model version. This will be populated if the trainingDataSource is EXTERNAL_EVENTS

getModelVersionResponse_ingestedEventsDetail :: Lens' GetModelVersionResponse (Maybe IngestedEventsDetail) Source #

The details of the ingested events data used for training the model version. This will be populated if the trainingDataSource is INGESTED_EVENTS.

getModelVersionResponse_status :: Lens' GetModelVersionResponse (Maybe Text) Source #

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

GetModels

getModels_maxResults :: Lens' GetModels (Maybe Natural) Source #

The maximum number of objects to return for the request.

getModels_nextToken :: Lens' GetModels (Maybe Text) Source #

The next token for the subsequent request.

getModelsResponse_nextToken :: Lens' GetModelsResponse (Maybe Text) Source #

The next page token to be used in subsequent requests.

getModelsResponse_httpStatus :: Lens' GetModelsResponse Int Source #

The response's http status code.

GetOutcomes

getOutcomes_maxResults :: Lens' GetOutcomes (Maybe Natural) Source #

The maximum number of objects to return for the request.

getOutcomes_name :: Lens' GetOutcomes (Maybe Text) Source #

The name of the outcome or outcomes to get.

getOutcomes_nextToken :: Lens' GetOutcomes (Maybe Text) Source #

The next page token for the request.

getOutcomesResponse_nextToken :: Lens' GetOutcomesResponse (Maybe Text) Source #

The next page token for subsequent requests.

GetRules

getRules_maxResults :: Lens' GetRules (Maybe Natural) Source #

The maximum number of rules to return for the request.

getRulesResponse_nextToken :: Lens' GetRulesResponse (Maybe Text) Source #

The next page token to be used in subsequent requests.

getRulesResponse_httpStatus :: Lens' GetRulesResponse Int Source #

The response's http status code.

GetVariables

getVariables_maxResults :: Lens' GetVariables (Maybe Natural) Source #

The max size per page determined for the get variable request.

getVariables_name :: Lens' GetVariables (Maybe Text) Source #

The name of the variable.

getVariables_nextToken :: Lens' GetVariables (Maybe Text) Source #

The next page token of the get variable request.

getVariablesResponse_nextToken :: Lens' GetVariablesResponse (Maybe Text) Source #

The next page token to be used in subsequent requests.

ListEventPredictions

listEventPredictions_eventType :: Lens' ListEventPredictions (Maybe FilterCondition) Source #

The event type associated with the detector.

listEventPredictions_maxResults :: Lens' ListEventPredictions (Maybe Natural) Source #

The maximum number of predictions to return for the request.

listEventPredictions_nextToken :: Lens' ListEventPredictions (Maybe Text) Source #

Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

listEventPredictions_predictionTimeRange :: Lens' ListEventPredictions (Maybe PredictionTimeRange) Source #

The time period for when the predictions were generated.

listEventPredictionsResponse_nextToken :: Lens' ListEventPredictionsResponse (Maybe Text) Source #

Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

ListTagsForResource

listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #

The maximum number of objects to return for the request.

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

The next token from the previous results.

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The ARN that specifies the resource whose tags you want to list.

PutDetector

putDetector_description :: Lens' PutDetector (Maybe Text) Source #

The description of the detector.

putDetector_tags :: Lens' PutDetector (Maybe [Tag]) Source #

A collection of key and value pairs.

putDetector_eventTypeName :: Lens' PutDetector Text Source #

The name of the event type.

PutEntityType

putEntityType_tags :: Lens' PutEntityType (Maybe [Tag]) Source #

A collection of key and value pairs.

putEntityType_name :: Lens' PutEntityType Text Source #

The name of the entity type.

PutEventType

putEventType_description :: Lens' PutEventType (Maybe Text) Source #

The description of the event type.

putEventType_eventIngestion :: Lens' PutEventType (Maybe EventIngestion) Source #

Specifies if ingenstion is enabled or disabled.

putEventType_labels :: Lens' PutEventType (Maybe [Text]) Source #

The event type labels.

putEventType_tags :: Lens' PutEventType (Maybe [Tag]) Source #

A collection of key and value pairs.

putEventType_entityTypes :: Lens' PutEventType (NonEmpty Text) Source #

The entity type for the event type. Example entity types: customer, merchant, account.

PutExternalModel

putExternalModel_tags :: Lens' PutExternalModel (Maybe [Tag]) Source #

A collection of key and value pairs.

putExternalModel_invokeModelEndpointRoleArn :: Lens' PutExternalModel Text Source #

The IAM role used to invoke the model endpoint.

putExternalModel_modelEndpointStatus :: Lens' PutExternalModel ModelEndpointStatus Source #

The model endpoint’s status in Amazon Fraud Detector.

PutKMSEncryptionKey

putKMSEncryptionKey_kmsEncryptionKeyArn :: Lens' PutKMSEncryptionKey Text Source #

The KMS encryption key ARN.

The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.

PutLabel

putLabel_description :: Lens' PutLabel (Maybe Text) Source #

The label description.

putLabelResponse_httpStatus :: Lens' PutLabelResponse Int Source #

The response's http status code.

PutOutcome

putOutcome_tags :: Lens' PutOutcome (Maybe [Tag]) Source #

A collection of key and value pairs.

putOutcome_name :: Lens' PutOutcome Text Source #

The name of the outcome.

SendEvent

sendEvent_assignedLabel :: Lens' SendEvent (Maybe Text) Source #

The label to associate with the event. Required if specifying labelTimestamp.

sendEvent_labelTimestamp :: Lens' SendEvent (Maybe Text) Source #

The timestamp associated with the label. Required if specifying assignedLabel.

sendEvent_eventId :: Lens' SendEvent Text Source #

The event ID to upload.

sendEvent_eventTypeName :: Lens' SendEvent Text Source #

The event type name of the event.

sendEvent_eventTimestamp :: Lens' SendEvent Text Source #

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

sendEvent_eventVariables :: Lens' SendEvent (HashMap Text Text) Source #

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.

sendEvent_entities :: Lens' SendEvent [Entity] Source #

An array of entities.

sendEventResponse_httpStatus :: Lens' SendEventResponse Int Source #

The response's http status code.

TagResource

tagResource_tags :: Lens' TagResource [Tag] Source #

The tags to assign to the resource.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The ARN of the resource from which to remove the tag.

UpdateDetectorVersion

updateDetectorVersion_modelVersions :: Lens' UpdateDetectorVersion (Maybe [ModelVersion]) Source #

The model versions to include in the detector version.

updateDetectorVersion_ruleExecutionMode :: Lens' UpdateDetectorVersion (Maybe RuleExecutionMode) Source #

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.

updateDetectorVersion_detectorId :: Lens' UpdateDetectorVersion Text Source #

The parent detector ID for the detector version you want to update.

updateDetectorVersion_externalModelEndpoints :: Lens' UpdateDetectorVersion [Text] Source #

The Amazon SageMaker model endpoints to include in the detector version.

updateDetectorVersion_rules :: Lens' UpdateDetectorVersion [Rule] Source #

The rules to include in the detector version.

UpdateDetectorVersionMetadata

UpdateDetectorVersionStatus

updateDetectorVersionStatus_status :: Lens' UpdateDetectorVersionStatus DetectorVersionStatus Source #

The new status.

The only supported values are ACTIVE and INACTIVE

UpdateEventLabel

updateEventLabel_eventId :: Lens' UpdateEventLabel Text Source #

The ID of the event associated with the label to update.

updateEventLabel_eventTypeName :: Lens' UpdateEventLabel Text Source #

The event type of the event associated with the label to update.

updateEventLabel_assignedLabel :: Lens' UpdateEventLabel Text Source #

The new label to assign to the event.

updateEventLabel_labelTimestamp :: Lens' UpdateEventLabel Text Source #

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

UpdateModel

updateModel_description :: Lens' UpdateModel (Maybe Text) Source #

The new model description.

UpdateModelVersion

updateModelVersion_externalEventsDetail :: Lens' UpdateModelVersion (Maybe ExternalEventsDetail) Source #

The details of the external events data used for training the model version. Required if trainingDataSource is EXTERNAL_EVENTS.

updateModelVersion_ingestedEventsDetail :: Lens' UpdateModelVersion (Maybe IngestedEventsDetail) Source #

The details of the ingested event used for training the model version. Required if your trainingDataSource is INGESTED_EVENTS.

updateModelVersion_tags :: Lens' UpdateModelVersion (Maybe [Tag]) Source #

A collection of key and value pairs.

updateModelVersionResponse_modelVersionNumber :: Lens' UpdateModelVersionResponse (Maybe Text) Source #

The model version number of the model version updated.

UpdateModelVersionStatus

updateModelVersionStatus_modelId :: Lens' UpdateModelVersionStatus Text Source #

The model ID of the model version to update.

UpdateRuleMetadata

UpdateRuleVersion

updateRuleVersion_tags :: Lens' UpdateRuleVersion (Maybe [Tag]) Source #

The tags to assign to the rule version.

UpdateVariable

updateVariable_defaultValue :: Lens' UpdateVariable (Maybe Text) Source #

The new default value of the variable.

updateVariable_variableType :: Lens' UpdateVariable (Maybe Text) Source #

The variable type. For more information see Variable types.

updateVariable_name :: Lens' UpdateVariable Text Source #

The name of the variable.

Types

ATIMetricDataPoint

aTIMetricDataPoint_adr :: Lens' ATIMetricDataPoint (Maybe Double) Source #

The anomaly discovery rate. This metric quantifies the percentage of anomalies that can be detected by the model at the selected score threshold. A lower score threshold increases the percentage of anomalies captured by the model, but would also require challenging a larger percentage of login events, leading to a higher customer friction.

aTIMetricDataPoint_atodr :: Lens' ATIMetricDataPoint (Maybe Double) Source #

The account takeover discovery rate. This metric quantifies the percentage of account compromise events that can be detected by the model at the selected score threshold. This metric is only available if 50 or more entities with at-least one labeled account takeover event is present in the ingested dataset.

aTIMetricDataPoint_cr :: Lens' ATIMetricDataPoint (Maybe Double) Source #

The challenge rate. This indicates the percentage of login events that the model recommends to challenge such as one-time password, multi-factor authentication, and investigations.

aTIMetricDataPoint_threshold :: Lens' ATIMetricDataPoint (Maybe Double) Source #

The model's 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.

ATIModelPerformance

aTIModelPerformance_asi :: Lens' ATIModelPerformance (Maybe Double) Source #

The anomaly separation index (ASI) score. This metric summarizes the overall ability of the model to separate anomalous activities from the normal behavior. Depending on the business, a large fraction of these anomalous activities can be malicious and correspond to the account takeover attacks. A model with no separability power will have the lowest possible ASI score of 0.5, whereas the a model with a high separability power will have the highest possible ASI score of 1.0

ATITrainingMetricsValue

AggregatedLogOddsMetric

aggregatedLogOddsMetric_aggregatedVariablesImportance :: Lens' AggregatedLogOddsMetric Double Source #

The relative importance of the variables in the list to the other event variable.

AggregatedVariablesImpactExplanation

aggregatedVariablesImpactExplanation_eventVariableNames :: Lens' AggregatedVariablesImpactExplanation (Maybe [Text]) Source #

The names of all the event variables that were used to derive the aggregated variables.

aggregatedVariablesImpactExplanation_logOddsImpact :: Lens' AggregatedVariablesImpactExplanation (Maybe Double) Source #

The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity.

  • A positive value indicates that the variables drove the risk score up.
  • A negative value indicates that the variables drove the risk score down.

aggregatedVariablesImpactExplanation_relativeImpact :: Lens' AggregatedVariablesImpactExplanation (Maybe Text) Source #

The relative impact of the aggregated variables in terms of magnitude on the prediction scores.

AggregatedVariablesImportanceMetrics

BatchCreateVariableError

BatchGetVariableError

BatchImport

batchImport_arn :: Lens' BatchImport (Maybe Text) Source #

The ARN of the batch import job.

batchImport_completionTime :: Lens' BatchImport (Maybe Text) Source #

Timestamp of when batch import job completed.

batchImport_eventTypeName :: Lens' BatchImport (Maybe Text) Source #

The name of the event type.

batchImport_failedRecordsCount :: Lens' BatchImport (Maybe Int) Source #

The number of records that failed to import.

batchImport_failureReason :: Lens' BatchImport (Maybe Text) Source #

The reason batch import job failed.

batchImport_iamRoleArn :: Lens' BatchImport (Maybe Text) Source #

The ARN of the IAM role to use for this job request.

batchImport_inputPath :: Lens' BatchImport (Maybe Text) Source #

The Amazon S3 location of your data file for batch import.

batchImport_jobId :: Lens' BatchImport (Maybe Text) Source #

The ID of the batch import job.

batchImport_outputPath :: Lens' BatchImport (Maybe Text) Source #

The Amazon S3 location of your output file.

batchImport_processedRecordsCount :: Lens' BatchImport (Maybe Int) Source #

The number of records processed by batch import job.

batchImport_startTime :: Lens' BatchImport (Maybe Text) Source #

Timestamp of when the batch import job started.

batchImport_status :: Lens' BatchImport (Maybe AsyncJobStatus) Source #

The status of the batch import job.

batchImport_totalRecordsCount :: Lens' BatchImport (Maybe Int) Source #

The total number of records in the batch import job.

BatchPrediction

batchPrediction_arn :: Lens' BatchPrediction (Maybe Text) Source #

The ARN of batch prediction job.

batchPrediction_completionTime :: Lens' BatchPrediction (Maybe Text) Source #

Timestamp of when the batch prediction job completed.

batchPrediction_failureReason :: Lens' BatchPrediction (Maybe Text) Source #

The reason a batch prediction job failed.

batchPrediction_iamRoleArn :: Lens' BatchPrediction (Maybe Text) Source #

The ARN of the IAM role to use for this job request.

batchPrediction_inputPath :: Lens' BatchPrediction (Maybe Text) Source #

The Amazon S3 location of your training file.

batchPrediction_jobId :: Lens' BatchPrediction (Maybe Text) Source #

The job ID for the batch prediction.

batchPrediction_lastHeartbeatTime :: Lens' BatchPrediction (Maybe Text) Source #

Timestamp of most recent heartbeat indicating the batch prediction job was making progress.

batchPrediction_outputPath :: Lens' BatchPrediction (Maybe Text) Source #

The Amazon S3 location of your output file.

batchPrediction_processedRecordsCount :: Lens' BatchPrediction (Maybe Int) Source #

The number of records processed by the batch prediction job.

batchPrediction_startTime :: Lens' BatchPrediction (Maybe Text) Source #

Timestamp of when the batch prediction job started.

batchPrediction_totalRecordsCount :: Lens' BatchPrediction (Maybe Int) Source #

The total number of records in the batch prediction job.

DataValidationMetrics

dataValidationMetrics_fieldLevelMessages :: Lens' DataValidationMetrics (Maybe [FieldValidationMessage]) Source #

The field-specific model training validation messages.

dataValidationMetrics_fileLevelMessages :: Lens' DataValidationMetrics (Maybe [FileValidationMessage]) Source #

The file-specific model training data validation messages.

Detector

detector_arn :: Lens' Detector (Maybe Text) Source #

The detector ARN.

detector_createdTime :: Lens' Detector (Maybe Text) Source #

Timestamp of when the detector was created.

detector_description :: Lens' Detector (Maybe Text) Source #

The detector description.

detector_eventTypeName :: Lens' Detector (Maybe Text) Source #

The name of the event type.

detector_lastUpdatedTime :: Lens' Detector (Maybe Text) Source #

Timestamp of when the detector was last updated.

DetectorVersionSummary

detectorVersionSummary_lastUpdatedTime :: Lens' DetectorVersionSummary (Maybe Text) Source #

Timestamp of when the detector version was last updated.

Entity

entity_entityId :: Lens' Entity Text Source #

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

EntityType

entityType_arn :: Lens' EntityType (Maybe Text) Source #

The entity type ARN.

entityType_createdTime :: Lens' EntityType (Maybe Text) Source #

Timestamp of when the entity type was created.

entityType_description :: Lens' EntityType (Maybe Text) Source #

The entity type description.

entityType_lastUpdatedTime :: Lens' EntityType (Maybe Text) Source #

Timestamp of when the entity type was last updated.

entityType_name :: Lens' EntityType (Maybe Text) Source #

The entity type name.

EvaluatedExternalModel

evaluatedExternalModel_inputVariables :: Lens' EvaluatedExternalModel (Maybe (HashMap Text Text)) Source #

Input variables use for generating predictions.

evaluatedExternalModel_modelEndpoint :: Lens' EvaluatedExternalModel (Maybe Text) Source #

The endpoint of the external (Amazon Sagemaker) model.

evaluatedExternalModel_useEventVariables :: Lens' EvaluatedExternalModel (Maybe Bool) Source #

Indicates whether event variables were used to generate predictions.

EvaluatedModelVersion

evaluatedModelVersion_modelType :: Lens' EvaluatedModelVersion (Maybe Text) Source #

The model type.

Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS

EvaluatedRule

evaluatedRule_evaluated :: Lens' EvaluatedRule (Maybe Bool) Source #

Indicates whether the rule was evaluated.

evaluatedRule_matched :: Lens' EvaluatedRule (Maybe Bool) Source #

Indicates whether the rule matched.

Event

event_currentLabel :: Lens' Event (Maybe Text) Source #

The label associated with the event.

event_entities :: Lens' Event (Maybe [Entity]) Source #

The event entities.

event_eventTimestamp :: Lens' Event (Maybe Text) Source #

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

event_eventVariables :: Lens' Event (Maybe (HashMap Text Text)) Source #

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.

event_labelTimestamp :: Lens' Event (Maybe Text) Source #

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

EventPredictionSummary

eventPredictionSummary_predictionTimestamp :: Lens' EventPredictionSummary (Maybe Text) Source #

The timestamp when the prediction was generated.

EventType

eventType_arn :: Lens' EventType (Maybe Text) Source #

The entity type ARN.

eventType_createdTime :: Lens' EventType (Maybe Text) Source #

Timestamp of when the event type was created.

eventType_description :: Lens' EventType (Maybe Text) Source #

The event type description.

eventType_entityTypes :: Lens' EventType (Maybe (NonEmpty Text)) Source #

The event type entity types.

eventType_eventIngestion :: Lens' EventType (Maybe EventIngestion) Source #

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.

eventType_eventVariables :: Lens' EventType (Maybe [Text]) Source #

The event type event variables.

eventType_labels :: Lens' EventType (Maybe [Text]) Source #

The event type labels.

eventType_lastUpdatedTime :: Lens' EventType (Maybe Text) Source #

Timestamp of when the event type was last updated.

eventType_name :: Lens' EventType (Maybe Text) Source #

The event type name.

EventVariableSummary

ExternalEventsDetail

externalEventsDetail_dataLocation :: Lens' ExternalEventsDetail Text Source #

The Amazon S3 bucket location for the data.

externalEventsDetail_dataAccessRoleArn :: Lens' ExternalEventsDetail Text Source #

The ARN of the role that provides Amazon Fraud Detector access to the data location.

ExternalModel

externalModel_createdTime :: Lens' ExternalModel (Maybe Text) Source #

Timestamp of when the model was last created.

externalModel_lastUpdatedTime :: Lens' ExternalModel (Maybe Text) Source #

Timestamp of when the model was last updated.

externalModel_modelEndpoint :: Lens' ExternalModel (Maybe Text) Source #

The Amazon SageMaker model endpoints.

externalModel_modelEndpointStatus :: Lens' ExternalModel (Maybe ModelEndpointStatus) Source #

The Amazon Fraud Detector status for the external model endpoint

ExternalModelOutputs

externalModelOutputs_outputs :: Lens' ExternalModelOutputs (Maybe (HashMap Text Text)) Source #

The fraud prediction scores from Amazon SageMaker model.

ExternalModelSummary

externalModelSummary_modelEndpoint :: Lens' ExternalModelSummary (Maybe Text) Source #

The endpoint of the Amazon SageMaker model.

FieldValidationMessage

FileValidationMessage

FilterCondition

filterCondition_value :: Lens' FilterCondition (Maybe Text) Source #

A statement containing a resource property and a value to specify filter condition.

IngestedEventStatistics

ingestedEventStatistics_lastUpdatedTime :: Lens' IngestedEventStatistics (Maybe Text) Source #

Timestamp of when the stored event was last updated.

IngestedEventsDetail

IngestedEventsTimeWindow

KMSKey

Label

label_arn :: Lens' Label (Maybe Text) Source #

The label ARN.

label_createdTime :: Lens' Label (Maybe Text) Source #

Timestamp of when the event type was created.

label_description :: Lens' Label (Maybe Text) Source #

The label description.

label_lastUpdatedTime :: Lens' Label (Maybe Text) Source #

Timestamp of when the label was last updated.

label_name :: Lens' Label (Maybe Text) Source #

The label name.

LabelSchema

labelSchema_labelMapper :: Lens' LabelSchema (Maybe (HashMap Text [Text])) Source #

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.

LogOddsMetric

logOddsMetric_variableImportance :: Lens' LogOddsMetric Double Source #

The relative importance of the variable. For more information, see Model variable importance.

MetricDataPoint

metricDataPoint_fpr :: Lens' MetricDataPoint (Maybe Double) Source #

The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.

metricDataPoint_precision :: Lens' MetricDataPoint (Maybe Double) Source #

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

metricDataPoint_threshold :: Lens' MetricDataPoint (Maybe Double) Source #

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.

metricDataPoint_tpr :: Lens' MetricDataPoint (Maybe Double) Source #

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

Model

model_arn :: Lens' Model (Maybe Text) Source #

The ARN of the model.

model_createdTime :: Lens' Model (Maybe Text) Source #

Timestamp of when the model was created.

model_description :: Lens' Model (Maybe Text) Source #

The model description.

model_eventTypeName :: Lens' Model (Maybe Text) Source #

The name of the event type.

model_lastUpdatedTime :: Lens' Model (Maybe Text) Source #

Timestamp of last time the model was updated.

ModelEndpointDataBlob

modelEndpointDataBlob_byteBuffer :: Lens' ModelEndpointDataBlob (Maybe ByteString) Source #

The byte buffer of the Amazon SageMaker model endpoint input data blob.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

modelEndpointDataBlob_contentType :: Lens' ModelEndpointDataBlob (Maybe Text) Source #

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

ModelInputConfiguration

modelInputConfiguration_csvInputTemplate :: Lens' ModelInputConfiguration (Maybe Text) Source #

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.

modelInputConfiguration_format :: Lens' ModelInputConfiguration (Maybe ModelInputDataFormat) Source #

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.

modelInputConfiguration_jsonInputTemplate :: Lens' ModelInputConfiguration (Maybe Text) Source #

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.

ModelOutputConfiguration

modelOutputConfiguration_csvIndexToVariableMap :: Lens' ModelOutputConfiguration (Maybe (HashMap Text Text)) Source #

A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.

modelOutputConfiguration_jsonKeyToVariableMap :: Lens' ModelOutputConfiguration (Maybe (HashMap Text Text)) Source #

A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.

ModelScores

modelScores_scores :: Lens' ModelScores (Maybe (HashMap Text Double)) Source #

The model's fraud prediction scores.

ModelVersion

modelVersion_arn :: Lens' ModelVersion (Maybe Text) Source #

The model version ARN.

ModelVersionDetail

modelVersionDetail_createdTime :: Lens' ModelVersionDetail (Maybe Text) Source #

The timestamp when the model was created.

modelVersionDetail_externalEventsDetail :: Lens' ModelVersionDetail (Maybe ExternalEventsDetail) Source #

The external events data details. This will be populated if the trainingDataSource for the model version is specified as EXTERNAL_EVENTS.

modelVersionDetail_ingestedEventsDetail :: Lens' ModelVersionDetail (Maybe IngestedEventsDetail) Source #

The ingested events data details. This will be populated if the trainingDataSource for the model version is specified as INGESTED_EVENTS.

modelVersionDetail_lastUpdatedTime :: Lens' ModelVersionDetail (Maybe Text) Source #

The timestamp when the model was last updated.

modelVersionDetail_status :: Lens' ModelVersionDetail (Maybe Text) Source #

The status of the model version.

modelVersionDetail_trainingResultV2 :: Lens' ModelVersionDetail (Maybe TrainingResultV2) Source #

The training result details. The details include the relative importance of the variables.

ModelVersionEvaluation

modelVersionEvaluation_evaluationScore :: Lens' ModelVersionEvaluation (Maybe Text) Source #

The evaluation score generated for the model version.

modelVersionEvaluation_predictionExplanations :: Lens' ModelVersionEvaluation (Maybe PredictionExplanations) Source #

The prediction explanations generated for the model version.

OFIMetricDataPoint

oFIMetricDataPoint_fpr :: Lens' OFIMetricDataPoint (Maybe Double) Source #

The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.

oFIMetricDataPoint_precision :: Lens' OFIMetricDataPoint (Maybe Double) Source #

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

oFIMetricDataPoint_threshold :: Lens' OFIMetricDataPoint (Maybe Double) Source #

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.

oFIMetricDataPoint_tpr :: Lens' OFIMetricDataPoint (Maybe Double) Source #

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

OFIModelPerformance

oFIModelPerformance_auc :: Lens' OFIModelPerformance (Maybe Double) Source #

The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.

OFITrainingMetricsValue

Outcome

outcome_arn :: Lens' Outcome (Maybe Text) Source #

The outcome ARN.

outcome_createdTime :: Lens' Outcome (Maybe Text) Source #

The timestamp when the outcome was created.

outcome_description :: Lens' Outcome (Maybe Text) Source #

The outcome description.

outcome_lastUpdatedTime :: Lens' Outcome (Maybe Text) Source #

The timestamp when the outcome was last updated.

outcome_name :: Lens' Outcome (Maybe Text) Source #

The outcome name.

PredictionExplanations

predictionExplanations_aggregatedVariablesImpactExplanations :: Lens' PredictionExplanations (Maybe [AggregatedVariablesImpactExplanation]) Source #

The details of the aggregated variables impact on the prediction score.

Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

predictionExplanations_variableImpactExplanations :: Lens' PredictionExplanations (Maybe [VariableImpactExplanation]) Source #

The details of the event variable's impact on the prediction score.

PredictionTimeRange

predictionTimeRange_startTime :: Lens' PredictionTimeRange Text Source #

The start time of the time period for when the predictions were generated.

predictionTimeRange_endTime :: Lens' PredictionTimeRange Text Source #

The end time of the time period for when the predictions were generated.

Rule

rule_detectorId :: Lens' Rule Text Source #

The detector for which the rule is associated.

rule_ruleVersion :: Lens' Rule Text Source #

The rule version.

RuleDetail

ruleDetail_createdTime :: Lens' RuleDetail (Maybe Text) Source #

The timestamp of when the rule was created.

ruleDetail_detectorId :: Lens' RuleDetail (Maybe Text) Source #

The detector for which the rule is associated.

ruleDetail_lastUpdatedTime :: Lens' RuleDetail (Maybe Text) Source #

Timestamp of the last time the rule was updated.

RuleResult

ruleResult_outcomes :: Lens' RuleResult (Maybe [Text]) Source #

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

ruleResult_ruleId :: Lens' RuleResult (Maybe Text) Source #

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

TFIMetricDataPoint

tFIMetricDataPoint_fpr :: Lens' TFIMetricDataPoint (Maybe Double) Source #

The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.

tFIMetricDataPoint_precision :: Lens' TFIMetricDataPoint (Maybe Double) Source #

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

tFIMetricDataPoint_threshold :: Lens' TFIMetricDataPoint (Maybe Double) Source #

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.

tFIMetricDataPoint_tpr :: Lens' TFIMetricDataPoint (Maybe Double) Source #

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

TFIModelPerformance

tFIModelPerformance_auc :: Lens' TFIModelPerformance (Maybe Double) Source #

The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.

TFITrainingMetricsValue

Tag

tag_key :: Lens' Tag Text Source #

A tag key.

tag_value :: Lens' Tag Text Source #

A value assigned to a tag key.

TrainingDataSchema

trainingDataSchema_modelVariables :: Lens' TrainingDataSchema [Text] Source #

The training data schema variables.

TrainingMetrics

trainingMetrics_auc :: Lens' TrainingMetrics (Maybe Double) Source #

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.

TrainingMetricsV2

trainingMetricsV2_ati :: Lens' TrainingMetricsV2 (Maybe ATITrainingMetricsValue) Source #

The Account Takeover Insights (ATI) model training metric details.

trainingMetricsV2_ofi :: Lens' TrainingMetricsV2 (Maybe OFITrainingMetricsValue) Source #

The Online Fraud Insights (OFI) model training metric details.

trainingMetricsV2_tfi :: Lens' TrainingMetricsV2 (Maybe TFITrainingMetricsValue) Source #

The Transaction Fraud Insights (TFI) model training metric details.

TrainingResult

TrainingResultV2

trainingResultV2_aggregatedVariablesImportanceMetrics :: Lens' TrainingResultV2 (Maybe AggregatedVariablesImportanceMetrics) Source #

The variable importance metrics of the aggregated variables.

Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.

Variable

variable_arn :: Lens' Variable (Maybe Text) Source #

The ARN of the variable.

variable_createdTime :: Lens' Variable (Maybe Text) Source #

The time when the variable was created.

variable_dataSource :: Lens' Variable (Maybe DataSource) Source #

The data source of the variable.

variable_dataType :: Lens' Variable (Maybe DataType) Source #

The data type of the variable. For more information see Variable types.

variable_defaultValue :: Lens' Variable (Maybe Text) Source #

The default value of the variable.

variable_description :: Lens' Variable (Maybe Text) Source #

The description of the variable.

variable_lastUpdatedTime :: Lens' Variable (Maybe Text) Source #

The time when variable was last updated.

variable_name :: Lens' Variable (Maybe Text) Source #

The name of the variable.

variable_variableType :: Lens' Variable (Maybe Text) Source #

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

VariableEntry

variableEntry_dataSource :: Lens' VariableEntry (Maybe Text) Source #

The data source of the variable.

variableEntry_dataType :: Lens' VariableEntry (Maybe Text) Source #

The data type of the variable.

variableEntry_defaultValue :: Lens' VariableEntry (Maybe Text) Source #

The default value of the variable.

variableEntry_description :: Lens' VariableEntry (Maybe Text) Source #

The description of the variable.

variableEntry_name :: Lens' VariableEntry (Maybe Text) Source #

The name of the variable.

variableEntry_variableType :: Lens' VariableEntry (Maybe Text) Source #

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

VariableImpactExplanation

variableImpactExplanation_logOddsImpact :: Lens' VariableImpactExplanation (Maybe Double) Source #

The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.

  • A positive value indicates that the variable drove the risk score up.
  • A negative value indicates that the variable drove the risk score down.

variableImpactExplanation_relativeImpact :: Lens' VariableImpactExplanation (Maybe Text) Source #

The event variable's relative impact in terms of magnitude on the prediction scores. The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.

VariableImportanceMetrics