| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.FraudDetector
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BatchCreateVariable
- BatchGetVariable
- CancelBatchImportJob
- CancelBatchPredictionJob
- CreateBatchImportJob
- CreateBatchPredictionJob
- CreateDetectorVersion
- CreateModel
- CreateModelVersion
- CreateRule
- CreateVariable
- DeleteBatchImportJob
- DeleteBatchPredictionJob
- DeleteDetector
- DeleteDetectorVersion
- DeleteEntityType
- DeleteEvent
- DeleteEventType
- DeleteEventsByEventType
- DeleteExternalModel
- DeleteLabel
- DeleteModel
- DeleteModelVersion
- DeleteOutcome
- DeleteRule
- DeleteVariable
- DescribeDetector
- DescribeModelVersions
- GetBatchImportJobs
- GetBatchPredictionJobs
- GetDeleteEventsByEventTypeStatus
- GetDetectorVersion
- GetDetectors
- GetEntityTypes
- GetEvent
- GetEventPrediction
- GetEventPredictionMetadata
- GetEventTypes
- GetExternalModels
- GetKMSEncryptionKey
- GetLabels
- GetModelVersion
- GetModels
- GetOutcomes
- GetRules
- GetVariables
- ListEventPredictions
- ListTagsForResource
- PutDetector
- PutEntityType
- PutEventType
- PutExternalModel
- PutKMSEncryptionKey
- PutLabel
- PutOutcome
- SendEvent
- TagResource
- UntagResource
- UpdateDetectorVersion
- UpdateDetectorVersionMetadata
- UpdateDetectorVersionStatus
- UpdateEventLabel
- UpdateModel
- UpdateModelVersion
- UpdateModelVersionStatus
- UpdateRuleMetadata
- UpdateRuleVersion
- UpdateVariable
- Types
- AsyncJobStatus
- DataSource
- DataType
- DetectorVersionStatus
- EventIngestion
- Language
- ModelEndpointStatus
- ModelInputDataFormat
- ModelOutputDataFormat
- ModelSource
- ModelTypeEnum
- ModelVersionStatus
- RuleExecutionMode
- TrainingDataSourceEnum
- UnlabeledEventsTreatment
- ATIMetricDataPoint
- ATIModelPerformance
- ATITrainingMetricsValue
- AggregatedLogOddsMetric
- AggregatedVariablesImpactExplanation
- AggregatedVariablesImportanceMetrics
- BatchCreateVariableError
- BatchGetVariableError
- BatchImport
- BatchPrediction
- DataValidationMetrics
- Detector
- DetectorVersionSummary
- Entity
- EntityType
- EvaluatedExternalModel
- EvaluatedModelVersion
- EvaluatedRule
- Event
- EventPredictionSummary
- EventType
- EventVariableSummary
- ExternalEventsDetail
- ExternalModel
- ExternalModelOutputs
- ExternalModelSummary
- FieldValidationMessage
- FileValidationMessage
- FilterCondition
- IngestedEventStatistics
- IngestedEventsDetail
- IngestedEventsTimeWindow
- KMSKey
- Label
- LabelSchema
- LogOddsMetric
- MetricDataPoint
- Model
- ModelEndpointDataBlob
- ModelInputConfiguration
- ModelOutputConfiguration
- ModelScores
- ModelVersion
- ModelVersionDetail
- ModelVersionEvaluation
- OFIMetricDataPoint
- OFIModelPerformance
- OFITrainingMetricsValue
- Outcome
- PredictionExplanations
- PredictionTimeRange
- Rule
- RuleDetail
- RuleResult
- TFIMetricDataPoint
- TFIModelPerformance
- TFITrainingMetricsValue
- Tag
- TrainingDataSchema
- TrainingMetrics
- TrainingMetricsV2
- TrainingResult
- TrainingResultV2
- Variable
- VariableEntry
- VariableImpactExplanation
- VariableImportanceMetrics
Description
Derived from API version 2019-11-15 of the AWS service descriptions, licensed under Apache 2.0.
This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
The Amazon Fraud Detector Query API provides HTTPS requests that use the
HTTP verb GET or POST and a Query parameter Action. AWS SDK provides
libraries, sample code, tutorials, and other resources for software
developers who prefer to build applications using language-specific APIs
instead of submitting a request over HTTP or HTTPS. These libraries
provide basic functions that automatically take care of tasks such as
cryptographically signing your requests, retrying requests, and handling
error responses, so that it is easier for you to get started. For more
information about the AWS SDKs, see
Tools to build on AWS.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ResourceUnavailableException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BatchCreateVariable = BatchCreateVariable' (Maybe [Tag]) (NonEmpty VariableEntry)
- newBatchCreateVariable :: NonEmpty VariableEntry -> BatchCreateVariable
- data BatchCreateVariableResponse = BatchCreateVariableResponse' (Maybe [BatchCreateVariableError]) Int
- newBatchCreateVariableResponse :: Int -> BatchCreateVariableResponse
- data BatchGetVariable = BatchGetVariable' (NonEmpty Text)
- newBatchGetVariable :: NonEmpty Text -> BatchGetVariable
- data BatchGetVariableResponse = BatchGetVariableResponse' (Maybe [BatchGetVariableError]) (Maybe [Variable]) Int
- newBatchGetVariableResponse :: Int -> BatchGetVariableResponse
- data CancelBatchImportJob = CancelBatchImportJob' Text
- newCancelBatchImportJob :: Text -> CancelBatchImportJob
- data CancelBatchImportJobResponse = CancelBatchImportJobResponse' Int
- newCancelBatchImportJobResponse :: Int -> CancelBatchImportJobResponse
- data CancelBatchPredictionJob = CancelBatchPredictionJob' Text
- newCancelBatchPredictionJob :: Text -> CancelBatchPredictionJob
- data CancelBatchPredictionJobResponse = CancelBatchPredictionJobResponse' Int
- newCancelBatchPredictionJobResponse :: Int -> CancelBatchPredictionJobResponse
- data CreateBatchImportJob = CreateBatchImportJob' (Maybe [Tag]) Text Text Text Text Text
- newCreateBatchImportJob :: Text -> Text -> Text -> Text -> Text -> CreateBatchImportJob
- data CreateBatchImportJobResponse = CreateBatchImportJobResponse' Int
- newCreateBatchImportJobResponse :: Int -> CreateBatchImportJobResponse
- data CreateBatchPredictionJob = CreateBatchPredictionJob' (Maybe Text) (Maybe [Tag]) Text Text Text Text Text Text
- newCreateBatchPredictionJob :: Text -> Text -> Text -> Text -> Text -> Text -> CreateBatchPredictionJob
- data CreateBatchPredictionJobResponse = CreateBatchPredictionJobResponse' Int
- newCreateBatchPredictionJobResponse :: Int -> CreateBatchPredictionJobResponse
- data CreateDetectorVersion = CreateDetectorVersion' (Maybe Text) (Maybe [Text]) (Maybe [ModelVersion]) (Maybe RuleExecutionMode) (Maybe [Tag]) Text [Rule]
- newCreateDetectorVersion :: Text -> CreateDetectorVersion
- data CreateDetectorVersionResponse = CreateDetectorVersionResponse' (Maybe Text) (Maybe Text) (Maybe DetectorVersionStatus) Int
- newCreateDetectorVersionResponse :: Int -> CreateDetectorVersionResponse
- data CreateModel = CreateModel' (Maybe Text) (Maybe [Tag]) Text ModelTypeEnum Text
- newCreateModel :: Text -> ModelTypeEnum -> Text -> CreateModel
- data CreateModelResponse = CreateModelResponse' Int
- newCreateModelResponse :: Int -> CreateModelResponse
- data CreateModelVersion = CreateModelVersion' (Maybe ExternalEventsDetail) (Maybe IngestedEventsDetail) (Maybe [Tag]) Text ModelTypeEnum TrainingDataSourceEnum TrainingDataSchema
- newCreateModelVersion :: Text -> ModelTypeEnum -> TrainingDataSourceEnum -> TrainingDataSchema -> CreateModelVersion
- data CreateModelVersionResponse = CreateModelVersionResponse' (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) Int
- newCreateModelVersionResponse :: Int -> CreateModelVersionResponse
- data CreateRule = CreateRule' (Maybe Text) (Maybe [Tag]) Text Text (Sensitive Text) Language (NonEmpty Text)
- newCreateRule :: Text -> Text -> Text -> Language -> NonEmpty Text -> CreateRule
- data CreateRuleResponse = CreateRuleResponse' (Maybe Rule) Int
- newCreateRuleResponse :: Int -> CreateRuleResponse
- data CreateVariable = CreateVariable' (Maybe Text) (Maybe [Tag]) (Maybe Text) Text DataType DataSource Text
- newCreateVariable :: Text -> DataType -> DataSource -> Text -> CreateVariable
- data CreateVariableResponse = CreateVariableResponse' Int
- newCreateVariableResponse :: Int -> CreateVariableResponse
- data DeleteBatchImportJob = DeleteBatchImportJob' Text
- newDeleteBatchImportJob :: Text -> DeleteBatchImportJob
- data DeleteBatchImportJobResponse = DeleteBatchImportJobResponse' Int
- newDeleteBatchImportJobResponse :: Int -> DeleteBatchImportJobResponse
- data DeleteBatchPredictionJob = DeleteBatchPredictionJob' Text
- newDeleteBatchPredictionJob :: Text -> DeleteBatchPredictionJob
- data DeleteBatchPredictionJobResponse = DeleteBatchPredictionJobResponse' Int
- newDeleteBatchPredictionJobResponse :: Int -> DeleteBatchPredictionJobResponse
- data DeleteDetector = DeleteDetector' Text
- newDeleteDetector :: Text -> DeleteDetector
- data DeleteDetectorResponse = DeleteDetectorResponse' Int
- newDeleteDetectorResponse :: Int -> DeleteDetectorResponse
- data DeleteDetectorVersion = DeleteDetectorVersion' Text Text
- newDeleteDetectorVersion :: Text -> Text -> DeleteDetectorVersion
- data DeleteDetectorVersionResponse = DeleteDetectorVersionResponse' Int
- newDeleteDetectorVersionResponse :: Int -> DeleteDetectorVersionResponse
- data DeleteEntityType = DeleteEntityType' Text
- newDeleteEntityType :: Text -> DeleteEntityType
- data DeleteEntityTypeResponse = DeleteEntityTypeResponse' Int
- newDeleteEntityTypeResponse :: Int -> DeleteEntityTypeResponse
- data DeleteEvent = DeleteEvent' (Maybe Bool) Text Text
- newDeleteEvent :: Text -> Text -> DeleteEvent
- data DeleteEventResponse = DeleteEventResponse' Int
- newDeleteEventResponse :: Int -> DeleteEventResponse
- data DeleteEventType = DeleteEventType' Text
- newDeleteEventType :: Text -> DeleteEventType
- data DeleteEventTypeResponse = DeleteEventTypeResponse' Int
- newDeleteEventTypeResponse :: Int -> DeleteEventTypeResponse
- data DeleteEventsByEventType = DeleteEventsByEventType' Text
- newDeleteEventsByEventType :: Text -> DeleteEventsByEventType
- data DeleteEventsByEventTypeResponse = DeleteEventsByEventTypeResponse' (Maybe Text) (Maybe Text) Int
- newDeleteEventsByEventTypeResponse :: Int -> DeleteEventsByEventTypeResponse
- data DeleteExternalModel = DeleteExternalModel' Text
- newDeleteExternalModel :: Text -> DeleteExternalModel
- data DeleteExternalModelResponse = DeleteExternalModelResponse' Int
- newDeleteExternalModelResponse :: Int -> DeleteExternalModelResponse
- data DeleteLabel = DeleteLabel' Text
- newDeleteLabel :: Text -> DeleteLabel
- data DeleteLabelResponse = DeleteLabelResponse' Int
- newDeleteLabelResponse :: Int -> DeleteLabelResponse
- data DeleteModel = DeleteModel' Text ModelTypeEnum
- newDeleteModel :: Text -> ModelTypeEnum -> DeleteModel
- data DeleteModelResponse = DeleteModelResponse' Int
- newDeleteModelResponse :: Int -> DeleteModelResponse
- data DeleteModelVersion = DeleteModelVersion' Text ModelTypeEnum Text
- newDeleteModelVersion :: Text -> ModelTypeEnum -> Text -> DeleteModelVersion
- data DeleteModelVersionResponse = DeleteModelVersionResponse' Int
- newDeleteModelVersionResponse :: Int -> DeleteModelVersionResponse
- data DeleteOutcome = DeleteOutcome' Text
- newDeleteOutcome :: Text -> DeleteOutcome
- data DeleteOutcomeResponse = DeleteOutcomeResponse' Int
- newDeleteOutcomeResponse :: Int -> DeleteOutcomeResponse
- data DeleteRule = DeleteRule' Rule
- newDeleteRule :: Rule -> DeleteRule
- data DeleteRuleResponse = DeleteRuleResponse' Int
- newDeleteRuleResponse :: Int -> DeleteRuleResponse
- data DeleteVariable = DeleteVariable' Text
- newDeleteVariable :: Text -> DeleteVariable
- data DeleteVariableResponse = DeleteVariableResponse' Int
- newDeleteVariableResponse :: Int -> DeleteVariableResponse
- data DescribeDetector = DescribeDetector' (Maybe Natural) (Maybe Text) Text
- newDescribeDetector :: Text -> DescribeDetector
- data DescribeDetectorResponse = DescribeDetectorResponse' (Maybe Text) (Maybe Text) (Maybe [DetectorVersionSummary]) (Maybe Text) Int
- newDescribeDetectorResponse :: Int -> DescribeDetectorResponse
- data DescribeModelVersions = DescribeModelVersions' (Maybe Natural) (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text)
- newDescribeModelVersions :: DescribeModelVersions
- data DescribeModelVersionsResponse = DescribeModelVersionsResponse' (Maybe [ModelVersionDetail]) (Maybe Text) Int
- newDescribeModelVersionsResponse :: Int -> DescribeModelVersionsResponse
- data GetBatchImportJobs = GetBatchImportJobs' (Maybe Text) (Maybe Natural) (Maybe Text)
- newGetBatchImportJobs :: GetBatchImportJobs
- data GetBatchImportJobsResponse = GetBatchImportJobsResponse' (Maybe [BatchImport]) (Maybe Text) Int
- newGetBatchImportJobsResponse :: Int -> GetBatchImportJobsResponse
- data GetBatchPredictionJobs = GetBatchPredictionJobs' (Maybe Text) (Maybe Natural) (Maybe Text)
- newGetBatchPredictionJobs :: GetBatchPredictionJobs
- data GetBatchPredictionJobsResponse = GetBatchPredictionJobsResponse' (Maybe [BatchPrediction]) (Maybe Text) Int
- newGetBatchPredictionJobsResponse :: Int -> GetBatchPredictionJobsResponse
- data GetDeleteEventsByEventTypeStatus = GetDeleteEventsByEventTypeStatus' Text
- newGetDeleteEventsByEventTypeStatus :: Text -> GetDeleteEventsByEventTypeStatus
- data GetDeleteEventsByEventTypeStatusResponse = GetDeleteEventsByEventTypeStatusResponse' (Maybe Text) (Maybe AsyncJobStatus) Int
- newGetDeleteEventsByEventTypeStatusResponse :: Int -> GetDeleteEventsByEventTypeStatusResponse
- data GetDetectorVersion = GetDetectorVersion' Text Text
- newGetDetectorVersion :: Text -> Text -> GetDetectorVersion
- data GetDetectorVersionResponse = GetDetectorVersionResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [ModelVersion]) (Maybe RuleExecutionMode) (Maybe [Rule]) (Maybe DetectorVersionStatus) Int
- newGetDetectorVersionResponse :: Int -> GetDetectorVersionResponse
- data GetDetectors = GetDetectors' (Maybe Text) (Maybe Natural) (Maybe Text)
- newGetDetectors :: GetDetectors
- data GetDetectorsResponse = GetDetectorsResponse' (Maybe [Detector]) (Maybe Text) Int
- newGetDetectorsResponse :: Int -> GetDetectorsResponse
- data GetEntityTypes = GetEntityTypes' (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetEntityTypes :: GetEntityTypes
- data GetEntityTypesResponse = GetEntityTypesResponse' (Maybe [EntityType]) (Maybe Text) Int
- newGetEntityTypesResponse :: Int -> GetEntityTypesResponse
- data GetEvent = GetEvent' Text Text
- newGetEvent :: Text -> Text -> GetEvent
- data GetEventResponse = GetEventResponse' (Maybe Event) Int
- newGetEventResponse :: Int -> GetEventResponse
- data GetEventPrediction = GetEventPrediction' (Maybe Text) (Maybe (Sensitive (HashMap Text ModelEndpointDataBlob))) Text Text Text [Sensitive Entity] Text (HashMap Text (Sensitive Text))
- newGetEventPrediction :: Text -> Text -> Text -> Text -> GetEventPrediction
- data GetEventPredictionResponse = GetEventPredictionResponse' (Maybe [ExternalModelOutputs]) (Maybe [ModelScores]) (Maybe [RuleResult]) Int
- newGetEventPredictionResponse :: Int -> GetEventPredictionResponse
- data GetEventPredictionMetadata = GetEventPredictionMetadata' Text Text Text Text Text
- newGetEventPredictionMetadata :: Text -> Text -> Text -> Text -> Text -> GetEventPredictionMetadata
- data GetEventPredictionMetadataResponse = GetEventPredictionMetadataResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [EvaluatedExternalModel]) (Maybe [EvaluatedModelVersion]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [EventVariableSummary]) (Maybe [Text]) (Maybe Text) (Maybe RuleExecutionMode) (Maybe [EvaluatedRule]) Int
- newGetEventPredictionMetadataResponse :: Int -> GetEventPredictionMetadataResponse
- data GetEventTypes = GetEventTypes' (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetEventTypes :: GetEventTypes
- data GetEventTypesResponse = GetEventTypesResponse' (Maybe [Sensitive EventType]) (Maybe Text) Int
- newGetEventTypesResponse :: Int -> GetEventTypesResponse
- data GetExternalModels = GetExternalModels' (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetExternalModels :: GetExternalModels
- data GetExternalModelsResponse = GetExternalModelsResponse' (Maybe [ExternalModel]) (Maybe Text) Int
- newGetExternalModelsResponse :: Int -> GetExternalModelsResponse
- data GetKMSEncryptionKey = GetKMSEncryptionKey' {
- newGetKMSEncryptionKey :: GetKMSEncryptionKey
- data GetKMSEncryptionKeyResponse = GetKMSEncryptionKeyResponse' (Maybe KMSKey) Int
- newGetKMSEncryptionKeyResponse :: Int -> GetKMSEncryptionKeyResponse
- data GetLabels = GetLabels' (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetLabels :: GetLabels
- data GetLabelsResponse = GetLabelsResponse' (Maybe [Label]) (Maybe Text) Int
- newGetLabelsResponse :: Int -> GetLabelsResponse
- data GetModelVersion = GetModelVersion' Text ModelTypeEnum Text
- newGetModelVersion :: Text -> ModelTypeEnum -> Text -> GetModelVersion
- data GetModelVersionResponse = GetModelVersionResponse' (Maybe Text) (Maybe ExternalEventsDetail) (Maybe IngestedEventsDetail) (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) (Maybe TrainingDataSchema) (Maybe TrainingDataSourceEnum) Int
- newGetModelVersionResponse :: Int -> GetModelVersionResponse
- data GetModels = GetModels' (Maybe Natural) (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text)
- newGetModels :: GetModels
- data GetModelsResponse = GetModelsResponse' (Maybe [Model]) (Maybe Text) Int
- newGetModelsResponse :: Int -> GetModelsResponse
- data GetOutcomes = GetOutcomes' (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetOutcomes :: GetOutcomes
- data GetOutcomesResponse = GetOutcomesResponse' (Maybe Text) (Maybe [Outcome]) Int
- newGetOutcomesResponse :: Int -> GetOutcomesResponse
- data GetRules = GetRules' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newGetRules :: Text -> GetRules
- data GetRulesResponse = GetRulesResponse' (Maybe Text) (Maybe [RuleDetail]) Int
- newGetRulesResponse :: Int -> GetRulesResponse
- data GetVariables = GetVariables' (Maybe Natural) (Maybe Text) (Maybe Text)
- newGetVariables :: GetVariables
- data GetVariablesResponse = GetVariablesResponse' (Maybe Text) (Maybe [Variable]) Int
- newGetVariablesResponse :: Int -> GetVariablesResponse
- data ListEventPredictions = ListEventPredictions' (Maybe FilterCondition) (Maybe FilterCondition) (Maybe FilterCondition) (Maybe FilterCondition) (Maybe Natural) (Maybe Text) (Maybe PredictionTimeRange)
- newListEventPredictions :: ListEventPredictions
- data ListEventPredictionsResponse = ListEventPredictionsResponse' (Maybe [EventPredictionSummary]) (Maybe Text) Int
- newListEventPredictionsResponse :: Int -> ListEventPredictionsResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutDetector = PutDetector' (Maybe Text) (Maybe [Tag]) Text Text
- newPutDetector :: Text -> Text -> PutDetector
- data PutDetectorResponse = PutDetectorResponse' Int
- newPutDetectorResponse :: Int -> PutDetectorResponse
- data PutEntityType = PutEntityType' (Maybe Text) (Maybe [Tag]) Text
- newPutEntityType :: Text -> PutEntityType
- data PutEntityTypeResponse = PutEntityTypeResponse' Int
- newPutEntityTypeResponse :: Int -> PutEntityTypeResponse
- data PutEventType = PutEventType' (Maybe Text) (Maybe EventIngestion) (Maybe [Text]) (Maybe [Tag]) Text (NonEmpty Text) (NonEmpty Text)
- newPutEventType :: Text -> NonEmpty Text -> NonEmpty Text -> PutEventType
- data PutEventTypeResponse = PutEventTypeResponse' Int
- newPutEventTypeResponse :: Int -> PutEventTypeResponse
- data PutExternalModel = PutExternalModel' (Maybe [Tag]) Text ModelSource Text ModelInputConfiguration ModelOutputConfiguration ModelEndpointStatus
- newPutExternalModel :: Text -> ModelSource -> Text -> ModelInputConfiguration -> ModelOutputConfiguration -> ModelEndpointStatus -> PutExternalModel
- data PutExternalModelResponse = PutExternalModelResponse' Int
- newPutExternalModelResponse :: Int -> PutExternalModelResponse
- data PutKMSEncryptionKey = PutKMSEncryptionKey' Text
- newPutKMSEncryptionKey :: Text -> PutKMSEncryptionKey
- data PutKMSEncryptionKeyResponse = PutKMSEncryptionKeyResponse' Int
- newPutKMSEncryptionKeyResponse :: Int -> PutKMSEncryptionKeyResponse
- data PutLabel = PutLabel' (Maybe Text) (Maybe [Tag]) Text
- newPutLabel :: Text -> PutLabel
- data PutLabelResponse = PutLabelResponse' Int
- newPutLabelResponse :: Int -> PutLabelResponse
- data PutOutcome = PutOutcome' (Maybe Text) (Maybe [Tag]) Text
- newPutOutcome :: Text -> PutOutcome
- data PutOutcomeResponse = PutOutcomeResponse' Int
- newPutOutcomeResponse :: Int -> PutOutcomeResponse
- data SendEvent = SendEvent' (Maybe Text) (Maybe Text) Text Text Text (HashMap Text (Sensitive Text)) [Sensitive Entity]
- newSendEvent :: Text -> Text -> Text -> SendEvent
- data SendEventResponse = SendEventResponse' Int
- newSendEventResponse :: Int -> SendEventResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDetectorVersion = UpdateDetectorVersion' (Maybe Text) (Maybe [ModelVersion]) (Maybe RuleExecutionMode) Text Text [Text] [Rule]
- newUpdateDetectorVersion :: Text -> Text -> UpdateDetectorVersion
- data UpdateDetectorVersionResponse = UpdateDetectorVersionResponse' Int
- newUpdateDetectorVersionResponse :: Int -> UpdateDetectorVersionResponse
- data UpdateDetectorVersionMetadata = UpdateDetectorVersionMetadata' Text Text Text
- newUpdateDetectorVersionMetadata :: Text -> Text -> Text -> UpdateDetectorVersionMetadata
- data UpdateDetectorVersionMetadataResponse = UpdateDetectorVersionMetadataResponse' Int
- newUpdateDetectorVersionMetadataResponse :: Int -> UpdateDetectorVersionMetadataResponse
- data UpdateDetectorVersionStatus = UpdateDetectorVersionStatus' Text Text DetectorVersionStatus
- newUpdateDetectorVersionStatus :: Text -> Text -> DetectorVersionStatus -> UpdateDetectorVersionStatus
- data UpdateDetectorVersionStatusResponse = UpdateDetectorVersionStatusResponse' Int
- newUpdateDetectorVersionStatusResponse :: Int -> UpdateDetectorVersionStatusResponse
- data UpdateEventLabel = UpdateEventLabel' Text Text Text Text
- newUpdateEventLabel :: Text -> Text -> Text -> Text -> UpdateEventLabel
- data UpdateEventLabelResponse = UpdateEventLabelResponse' Int
- newUpdateEventLabelResponse :: Int -> UpdateEventLabelResponse
- data UpdateModel = UpdateModel' (Maybe Text) Text ModelTypeEnum
- newUpdateModel :: Text -> ModelTypeEnum -> UpdateModel
- data UpdateModelResponse = UpdateModelResponse' Int
- newUpdateModelResponse :: Int -> UpdateModelResponse
- data UpdateModelVersion = UpdateModelVersion' (Maybe ExternalEventsDetail) (Maybe IngestedEventsDetail) (Maybe [Tag]) Text ModelTypeEnum Text
- newUpdateModelVersion :: Text -> ModelTypeEnum -> Text -> UpdateModelVersion
- data UpdateModelVersionResponse = UpdateModelVersionResponse' (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) Int
- newUpdateModelVersionResponse :: Int -> UpdateModelVersionResponse
- data UpdateModelVersionStatus = UpdateModelVersionStatus' Text ModelTypeEnum Text ModelVersionStatus
- newUpdateModelVersionStatus :: Text -> ModelTypeEnum -> Text -> ModelVersionStatus -> UpdateModelVersionStatus
- data UpdateModelVersionStatusResponse = UpdateModelVersionStatusResponse' Int
- newUpdateModelVersionStatusResponse :: Int -> UpdateModelVersionStatusResponse
- data UpdateRuleMetadata = UpdateRuleMetadata' Rule Text
- newUpdateRuleMetadata :: Rule -> Text -> UpdateRuleMetadata
- data UpdateRuleMetadataResponse = UpdateRuleMetadataResponse' Int
- newUpdateRuleMetadataResponse :: Int -> UpdateRuleMetadataResponse
- data UpdateRuleVersion = UpdateRuleVersion' (Maybe Text) (Maybe [Tag]) Rule (Sensitive Text) Language (NonEmpty Text)
- newUpdateRuleVersion :: Rule -> Text -> Language -> NonEmpty Text -> UpdateRuleVersion
- data UpdateRuleVersionResponse = UpdateRuleVersionResponse' (Maybe Rule) Int
- newUpdateRuleVersionResponse :: Int -> UpdateRuleVersionResponse
- data UpdateVariable = UpdateVariable' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateVariable :: Text -> UpdateVariable
- data UpdateVariableResponse = UpdateVariableResponse' Int
- newUpdateVariableResponse :: Int -> UpdateVariableResponse
- newtype AsyncJobStatus where
- AsyncJobStatus' { }
- pattern AsyncJobStatus_CANCELED :: AsyncJobStatus
- pattern AsyncJobStatus_CANCEL_IN_PROGRESS :: AsyncJobStatus
- pattern AsyncJobStatus_COMPLETE :: AsyncJobStatus
- pattern AsyncJobStatus_FAILED :: AsyncJobStatus
- pattern AsyncJobStatus_IN_PROGRESS :: AsyncJobStatus
- pattern AsyncJobStatus_IN_PROGRESS_INITIALIZING :: AsyncJobStatus
- newtype DataSource where
- DataSource' { }
- pattern DataSource_EVENT :: DataSource
- pattern DataSource_EXTERNAL_MODEL_SCORE :: DataSource
- pattern DataSource_MODEL_SCORE :: DataSource
- newtype DataType where
- DataType' {
- fromDataType :: Text
- pattern DataType_BOOLEAN :: DataType
- pattern DataType_FLOAT :: DataType
- pattern DataType_INTEGER :: DataType
- pattern DataType_STRING :: DataType
- DataType' {
- newtype DetectorVersionStatus where
- newtype EventIngestion where
- EventIngestion' { }
- pattern EventIngestion_DISABLED :: EventIngestion
- pattern EventIngestion_ENABLED :: EventIngestion
- newtype Language where
- Language' {
- fromLanguage :: Text
- pattern Language_DETECTORPL :: Language
- Language' {
- newtype ModelEndpointStatus where
- newtype ModelInputDataFormat where
- newtype ModelOutputDataFormat where
- newtype ModelSource where
- ModelSource' { }
- pattern ModelSource_SAGEMAKER :: ModelSource
- newtype ModelTypeEnum where
- newtype ModelVersionStatus where
- newtype RuleExecutionMode where
- newtype TrainingDataSourceEnum where
- newtype UnlabeledEventsTreatment where
- data ATIMetricDataPoint = ATIMetricDataPoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newATIMetricDataPoint :: ATIMetricDataPoint
- data ATIModelPerformance = ATIModelPerformance' (Maybe Double)
- newATIModelPerformance :: ATIModelPerformance
- data ATITrainingMetricsValue = ATITrainingMetricsValue' (Maybe [ATIMetricDataPoint]) (Maybe ATIModelPerformance)
- newATITrainingMetricsValue :: ATITrainingMetricsValue
- data AggregatedLogOddsMetric = AggregatedLogOddsMetric' [Text] Double
- newAggregatedLogOddsMetric :: Double -> AggregatedLogOddsMetric
- data AggregatedVariablesImpactExplanation = AggregatedVariablesImpactExplanation' (Maybe [Text]) (Maybe Double) (Maybe Text)
- newAggregatedVariablesImpactExplanation :: AggregatedVariablesImpactExplanation
- data AggregatedVariablesImportanceMetrics = AggregatedVariablesImportanceMetrics' (Maybe [AggregatedLogOddsMetric])
- newAggregatedVariablesImportanceMetrics :: AggregatedVariablesImportanceMetrics
- data BatchCreateVariableError = BatchCreateVariableError' (Maybe Int) (Maybe Text) (Maybe Text)
- newBatchCreateVariableError :: BatchCreateVariableError
- data BatchGetVariableError = BatchGetVariableError' (Maybe Int) (Maybe Text) (Maybe Text)
- newBatchGetVariableError :: BatchGetVariableError
- data BatchImport = BatchImport' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe AsyncJobStatus) (Maybe Int)
- newBatchImport :: BatchImport
- data BatchPrediction = BatchPrediction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe AsyncJobStatus) (Maybe Int)
- newBatchPrediction :: BatchPrediction
- data DataValidationMetrics = DataValidationMetrics' (Maybe [FieldValidationMessage]) (Maybe [FileValidationMessage])
- newDataValidationMetrics :: DataValidationMetrics
- data Detector = Detector' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDetector :: Detector
- data DetectorVersionSummary = DetectorVersionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DetectorVersionStatus)
- newDetectorVersionSummary :: DetectorVersionSummary
- data Entity = Entity' Text Text
- newEntity :: Text -> Text -> Entity
- data EntityType = EntityType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEntityType :: EntityType
- data EvaluatedExternalModel = EvaluatedExternalModel' (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe Bool)
- newEvaluatedExternalModel :: EvaluatedExternalModel
- data EvaluatedModelVersion = EvaluatedModelVersion' (Maybe [ModelVersionEvaluation]) (Maybe Text) (Maybe Text) (Maybe Text)
- newEvaluatedModelVersion :: EvaluatedModelVersion
- data EvaluatedRule = EvaluatedRule' (Maybe Bool) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newEvaluatedRule :: EvaluatedRule
- data Event = Event' (Maybe Text) (Maybe [Sensitive Entity]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text)
- newEvent :: Event
- data EventPredictionSummary = EventPredictionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEventPredictionSummary :: EventPredictionSummary
- data EventType = EventType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe EventIngestion) (Maybe [Text]) (Maybe IngestedEventStatistics) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newEventType :: EventType
- data EventVariableSummary = EventVariableSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newEventVariableSummary :: EventVariableSummary
- data ExternalEventsDetail = ExternalEventsDetail' Text Text
- newExternalEventsDetail :: Text -> Text -> ExternalEventsDetail
- data ExternalModel = ExternalModel' (Maybe Text) (Maybe Text) (Maybe ModelInputConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ModelEndpointStatus) (Maybe ModelSource) (Maybe ModelOutputConfiguration)
- newExternalModel :: ExternalModel
- data ExternalModelOutputs = ExternalModelOutputs' (Maybe ExternalModelSummary) (Maybe (HashMap Text Text))
- newExternalModelOutputs :: ExternalModelOutputs
- data ExternalModelSummary = ExternalModelSummary' (Maybe Text) (Maybe ModelSource)
- newExternalModelSummary :: ExternalModelSummary
- data FieldValidationMessage = FieldValidationMessage' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newFieldValidationMessage :: FieldValidationMessage
- data FileValidationMessage = FileValidationMessage' (Maybe Text) (Maybe Text) (Maybe Text)
- newFileValidationMessage :: FileValidationMessage
- data FilterCondition = FilterCondition' (Maybe Text)
- newFilterCondition :: FilterCondition
- data IngestedEventStatistics = IngestedEventStatistics' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer)
- newIngestedEventStatistics :: IngestedEventStatistics
- data IngestedEventsDetail = IngestedEventsDetail' IngestedEventsTimeWindow
- newIngestedEventsDetail :: IngestedEventsTimeWindow -> IngestedEventsDetail
- data IngestedEventsTimeWindow = IngestedEventsTimeWindow' Text Text
- newIngestedEventsTimeWindow :: Text -> Text -> IngestedEventsTimeWindow
- data KMSKey = KMSKey' (Maybe Text)
- newKMSKey :: KMSKey
- data Label = Label' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newLabel :: Label
- data LabelSchema = LabelSchema' (Maybe (HashMap Text [Text])) (Maybe UnlabeledEventsTreatment)
- newLabelSchema :: LabelSchema
- data LogOddsMetric = LogOddsMetric' Text Text Double
- newLogOddsMetric :: Text -> Text -> Double -> LogOddsMetric
- data MetricDataPoint = MetricDataPoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newMetricDataPoint :: MetricDataPoint
- data Model = Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ModelTypeEnum)
- newModel :: Model
- data ModelEndpointDataBlob = ModelEndpointDataBlob' (Maybe Base64) (Maybe Text)
- newModelEndpointDataBlob :: ModelEndpointDataBlob
- data ModelInputConfiguration = ModelInputConfiguration' (Maybe Text) (Maybe Text) (Maybe ModelInputDataFormat) (Maybe Text) Bool
- newModelInputConfiguration :: Bool -> ModelInputConfiguration
- data ModelOutputConfiguration = ModelOutputConfiguration' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) ModelOutputDataFormat
- newModelOutputConfiguration :: ModelOutputDataFormat -> ModelOutputConfiguration
- data ModelScores = ModelScores' (Maybe ModelVersion) (Maybe (HashMap Text Double))
- newModelScores :: ModelScores
- data ModelVersion = ModelVersion' (Maybe Text) Text ModelTypeEnum Text
- newModelVersion :: Text -> ModelTypeEnum -> Text -> ModelVersion
- data ModelVersionDetail = ModelVersionDetail' (Maybe Text) (Maybe Text) (Maybe ExternalEventsDetail) (Maybe IngestedEventsDetail) (Maybe Text) (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) (Maybe TrainingDataSchema) (Maybe TrainingDataSourceEnum) (Maybe TrainingResult) (Maybe TrainingResultV2)
- newModelVersionDetail :: ModelVersionDetail
- data ModelVersionEvaluation = ModelVersionEvaluation' (Maybe Text) (Maybe Text) (Maybe PredictionExplanations)
- newModelVersionEvaluation :: ModelVersionEvaluation
- data OFIMetricDataPoint = OFIMetricDataPoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newOFIMetricDataPoint :: OFIMetricDataPoint
- data OFIModelPerformance = OFIModelPerformance' (Maybe Double)
- newOFIModelPerformance :: OFIModelPerformance
- data OFITrainingMetricsValue = OFITrainingMetricsValue' (Maybe [OFIMetricDataPoint]) (Maybe OFIModelPerformance)
- newOFITrainingMetricsValue :: OFITrainingMetricsValue
- data Outcome = Outcome' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newOutcome :: Outcome
- data PredictionExplanations = PredictionExplanations' (Maybe [AggregatedVariablesImpactExplanation]) (Maybe [VariableImpactExplanation])
- newPredictionExplanations :: PredictionExplanations
- data PredictionTimeRange = PredictionTimeRange' Text Text
- newPredictionTimeRange :: Text -> Text -> PredictionTimeRange
- data Rule = Rule' Text Text Text
- newRule :: Text -> Text -> Text -> Rule
- data RuleDetail = RuleDetail' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Language) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newRuleDetail :: RuleDetail
- data RuleResult = RuleResult' (Maybe [Text]) (Maybe Text)
- newRuleResult :: RuleResult
- data TFIMetricDataPoint = TFIMetricDataPoint' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newTFIMetricDataPoint :: TFIMetricDataPoint
- data TFIModelPerformance = TFIModelPerformance' (Maybe Double)
- newTFIModelPerformance :: TFIModelPerformance
- data TFITrainingMetricsValue = TFITrainingMetricsValue' (Maybe [TFIMetricDataPoint]) (Maybe TFIModelPerformance)
- newTFITrainingMetricsValue :: TFITrainingMetricsValue
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TrainingDataSchema = TrainingDataSchema' (Maybe LabelSchema) [Text]
- newTrainingDataSchema :: TrainingDataSchema
- data TrainingMetrics = TrainingMetrics' (Maybe Double) (Maybe [MetricDataPoint])
- newTrainingMetrics :: TrainingMetrics
- data TrainingMetricsV2 = TrainingMetricsV2' (Maybe ATITrainingMetricsValue) (Maybe OFITrainingMetricsValue) (Maybe TFITrainingMetricsValue)
- newTrainingMetricsV2 :: TrainingMetricsV2
- data TrainingResult = TrainingResult' (Maybe DataValidationMetrics) (Maybe TrainingMetrics) (Maybe VariableImportanceMetrics)
- newTrainingResult :: TrainingResult
- data TrainingResultV2 = TrainingResultV2' (Maybe AggregatedVariablesImportanceMetrics) (Maybe DataValidationMetrics) (Maybe TrainingMetricsV2) (Maybe VariableImportanceMetrics)
- newTrainingResultV2 :: TrainingResultV2
- data Variable = Variable' (Maybe Text) (Maybe Text) (Maybe DataSource) (Maybe DataType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newVariable :: Variable
- data VariableEntry = VariableEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newVariableEntry :: VariableEntry
- data VariableImpactExplanation = VariableImpactExplanation' (Maybe Text) (Maybe Double) (Maybe Text)
- newVariableImpactExplanation :: VariableImpactExplanation
- data VariableImportanceMetrics = VariableImportanceMetrics' (Maybe [LogOddsMetric])
- newVariableImportanceMetrics :: VariableImportanceMetrics
Service Configuration
defaultService :: Service Source #
API version 2019-11-15 of the Amazon Fraud Detector SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by FraudDetector.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
An exception indicating Amazon Fraud Detector does not have the needed
permissions. This can occur if you submit a request, such as
PutExternalModel, that specifies a role that is not in your account.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
An exception indicating there was a conflict during a delete operation.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An exception indicating an internal server error.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
An exception indicating the specified resource was not found.
ResourceUnavailableException
_ResourceUnavailableException :: AsError a => Fold a ServiceError Source #
An exception indicating that the attached customer-owned (external) model threw an exception when Amazon Fraud Detector invoked the model.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
An exception indicating a throttling error.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
An exception indicating a specified value is not allowed.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchCreateVariable
data BatchCreateVariable Source #
See: newBatchCreateVariable smart constructor.
Constructors
| BatchCreateVariable' (Maybe [Tag]) (NonEmpty VariableEntry) |
Instances
newBatchCreateVariable Source #
Create a value of BatchCreateVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:BatchCreateVariable', batchCreateVariable_tags - A collection of key and value pairs.
$sel:variableEntries:BatchCreateVariable', batchCreateVariable_variableEntries - The list of variables for the batch create variable request.
data BatchCreateVariableResponse Source #
See: newBatchCreateVariableResponse smart constructor.
Constructors
| BatchCreateVariableResponse' (Maybe [BatchCreateVariableError]) Int |
Instances
newBatchCreateVariableResponse Source #
Create a value of BatchCreateVariableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchCreateVariableResponse', batchCreateVariableResponse_errors - Provides the errors for the BatchCreateVariable request.
$sel:httpStatus:BatchCreateVariableResponse', batchCreateVariableResponse_httpStatus - The response's http status code.
BatchGetVariable
data BatchGetVariable Source #
See: newBatchGetVariable smart constructor.
Constructors
| BatchGetVariable' (NonEmpty Text) |
Instances
Arguments
| :: NonEmpty Text | |
| -> BatchGetVariable |
Create a value of BatchGetVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:names:BatchGetVariable', batchGetVariable_names - The list of variable names to get.
data BatchGetVariableResponse Source #
See: newBatchGetVariableResponse smart constructor.
Constructors
| BatchGetVariableResponse' (Maybe [BatchGetVariableError]) (Maybe [Variable]) Int |
Instances
newBatchGetVariableResponse Source #
Create a value of BatchGetVariableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchGetVariableResponse', batchGetVariableResponse_errors - The errors from the request.
$sel:variables:BatchGetVariableResponse', batchGetVariableResponse_variables - The returned variables.
$sel:httpStatus:BatchGetVariableResponse', batchGetVariableResponse_httpStatus - The response's http status code.
CancelBatchImportJob
data CancelBatchImportJob Source #
See: newCancelBatchImportJob smart constructor.
Constructors
| CancelBatchImportJob' Text |
Instances
newCancelBatchImportJob Source #
Arguments
| :: Text | |
| -> CancelBatchImportJob |
Create a value of CancelBatchImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelBatchImportJob, cancelBatchImportJob_jobId - 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.
data CancelBatchImportJobResponse Source #
See: newCancelBatchImportJobResponse smart constructor.
Constructors
| CancelBatchImportJobResponse' Int |
Instances
newCancelBatchImportJobResponse Source #
Create a value of CancelBatchImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelBatchImportJobResponse', cancelBatchImportJobResponse_httpStatus - The response's http status code.
CancelBatchPredictionJob
data CancelBatchPredictionJob Source #
See: newCancelBatchPredictionJob smart constructor.
Constructors
| CancelBatchPredictionJob' Text |
Instances
newCancelBatchPredictionJob Source #
Arguments
| :: Text | |
| -> CancelBatchPredictionJob |
Create a value of CancelBatchPredictionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelBatchPredictionJob, cancelBatchPredictionJob_jobId - The ID of the batch prediction job to cancel.
data CancelBatchPredictionJobResponse Source #
See: newCancelBatchPredictionJobResponse smart constructor.
Constructors
| CancelBatchPredictionJobResponse' Int |
Instances
newCancelBatchPredictionJobResponse Source #
Create a value of CancelBatchPredictionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelBatchPredictionJobResponse', cancelBatchPredictionJobResponse_httpStatus - The response's http status code.
CreateBatchImportJob
data CreateBatchImportJob Source #
See: newCreateBatchImportJob smart constructor.
Instances
newCreateBatchImportJob Source #
Create a value of CreateBatchImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateBatchImportJob', createBatchImportJob_tags - A collection of key-value pairs associated with this request.
CreateBatchImportJob, createBatchImportJob_jobId - The ID of the batch import job. The ID cannot be of a past job, unless
the job exists in CREATE_FAILED state.
CreateBatchImportJob, createBatchImportJob_inputPath - The URI that points to the Amazon S3 location of your data file.
CreateBatchImportJob, createBatchImportJob_outputPath - The URI that points to the Amazon S3 location for storing your results.
CreateBatchImportJob, createBatchImportJob_eventTypeName - The name of the event type.
CreateBatchImportJob, createBatchImportJob_iamRoleArn - 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.
data CreateBatchImportJobResponse Source #
See: newCreateBatchImportJobResponse smart constructor.
Constructors
| CreateBatchImportJobResponse' Int |
Instances
newCreateBatchImportJobResponse Source #
Create a value of CreateBatchImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBatchImportJobResponse', createBatchImportJobResponse_httpStatus - The response's http status code.
CreateBatchPredictionJob
data CreateBatchPredictionJob Source #
See: newCreateBatchPredictionJob smart constructor.
Instances
newCreateBatchPredictionJob Source #
Create a value of CreateBatchPredictionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBatchPredictionJob, createBatchPredictionJob_detectorVersion - The detector version.
$sel:tags:CreateBatchPredictionJob', createBatchPredictionJob_tags - A collection of key and value pairs.
CreateBatchPredictionJob, createBatchPredictionJob_jobId - The ID of the batch prediction job.
CreateBatchPredictionJob, createBatchPredictionJob_inputPath - The Amazon S3 location of your training file.
CreateBatchPredictionJob, createBatchPredictionJob_outputPath - The Amazon S3 location of your output file.
CreateBatchPredictionJob, createBatchPredictionJob_eventTypeName - The name of the event type.
CreateBatchPredictionJob, createBatchPredictionJob_detectorName - The name of the detector.
CreateBatchPredictionJob, createBatchPredictionJob_iamRoleArn - 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.
data CreateBatchPredictionJobResponse Source #
See: newCreateBatchPredictionJobResponse smart constructor.
Constructors
| CreateBatchPredictionJobResponse' Int |
Instances
newCreateBatchPredictionJobResponse Source #
Create a value of CreateBatchPredictionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBatchPredictionJobResponse', createBatchPredictionJobResponse_httpStatus - The response's http status code.
CreateDetectorVersion
data CreateDetectorVersion Source #
See: newCreateDetectorVersion smart constructor.
Constructors
| CreateDetectorVersion' (Maybe Text) (Maybe [Text]) (Maybe [ModelVersion]) (Maybe RuleExecutionMode) (Maybe [Tag]) Text [Rule] |
Instances
newCreateDetectorVersion Source #
Arguments
| :: Text | |
| -> CreateDetectorVersion |
Create a value of CreateDetectorVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDetectorVersion, createDetectorVersion_description - The description of the detector version.
$sel:externalModelEndpoints:CreateDetectorVersion', createDetectorVersion_externalModelEndpoints - The Amazon Sagemaker model endpoints to include in the detector version.
$sel:modelVersions:CreateDetectorVersion', createDetectorVersion_modelVersions - The model versions to include in the detector version.
$sel:ruleExecutionMode:CreateDetectorVersion', createDetectorVersion_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.
$sel:tags:CreateDetectorVersion', createDetectorVersion_tags - A collection of key and value pairs.
CreateDetectorVersion, createDetectorVersion_detectorId - The ID of the detector under which you want to create a new version.
$sel:rules:CreateDetectorVersion', createDetectorVersion_rules - The rules to include in the detector version.
data CreateDetectorVersionResponse Source #
See: newCreateDetectorVersionResponse smart constructor.
Constructors
| CreateDetectorVersionResponse' (Maybe Text) (Maybe Text) (Maybe DetectorVersionStatus) Int |
Instances
newCreateDetectorVersionResponse Source #
Create a value of CreateDetectorVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDetectorVersion, createDetectorVersionResponse_detectorId - The ID for the created version's parent detector.
CreateDetectorVersionResponse, createDetectorVersionResponse_detectorVersionId - The ID for the created detector.
CreateDetectorVersionResponse, createDetectorVersionResponse_status - The status of the detector version.
$sel:httpStatus:CreateDetectorVersionResponse', createDetectorVersionResponse_httpStatus - The response's http status code.
CreateModel
data CreateModel Source #
See: newCreateModel smart constructor.
Constructors
| CreateModel' (Maybe Text) (Maybe [Tag]) Text ModelTypeEnum Text |
Instances
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> Text | |
| -> CreateModel |
Create a value of CreateModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateModel, createModel_description - The model description.
$sel:tags:CreateModel', createModel_tags - A collection of key and value pairs.
CreateModel, createModel_modelId - The model ID.
CreateModel, createModel_modelType - The model type.
CreateModel, createModel_eventTypeName - The name of the event type.
data CreateModelResponse Source #
See: newCreateModelResponse smart constructor.
Constructors
| CreateModelResponse' Int |
Instances
newCreateModelResponse Source #
Arguments
| :: Int | |
| -> CreateModelResponse |
Create a value of CreateModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateModelResponse', createModelResponse_httpStatus - The response's http status code.
CreateModelVersion
data CreateModelVersion Source #
See: newCreateModelVersion smart constructor.
Constructors
| CreateModelVersion' (Maybe ExternalEventsDetail) (Maybe IngestedEventsDetail) (Maybe [Tag]) Text ModelTypeEnum TrainingDataSourceEnum TrainingDataSchema |
Instances
newCreateModelVersion Source #
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> TrainingDataSourceEnum | |
| -> TrainingDataSchema | |
| -> CreateModelVersion |
Create a value of CreateModelVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateModelVersion, createModelVersion_externalEventsDetail - Details of the external events data used for model version training.
Required if trainingDataSource is EXTERNAL_EVENTS.
CreateModelVersion, createModelVersion_ingestedEventsDetail - Details of the ingested events data used for model version training.
Required if trainingDataSource is INGESTED_EVENTS.
$sel:tags:CreateModelVersion', createModelVersion_tags - A collection of key and value pairs.
CreateModelVersion, createModelVersion_modelId - The model ID.
CreateModelVersion, createModelVersion_modelType - The model type.
CreateModelVersion, createModelVersion_trainingDataSource - The training data source location in Amazon S3.
CreateModelVersion, createModelVersion_trainingDataSchema - The training data schema.
data CreateModelVersionResponse Source #
See: newCreateModelVersionResponse smart constructor.
Constructors
| CreateModelVersionResponse' (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) Int |
Instances
newCreateModelVersionResponse Source #
Create a value of CreateModelVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateModelVersion, createModelVersionResponse_modelId - The model ID.
CreateModelVersion, createModelVersionResponse_modelType - The model type.
CreateModelVersionResponse, createModelVersionResponse_modelVersionNumber - The model version number of the model version created.
CreateModelVersionResponse, createModelVersionResponse_status - The model version status.
$sel:httpStatus:CreateModelVersionResponse', createModelVersionResponse_httpStatus - The response's http status code.
CreateRule
data CreateRule Source #
See: newCreateRule smart constructor.
Constructors
| CreateRule' (Maybe Text) (Maybe [Tag]) Text Text (Sensitive Text) Language (NonEmpty Text) |
Instances
Create a value of CreateRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRule, createRule_description - The rule description.
$sel:tags:CreateRule', createRule_tags - A collection of key and value pairs.
CreateRule, createRule_ruleId - The rule ID.
CreateRule, createRule_detectorId - The detector ID for the rule's parent detector.
CreateRule, createRule_expression - The rule expression.
CreateRule, createRule_language - The language of the rule.
CreateRule, createRule_outcomes - The outcome or outcomes returned when the rule expression matches.
data CreateRuleResponse Source #
See: newCreateRuleResponse smart constructor.
Constructors
| CreateRuleResponse' (Maybe Rule) Int |
Instances
newCreateRuleResponse Source #
Arguments
| :: Int | |
| -> CreateRuleResponse |
Create a value of CreateRuleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rule:CreateRuleResponse', createRuleResponse_rule - The created rule.
$sel:httpStatus:CreateRuleResponse', createRuleResponse_httpStatus - The response's http status code.
CreateVariable
data CreateVariable Source #
See: newCreateVariable smart constructor.
Instances
Arguments
| :: Text | |
| -> DataType | |
| -> DataSource | |
| -> Text | |
| -> CreateVariable |
Create a value of CreateVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateVariable, createVariable_description - The description.
$sel:tags:CreateVariable', createVariable_tags - A collection of key and value pairs.
CreateVariable, createVariable_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
CreateVariable, createVariable_name - The name of the variable.
CreateVariable, createVariable_dataType - The data type.
CreateVariable, createVariable_dataSource - The source of the data.
CreateVariable, createVariable_defaultValue - The default value for the variable when no value is received.
data CreateVariableResponse Source #
See: newCreateVariableResponse smart constructor.
Constructors
| CreateVariableResponse' Int |
Instances
newCreateVariableResponse Source #
Create a value of CreateVariableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateVariableResponse', createVariableResponse_httpStatus - The response's http status code.
DeleteBatchImportJob
data DeleteBatchImportJob Source #
See: newDeleteBatchImportJob smart constructor.
Constructors
| DeleteBatchImportJob' Text |
Instances
newDeleteBatchImportJob Source #
Arguments
| :: Text | |
| -> DeleteBatchImportJob |
Create a value of DeleteBatchImportJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBatchImportJob, deleteBatchImportJob_jobId - The ID of the batch import job to delete.
data DeleteBatchImportJobResponse Source #
See: newDeleteBatchImportJobResponse smart constructor.
Constructors
| DeleteBatchImportJobResponse' Int |
Instances
newDeleteBatchImportJobResponse Source #
Create a value of DeleteBatchImportJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBatchImportJobResponse', deleteBatchImportJobResponse_httpStatus - The response's http status code.
DeleteBatchPredictionJob
data DeleteBatchPredictionJob Source #
See: newDeleteBatchPredictionJob smart constructor.
Constructors
| DeleteBatchPredictionJob' Text |
Instances
newDeleteBatchPredictionJob Source #
Arguments
| :: Text | |
| -> DeleteBatchPredictionJob |
Create a value of DeleteBatchPredictionJob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBatchPredictionJob, deleteBatchPredictionJob_jobId - The ID of the batch prediction job to delete.
data DeleteBatchPredictionJobResponse Source #
See: newDeleteBatchPredictionJobResponse smart constructor.
Constructors
| DeleteBatchPredictionJobResponse' Int |
Instances
newDeleteBatchPredictionJobResponse Source #
Create a value of DeleteBatchPredictionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBatchPredictionJobResponse', deleteBatchPredictionJobResponse_httpStatus - The response's http status code.
DeleteDetector
data DeleteDetector Source #
See: newDeleteDetector smart constructor.
Constructors
| DeleteDetector' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDetector |
Create a value of DeleteDetector with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDetector, deleteDetector_detectorId - The ID of the detector to delete.
data DeleteDetectorResponse Source #
See: newDeleteDetectorResponse smart constructor.
Constructors
| DeleteDetectorResponse' Int |
Instances
newDeleteDetectorResponse Source #
Create a value of DeleteDetectorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDetectorResponse', deleteDetectorResponse_httpStatus - The response's http status code.
DeleteDetectorVersion
data DeleteDetectorVersion Source #
See: newDeleteDetectorVersion smart constructor.
Constructors
| DeleteDetectorVersion' Text Text |
Instances
newDeleteDetectorVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteDetectorVersion |
Create a value of DeleteDetectorVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDetectorVersion, deleteDetectorVersion_detectorId - The ID of the parent detector for the detector version to delete.
DeleteDetectorVersion, deleteDetectorVersion_detectorVersionId - The ID of the detector version to delete.
data DeleteDetectorVersionResponse Source #
See: newDeleteDetectorVersionResponse smart constructor.
Constructors
| DeleteDetectorVersionResponse' Int |
Instances
newDeleteDetectorVersionResponse Source #
Create a value of DeleteDetectorVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDetectorVersionResponse', deleteDetectorVersionResponse_httpStatus - The response's http status code.
DeleteEntityType
data DeleteEntityType Source #
See: newDeleteEntityType smart constructor.
Constructors
| DeleteEntityType' Text |
Instances
Arguments
| :: Text | |
| -> DeleteEntityType |
Create a value of DeleteEntityType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEntityType, deleteEntityType_name - The name of the entity type to delete.
data DeleteEntityTypeResponse Source #
See: newDeleteEntityTypeResponse smart constructor.
Constructors
| DeleteEntityTypeResponse' Int |
Instances
newDeleteEntityTypeResponse Source #
Create a value of DeleteEntityTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEntityTypeResponse', deleteEntityTypeResponse_httpStatus - The response's http status code.
DeleteEvent
data DeleteEvent Source #
See: newDeleteEvent smart constructor.
Constructors
| DeleteEvent' (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteEvent |
Create a value of DeleteEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteAuditHistory:DeleteEvent', deleteEvent_deleteAuditHistory - Specifies whether or not to delete any predictions associated with the
event.
DeleteEvent, deleteEvent_eventId - The ID of the event to delete.
DeleteEvent, deleteEvent_eventTypeName - The name of the event type.
data DeleteEventResponse Source #
See: newDeleteEventResponse smart constructor.
Constructors
| DeleteEventResponse' Int |
Instances
newDeleteEventResponse Source #
Arguments
| :: Int | |
| -> DeleteEventResponse |
Create a value of DeleteEventResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEventResponse', deleteEventResponse_httpStatus - The response's http status code.
DeleteEventType
data DeleteEventType Source #
See: newDeleteEventType smart constructor.
Constructors
| DeleteEventType' Text |
Instances
Arguments
| :: Text | |
| -> DeleteEventType |
Create a value of DeleteEventType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEventType, deleteEventType_name - The name of the event type to delete.
data DeleteEventTypeResponse Source #
See: newDeleteEventTypeResponse smart constructor.
Constructors
| DeleteEventTypeResponse' Int |
Instances
newDeleteEventTypeResponse Source #
Create a value of DeleteEventTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEventTypeResponse', deleteEventTypeResponse_httpStatus - The response's http status code.
DeleteEventsByEventType
data DeleteEventsByEventType Source #
See: newDeleteEventsByEventType smart constructor.
Constructors
| DeleteEventsByEventType' Text |
Instances
newDeleteEventsByEventType Source #
Arguments
| :: Text | |
| -> DeleteEventsByEventType |
Create a value of DeleteEventsByEventType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEventsByEventType, deleteEventsByEventType_eventTypeName - The name of the event type.
data DeleteEventsByEventTypeResponse Source #
See: newDeleteEventsByEventTypeResponse smart constructor.
Instances
newDeleteEventsByEventTypeResponse Source #
Create a value of DeleteEventsByEventTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEventsByEventType, deleteEventsByEventTypeResponse_eventTypeName - Name of event type for which to delete the events.
$sel:eventsDeletionStatus:DeleteEventsByEventTypeResponse', deleteEventsByEventTypeResponse_eventsDeletionStatus - The status of the delete request.
$sel:httpStatus:DeleteEventsByEventTypeResponse', deleteEventsByEventTypeResponse_httpStatus - The response's http status code.
DeleteExternalModel
data DeleteExternalModel Source #
See: newDeleteExternalModel smart constructor.
Constructors
| DeleteExternalModel' Text |
Instances
newDeleteExternalModel Source #
Arguments
| :: Text | |
| -> DeleteExternalModel |
Create a value of DeleteExternalModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteExternalModel, deleteExternalModel_modelEndpoint - The endpoint of the Amazon Sagemaker model to delete.
data DeleteExternalModelResponse Source #
See: newDeleteExternalModelResponse smart constructor.
Constructors
| DeleteExternalModelResponse' Int |
Instances
newDeleteExternalModelResponse Source #
Create a value of DeleteExternalModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteExternalModelResponse', deleteExternalModelResponse_httpStatus - The response's http status code.
DeleteLabel
data DeleteLabel Source #
See: newDeleteLabel smart constructor.
Constructors
| DeleteLabel' Text |
Instances
Arguments
| :: Text | |
| -> DeleteLabel |
Create a value of DeleteLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteLabel, deleteLabel_name - The name of the label to delete.
data DeleteLabelResponse Source #
See: newDeleteLabelResponse smart constructor.
Constructors
| DeleteLabelResponse' Int |
Instances
newDeleteLabelResponse Source #
Arguments
| :: Int | |
| -> DeleteLabelResponse |
Create a value of DeleteLabelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteLabelResponse', deleteLabelResponse_httpStatus - The response's http status code.
DeleteModel
data DeleteModel Source #
See: newDeleteModel smart constructor.
Constructors
| DeleteModel' Text ModelTypeEnum |
Instances
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> DeleteModel |
Create a value of DeleteModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteModel, deleteModel_modelId - The model ID of the model to delete.
DeleteModel, deleteModel_modelType - The model type of the model to delete.
data DeleteModelResponse Source #
See: newDeleteModelResponse smart constructor.
Constructors
| DeleteModelResponse' Int |
Instances
newDeleteModelResponse Source #
Arguments
| :: Int | |
| -> DeleteModelResponse |
Create a value of DeleteModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteModelResponse', deleteModelResponse_httpStatus - The response's http status code.
DeleteModelVersion
data DeleteModelVersion Source #
See: newDeleteModelVersion smart constructor.
Constructors
| DeleteModelVersion' Text ModelTypeEnum Text |
Instances
newDeleteModelVersion Source #
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> Text | |
| -> DeleteModelVersion |
Create a value of DeleteModelVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteModelVersion, deleteModelVersion_modelId - The model ID of the model version to delete.
DeleteModelVersion, deleteModelVersion_modelType - The model type of the model version to delete.
DeleteModelVersion, deleteModelVersion_modelVersionNumber - The model version number of the model version to delete.
data DeleteModelVersionResponse Source #
See: newDeleteModelVersionResponse smart constructor.
Constructors
| DeleteModelVersionResponse' Int |
Instances
newDeleteModelVersionResponse Source #
Create a value of DeleteModelVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteModelVersionResponse', deleteModelVersionResponse_httpStatus - The response's http status code.
DeleteOutcome
data DeleteOutcome Source #
See: newDeleteOutcome smart constructor.
Constructors
| DeleteOutcome' Text |
Instances
Arguments
| :: Text | |
| -> DeleteOutcome |
Create a value of DeleteOutcome with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteOutcome, deleteOutcome_name - The name of the outcome to delete.
data DeleteOutcomeResponse Source #
See: newDeleteOutcomeResponse smart constructor.
Constructors
| DeleteOutcomeResponse' Int |
Instances
newDeleteOutcomeResponse Source #
Create a value of DeleteOutcomeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteOutcomeResponse', deleteOutcomeResponse_httpStatus - The response's http status code.
DeleteRule
data DeleteRule Source #
See: newDeleteRule smart constructor.
Constructors
| DeleteRule' Rule |
Instances
Arguments
| :: Rule | |
| -> DeleteRule |
Create a value of DeleteRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rule:DeleteRule', deleteRule_rule - Undocumented member.
data DeleteRuleResponse Source #
See: newDeleteRuleResponse smart constructor.
Constructors
| DeleteRuleResponse' Int |
Instances
newDeleteRuleResponse Source #
Arguments
| :: Int | |
| -> DeleteRuleResponse |
Create a value of DeleteRuleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteRuleResponse', deleteRuleResponse_httpStatus - The response's http status code.
DeleteVariable
data DeleteVariable Source #
See: newDeleteVariable smart constructor.
Constructors
| DeleteVariable' Text |
Instances
Arguments
| :: Text | |
| -> DeleteVariable |
Create a value of DeleteVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteVariable, deleteVariable_name - The name of the variable to delete.
data DeleteVariableResponse Source #
See: newDeleteVariableResponse smart constructor.
Constructors
| DeleteVariableResponse' Int |
Instances
newDeleteVariableResponse Source #
Create a value of DeleteVariableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteVariableResponse', deleteVariableResponse_httpStatus - The response's http status code.
DescribeDetector
data DescribeDetector Source #
See: newDescribeDetector smart constructor.
Instances
Arguments
| :: Text | |
| -> DescribeDetector |
Create a value of DescribeDetector with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeDetector', describeDetector_maxResults - The maximum number of results to return for the request.
DescribeDetector, describeDetector_nextToken - The next token from the previous response.
DescribeDetector, describeDetector_detectorId - The detector ID.
data DescribeDetectorResponse Source #
See: newDescribeDetectorResponse smart constructor.
Constructors
| DescribeDetectorResponse' (Maybe Text) (Maybe Text) (Maybe [DetectorVersionSummary]) (Maybe Text) Int |
Instances
newDescribeDetectorResponse Source #
Create a value of DescribeDetectorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDetectorResponse, describeDetectorResponse_arn - The detector ARN.
DescribeDetector, describeDetectorResponse_detectorId - The detector ID.
$sel:detectorVersionSummaries:DescribeDetectorResponse', describeDetectorResponse_detectorVersionSummaries - The status and description for each detector version.
DescribeDetector, describeDetectorResponse_nextToken - The next token to be used for subsequent requests.
$sel:httpStatus:DescribeDetectorResponse', describeDetectorResponse_httpStatus - The response's http status code.
DescribeModelVersions
data DescribeModelVersions Source #
See: newDescribeModelVersions smart constructor.
Constructors
| DescribeModelVersions' (Maybe Natural) (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) |
Instances
newDescribeModelVersions :: DescribeModelVersions Source #
Create a value of DescribeModelVersions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeModelVersions', describeModelVersions_maxResults - The maximum number of results to return.
DescribeModelVersions, describeModelVersions_modelId - The model ID.
DescribeModelVersions, describeModelVersions_modelType - The model type.
DescribeModelVersions, describeModelVersions_modelVersionNumber - The model version number.
DescribeModelVersions, describeModelVersions_nextToken - The next token from the previous results.
data DescribeModelVersionsResponse Source #
See: newDescribeModelVersionsResponse smart constructor.
Constructors
| DescribeModelVersionsResponse' (Maybe [ModelVersionDetail]) (Maybe Text) Int |
Instances
newDescribeModelVersionsResponse Source #
Create a value of DescribeModelVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:modelVersionDetails:DescribeModelVersionsResponse', describeModelVersionsResponse_modelVersionDetails - The model version details.
DescribeModelVersions, describeModelVersionsResponse_nextToken - The next token.
$sel:httpStatus:DescribeModelVersionsResponse', describeModelVersionsResponse_httpStatus - The response's http status code.
GetBatchImportJobs
data GetBatchImportJobs Source #
See: newGetBatchImportJobs smart constructor.
Instances
newGetBatchImportJobs :: GetBatchImportJobs Source #
Create a value of GetBatchImportJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBatchImportJobs, getBatchImportJobs_jobId - The ID of the batch import job to get.
$sel:maxResults:GetBatchImportJobs', getBatchImportJobs_maxResults - The maximum number of objects to return for request.
GetBatchImportJobs, getBatchImportJobs_nextToken - The next token from the previous request.
data GetBatchImportJobsResponse Source #
See: newGetBatchImportJobsResponse smart constructor.
Constructors
| GetBatchImportJobsResponse' (Maybe [BatchImport]) (Maybe Text) Int |
Instances
newGetBatchImportJobsResponse Source #
Create a value of GetBatchImportJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchImports:GetBatchImportJobsResponse', getBatchImportJobsResponse_batchImports - An array containing the details of each batch import job.
GetBatchImportJobs, getBatchImportJobsResponse_nextToken - The next token for the subsequent resquest.
$sel:httpStatus:GetBatchImportJobsResponse', getBatchImportJobsResponse_httpStatus - The response's http status code.
GetBatchPredictionJobs
data GetBatchPredictionJobs Source #
See: newGetBatchPredictionJobs smart constructor.
Instances
newGetBatchPredictionJobs :: GetBatchPredictionJobs Source #
Create a value of GetBatchPredictionJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBatchPredictionJobs, getBatchPredictionJobs_jobId - The batch prediction job for which to get the details.
$sel:maxResults:GetBatchPredictionJobs', getBatchPredictionJobs_maxResults - The maximum number of objects to return for the request.
GetBatchPredictionJobs, getBatchPredictionJobs_nextToken - The next token from the previous request.
data GetBatchPredictionJobsResponse Source #
See: newGetBatchPredictionJobsResponse smart constructor.
Constructors
| GetBatchPredictionJobsResponse' (Maybe [BatchPrediction]) (Maybe Text) Int |
Instances
newGetBatchPredictionJobsResponse Source #
Create a value of GetBatchPredictionJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchPredictions:GetBatchPredictionJobsResponse', getBatchPredictionJobsResponse_batchPredictions - An array containing the details of each batch prediction job.
GetBatchPredictionJobs, getBatchPredictionJobsResponse_nextToken - The next token for the subsequent request.
$sel:httpStatus:GetBatchPredictionJobsResponse', getBatchPredictionJobsResponse_httpStatus - The response's http status code.
GetDeleteEventsByEventTypeStatus
data GetDeleteEventsByEventTypeStatus Source #
See: newGetDeleteEventsByEventTypeStatus smart constructor.
Constructors
| GetDeleteEventsByEventTypeStatus' Text |
Instances
newGetDeleteEventsByEventTypeStatus Source #
Create a value of GetDeleteEventsByEventTypeStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDeleteEventsByEventTypeStatus, getDeleteEventsByEventTypeStatus_eventTypeName - Name of event type for which to get the deletion status.
data GetDeleteEventsByEventTypeStatusResponse Source #
See: newGetDeleteEventsByEventTypeStatusResponse smart constructor.
Constructors
| GetDeleteEventsByEventTypeStatusResponse' (Maybe Text) (Maybe AsyncJobStatus) Int |
Instances
newGetDeleteEventsByEventTypeStatusResponse Source #
Arguments
| :: Int | |
| -> GetDeleteEventsByEventTypeStatusResponse |
Create a value of GetDeleteEventsByEventTypeStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDeleteEventsByEventTypeStatus, getDeleteEventsByEventTypeStatusResponse_eventTypeName - The event type name.
$sel:eventsDeletionStatus:GetDeleteEventsByEventTypeStatusResponse', getDeleteEventsByEventTypeStatusResponse_eventsDeletionStatus - The deletion status.
$sel:httpStatus:GetDeleteEventsByEventTypeStatusResponse', getDeleteEventsByEventTypeStatusResponse_httpStatus - The response's http status code.
GetDetectorVersion
data GetDetectorVersion Source #
See: newGetDetectorVersion smart constructor.
Constructors
| GetDetectorVersion' Text Text |
Instances
newGetDetectorVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetDetectorVersion |
Create a value of GetDetectorVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDetectorVersion, getDetectorVersion_detectorId - The detector ID.
GetDetectorVersion, getDetectorVersion_detectorVersionId - The detector version ID.
data GetDetectorVersionResponse Source #
See: newGetDetectorVersionResponse smart constructor.
Constructors
| GetDetectorVersionResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe [ModelVersion]) (Maybe RuleExecutionMode) (Maybe [Rule]) (Maybe DetectorVersionStatus) Int |
Instances
newGetDetectorVersionResponse Source #
Create a value of GetDetectorVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDetectorVersionResponse, getDetectorVersionResponse_arn - The detector version ARN.
GetDetectorVersionResponse, getDetectorVersionResponse_createdTime - The timestamp when the detector version was created.
GetDetectorVersionResponse, getDetectorVersionResponse_description - The detector version description.
GetDetectorVersion, getDetectorVersionResponse_detectorId - The detector ID.
GetDetectorVersion, getDetectorVersionResponse_detectorVersionId - The detector version ID.
$sel:externalModelEndpoints:GetDetectorVersionResponse', getDetectorVersionResponse_externalModelEndpoints - The Amazon SageMaker model endpoints included in the detector version.
GetDetectorVersionResponse, getDetectorVersionResponse_lastUpdatedTime - The timestamp when the detector version was last updated.
$sel:modelVersions:GetDetectorVersionResponse', getDetectorVersionResponse_modelVersions - The model versions included in the detector version.
$sel:ruleExecutionMode:GetDetectorVersionResponse', getDetectorVersionResponse_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.
$sel:rules:GetDetectorVersionResponse', getDetectorVersionResponse_rules - The rules included in the detector version.
GetDetectorVersionResponse, getDetectorVersionResponse_status - The status of the detector version.
$sel:httpStatus:GetDetectorVersionResponse', getDetectorVersionResponse_httpStatus - The response's http status code.
GetDetectors
data GetDetectors Source #
See: newGetDetectors smart constructor.
Instances
newGetDetectors :: GetDetectors Source #
Create a value of GetDetectors with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDetectors, getDetectors_detectorId - The detector ID.
$sel:maxResults:GetDetectors', getDetectors_maxResults - The maximum number of objects to return for the request.
GetDetectors, getDetectors_nextToken - The next token for the subsequent request.
data GetDetectorsResponse Source #
See: newGetDetectorsResponse smart constructor.
Instances
newGetDetectorsResponse Source #
Arguments
| :: Int | |
| -> GetDetectorsResponse |
Create a value of GetDetectorsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detectors:GetDetectorsResponse', getDetectorsResponse_detectors - The detectors.
GetDetectors, getDetectorsResponse_nextToken - The next page token.
$sel:httpStatus:GetDetectorsResponse', getDetectorsResponse_httpStatus - The response's http status code.
GetEntityTypes
data GetEntityTypes Source #
See: newGetEntityTypes smart constructor.
Instances
newGetEntityTypes :: GetEntityTypes Source #
Create a value of GetEntityTypes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetEntityTypes', getEntityTypes_maxResults - The maximum number of objects to return for the request.
GetEntityTypes, getEntityTypes_name - The name.
GetEntityTypes, getEntityTypes_nextToken - The next token for the subsequent request.
data GetEntityTypesResponse Source #
See: newGetEntityTypesResponse smart constructor.
Constructors
| GetEntityTypesResponse' (Maybe [EntityType]) (Maybe Text) Int |
Instances
newGetEntityTypesResponse Source #
Create a value of GetEntityTypesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEntityTypesResponse, getEntityTypesResponse_entityTypes - An array of entity types.
GetEntityTypes, getEntityTypesResponse_nextToken - The next page token.
$sel:httpStatus:GetEntityTypesResponse', getEntityTypesResponse_httpStatus - The response's http status code.
GetEvent
See: newGetEvent smart constructor.
Instances
Create a value of GetEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEvent, getEvent_eventId - The ID of the event to retrieve.
GetEvent, getEvent_eventTypeName - The event type of the event to retrieve.
data GetEventResponse Source #
See: newGetEventResponse smart constructor.
Constructors
| GetEventResponse' (Maybe Event) Int |
Instances
Arguments
| :: Int | |
| -> GetEventResponse |
Create a value of GetEventResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:event:GetEventResponse', getEventResponse_event - The details of the event.
$sel:httpStatus:GetEventResponse', getEventResponse_httpStatus - The response's http status code.
GetEventPrediction
data GetEventPrediction Source #
See: newGetEventPrediction smart constructor.
Constructors
| GetEventPrediction' (Maybe Text) (Maybe (Sensitive (HashMap Text ModelEndpointDataBlob))) Text Text Text [Sensitive Entity] Text (HashMap Text (Sensitive Text)) |
Instances
newGetEventPrediction Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> GetEventPrediction |
Create a value of GetEventPrediction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEventPrediction, getEventPrediction_detectorVersionId - The detector version ID.
$sel:externalModelEndpointDataBlobs:GetEventPrediction', getEventPrediction_externalModelEndpointDataBlobs - The Amazon SageMaker model endpoint input data blobs.
GetEventPrediction, getEventPrediction_detectorId - The detector ID.
GetEventPrediction, getEventPrediction_eventId - The unique ID used to identify the event.
GetEventPrediction, getEventPrediction_eventTypeName - The event type associated with the detector specified for the
prediction.
GetEventPrediction, getEventPrediction_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."
GetEventPrediction, getEventPrediction_eventTimestamp - Timestamp that defines when the event under evaluation occurred. The
timestamp must be specified using ISO 8601 standard in UTC.
GetEventPrediction, getEventPrediction_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.
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.
data GetEventPredictionResponse Source #
See: newGetEventPredictionResponse smart constructor.
Constructors
| GetEventPredictionResponse' (Maybe [ExternalModelOutputs]) (Maybe [ModelScores]) (Maybe [RuleResult]) Int |
Instances
newGetEventPredictionResponse Source #
Create a value of GetEventPredictionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalModelOutputs:GetEventPredictionResponse', getEventPredictionResponse_externalModelOutputs - The model scores for Amazon SageMaker models.
$sel:modelScores:GetEventPredictionResponse', getEventPredictionResponse_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.
$sel:ruleResults:GetEventPredictionResponse', getEventPredictionResponse_ruleResults - The results from the rules.
$sel:httpStatus:GetEventPredictionResponse', getEventPredictionResponse_httpStatus - The response's http status code.
GetEventPredictionMetadata
data GetEventPredictionMetadata Source #
See: newGetEventPredictionMetadata smart constructor.
Instances
newGetEventPredictionMetadata Source #
Create a value of GetEventPredictionMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEventPredictionMetadata, getEventPredictionMetadata_eventId - The event ID.
GetEventPredictionMetadata, getEventPredictionMetadata_eventTypeName - The event type associated with the detector specified for the
prediction.
GetEventPredictionMetadata, getEventPredictionMetadata_detectorId - The detector ID.
GetEventPredictionMetadata, getEventPredictionMetadata_detectorVersionId - The detector version ID.
GetEventPredictionMetadata, getEventPredictionMetadata_predictionTimestamp - 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.
data GetEventPredictionMetadataResponse Source #
See: newGetEventPredictionMetadataResponse smart constructor.
Constructors
| GetEventPredictionMetadataResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [EvaluatedExternalModel]) (Maybe [EvaluatedModelVersion]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [EventVariableSummary]) (Maybe [Text]) (Maybe Text) (Maybe RuleExecutionMode) (Maybe [EvaluatedRule]) Int |
Instances
newGetEventPredictionMetadataResponse Source #
Arguments
| :: Int | |
| -> GetEventPredictionMetadataResponse |
Create a value of GetEventPredictionMetadataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEventPredictionMetadata, getEventPredictionMetadataResponse_detectorId - The detector ID.
GetEventPredictionMetadata, getEventPredictionMetadataResponse_detectorVersionId - The detector version ID.
$sel:detectorVersionStatus:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_detectorVersionStatus - The status of the detector version.
GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_entityId - The entity ID.
GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_entityType - The entity type.
$sel:evaluatedExternalModels:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_evaluatedExternalModels - External (Amazon SageMaker) models that were evaluated for generating
predictions.
$sel:evaluatedModelVersions:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_evaluatedModelVersions - Model versions that were evaluated for generating predictions.
GetEventPredictionMetadata, getEventPredictionMetadataResponse_eventId - The event ID.
GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_eventTimestamp - The timestamp for when the prediction was generated for the associated
event ID.
GetEventPredictionMetadata, getEventPredictionMetadataResponse_eventTypeName - The event type associated with the detector specified for this
prediction.
GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_eventVariables - A list of event variables that influenced the prediction scores.
GetEventPredictionMetadataResponse, getEventPredictionMetadataResponse_outcomes - The outcomes of the matched rule, based on the rule execution mode.
GetEventPredictionMetadata, getEventPredictionMetadataResponse_predictionTimestamp - The timestamp that defines when the prediction was generated.
$sel:ruleExecutionMode:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_ruleExecutionMode - The execution mode of the rule used for evaluating variable values.
$sel:rules:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_rules - List of rules associated with the detector version that were used for
evaluating variable values.
$sel:httpStatus:GetEventPredictionMetadataResponse', getEventPredictionMetadataResponse_httpStatus - The response's http status code.
GetEventTypes
data GetEventTypes Source #
See: newGetEventTypes smart constructor.
Instances
newGetEventTypes :: GetEventTypes Source #
Create a value of GetEventTypes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetEventTypes', getEventTypes_maxResults - The maximum number of objects to return for the request.
GetEventTypes, getEventTypes_name - The name.
GetEventTypes, getEventTypes_nextToken - The next token for the subsequent request.
data GetEventTypesResponse Source #
See: newGetEventTypesResponse smart constructor.
Instances
newGetEventTypesResponse Source #
Create a value of GetEventTypesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventTypes:GetEventTypesResponse', getEventTypesResponse_eventTypes - An array of event types.
GetEventTypes, getEventTypesResponse_nextToken - The next page token.
$sel:httpStatus:GetEventTypesResponse', getEventTypesResponse_httpStatus - The response's http status code.
GetExternalModels
data GetExternalModels Source #
See: newGetExternalModels smart constructor.
Instances
newGetExternalModels :: GetExternalModels Source #
Create a value of GetExternalModels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetExternalModels', getExternalModels_maxResults - The maximum number of objects to return for the request.
GetExternalModels, getExternalModels_modelEndpoint - The Amazon SageMaker model endpoint.
GetExternalModels, getExternalModels_nextToken - The next page token for the request.
data GetExternalModelsResponse Source #
See: newGetExternalModelsResponse smart constructor.
Constructors
| GetExternalModelsResponse' (Maybe [ExternalModel]) (Maybe Text) Int |
Instances
newGetExternalModelsResponse Source #
Create a value of GetExternalModelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalModels:GetExternalModelsResponse', getExternalModelsResponse_externalModels - Gets the Amazon SageMaker models.
GetExternalModels, getExternalModelsResponse_nextToken - The next page token to be used in subsequent requests.
$sel:httpStatus:GetExternalModelsResponse', getExternalModelsResponse_httpStatus - The response's http status code.
GetKMSEncryptionKey
data GetKMSEncryptionKey Source #
See: newGetKMSEncryptionKey smart constructor.
Constructors
| GetKMSEncryptionKey' | |
Instances
newGetKMSEncryptionKey :: GetKMSEncryptionKey Source #
Create a value of GetKMSEncryptionKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetKMSEncryptionKeyResponse Source #
See: newGetKMSEncryptionKeyResponse smart constructor.
Constructors
| GetKMSEncryptionKeyResponse' (Maybe KMSKey) Int |
Instances
newGetKMSEncryptionKeyResponse Source #
Create a value of GetKMSEncryptionKeyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKey:GetKMSEncryptionKeyResponse', getKMSEncryptionKeyResponse_kmsKey - The KMS encryption key.
$sel:httpStatus:GetKMSEncryptionKeyResponse', getKMSEncryptionKeyResponse_httpStatus - The response's http status code.
GetLabels
See: newGetLabels smart constructor.
Instances
newGetLabels :: GetLabels Source #
Create a value of GetLabels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetLabels', getLabels_maxResults - The maximum number of objects to return for the request.
GetLabels, getLabels_name - The name of the label or labels to get.
GetLabels, getLabels_nextToken - The next token for the subsequent request.
data GetLabelsResponse Source #
See: newGetLabelsResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> GetLabelsResponse |
Create a value of GetLabelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetLabelsResponse, getLabelsResponse_labels - An array of labels.
GetLabels, getLabelsResponse_nextToken - The next page token.
$sel:httpStatus:GetLabelsResponse', getLabelsResponse_httpStatus - The response's http status code.
GetModelVersion
data GetModelVersion Source #
See: newGetModelVersion smart constructor.
Constructors
| GetModelVersion' Text ModelTypeEnum Text |
Instances
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> Text | |
| -> GetModelVersion |
Create a value of GetModelVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetModelVersion, getModelVersion_modelId - The model ID.
GetModelVersion, getModelVersion_modelType - The model type.
GetModelVersion, getModelVersion_modelVersionNumber - The model version number.
data GetModelVersionResponse Source #
See: newGetModelVersionResponse smart constructor.
Constructors
Instances
newGetModelVersionResponse Source #
Create a value of GetModelVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetModelVersionResponse, getModelVersionResponse_arn - The model version ARN.
GetModelVersionResponse, getModelVersionResponse_externalEventsDetail - The details of the external events data used for training the model
version. This will be populated if the trainingDataSource is
EXTERNAL_EVENTS
GetModelVersionResponse, getModelVersionResponse_ingestedEventsDetail - The details of the ingested events data used for training the model
version. This will be populated if the trainingDataSource is
INGESTED_EVENTS.
GetModelVersion, getModelVersionResponse_modelId - The model ID.
GetModelVersion, getModelVersionResponse_modelType - The model type.
GetModelVersion, getModelVersionResponse_modelVersionNumber - The model version number.
GetModelVersionResponse, getModelVersionResponse_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
GetModelVersionResponse, getModelVersionResponse_trainingDataSchema - The training data schema.
GetModelVersionResponse, getModelVersionResponse_trainingDataSource - The training data source.
$sel:httpStatus:GetModelVersionResponse', getModelVersionResponse_httpStatus - The response's http status code.
GetModels
See: newGetModels smart constructor.
Constructors
| GetModels' (Maybe Natural) (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) |
Instances
newGetModels :: GetModels Source #
Create a value of GetModels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetModels', getModels_maxResults - The maximum number of objects to return for the request.
GetModels, getModels_modelId - The model ID.
GetModels, getModels_modelType - The model type.
GetModels, getModels_nextToken - The next token for the subsequent request.
data GetModelsResponse Source #
See: newGetModelsResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> GetModelsResponse |
Create a value of GetModelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:models:GetModelsResponse', getModelsResponse_models - The array of models.
GetModels, getModelsResponse_nextToken - The next page token to be used in subsequent requests.
$sel:httpStatus:GetModelsResponse', getModelsResponse_httpStatus - The response's http status code.
GetOutcomes
data GetOutcomes Source #
See: newGetOutcomes smart constructor.
Instances
newGetOutcomes :: GetOutcomes Source #
Create a value of GetOutcomes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetOutcomes', getOutcomes_maxResults - The maximum number of objects to return for the request.
GetOutcomes, getOutcomes_name - The name of the outcome or outcomes to get.
GetOutcomes, getOutcomes_nextToken - The next page token for the request.
data GetOutcomesResponse Source #
See: newGetOutcomesResponse smart constructor.
Instances
newGetOutcomesResponse Source #
Arguments
| :: Int | |
| -> GetOutcomesResponse |
Create a value of GetOutcomesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetOutcomes, getOutcomesResponse_nextToken - The next page token for subsequent requests.
GetOutcomesResponse, getOutcomesResponse_outcomes - The outcomes.
$sel:httpStatus:GetOutcomesResponse', getOutcomesResponse_httpStatus - The response's http status code.
GetRules
See: newGetRules smart constructor.
Instances
Create a value of GetRules with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetRules', getRules_maxResults - The maximum number of rules to return for the request.
GetRules, getRules_nextToken - The next page token.
GetRules, getRules_ruleId - The rule ID.
GetRules, getRules_ruleVersion - The rule version.
GetRules, getRules_detectorId - The detector ID.
data GetRulesResponse Source #
See: newGetRulesResponse smart constructor.
Constructors
| GetRulesResponse' (Maybe Text) (Maybe [RuleDetail]) Int |
Instances
Arguments
| :: Int | |
| -> GetRulesResponse |
Create a value of GetRulesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRules, getRulesResponse_nextToken - The next page token to be used in subsequent requests.
$sel:ruleDetails:GetRulesResponse', getRulesResponse_ruleDetails - The details of the requested rule.
$sel:httpStatus:GetRulesResponse', getRulesResponse_httpStatus - The response's http status code.
GetVariables
data GetVariables Source #
See: newGetVariables smart constructor.
Instances
newGetVariables :: GetVariables Source #
Create a value of GetVariables with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetVariables', getVariables_maxResults - The max size per page determined for the get variable request.
GetVariables, getVariables_name - The name of the variable.
GetVariables, getVariables_nextToken - The next page token of the get variable request.
data GetVariablesResponse Source #
See: newGetVariablesResponse smart constructor.
Instances
newGetVariablesResponse Source #
Arguments
| :: Int | |
| -> GetVariablesResponse |
Create a value of GetVariablesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetVariables, getVariablesResponse_nextToken - The next page token to be used in subsequent requests.
$sel:variables:GetVariablesResponse', getVariablesResponse_variables - The names of the variables returned.
$sel:httpStatus:GetVariablesResponse', getVariablesResponse_httpStatus - The response's http status code.
ListEventPredictions
data ListEventPredictions Source #
See: newListEventPredictions smart constructor.
Constructors
| ListEventPredictions' (Maybe FilterCondition) (Maybe FilterCondition) (Maybe FilterCondition) (Maybe FilterCondition) (Maybe Natural) (Maybe Text) (Maybe PredictionTimeRange) |
Instances
newListEventPredictions :: ListEventPredictions Source #
Create a value of ListEventPredictions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListEventPredictions, listEventPredictions_detectorId - The detector ID.
ListEventPredictions, listEventPredictions_detectorVersionId - The detector version ID.
ListEventPredictions, listEventPredictions_eventId - The event ID.
$sel:eventType:ListEventPredictions', listEventPredictions_eventType - The event type associated with the detector.
$sel:maxResults:ListEventPredictions', listEventPredictions_maxResults - The maximum number of predictions to return for the request.
ListEventPredictions, listEventPredictions_nextToken - 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.
$sel:predictionTimeRange:ListEventPredictions', listEventPredictions_predictionTimeRange - The time period for when the predictions were generated.
data ListEventPredictionsResponse Source #
See: newListEventPredictionsResponse smart constructor.
Constructors
| ListEventPredictionsResponse' (Maybe [EventPredictionSummary]) (Maybe Text) Int |
Instances
newListEventPredictionsResponse Source #
Create a value of ListEventPredictionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventPredictionSummaries:ListEventPredictionsResponse', listEventPredictionsResponse_eventPredictionSummaries - The summary of the past predictions.
ListEventPredictions, listEventPredictionsResponse_nextToken - 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.
$sel:httpStatus:ListEventPredictionsResponse', listEventPredictionsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForResource', listTagsForResource_maxResults - The maximum number of objects to return for the request.
ListTagsForResource, listTagsForResource_nextToken - The next token from the previous results.
$sel:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The ARN that specifies the resource whose tags you want to list.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResourceResponse_nextToken - The next token for subsequent requests.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A collection of key and value pairs.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
PutDetector
data PutDetector Source #
See: newPutDetector smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> PutDetector |
Create a value of PutDetector with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutDetector, putDetector_description - The description of the detector.
$sel:tags:PutDetector', putDetector_tags - A collection of key and value pairs.
PutDetector, putDetector_detectorId - The detector ID.
PutDetector, putDetector_eventTypeName - The name of the event type.
data PutDetectorResponse Source #
See: newPutDetectorResponse smart constructor.
Constructors
| PutDetectorResponse' Int |
Instances
newPutDetectorResponse Source #
Arguments
| :: Int | |
| -> PutDetectorResponse |
Create a value of PutDetectorResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutDetectorResponse', putDetectorResponse_httpStatus - The response's http status code.
PutEntityType
data PutEntityType Source #
See: newPutEntityType smart constructor.
Instances
Arguments
| :: Text | |
| -> PutEntityType |
Create a value of PutEntityType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEntityType, putEntityType_description - The description.
$sel:tags:PutEntityType', putEntityType_tags - A collection of key and value pairs.
PutEntityType, putEntityType_name - The name of the entity type.
data PutEntityTypeResponse Source #
See: newPutEntityTypeResponse smart constructor.
Constructors
| PutEntityTypeResponse' Int |
Instances
newPutEntityTypeResponse Source #
Create a value of PutEntityTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutEntityTypeResponse', putEntityTypeResponse_httpStatus - The response's http status code.
PutEventType
data PutEventType Source #
See: newPutEventType smart constructor.
Constructors
| PutEventType' (Maybe Text) (Maybe EventIngestion) (Maybe [Text]) (Maybe [Tag]) Text (NonEmpty Text) (NonEmpty Text) |
Instances
Create a value of PutEventType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutEventType, putEventType_description - The description of the event type.
PutEventType, putEventType_eventIngestion - Specifies if ingenstion is enabled or disabled.
PutEventType, putEventType_labels - The event type labels.
$sel:tags:PutEventType', putEventType_tags - A collection of key and value pairs.
PutEventType, putEventType_name - The name.
PutEventType, putEventType_eventVariables - The event type variables.
PutEventType, putEventType_entityTypes - The entity type for the event type. Example entity types: customer,
merchant, account.
data PutEventTypeResponse Source #
See: newPutEventTypeResponse smart constructor.
Constructors
| PutEventTypeResponse' Int |
Instances
newPutEventTypeResponse Source #
Arguments
| :: Int | |
| -> PutEventTypeResponse |
Create a value of PutEventTypeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutEventTypeResponse', putEventTypeResponse_httpStatus - The response's http status code.
PutExternalModel
data PutExternalModel Source #
See: newPutExternalModel smart constructor.
Constructors
| PutExternalModel' (Maybe [Tag]) Text ModelSource Text ModelInputConfiguration ModelOutputConfiguration ModelEndpointStatus |
Instances
Arguments
| :: Text | |
| -> ModelSource | |
| -> Text | |
| -> ModelInputConfiguration | |
| -> ModelOutputConfiguration | |
| -> ModelEndpointStatus | |
| -> PutExternalModel |
Create a value of PutExternalModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:PutExternalModel', putExternalModel_tags - A collection of key and value pairs.
PutExternalModel, putExternalModel_modelEndpoint - The model endpoints name.
PutExternalModel, putExternalModel_modelSource - The source of the model.
PutExternalModel, putExternalModel_invokeModelEndpointRoleArn - The IAM role used to invoke the model endpoint.
PutExternalModel, putExternalModel_inputConfiguration - The model endpoint input configuration.
PutExternalModel, putExternalModel_outputConfiguration - The model endpoint output configuration.
PutExternalModel, putExternalModel_modelEndpointStatus - The model endpoint’s status in Amazon Fraud Detector.
data PutExternalModelResponse Source #
See: newPutExternalModelResponse smart constructor.
Constructors
| PutExternalModelResponse' Int |
Instances
newPutExternalModelResponse Source #
Create a value of PutExternalModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutExternalModelResponse', putExternalModelResponse_httpStatus - The response's http status code.
PutKMSEncryptionKey
data PutKMSEncryptionKey Source #
See: newPutKMSEncryptionKey smart constructor.
Constructors
| PutKMSEncryptionKey' Text |
Instances
newPutKMSEncryptionKey Source #
Arguments
| :: Text | |
| -> PutKMSEncryptionKey |
Create a value of PutKMSEncryptionKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutKMSEncryptionKey, putKMSEncryptionKey_kmsEncryptionKeyArn - The KMS encryption key ARN.
The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.
data PutKMSEncryptionKeyResponse Source #
See: newPutKMSEncryptionKeyResponse smart constructor.
Constructors
| PutKMSEncryptionKeyResponse' Int |
Instances
newPutKMSEncryptionKeyResponse Source #
Create a value of PutKMSEncryptionKeyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutKMSEncryptionKeyResponse', putKMSEncryptionKeyResponse_httpStatus - The response's http status code.
PutLabel
See: newPutLabel smart constructor.
Instances
Create a value of PutLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutLabel, putLabel_description - The label description.
$sel:tags:PutLabel', putLabel_tags -
PutLabel, putLabel_name - The label name.
data PutLabelResponse Source #
See: newPutLabelResponse smart constructor.
Constructors
| PutLabelResponse' Int |
Instances
Arguments
| :: Int | |
| -> PutLabelResponse |
Create a value of PutLabelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutLabelResponse', putLabelResponse_httpStatus - The response's http status code.
PutOutcome
data PutOutcome Source #
See: newPutOutcome smart constructor.
Instances
Arguments
| :: Text | |
| -> PutOutcome |
Create a value of PutOutcome with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutOutcome, putOutcome_description - The outcome description.
$sel:tags:PutOutcome', putOutcome_tags - A collection of key and value pairs.
PutOutcome, putOutcome_name - The name of the outcome.
data PutOutcomeResponse Source #
See: newPutOutcomeResponse smart constructor.
Constructors
| PutOutcomeResponse' Int |
Instances
newPutOutcomeResponse Source #
Arguments
| :: Int | |
| -> PutOutcomeResponse |
Create a value of PutOutcomeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutOutcomeResponse', putOutcomeResponse_httpStatus - The response's http status code.
SendEvent
See: newSendEvent smart constructor.
Constructors
| SendEvent' (Maybe Text) (Maybe Text) Text Text Text (HashMap Text (Sensitive Text)) [Sensitive Entity] |
Instances
Create a value of SendEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignedLabel:SendEvent', sendEvent_assignedLabel - The label to associate with the event. Required if specifying
labelTimestamp.
SendEvent, sendEvent_labelTimestamp - The timestamp associated with the label. Required if specifying
assignedLabel.
SendEvent, sendEvent_eventId - The event ID to upload.
SendEvent, sendEvent_eventTypeName - The event type name of the event.
SendEvent, sendEvent_eventTimestamp - The timestamp that defines when the event under evaluation occurred. The
timestamp must be specified using ISO 8601 standard in UTC.
SendEvent, sendEvent_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.
SendEvent, sendEvent_entities - An array of entities.
data SendEventResponse Source #
See: newSendEventResponse smart constructor.
Constructors
| SendEventResponse' Int |
Instances
Arguments
| :: Int | |
| -> SendEventResponse |
Create a value of SendEventResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SendEventResponse', sendEventResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:TagResource', tagResource_resourceARN - The resource ARN.
$sel:tags:TagResource', tagResource_tags - The tags to assign to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceARN:UntagResource', untagResource_resourceARN - The ARN of the resource from which to remove the tag.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The resource ARN.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateDetectorVersion
data UpdateDetectorVersion Source #
See: newUpdateDetectorVersion smart constructor.
Constructors
| UpdateDetectorVersion' (Maybe Text) (Maybe [ModelVersion]) (Maybe RuleExecutionMode) Text Text [Text] [Rule] |
Instances
newUpdateDetectorVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateDetectorVersion |
Create a value of UpdateDetectorVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDetectorVersion, updateDetectorVersion_description - The detector version description.
$sel:modelVersions:UpdateDetectorVersion', updateDetectorVersion_modelVersions - The model versions to include in the detector version.
$sel:ruleExecutionMode:UpdateDetectorVersion', updateDetectorVersion_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.
UpdateDetectorVersion, updateDetectorVersion_detectorId - The parent detector ID for the detector version you want to update.
UpdateDetectorVersion, updateDetectorVersion_detectorVersionId - The detector version ID.
$sel:externalModelEndpoints:UpdateDetectorVersion', updateDetectorVersion_externalModelEndpoints - The Amazon SageMaker model endpoints to include in the detector version.
$sel:rules:UpdateDetectorVersion', updateDetectorVersion_rules - The rules to include in the detector version.
data UpdateDetectorVersionResponse Source #
See: newUpdateDetectorVersionResponse smart constructor.
Constructors
| UpdateDetectorVersionResponse' Int |
Instances
newUpdateDetectorVersionResponse Source #
Create a value of UpdateDetectorVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDetectorVersionResponse', updateDetectorVersionResponse_httpStatus - The response's http status code.
UpdateDetectorVersionMetadata
data UpdateDetectorVersionMetadata Source #
See: newUpdateDetectorVersionMetadata smart constructor.
Constructors
| UpdateDetectorVersionMetadata' Text Text Text |
Instances
newUpdateDetectorVersionMetadata Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateDetectorVersionMetadata |
Create a value of UpdateDetectorVersionMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDetectorVersionMetadata, updateDetectorVersionMetadata_detectorId - The detector ID.
UpdateDetectorVersionMetadata, updateDetectorVersionMetadata_detectorVersionId - The detector version ID.
UpdateDetectorVersionMetadata, updateDetectorVersionMetadata_description - The description.
data UpdateDetectorVersionMetadataResponse Source #
See: newUpdateDetectorVersionMetadataResponse smart constructor.
Constructors
| UpdateDetectorVersionMetadataResponse' Int |
Instances
newUpdateDetectorVersionMetadataResponse Source #
Arguments
| :: Int | |
| -> UpdateDetectorVersionMetadataResponse |
Create a value of UpdateDetectorVersionMetadataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDetectorVersionMetadataResponse', updateDetectorVersionMetadataResponse_httpStatus - The response's http status code.
UpdateDetectorVersionStatus
data UpdateDetectorVersionStatus Source #
See: newUpdateDetectorVersionStatus smart constructor.
Constructors
| UpdateDetectorVersionStatus' Text Text DetectorVersionStatus |
Instances
newUpdateDetectorVersionStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> DetectorVersionStatus | |
| -> UpdateDetectorVersionStatus |
Create a value of UpdateDetectorVersionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDetectorVersionStatus, updateDetectorVersionStatus_detectorId - The detector ID.
UpdateDetectorVersionStatus, updateDetectorVersionStatus_detectorVersionId - The detector version ID.
UpdateDetectorVersionStatus, updateDetectorVersionStatus_status - The new status.
The only supported values are ACTIVE and INACTIVE
data UpdateDetectorVersionStatusResponse Source #
See: newUpdateDetectorVersionStatusResponse smart constructor.
Constructors
| UpdateDetectorVersionStatusResponse' Int |
Instances
newUpdateDetectorVersionStatusResponse Source #
Arguments
| :: Int | |
| -> UpdateDetectorVersionStatusResponse |
Create a value of UpdateDetectorVersionStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDetectorVersionStatusResponse', updateDetectorVersionStatusResponse_httpStatus - The response's http status code.
UpdateEventLabel
data UpdateEventLabel Source #
See: newUpdateEventLabel smart constructor.
Constructors
| UpdateEventLabel' Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UpdateEventLabel |
Create a value of UpdateEventLabel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEventLabel, updateEventLabel_eventId - The ID of the event associated with the label to update.
UpdateEventLabel, updateEventLabel_eventTypeName - The event type of the event associated with the label to update.
$sel:assignedLabel:UpdateEventLabel', updateEventLabel_assignedLabel - The new label to assign to the event.
UpdateEventLabel, updateEventLabel_labelTimestamp - The timestamp associated with the label. The timestamp must be specified
using ISO 8601 standard in UTC.
data UpdateEventLabelResponse Source #
See: newUpdateEventLabelResponse smart constructor.
Constructors
| UpdateEventLabelResponse' Int |
Instances
newUpdateEventLabelResponse Source #
Create a value of UpdateEventLabelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateEventLabelResponse', updateEventLabelResponse_httpStatus - The response's http status code.
UpdateModel
data UpdateModel Source #
See: newUpdateModel smart constructor.
Constructors
| UpdateModel' (Maybe Text) Text ModelTypeEnum |
Instances
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> UpdateModel |
Create a value of UpdateModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateModel, updateModel_description - The new model description.
UpdateModel, updateModel_modelId - The model ID.
UpdateModel, updateModel_modelType - The model type.
data UpdateModelResponse Source #
See: newUpdateModelResponse smart constructor.
Constructors
| UpdateModelResponse' Int |
Instances
newUpdateModelResponse Source #
Arguments
| :: Int | |
| -> UpdateModelResponse |
Create a value of UpdateModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateModelResponse', updateModelResponse_httpStatus - The response's http status code.
UpdateModelVersion
data UpdateModelVersion Source #
See: newUpdateModelVersion smart constructor.
Constructors
| UpdateModelVersion' (Maybe ExternalEventsDetail) (Maybe IngestedEventsDetail) (Maybe [Tag]) Text ModelTypeEnum Text |
Instances
newUpdateModelVersion Source #
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> Text | |
| -> UpdateModelVersion |
Create a value of UpdateModelVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateModelVersion, updateModelVersion_externalEventsDetail - The details of the external events data used for training the model
version. Required if trainingDataSource is EXTERNAL_EVENTS.
UpdateModelVersion, updateModelVersion_ingestedEventsDetail - The details of the ingested event used for training the model version.
Required if your trainingDataSource is INGESTED_EVENTS.
$sel:tags:UpdateModelVersion', updateModelVersion_tags - A collection of key and value pairs.
UpdateModelVersion, updateModelVersion_modelId - The model ID.
UpdateModelVersion, updateModelVersion_modelType - The model type.
$sel:majorVersionNumber:UpdateModelVersion', updateModelVersion_majorVersionNumber - The major version number.
data UpdateModelVersionResponse Source #
See: newUpdateModelVersionResponse smart constructor.
Constructors
| UpdateModelVersionResponse' (Maybe Text) (Maybe ModelTypeEnum) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateModelVersionResponse Source #
Create a value of UpdateModelVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateModelVersion, updateModelVersionResponse_modelId - The model ID.
UpdateModelVersion, updateModelVersionResponse_modelType - The model type.
UpdateModelVersionResponse, updateModelVersionResponse_modelVersionNumber - The model version number of the model version updated.
UpdateModelVersionResponse, updateModelVersionResponse_status - The status of the updated model version.
$sel:httpStatus:UpdateModelVersionResponse', updateModelVersionResponse_httpStatus - The response's http status code.
UpdateModelVersionStatus
data UpdateModelVersionStatus Source #
See: newUpdateModelVersionStatus smart constructor.
Constructors
| UpdateModelVersionStatus' Text ModelTypeEnum Text ModelVersionStatus |
Instances
newUpdateModelVersionStatus Source #
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> Text | |
| -> ModelVersionStatus | |
| -> UpdateModelVersionStatus |
Create a value of UpdateModelVersionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateModelVersionStatus, updateModelVersionStatus_modelId - The model ID of the model version to update.
UpdateModelVersionStatus, updateModelVersionStatus_modelType - The model type.
UpdateModelVersionStatus, updateModelVersionStatus_modelVersionNumber - The model version number.
UpdateModelVersionStatus, updateModelVersionStatus_status - The model version status.
data UpdateModelVersionStatusResponse Source #
See: newUpdateModelVersionStatusResponse smart constructor.
Constructors
| UpdateModelVersionStatusResponse' Int |
Instances
newUpdateModelVersionStatusResponse Source #
Create a value of UpdateModelVersionStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateModelVersionStatusResponse', updateModelVersionStatusResponse_httpStatus - The response's http status code.
UpdateRuleMetadata
data UpdateRuleMetadata Source #
See: newUpdateRuleMetadata smart constructor.
Constructors
| UpdateRuleMetadata' Rule Text |
Instances
newUpdateRuleMetadata Source #
Create a value of UpdateRuleMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rule:UpdateRuleMetadata', updateRuleMetadata_rule - The rule to update.
UpdateRuleMetadata, updateRuleMetadata_description - The rule description.
data UpdateRuleMetadataResponse Source #
See: newUpdateRuleMetadataResponse smart constructor.
Constructors
| UpdateRuleMetadataResponse' Int |
Instances
newUpdateRuleMetadataResponse Source #
Create a value of UpdateRuleMetadataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateRuleMetadataResponse', updateRuleMetadataResponse_httpStatus - The response's http status code.
UpdateRuleVersion
data UpdateRuleVersion Source #
See: newUpdateRuleVersion smart constructor.
Constructors
| UpdateRuleVersion' (Maybe Text) (Maybe [Tag]) Rule (Sensitive Text) Language (NonEmpty Text) |
Instances
Create a value of UpdateRuleVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRuleVersion, updateRuleVersion_description - The description.
$sel:tags:UpdateRuleVersion', updateRuleVersion_tags - The tags to assign to the rule version.
UpdateRuleVersion, updateRuleVersion_rule - The rule to update.
UpdateRuleVersion, updateRuleVersion_expression - The rule expression.
UpdateRuleVersion, updateRuleVersion_language - The language.
UpdateRuleVersion, updateRuleVersion_outcomes - The outcomes.
data UpdateRuleVersionResponse Source #
See: newUpdateRuleVersionResponse smart constructor.
Constructors
| UpdateRuleVersionResponse' (Maybe Rule) Int |
Instances
newUpdateRuleVersionResponse Source #
Create a value of UpdateRuleVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRuleVersion, updateRuleVersionResponse_rule - The new rule version that was created.
$sel:httpStatus:UpdateRuleVersionResponse', updateRuleVersionResponse_httpStatus - The response's http status code.
UpdateVariable
data UpdateVariable Source #
See: newUpdateVariable smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateVariable |
Create a value of UpdateVariable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateVariable, updateVariable_defaultValue - The new default value of the variable.
UpdateVariable, updateVariable_description - The new description.
UpdateVariable, updateVariable_variableType - The variable type. For more information see
Variable types.
UpdateVariable, updateVariable_name - The name of the variable.
data UpdateVariableResponse Source #
See: newUpdateVariableResponse smart constructor.
Constructors
| UpdateVariableResponse' Int |
Instances
newUpdateVariableResponse Source #
Create a value of UpdateVariableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateVariableResponse', updateVariableResponse_httpStatus - The response's http status code.
Types
AsyncJobStatus
newtype AsyncJobStatus Source #
Constructors
| AsyncJobStatus' | |
Fields | |
Bundled Patterns
| pattern AsyncJobStatus_CANCELED :: AsyncJobStatus | |
| pattern AsyncJobStatus_CANCEL_IN_PROGRESS :: AsyncJobStatus | |
| pattern AsyncJobStatus_COMPLETE :: AsyncJobStatus | |
| pattern AsyncJobStatus_FAILED :: AsyncJobStatus | |
| pattern AsyncJobStatus_IN_PROGRESS :: AsyncJobStatus | |
| pattern AsyncJobStatus_IN_PROGRESS_INITIALIZING :: AsyncJobStatus |
Instances
DataSource
newtype DataSource Source #
Constructors
| DataSource' | |
Fields | |
Bundled Patterns
| pattern DataSource_EVENT :: DataSource | |
| pattern DataSource_EXTERNAL_MODEL_SCORE :: DataSource | |
| pattern DataSource_MODEL_SCORE :: DataSource |
Instances
DataType
Constructors
| DataType' | |
Fields
| |
Bundled Patterns
| pattern DataType_BOOLEAN :: DataType | |
| pattern DataType_FLOAT :: DataType | |
| pattern DataType_INTEGER :: DataType | |
| pattern DataType_STRING :: DataType |
Instances
DetectorVersionStatus
newtype DetectorVersionStatus Source #
Constructors
| DetectorVersionStatus' | |
Fields | |
Bundled Patterns
| pattern DetectorVersionStatus_ACTIVE :: DetectorVersionStatus | |
| pattern DetectorVersionStatus_DRAFT :: DetectorVersionStatus | |
| pattern DetectorVersionStatus_INACTIVE :: DetectorVersionStatus |
Instances
EventIngestion
newtype EventIngestion Source #
Constructors
| EventIngestion' | |
Fields | |
Bundled Patterns
| pattern EventIngestion_DISABLED :: EventIngestion | |
| pattern EventIngestion_ENABLED :: EventIngestion |
Instances
Language
Constructors
| Language' | |
Fields
| |
Bundled Patterns
| pattern Language_DETECTORPL :: Language |
Instances
ModelEndpointStatus
newtype ModelEndpointStatus Source #
Constructors
| ModelEndpointStatus' | |
Fields | |
Bundled Patterns
| pattern ModelEndpointStatus_ASSOCIATED :: ModelEndpointStatus | |
| pattern ModelEndpointStatus_DISSOCIATED :: ModelEndpointStatus |
Instances
ModelInputDataFormat
newtype ModelInputDataFormat Source #
Constructors
| ModelInputDataFormat' | |
Fields | |
Bundled Patterns
| pattern ModelInputDataFormat_APPLICATION_JSON :: ModelInputDataFormat | |
| pattern ModelInputDataFormat_TEXT_CSV :: ModelInputDataFormat |
Instances
ModelOutputDataFormat
newtype ModelOutputDataFormat Source #
Constructors
| ModelOutputDataFormat' | |
Fields | |
Bundled Patterns
| pattern ModelOutputDataFormat_APPLICATION_JSONLINES :: ModelOutputDataFormat | |
| pattern ModelOutputDataFormat_TEXT_CSV :: ModelOutputDataFormat |
Instances
ModelSource
newtype ModelSource Source #
Constructors
| ModelSource' | |
Fields | |
Bundled Patterns
| pattern ModelSource_SAGEMAKER :: ModelSource |
Instances
ModelTypeEnum
newtype ModelTypeEnum Source #
Constructors
| ModelTypeEnum' | |
Fields | |
Bundled Patterns
| pattern ModelTypeEnum_ACCOUNT_TAKEOVER_INSIGHTS :: ModelTypeEnum | |
| pattern ModelTypeEnum_ONLINE_FRAUD_INSIGHTS :: ModelTypeEnum | |
| pattern ModelTypeEnum_TRANSACTION_FRAUD_INSIGHTS :: ModelTypeEnum |
Instances
ModelVersionStatus
newtype ModelVersionStatus Source #
Constructors
| ModelVersionStatus' | |
Fields | |
Bundled Patterns
| pattern ModelVersionStatus_ACTIVE :: ModelVersionStatus | |
| pattern ModelVersionStatus_INACTIVE :: ModelVersionStatus | |
| pattern ModelVersionStatus_TRAINING_CANCELLED :: ModelVersionStatus |
Instances
RuleExecutionMode
newtype RuleExecutionMode Source #
Constructors
| RuleExecutionMode' | |
Fields | |
Bundled Patterns
| pattern RuleExecutionMode_ALL_MATCHED :: RuleExecutionMode | |
| pattern RuleExecutionMode_FIRST_MATCHED :: RuleExecutionMode |
Instances
TrainingDataSourceEnum
newtype TrainingDataSourceEnum Source #
Constructors
| TrainingDataSourceEnum' | |
Fields | |
Bundled Patterns
| pattern TrainingDataSourceEnum_EXTERNAL_EVENTS :: TrainingDataSourceEnum | |
| pattern TrainingDataSourceEnum_INGESTED_EVENTS :: TrainingDataSourceEnum |
Instances
UnlabeledEventsTreatment
newtype UnlabeledEventsTreatment Source #
Constructors
| UnlabeledEventsTreatment' | |
Fields | |
Bundled Patterns
Instances
ATIMetricDataPoint
data ATIMetricDataPoint Source #
The Account Takeover Insights (ATI) model performance metrics data points.
See: newATIMetricDataPoint smart constructor.
Instances
newATIMetricDataPoint :: ATIMetricDataPoint Source #
Create a value of ATIMetricDataPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:adr:ATIMetricDataPoint', aTIMetricDataPoint_adr - 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.
$sel:atodr:ATIMetricDataPoint', aTIMetricDataPoint_atodr - 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.
$sel:cr:ATIMetricDataPoint', aTIMetricDataPoint_cr - 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.
$sel:threshold:ATIMetricDataPoint', aTIMetricDataPoint_threshold - 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
data ATIModelPerformance Source #
The Account Takeover Insights (ATI) model performance score.
See: newATIModelPerformance smart constructor.
Constructors
| ATIModelPerformance' (Maybe Double) |
Instances
newATIModelPerformance :: ATIModelPerformance Source #
Create a value of ATIModelPerformance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:asi:ATIModelPerformance', aTIModelPerformance_asi - 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
data ATITrainingMetricsValue Source #
The Account Takeover Insights (ATI) model training metric details.
See: newATITrainingMetricsValue smart constructor.
Constructors
| ATITrainingMetricsValue' (Maybe [ATIMetricDataPoint]) (Maybe ATIModelPerformance) |
Instances
newATITrainingMetricsValue :: ATITrainingMetricsValue Source #
Create a value of ATITrainingMetricsValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDataPoints:ATITrainingMetricsValue', aTITrainingMetricsValue_metricDataPoints - The model's performance metrics data points.
$sel:modelPerformance:ATITrainingMetricsValue', aTITrainingMetricsValue_modelPerformance - The model's overall performance scores.
AggregatedLogOddsMetric
data AggregatedLogOddsMetric Source #
The log odds metric details.
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.
See: newAggregatedLogOddsMetric smart constructor.
Constructors
| AggregatedLogOddsMetric' [Text] Double |
Instances
newAggregatedLogOddsMetric Source #
Arguments
| :: Double | |
| -> AggregatedLogOddsMetric |
Create a value of AggregatedLogOddsMetric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:variableNames:AggregatedLogOddsMetric', aggregatedLogOddsMetric_variableNames - The names of all the variables.
$sel:aggregatedVariablesImportance:AggregatedLogOddsMetric', aggregatedLogOddsMetric_aggregatedVariablesImportance - The relative importance of the variables in the list to the other event
variable.
AggregatedVariablesImpactExplanation
data AggregatedVariablesImpactExplanation Source #
The details of the impact of aggregated variables on the prediction score.
Account Takeover Insights (ATI) model uses the login data you provide to
continuously calculate a set of variables (aggregated variables) based
on historical events. For example, the 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.
See: newAggregatedVariablesImpactExplanation smart constructor.
Instances
newAggregatedVariablesImpactExplanation :: AggregatedVariablesImpactExplanation Source #
Create a value of AggregatedVariablesImpactExplanation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventVariableNames:AggregatedVariablesImpactExplanation', aggregatedVariablesImpactExplanation_eventVariableNames - The names of all the event variables that were used to derive the
aggregated variables.
$sel:logOddsImpact:AggregatedVariablesImpactExplanation', aggregatedVariablesImpactExplanation_logOddsImpact - 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.
$sel:relativeImpact:AggregatedVariablesImpactExplanation', aggregatedVariablesImpactExplanation_relativeImpact - The relative impact of the aggregated variables in terms of magnitude on
the prediction scores.
AggregatedVariablesImportanceMetrics
data AggregatedVariablesImportanceMetrics Source #
The details of the relative importance 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.
See: newAggregatedVariablesImportanceMetrics smart constructor.
Constructors
| AggregatedVariablesImportanceMetrics' (Maybe [AggregatedLogOddsMetric]) |
Instances
newAggregatedVariablesImportanceMetrics :: AggregatedVariablesImportanceMetrics Source #
Create a value of AggregatedVariablesImportanceMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logOddsMetrics:AggregatedVariablesImportanceMetrics', aggregatedVariablesImportanceMetrics_logOddsMetrics - List of variables' metrics.
BatchCreateVariableError
data BatchCreateVariableError Source #
Provides the error of the batch create variable API.
See: newBatchCreateVariableError smart constructor.
Instances
newBatchCreateVariableError :: BatchCreateVariableError Source #
Create a value of BatchCreateVariableError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:BatchCreateVariableError', batchCreateVariableError_code - The error code.
$sel:message:BatchCreateVariableError', batchCreateVariableError_message - The error message.
$sel:name:BatchCreateVariableError', batchCreateVariableError_name - The name.
BatchGetVariableError
data BatchGetVariableError Source #
Provides the error of the batch get variable API.
See: newBatchGetVariableError smart constructor.
Instances
newBatchGetVariableError :: BatchGetVariableError Source #
Create a value of BatchGetVariableError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:BatchGetVariableError', batchGetVariableError_code - The error code.
$sel:message:BatchGetVariableError', batchGetVariableError_message - The error message.
$sel:name:BatchGetVariableError', batchGetVariableError_name - The error name.
BatchImport
data BatchImport Source #
The batch import job details.
See: newBatchImport smart constructor.
Constructors
| BatchImport' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe AsyncJobStatus) (Maybe Int) |
Instances
newBatchImport :: BatchImport Source #
Create a value of BatchImport with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:BatchImport', batchImport_arn - The ARN of the batch import job.
$sel:completionTime:BatchImport', batchImport_completionTime - Timestamp of when batch import job completed.
$sel:eventTypeName:BatchImport', batchImport_eventTypeName - The name of the event type.
$sel:failedRecordsCount:BatchImport', batchImport_failedRecordsCount - The number of records that failed to import.
$sel:failureReason:BatchImport', batchImport_failureReason - The reason batch import job failed.
$sel:iamRoleArn:BatchImport', batchImport_iamRoleArn - The ARN of the IAM role to use for this job request.
$sel:inputPath:BatchImport', batchImport_inputPath - The Amazon S3 location of your data file for batch import.
$sel:jobId:BatchImport', batchImport_jobId - The ID of the batch import job.
$sel:outputPath:BatchImport', batchImport_outputPath - The Amazon S3 location of your output file.
$sel:processedRecordsCount:BatchImport', batchImport_processedRecordsCount - The number of records processed by batch import job.
$sel:startTime:BatchImport', batchImport_startTime - Timestamp of when the batch import job started.
$sel:status:BatchImport', batchImport_status - The status of the batch import job.
$sel:totalRecordsCount:BatchImport', batchImport_totalRecordsCount - The total number of records in the batch import job.
BatchPrediction
data BatchPrediction Source #
The batch prediction details.
See: newBatchPrediction smart constructor.
Constructors
| BatchPrediction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe AsyncJobStatus) (Maybe Int) |
Instances
newBatchPrediction :: BatchPrediction Source #
Create a value of BatchPrediction with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:BatchPrediction', batchPrediction_arn - The ARN of batch prediction job.
$sel:completionTime:BatchPrediction', batchPrediction_completionTime - Timestamp of when the batch prediction job completed.
$sel:detectorName:BatchPrediction', batchPrediction_detectorName - The name of the detector.
$sel:detectorVersion:BatchPrediction', batchPrediction_detectorVersion - The detector version.
$sel:eventTypeName:BatchPrediction', batchPrediction_eventTypeName - The name of the event type.
$sel:failureReason:BatchPrediction', batchPrediction_failureReason - The reason a batch prediction job failed.
$sel:iamRoleArn:BatchPrediction', batchPrediction_iamRoleArn - The ARN of the IAM role to use for this job request.
$sel:inputPath:BatchPrediction', batchPrediction_inputPath - The Amazon S3 location of your training file.
$sel:jobId:BatchPrediction', batchPrediction_jobId - The job ID for the batch prediction.
$sel:lastHeartbeatTime:BatchPrediction', batchPrediction_lastHeartbeatTime - Timestamp of most recent heartbeat indicating the batch prediction job
was making progress.
$sel:outputPath:BatchPrediction', batchPrediction_outputPath - The Amazon S3 location of your output file.
$sel:processedRecordsCount:BatchPrediction', batchPrediction_processedRecordsCount - The number of records processed by the batch prediction job.
$sel:startTime:BatchPrediction', batchPrediction_startTime - Timestamp of when the batch prediction job started.
$sel:status:BatchPrediction', batchPrediction_status - The batch prediction status.
$sel:totalRecordsCount:BatchPrediction', batchPrediction_totalRecordsCount - The total number of records in the batch prediction job.
DataValidationMetrics
data DataValidationMetrics Source #
The model training data validation metrics.
See: newDataValidationMetrics smart constructor.
Constructors
| DataValidationMetrics' (Maybe [FieldValidationMessage]) (Maybe [FileValidationMessage]) |
Instances
newDataValidationMetrics :: DataValidationMetrics Source #
Create a value of DataValidationMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldLevelMessages:DataValidationMetrics', dataValidationMetrics_fieldLevelMessages - The field-specific model training validation messages.
$sel:fileLevelMessages:DataValidationMetrics', dataValidationMetrics_fileLevelMessages - The file-specific model training data validation messages.
Detector
The detector.
See: newDetector smart constructor.
Instances
newDetector :: Detector Source #
Create a value of Detector with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Detector', detector_arn - The detector ARN.
$sel:createdTime:Detector', detector_createdTime - Timestamp of when the detector was created.
$sel:description:Detector', detector_description - The detector description.
$sel:detectorId:Detector', detector_detectorId - The detector ID.
$sel:eventTypeName:Detector', detector_eventTypeName - The name of the event type.
$sel:lastUpdatedTime:Detector', detector_lastUpdatedTime - Timestamp of when the detector was last updated.
DetectorVersionSummary
data DetectorVersionSummary Source #
The summary of the detector version.
See: newDetectorVersionSummary smart constructor.
Constructors
| DetectorVersionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DetectorVersionStatus) |
Instances
newDetectorVersionSummary :: DetectorVersionSummary Source #
Create a value of DetectorVersionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:DetectorVersionSummary', detectorVersionSummary_description - The detector version description.
$sel:detectorVersionId:DetectorVersionSummary', detectorVersionSummary_detectorVersionId - The detector version ID.
$sel:lastUpdatedTime:DetectorVersionSummary', detectorVersionSummary_lastUpdatedTime - Timestamp of when the detector version was last updated.
$sel:status:DetectorVersionSummary', detectorVersionSummary_status - The detector version status.
Entity
The entity details.
See: newEntity smart constructor.
Instances
| FromJSON Entity Source # | |
| ToJSON Entity Source # | |
Defined in Amazonka.FraudDetector.Types.Entity | |
| Generic Entity Source # | |
| Show Entity Source # | |
| NFData Entity Source # | |
Defined in Amazonka.FraudDetector.Types.Entity | |
| Eq Entity Source # | |
| Hashable Entity Source # | |
Defined in Amazonka.FraudDetector.Types.Entity | |
| type Rep Entity Source # | |
Defined in Amazonka.FraudDetector.Types.Entity type Rep Entity = D1 ('MetaData "Entity" "Amazonka.FraudDetector.Types.Entity" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "Entity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Entity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityType:Entity', entity_entityType - The entity type.
$sel:entityId:Entity', entity_entityId - The entity ID. If you do not know the entityId, you can pass
unknown, which is areserved string literal.
EntityType
data EntityType Source #
The entity type details.
See: newEntityType smart constructor.
Instances
newEntityType :: EntityType Source #
Create a value of EntityType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:EntityType', entityType_arn - The entity type ARN.
$sel:createdTime:EntityType', entityType_createdTime - Timestamp of when the entity type was created.
$sel:description:EntityType', entityType_description - The entity type description.
$sel:lastUpdatedTime:EntityType', entityType_lastUpdatedTime - Timestamp of when the entity type was last updated.
$sel:name:EntityType', entityType_name - The entity type name.
EvaluatedExternalModel
data EvaluatedExternalModel Source #
The details of the external (Amazon Sagemaker) model evaluated for generating predictions.
See: newEvaluatedExternalModel smart constructor.
Constructors
| EvaluatedExternalModel' (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe Bool) |
Instances
newEvaluatedExternalModel :: EvaluatedExternalModel Source #
Create a value of EvaluatedExternalModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputVariables:EvaluatedExternalModel', evaluatedExternalModel_inputVariables - Input variables use for generating predictions.
$sel:modelEndpoint:EvaluatedExternalModel', evaluatedExternalModel_modelEndpoint - The endpoint of the external (Amazon Sagemaker) model.
$sel:outputVariables:EvaluatedExternalModel', evaluatedExternalModel_outputVariables - Output variables.
$sel:useEventVariables:EvaluatedExternalModel', evaluatedExternalModel_useEventVariables - Indicates whether event variables were used to generate predictions.
EvaluatedModelVersion
data EvaluatedModelVersion Source #
The model version evaluated for generating prediction.
See: newEvaluatedModelVersion smart constructor.
Constructors
| EvaluatedModelVersion' (Maybe [ModelVersionEvaluation]) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEvaluatedModelVersion :: EvaluatedModelVersion Source #
Create a value of EvaluatedModelVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluations:EvaluatedModelVersion', evaluatedModelVersion_evaluations - Evaluations generated for the model version.
$sel:modelId:EvaluatedModelVersion', evaluatedModelVersion_modelId - The model ID.
$sel:modelType:EvaluatedModelVersion', evaluatedModelVersion_modelType - The model type.
Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS
$sel:modelVersion:EvaluatedModelVersion', evaluatedModelVersion_modelVersion - The model version.
EvaluatedRule
data EvaluatedRule Source #
The details of the rule used for evaluating variable values.
See: newEvaluatedRule smart constructor.
Constructors
| EvaluatedRule' (Maybe Bool) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) |
Instances
newEvaluatedRule :: EvaluatedRule Source #
Create a value of EvaluatedRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluated:EvaluatedRule', evaluatedRule_evaluated - Indicates whether the rule was evaluated.
$sel:expression:EvaluatedRule', evaluatedRule_expression - The rule expression.
$sel:expressionWithValues:EvaluatedRule', evaluatedRule_expressionWithValues - The rule expression value.
$sel:matched:EvaluatedRule', evaluatedRule_matched - Indicates whether the rule matched.
$sel:outcomes:EvaluatedRule', evaluatedRule_outcomes - The rule outcome.
$sel:ruleId:EvaluatedRule', evaluatedRule_ruleId - The rule ID.
$sel:ruleVersion:EvaluatedRule', evaluatedRule_ruleVersion - The rule version.
Event
The event details.
See: newEvent smart constructor.
Constructors
| Event' (Maybe Text) (Maybe [Sensitive Entity]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (Sensitive Text))) (Maybe Text) |
Instances
Create a value of Event with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currentLabel:Event', event_currentLabel - The label associated with the event.
$sel:entities:Event', event_entities - The event entities.
$sel:eventId:Event', event_eventId - The event ID.
$sel:eventTimestamp:Event', event_eventTimestamp - The timestamp that defines when the event under evaluation occurred. The
timestamp must be specified using ISO 8601 standard in UTC.
$sel:eventTypeName:Event', event_eventTypeName - The event type.
$sel:eventVariables:Event', event_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.
$sel:labelTimestamp:Event', event_labelTimestamp - The timestamp associated with the label to update. The timestamp must be
specified using ISO 8601 standard in UTC.
EventPredictionSummary
data EventPredictionSummary Source #
Information about the summary of an event prediction.
See: newEventPredictionSummary smart constructor.
Constructors
| EventPredictionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEventPredictionSummary :: EventPredictionSummary Source #
Create a value of EventPredictionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detectorId:EventPredictionSummary', eventPredictionSummary_detectorId - The detector ID.
$sel:detectorVersionId:EventPredictionSummary', eventPredictionSummary_detectorVersionId - The detector version ID.
$sel:eventId:EventPredictionSummary', eventPredictionSummary_eventId - The event ID.
$sel:eventTimestamp:EventPredictionSummary', eventPredictionSummary_eventTimestamp - The timestamp of the event.
$sel:eventTypeName:EventPredictionSummary', eventPredictionSummary_eventTypeName - The event type.
$sel:predictionTimestamp:EventPredictionSummary', eventPredictionSummary_predictionTimestamp - The timestamp when the prediction was generated.
EventType
The event type details.
See: newEventType smart constructor.
Constructors
| EventType' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe EventIngestion) (Maybe [Text]) (Maybe IngestedEventStatistics) (Maybe [Text]) (Maybe Text) (Maybe Text) |
Instances
newEventType :: EventType Source #
Create a value of EventType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:EventType', eventType_arn - The entity type ARN.
$sel:createdTime:EventType', eventType_createdTime - Timestamp of when the event type was created.
$sel:description:EventType', eventType_description - The event type description.
$sel:entityTypes:EventType', eventType_entityTypes - The event type entity types.
$sel:eventIngestion:EventType', eventType_eventIngestion - 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.
$sel:eventVariables:EventType', eventType_eventVariables - The event type event variables.
$sel:ingestedEventStatistics:EventType', eventType_ingestedEventStatistics - Data about the stored events.
$sel:labels:EventType', eventType_labels - The event type labels.
EventType, eventType_lastUpdatedTime - Timestamp of when the event type was last updated.
$sel:name:EventType', eventType_name - The event type name.
EventVariableSummary
data EventVariableSummary Source #
Information about the summary of an event variable that was evaluated for generating prediction.
See: newEventVariableSummary smart constructor.
Constructors
| EventVariableSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) |
Instances
newEventVariableSummary :: EventVariableSummary Source #
Create a value of EventVariableSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:EventVariableSummary', eventVariableSummary_name - The event variable name.
$sel:source:EventVariableSummary', eventVariableSummary_source - The event variable source.
$sel:value:EventVariableSummary', eventVariableSummary_value - The value of the event variable.
ExternalEventsDetail
data ExternalEventsDetail Source #
Details for the external events data used for model version training.
See: newExternalEventsDetail smart constructor.
Constructors
| ExternalEventsDetail' Text Text |
Instances
newExternalEventsDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExternalEventsDetail |
Create a value of ExternalEventsDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataLocation:ExternalEventsDetail', externalEventsDetail_dataLocation - The Amazon S3 bucket location for the data.
$sel:dataAccessRoleArn:ExternalEventsDetail', externalEventsDetail_dataAccessRoleArn - The ARN of the role that provides Amazon Fraud Detector access to the
data location.
ExternalModel
data ExternalModel Source #
The Amazon SageMaker model.
See: newExternalModel smart constructor.
Constructors
| ExternalModel' (Maybe Text) (Maybe Text) (Maybe ModelInputConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ModelEndpointStatus) (Maybe ModelSource) (Maybe ModelOutputConfiguration) |
Instances
newExternalModel :: ExternalModel Source #
Create a value of ExternalModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ExternalModel', externalModel_arn - The model ARN.
$sel:createdTime:ExternalModel', externalModel_createdTime - Timestamp of when the model was last created.
$sel:inputConfiguration:ExternalModel', externalModel_inputConfiguration - The input configuration.
$sel:invokeModelEndpointRoleArn:ExternalModel', externalModel_invokeModelEndpointRoleArn - The role used to invoke the model.
$sel:lastUpdatedTime:ExternalModel', externalModel_lastUpdatedTime - Timestamp of when the model was last updated.
$sel:modelEndpoint:ExternalModel', externalModel_modelEndpoint - The Amazon SageMaker model endpoints.
$sel:modelEndpointStatus:ExternalModel', externalModel_modelEndpointStatus - The Amazon Fraud Detector status for the external model endpoint
$sel:modelSource:ExternalModel', externalModel_modelSource - The source of the model.
$sel:outputConfiguration:ExternalModel', externalModel_outputConfiguration - The output configuration.
ExternalModelOutputs
data ExternalModelOutputs Source #
The fraud prediction scores from Amazon SageMaker model.
See: newExternalModelOutputs smart constructor.
Constructors
| ExternalModelOutputs' (Maybe ExternalModelSummary) (Maybe (HashMap Text Text)) |
Instances
newExternalModelOutputs :: ExternalModelOutputs Source #
Create a value of ExternalModelOutputs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:externalModel:ExternalModelOutputs', externalModelOutputs_externalModel - The Amazon SageMaker model.
$sel:outputs:ExternalModelOutputs', externalModelOutputs_outputs - The fraud prediction scores from Amazon SageMaker model.
ExternalModelSummary
data ExternalModelSummary Source #
The Amazon SageMaker model.
See: newExternalModelSummary smart constructor.
Constructors
| ExternalModelSummary' (Maybe Text) (Maybe ModelSource) |
Instances
newExternalModelSummary :: ExternalModelSummary Source #
Create a value of ExternalModelSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:modelEndpoint:ExternalModelSummary', externalModelSummary_modelEndpoint - The endpoint of the Amazon SageMaker model.
$sel:modelSource:ExternalModelSummary', externalModelSummary_modelSource - The source of the model.
FieldValidationMessage
data FieldValidationMessage Source #
The message details.
See: newFieldValidationMessage smart constructor.
Constructors
| FieldValidationMessage' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newFieldValidationMessage :: FieldValidationMessage Source #
Create a value of FieldValidationMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:FieldValidationMessage', fieldValidationMessage_content - The message content.
$sel:fieldName:FieldValidationMessage', fieldValidationMessage_fieldName - The field name.
$sel:identifier:FieldValidationMessage', fieldValidationMessage_identifier - The message ID.
$sel:title:FieldValidationMessage', fieldValidationMessage_title - The message title.
$sel:type':FieldValidationMessage', fieldValidationMessage_type - The message type.
FileValidationMessage
data FileValidationMessage Source #
The message details.
See: newFileValidationMessage smart constructor.
Instances
newFileValidationMessage :: FileValidationMessage Source #
Create a value of FileValidationMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:FileValidationMessage', fileValidationMessage_content - The message content.
$sel:title:FileValidationMessage', fileValidationMessage_title - The message title.
$sel:type':FileValidationMessage', fileValidationMessage_type - The message type.
FilterCondition
data FilterCondition Source #
A conditional statement for filtering a list of past predictions.
See: newFilterCondition smart constructor.
Constructors
| FilterCondition' (Maybe Text) |
Instances
newFilterCondition :: FilterCondition Source #
Create a value of FilterCondition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:FilterCondition', filterCondition_value - A statement containing a resource property and a value to specify filter
condition.
IngestedEventStatistics
data IngestedEventStatistics Source #
Data about the stored events.
See: newIngestedEventStatistics smart constructor.
Constructors
| IngestedEventStatistics' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) |
Instances
newIngestedEventStatistics :: IngestedEventStatistics Source #
Create a value of IngestedEventStatistics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventDataSizeInBytes:IngestedEventStatistics', ingestedEventStatistics_eventDataSizeInBytes - The total size of the stored events.
$sel:lastUpdatedTime:IngestedEventStatistics', ingestedEventStatistics_lastUpdatedTime - Timestamp of when the stored event was last updated.
$sel:leastRecentEvent:IngestedEventStatistics', ingestedEventStatistics_leastRecentEvent - The oldest stored event.
$sel:mostRecentEvent:IngestedEventStatistics', ingestedEventStatistics_mostRecentEvent - The newest stored event.
$sel:numberOfEvents:IngestedEventStatistics', ingestedEventStatistics_numberOfEvents - The number of stored events.
IngestedEventsDetail
data IngestedEventsDetail Source #
The details of the ingested event.
See: newIngestedEventsDetail smart constructor.
Constructors
| IngestedEventsDetail' IngestedEventsTimeWindow |
Instances
newIngestedEventsDetail Source #
Arguments
| :: IngestedEventsTimeWindow | |
| -> IngestedEventsDetail |
Create a value of IngestedEventsDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ingestedEventsTimeWindow:IngestedEventsDetail', ingestedEventsDetail_ingestedEventsTimeWindow - The start and stop time of the ingested events.
IngestedEventsTimeWindow
data IngestedEventsTimeWindow Source #
The start and stop time of the ingested events.
See: newIngestedEventsTimeWindow smart constructor.
Constructors
| IngestedEventsTimeWindow' Text Text |
Instances
newIngestedEventsTimeWindow Source #
Arguments
| :: Text | |
| -> Text | |
| -> IngestedEventsTimeWindow |
Create a value of IngestedEventsTimeWindow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:IngestedEventsTimeWindow', ingestedEventsTimeWindow_startTime - Timestamp of the first ingensted event.
$sel:endTime:IngestedEventsTimeWindow', ingestedEventsTimeWindow_endTime - Timestamp of the final ingested event.
KMSKey
The KMS key details.
See: newKMSKey smart constructor.
Instances
| FromJSON KMSKey Source # | |
| Generic KMSKey Source # | |
| Read KMSKey Source # | |
| Show KMSKey Source # | |
| NFData KMSKey Source # | |
Defined in Amazonka.FraudDetector.Types.KMSKey | |
| Eq KMSKey Source # | |
| Hashable KMSKey Source # | |
Defined in Amazonka.FraudDetector.Types.KMSKey | |
| type Rep KMSKey Source # | |
Defined in Amazonka.FraudDetector.Types.KMSKey type Rep KMSKey = D1 ('MetaData "KMSKey" "Amazonka.FraudDetector.Types.KMSKey" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "KMSKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsEncryptionKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of KMSKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsEncryptionKeyArn:KMSKey', kmsKey_kmsEncryptionKeyArn - The encryption key ARN.
Label
The label details.
See: newLabel smart constructor.
Instances
Create a value of Label with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Label', label_arn - The label ARN.
$sel:createdTime:Label', label_createdTime - Timestamp of when the event type was created.
$sel:description:Label', label_description - The label description.
$sel:lastUpdatedTime:Label', label_lastUpdatedTime - Timestamp of when the label was last updated.
$sel:name:Label', label_name - The label name.
LabelSchema
data LabelSchema Source #
The label schema.
See: newLabelSchema smart constructor.
Constructors
| LabelSchema' (Maybe (HashMap Text [Text])) (Maybe UnlabeledEventsTreatment) |
Instances
newLabelSchema :: LabelSchema Source #
Create a value of LabelSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labelMapper:LabelSchema', labelSchema_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.
$sel:unlabeledEventsTreatment:LabelSchema', labelSchema_unlabeledEventsTreatment - The action to take for unlabeled events.
LogOddsMetric
data LogOddsMetric Source #
The log odds metric details.
See: newLogOddsMetric smart constructor.
Constructors
| LogOddsMetric' Text Text Double |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Double | |
| -> LogOddsMetric |
Create a value of LogOddsMetric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:variableName:LogOddsMetric', logOddsMetric_variableName - The name of the variable.
$sel:variableType:LogOddsMetric', logOddsMetric_variableType - The type of variable.
$sel:variableImportance:LogOddsMetric', logOddsMetric_variableImportance - The relative importance of the variable. For more information, see
Model variable importance.
MetricDataPoint
data MetricDataPoint Source #
Model performance metrics data points.
See: newMetricDataPoint smart constructor.
Instances
newMetricDataPoint :: MetricDataPoint Source #
Create a value of MetricDataPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fpr:MetricDataPoint', metricDataPoint_fpr - The false positive rate. This is the percentage of total legitimate
events that are incorrectly predicted as fraud.
$sel:precision:MetricDataPoint', metricDataPoint_precision - The percentage of fraud events correctly predicted as fraudulent as
compared to all events predicted as fraudulent.
$sel:threshold:MetricDataPoint', metricDataPoint_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.
$sel:tpr:MetricDataPoint', metricDataPoint_tpr - The true positive rate. This is the percentage of total fraud the model
detects. Also known as capture rate.
Model
The model.
See: newModel smart constructor.
Constructors
| Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ModelTypeEnum) |
Instances
Create a value of Model with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Model', model_arn - The ARN of the model.
$sel:createdTime:Model', model_createdTime - Timestamp of when the model was created.
$sel:description:Model', model_description - The model description.
$sel:eventTypeName:Model', model_eventTypeName - The name of the event type.
$sel:lastUpdatedTime:Model', model_lastUpdatedTime - Timestamp of last time the model was updated.
$sel:modelId:Model', model_modelId - The model ID.
$sel:modelType:Model', model_modelType - The model type.
ModelEndpointDataBlob
data ModelEndpointDataBlob Source #
A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.
See: newModelEndpointDataBlob smart constructor.
Constructors
| ModelEndpointDataBlob' (Maybe Base64) (Maybe Text) |
Instances
newModelEndpointDataBlob :: ModelEndpointDataBlob Source #
Create a value of ModelEndpointDataBlob with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byteBuffer:ModelEndpointDataBlob', modelEndpointDataBlob_byteBuffer - 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.
$sel:contentType:ModelEndpointDataBlob', modelEndpointDataBlob_contentType - The content type of the Amazon SageMaker model endpoint input data blob.
ModelInputConfiguration
data ModelInputConfiguration Source #
The Amazon SageMaker model input configuration.
See: newModelInputConfiguration smart constructor.
Constructors
| ModelInputConfiguration' (Maybe Text) (Maybe Text) (Maybe ModelInputDataFormat) (Maybe Text) Bool |
Instances
newModelInputConfiguration Source #
Create a value of ModelInputConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:csvInputTemplate:ModelInputConfiguration', modelInputConfiguration_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.
$sel:eventTypeName:ModelInputConfiguration', modelInputConfiguration_eventTypeName - The event type name.
$sel:format:ModelInputConfiguration', modelInputConfiguration_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.
$sel:jsonInputTemplate:ModelInputConfiguration', modelInputConfiguration_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.
$sel:useEventVariables:ModelInputConfiguration', modelInputConfiguration_useEventVariables - The event variables.
ModelOutputConfiguration
data ModelOutputConfiguration Source #
Provides the Amazon Sagemaker model output configuration.
See: newModelOutputConfiguration smart constructor.
Constructors
| ModelOutputConfiguration' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) ModelOutputDataFormat |
Instances
newModelOutputConfiguration Source #
Create a value of ModelOutputConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:csvIndexToVariableMap:ModelOutputConfiguration', modelOutputConfiguration_csvIndexToVariableMap - A map of CSV index values in the SageMaker response to the Amazon Fraud
Detector variables.
$sel:jsonKeyToVariableMap:ModelOutputConfiguration', modelOutputConfiguration_jsonKeyToVariableMap - A map of JSON keys in response from SageMaker to the Amazon Fraud
Detector variables.
$sel:format:ModelOutputConfiguration', modelOutputConfiguration_format - The format of the model output configuration.
ModelScores
data ModelScores Source #
The fraud prediction scores.
See: newModelScores smart constructor.
Constructors
| ModelScores' (Maybe ModelVersion) (Maybe (HashMap Text Double)) |
Instances
newModelScores :: ModelScores Source #
Create a value of ModelScores with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:modelVersion:ModelScores', modelScores_modelVersion - The model version.
$sel:scores:ModelScores', modelScores_scores - The model's fraud prediction scores.
ModelVersion
data ModelVersion Source #
The model version.
See: newModelVersion smart constructor.
Constructors
| ModelVersion' (Maybe Text) Text ModelTypeEnum Text |
Instances
Arguments
| :: Text | |
| -> ModelTypeEnum | |
| -> Text | |
| -> ModelVersion |
Create a value of ModelVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ModelVersion', modelVersion_arn - The model version ARN.
$sel:modelId:ModelVersion', modelVersion_modelId - The model ID.
$sel:modelType:ModelVersion', modelVersion_modelType - The model type.
$sel:modelVersionNumber:ModelVersion', modelVersion_modelVersionNumber - The model version number.
ModelVersionDetail
data ModelVersionDetail Source #
The details of the model version.
See: newModelVersionDetail smart constructor.
Constructors
Instances
newModelVersionDetail :: ModelVersionDetail Source #
Create a value of ModelVersionDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ModelVersionDetail', modelVersionDetail_arn - The model version ARN.
$sel:createdTime:ModelVersionDetail', modelVersionDetail_createdTime - The timestamp when the model was created.
$sel:externalEventsDetail:ModelVersionDetail', modelVersionDetail_externalEventsDetail - The external events data details. This will be populated if the
trainingDataSource for the model version is specified as
EXTERNAL_EVENTS.
$sel:ingestedEventsDetail:ModelVersionDetail', modelVersionDetail_ingestedEventsDetail - The ingested events data details. This will be populated if the
trainingDataSource for the model version is specified as
INGESTED_EVENTS.
$sel:lastUpdatedTime:ModelVersionDetail', modelVersionDetail_lastUpdatedTime - The timestamp when the model was last updated.
$sel:modelId:ModelVersionDetail', modelVersionDetail_modelId - The model ID.
$sel:modelType:ModelVersionDetail', modelVersionDetail_modelType - The model type.
$sel:modelVersionNumber:ModelVersionDetail', modelVersionDetail_modelVersionNumber - The model version number.
$sel:status:ModelVersionDetail', modelVersionDetail_status - The status of the model version.
$sel:trainingDataSchema:ModelVersionDetail', modelVersionDetail_trainingDataSchema - The training data schema.
$sel:trainingDataSource:ModelVersionDetail', modelVersionDetail_trainingDataSource - The model version training data source.
$sel:trainingResult:ModelVersionDetail', modelVersionDetail_trainingResult - The training results.
$sel:trainingResultV2:ModelVersionDetail', modelVersionDetail_trainingResultV2 - The training result details. The details include the relative importance
of the variables.
ModelVersionEvaluation
data ModelVersionEvaluation Source #
The model version evalutions.
See: newModelVersionEvaluation smart constructor.
Constructors
| ModelVersionEvaluation' (Maybe Text) (Maybe Text) (Maybe PredictionExplanations) |
Instances
newModelVersionEvaluation :: ModelVersionEvaluation Source #
Create a value of ModelVersionEvaluation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationScore:ModelVersionEvaluation', modelVersionEvaluation_evaluationScore - The evaluation score generated for the model version.
$sel:outputVariableName:ModelVersionEvaluation', modelVersionEvaluation_outputVariableName - The output variable name.
$sel:predictionExplanations:ModelVersionEvaluation', modelVersionEvaluation_predictionExplanations - The prediction explanations generated for the model version.
OFIMetricDataPoint
data OFIMetricDataPoint Source #
The Online Fraud Insights (OFI) model performance metrics data points.
See: newOFIMetricDataPoint smart constructor.
Instances
newOFIMetricDataPoint :: OFIMetricDataPoint Source #
Create a value of OFIMetricDataPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fpr:OFIMetricDataPoint', oFIMetricDataPoint_fpr - The false positive rate. This is the percentage of total legitimate
events that are incorrectly predicted as fraud.
$sel:precision:OFIMetricDataPoint', oFIMetricDataPoint_precision - The percentage of fraud events correctly predicted as fraudulent as
compared to all events predicted as fraudulent.
$sel:threshold:OFIMetricDataPoint', oFIMetricDataPoint_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.
$sel:tpr:OFIMetricDataPoint', oFIMetricDataPoint_tpr - The true positive rate. This is the percentage of total fraud the model
detects. Also known as capture rate.
OFIModelPerformance
data OFIModelPerformance Source #
The Online Fraud Insights (OFI) model performance score.
See: newOFIModelPerformance smart constructor.
Constructors
| OFIModelPerformance' (Maybe Double) |
Instances
newOFIModelPerformance :: OFIModelPerformance Source #
Create a value of OFIModelPerformance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auc:OFIModelPerformance', oFIModelPerformance_auc - 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
data OFITrainingMetricsValue Source #
The Online Fraud Insights (OFI) model training metric details.
See: newOFITrainingMetricsValue smart constructor.
Constructors
| OFITrainingMetricsValue' (Maybe [OFIMetricDataPoint]) (Maybe OFIModelPerformance) |
Instances
newOFITrainingMetricsValue :: OFITrainingMetricsValue Source #
Create a value of OFITrainingMetricsValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDataPoints:OFITrainingMetricsValue', oFITrainingMetricsValue_metricDataPoints - The model's performance metrics data points.
$sel:modelPerformance:OFITrainingMetricsValue', oFITrainingMetricsValue_modelPerformance - The model's overall performance score.
Outcome
The outcome.
See: newOutcome smart constructor.
Instances
newOutcome :: Outcome Source #
Create a value of Outcome with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Outcome', outcome_arn - The outcome ARN.
$sel:createdTime:Outcome', outcome_createdTime - The timestamp when the outcome was created.
$sel:description:Outcome', outcome_description - The outcome description.
$sel:lastUpdatedTime:Outcome', outcome_lastUpdatedTime - The timestamp when the outcome was last updated.
$sel:name:Outcome', outcome_name - The outcome name.
PredictionExplanations
data PredictionExplanations Source #
The prediction explanations that provide insight into how each event variable impacted the model version's fraud prediction score.
See: newPredictionExplanations smart constructor.
Constructors
| PredictionExplanations' (Maybe [AggregatedVariablesImpactExplanation]) (Maybe [VariableImpactExplanation]) |
Instances
newPredictionExplanations :: PredictionExplanations Source #
Create a value of PredictionExplanations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aggregatedVariablesImpactExplanations:PredictionExplanations', predictionExplanations_aggregatedVariablesImpactExplanations - 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.
$sel:variableImpactExplanations:PredictionExplanations', predictionExplanations_variableImpactExplanations - The details of the event variable's impact on the prediction score.
PredictionTimeRange
data PredictionTimeRange Source #
The time period for when the predictions were generated.
See: newPredictionTimeRange smart constructor.
Constructors
| PredictionTimeRange' Text Text |
Instances
newPredictionTimeRange Source #
Arguments
| :: Text | |
| -> Text | |
| -> PredictionTimeRange |
Create a value of PredictionTimeRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:PredictionTimeRange', predictionTimeRange_startTime - The start time of the time period for when the predictions were
generated.
$sel:endTime:PredictionTimeRange', predictionTimeRange_endTime - The end time of the time period for when the predictions were generated.
Rule
A rule.
See: newRule smart constructor.
Instances
| FromJSON Rule Source # | |
| ToJSON Rule Source # | |
Defined in Amazonka.FraudDetector.Types.Rule | |
| Generic Rule Source # | |
| Read Rule Source # | |
| Show Rule Source # | |
| NFData Rule Source # | |
Defined in Amazonka.FraudDetector.Types.Rule | |
| Eq Rule Source # | |
| Hashable Rule Source # | |
Defined in Amazonka.FraudDetector.Types.Rule | |
| type Rep Rule Source # | |
Defined in Amazonka.FraudDetector.Types.Rule type Rep Rule = D1 ('MetaData "Rule" "Amazonka.FraudDetector.Types.Rule" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "Rule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ruleVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Rule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detectorId:Rule', rule_detectorId - The detector for which the rule is associated.
$sel:ruleId:Rule', rule_ruleId - The rule ID.
$sel:ruleVersion:Rule', rule_ruleVersion - The rule version.
RuleDetail
data RuleDetail Source #
The details of the rule.
See: newRuleDetail smart constructor.
Constructors
| RuleDetail' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Language) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) |
Instances
newRuleDetail :: RuleDetail Source #
Create a value of RuleDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:RuleDetail', ruleDetail_arn - The rule ARN.
$sel:createdTime:RuleDetail', ruleDetail_createdTime - The timestamp of when the rule was created.
$sel:description:RuleDetail', ruleDetail_description - The rule description.
$sel:detectorId:RuleDetail', ruleDetail_detectorId - The detector for which the rule is associated.
$sel:expression:RuleDetail', ruleDetail_expression - The rule expression.
$sel:language:RuleDetail', ruleDetail_language - The rule language.
$sel:lastUpdatedTime:RuleDetail', ruleDetail_lastUpdatedTime - Timestamp of the last time the rule was updated.
$sel:outcomes:RuleDetail', ruleDetail_outcomes - The rule outcomes.
$sel:ruleId:RuleDetail', ruleDetail_ruleId - The rule ID.
$sel:ruleVersion:RuleDetail', ruleDetail_ruleVersion - The rule version.
RuleResult
data RuleResult Source #
The rule results.
See: newRuleResult smart constructor.
Constructors
| RuleResult' (Maybe [Text]) (Maybe Text) |
Instances
newRuleResult :: RuleResult Source #
Create a value of RuleResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:outcomes:RuleResult', ruleResult_outcomes - The outcomes of the matched rule, based on the rule execution mode.
$sel:ruleId:RuleResult', ruleResult_ruleId - The rule ID that was matched, based on the rule execution mode.
TFIMetricDataPoint
data TFIMetricDataPoint Source #
The performance metrics data points for Transaction Fraud Insights (TFI) model.
See: newTFIMetricDataPoint smart constructor.
Instances
newTFIMetricDataPoint :: TFIMetricDataPoint Source #
Create a value of TFIMetricDataPoint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fpr:TFIMetricDataPoint', tFIMetricDataPoint_fpr - The false positive rate. This is the percentage of total legitimate
events that are incorrectly predicted as fraud.
$sel:precision:TFIMetricDataPoint', tFIMetricDataPoint_precision - The percentage of fraud events correctly predicted as fraudulent as
compared to all events predicted as fraudulent.
$sel:threshold:TFIMetricDataPoint', tFIMetricDataPoint_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.
$sel:tpr:TFIMetricDataPoint', tFIMetricDataPoint_tpr - The true positive rate. This is the percentage of total fraud the model
detects. Also known as capture rate.
TFIModelPerformance
data TFIModelPerformance Source #
The Transaction Fraud Insights (TFI) model performance score.
See: newTFIModelPerformance smart constructor.
Constructors
| TFIModelPerformance' (Maybe Double) |
Instances
newTFIModelPerformance :: TFIModelPerformance Source #
Create a value of TFIModelPerformance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auc:TFIModelPerformance', tFIModelPerformance_auc - 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
data TFITrainingMetricsValue Source #
The Transaction Fraud Insights (TFI) model training metric details.
See: newTFITrainingMetricsValue smart constructor.
Constructors
| TFITrainingMetricsValue' (Maybe [TFIMetricDataPoint]) (Maybe TFIModelPerformance) |
Instances
newTFITrainingMetricsValue :: TFITrainingMetricsValue Source #
Create a value of TFITrainingMetricsValue with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDataPoints:TFITrainingMetricsValue', tFITrainingMetricsValue_metricDataPoints - The model's performance metrics data points.
$sel:modelPerformance:TFITrainingMetricsValue', tFITrainingMetricsValue_modelPerformance - The model performance score.
Tag
A key and value pair.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.FraudDetector.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.FraudDetector.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.FraudDetector.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.FraudDetector.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.FraudDetector.Types.Tag" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - A tag key.
$sel:value:Tag', tag_value - A value assigned to a tag key.
TrainingDataSchema
data TrainingDataSchema Source #
The training data schema.
See: newTrainingDataSchema smart constructor.
Constructors
| TrainingDataSchema' (Maybe LabelSchema) [Text] |
Instances
newTrainingDataSchema :: TrainingDataSchema Source #
Create a value of TrainingDataSchema with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:labelSchema:TrainingDataSchema', trainingDataSchema_labelSchema - Undocumented member.
$sel:modelVariables:TrainingDataSchema', trainingDataSchema_modelVariables - The training data schema variables.
TrainingMetrics
data TrainingMetrics Source #
The training metric details.
See: newTrainingMetrics smart constructor.
Constructors
| TrainingMetrics' (Maybe Double) (Maybe [MetricDataPoint]) |
Instances
newTrainingMetrics :: TrainingMetrics Source #
Create a value of TrainingMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:auc:TrainingMetrics', trainingMetrics_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.
$sel:metricDataPoints:TrainingMetrics', trainingMetrics_metricDataPoints - The data points details.
TrainingMetricsV2
data TrainingMetricsV2 Source #
The training metrics details.
See: newTrainingMetricsV2 smart constructor.
Constructors
| TrainingMetricsV2' (Maybe ATITrainingMetricsValue) (Maybe OFITrainingMetricsValue) (Maybe TFITrainingMetricsValue) |
Instances
newTrainingMetricsV2 :: TrainingMetricsV2 Source #
Create a value of TrainingMetricsV2 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ati:TrainingMetricsV2', trainingMetricsV2_ati - The Account Takeover Insights (ATI) model training metric details.
$sel:ofi:TrainingMetricsV2', trainingMetricsV2_ofi - The Online Fraud Insights (OFI) model training metric details.
$sel:tfi:TrainingMetricsV2', trainingMetricsV2_tfi - The Transaction Fraud Insights (TFI) model training metric details.
TrainingResult
data TrainingResult Source #
The training result details.
See: newTrainingResult smart constructor.
Constructors
| TrainingResult' (Maybe DataValidationMetrics) (Maybe TrainingMetrics) (Maybe VariableImportanceMetrics) |
Instances
newTrainingResult :: TrainingResult Source #
Create a value of TrainingResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataValidationMetrics:TrainingResult', trainingResult_dataValidationMetrics - The validation metrics.
$sel:trainingMetrics:TrainingResult', trainingResult_trainingMetrics - The training metric details.
$sel:variableImportanceMetrics:TrainingResult', trainingResult_variableImportanceMetrics - The variable importance metrics.
TrainingResultV2
data TrainingResultV2 Source #
The training result details.
See: newTrainingResultV2 smart constructor.
Constructors
| TrainingResultV2' (Maybe AggregatedVariablesImportanceMetrics) (Maybe DataValidationMetrics) (Maybe TrainingMetricsV2) (Maybe VariableImportanceMetrics) |
Instances
newTrainingResultV2 :: TrainingResultV2 Source #
Create a value of TrainingResultV2 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aggregatedVariablesImportanceMetrics:TrainingResultV2', trainingResultV2_aggregatedVariablesImportanceMetrics - 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.
$sel:dataValidationMetrics:TrainingResultV2', trainingResultV2_dataValidationMetrics - Undocumented member.
$sel:trainingMetricsV2:TrainingResultV2', trainingResultV2_trainingMetricsV2 - The training metric details.
$sel:variableImportanceMetrics:TrainingResultV2', trainingResultV2_variableImportanceMetrics - Undocumented member.
Variable
The variable.
See: newVariable smart constructor.
Constructors
| Variable' (Maybe Text) (Maybe Text) (Maybe DataSource) (Maybe DataType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newVariable :: Variable Source #
Create a value of Variable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Variable', variable_arn - The ARN of the variable.
$sel:createdTime:Variable', variable_createdTime - The time when the variable was created.
$sel:dataSource:Variable', variable_dataSource - The data source of the variable.
$sel:dataType:Variable', variable_dataType - The data type of the variable. For more information see
Variable types.
$sel:defaultValue:Variable', variable_defaultValue - The default value of the variable.
$sel:description:Variable', variable_description - The description of the variable.
$sel:lastUpdatedTime:Variable', variable_lastUpdatedTime - The time when variable was last updated.
$sel:name:Variable', variable_name - The name of the variable.
$sel:variableType:Variable', variable_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
VariableEntry
data VariableEntry Source #
A variable in the list of variables for the batch create variable request.
See: newVariableEntry smart constructor.
Constructors
| VariableEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newVariableEntry :: VariableEntry Source #
Create a value of VariableEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:VariableEntry', variableEntry_dataSource - The data source of the variable.
$sel:dataType:VariableEntry', variableEntry_dataType - The data type of the variable.
$sel:defaultValue:VariableEntry', variableEntry_defaultValue - The default value of the variable.
$sel:description:VariableEntry', variableEntry_description - The description of the variable.
$sel:name:VariableEntry', variableEntry_name - The name of the variable.
$sel:variableType:VariableEntry', variableEntry_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
VariableImpactExplanation
data VariableImpactExplanation Source #
The details of the event variable's impact on the prediction score.
See: newVariableImpactExplanation smart constructor.
Instances
newVariableImpactExplanation :: VariableImpactExplanation Source #
Create a value of VariableImpactExplanation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventVariableName:VariableImpactExplanation', variableImpactExplanation_eventVariableName - The event variable name.
$sel:logOddsImpact:VariableImpactExplanation', variableImpactExplanation_logOddsImpact - 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.
$sel:relativeImpact:VariableImpactExplanation', variableImpactExplanation_relativeImpact - 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
data VariableImportanceMetrics Source #
The variable importance metrics details.
See: newVariableImportanceMetrics smart constructor.
Constructors
| VariableImportanceMetrics' (Maybe [LogOddsMetric]) |
Instances
newVariableImportanceMetrics :: VariableImportanceMetrics Source #
Create a value of VariableImportanceMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logOddsMetrics:VariableImportanceMetrics', variableImportanceMetrics_logOddsMetrics - List of variable metrics.