@datafire/amazonaws_frauddetector v5.0.0

@datafire/amazonaws_frauddetector

Client library for Amazon Fraud Detector

Installation and Usage

npm install --save @datafire/amazonaws_frauddetector

let amazonaws_frauddetector = require('@datafire/amazonaws_frauddetector').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

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.

Actions

BatchCreateVariable

amazonaws_frauddetector.BatchCreateVariable({
  "variableEntries": null
}, context)

Input

• input object
  • tags
    • items Tag
  • variableEntries required
    • items VariableEntry

Output

• output BatchCreateVariableResult

BatchGetVariable

amazonaws_frauddetector.BatchGetVariable({
  "names": null
}, context)

Input

• input object
  • names required
    • items string

Output

• output BatchGetVariableResult

CreateDetectorVersion

amazonaws_frauddetector.CreateDetectorVersion({
  "detectorId": null,
  "rules": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • detectorId required
  • externalModelEndpoints
    • items string
  • modelVersions
    • items ModelVersion
  • ruleExecutionMode
  • rules required
    • items Rule

Output

• output CreateDetectorVersionResult

CreateModel

amazonaws_frauddetector.CreateModel({
  "modelId": null,
  "modelType": null,
  "eventTypeName": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • eventTypeName required
  • modelId required
  • modelType required

Output

• output CreateModelResult

CreateModelVersion

amazonaws_frauddetector.CreateModelVersion({
  "modelId": null,
  "modelType": null,
  "trainingDataSource": null,
  "trainingDataSchema": null
}, context)

Input

• input object
  • tags
    • items Tag
  • externalEventsDetail
    • dataAccessRoleArn required
    • dataLocation required
  • modelId required
  • modelType required
  • trainingDataSchema required
    • labelSchema required LabelSchema
    • modelVariables required
      • items string
  • trainingDataSource required

Output

• output CreateModelVersionResult

CreateRule

amazonaws_frauddetector.CreateRule({
  "ruleId": null,
  "detectorId": null,
  "expression": null,
  "language": null,
  "outcomes": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • detectorId required
  • expression required
  • language required
  • outcomes required
    • items string
  • ruleId required

Output

• output CreateRuleResult

CreateVariable

amazonaws_frauddetector.CreateVariable({
  "name": null,
  "dataType": null,
  "dataSource": null,
  "defaultValue": null
}, context)

Input

• input object
  • tags
    • items Tag
  • dataSource required
  • dataType required
  • defaultValue required
  • description
  • name required
  • variableType

Output

• output CreateVariableResult

DeleteDetector

amazonaws_frauddetector.DeleteDetector({
  "detectorId": null
}, context)

Input

• input object
  • detectorId required

Output

• output DeleteDetectorResult

DeleteDetectorVersion

amazonaws_frauddetector.DeleteDetectorVersion({
  "detectorId": null,
  "detectorVersionId": null
}, context)

Input

• input object
  • detectorId required
  • detectorVersionId required

Output

• output DeleteDetectorVersionResult

DeleteEntityType

amazonaws_frauddetector.DeleteEntityType({
  "name": null
}, context)

Input

• input object
  • name required

Output

• output DeleteEntityTypeResult

DeleteEvent

amazonaws_frauddetector.DeleteEvent({
  "eventId": null,
  "eventTypeName": null
}, context)

Input

• input object
  • eventId required
  • eventTypeName required

Output

• output DeleteEventResult

DeleteEventType

amazonaws_frauddetector.DeleteEventType({
  "name": null
}, context)

Input

• input object
  • name required

Output

• output DeleteEventTypeResult

DeleteExternalModel

amazonaws_frauddetector.DeleteExternalModel({
  "modelEndpoint": null
}, context)

Input

• input object
  • modelEndpoint required

Output

• output DeleteExternalModelResult

DeleteLabel

amazonaws_frauddetector.DeleteLabel({
  "name": null
}, context)

Input

• input object
  • name required

Output

• output DeleteLabelResult

DeleteModel

amazonaws_frauddetector.DeleteModel({
  "modelId": null,
  "modelType": null
}, context)

Input

• input object
  • modelId required
  • modelType required

Output

• output DeleteModelResult

DeleteModelVersion

amazonaws_frauddetector.DeleteModelVersion({
  "modelId": null,
  "modelType": null,
  "modelVersionNumber": null
}, context)

Input

• input object
  • modelId required
  • modelType required
  • modelVersionNumber required

Output

• output DeleteModelVersionResult

DeleteOutcome

amazonaws_frauddetector.DeleteOutcome({
  "name": null
}, context)

Input

• input object
  • name required

Output

• output DeleteOutcomeResult

DeleteRule

amazonaws_frauddetector.DeleteRule({
  "rule": {
    "detectorId": null,
    "ruleId": null,
    "ruleVersion": null
  }
}, context)

Input

• input object
  • rule required Rule

Output

• output DeleteRuleResult

DeleteVariable

amazonaws_frauddetector.DeleteVariable({
  "name": null
}, context)

Input

• input object
  • name required

Output

• output DeleteVariableResult

DescribeDetector

amazonaws_frauddetector.DescribeDetector({
  "detectorId": null
}, context)

Input

• input object
  • detectorId required
  • maxResults
  • nextToken

Output

• output DescribeDetectorResult

DescribeModelVersions

amazonaws_frauddetector.DescribeModelVersions({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • modelId
  • modelType
  • modelVersionNumber
  • nextToken

Output

• output DescribeModelVersionsResult

GetDetectorVersion

amazonaws_frauddetector.GetDetectorVersion({
  "detectorId": null,
  "detectorVersionId": null
}, context)

Input

• input object
  • detectorId required
  • detectorVersionId required

Output

• output GetDetectorVersionResult

GetDetectors

amazonaws_frauddetector.GetDetectors({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • detectorId
  • maxResults
  • nextToken

Output

• output GetDetectorsResult

GetEntityTypes

amazonaws_frauddetector.GetEntityTypes({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • name
  • nextToken

Output

• output GetEntityTypesResult

GetEventPrediction

amazonaws_frauddetector.GetEventPrediction({
  "detectorId": null,
  "eventId": null,
  "eventTypeName": null,
  "entities": null,
  "eventTimestamp": null,
  "eventVariables": null
}, context)

Input

• input object
  • detectorId required
  • detectorVersionId
  • entities required
    • items Entity
  • eventId required
  • eventTimestamp required
  • eventTypeName required
  • eventVariables required
  • externalModelEndpointDataBlobs

Output

• output GetEventPredictionResult

GetEventTypes

amazonaws_frauddetector.GetEventTypes({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • name
  • nextToken

Output

• output GetEventTypesResult

GetExternalModels

amazonaws_frauddetector.GetExternalModels({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • modelEndpoint
  • nextToken

Output

• output GetExternalModelsResult

GetKMSEncryptionKey

amazonaws_frauddetector.GetKMSEncryptionKey({}, context)

Input

• input object

Output

• output GetKMSEncryptionKeyResult

GetLabels

amazonaws_frauddetector.GetLabels({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • name
  • nextToken

Output

• output GetLabelsResult

GetModelVersion

amazonaws_frauddetector.GetModelVersion({
  "modelId": null,
  "modelType": null,
  "modelVersionNumber": null
}, context)

Input

• input object
  • modelId required
  • modelType required
  • modelVersionNumber required

Output

• output GetModelVersionResult

GetModels

amazonaws_frauddetector.GetModels({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • modelId
  • modelType
  • nextToken

Output

• output GetModelsResult

GetOutcomes

amazonaws_frauddetector.GetOutcomes({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • name
  • nextToken

Output

• output GetOutcomesResult

GetRules

amazonaws_frauddetector.GetRules({
  "detectorId": null
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • detectorId required
  • maxResults
  • nextToken
  • ruleId
  • ruleVersion

Output

• output GetRulesResult

GetVariables

amazonaws_frauddetector.GetVariables({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • name
  • nextToken

Output

• output GetVariablesResult

ListTagsForResource

amazonaws_frauddetector.ListTagsForResource({
  "resourceARN": null
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • nextToken
  • resourceARN required

Output

• output ListTagsForResourceResult

PutDetector

amazonaws_frauddetector.PutDetector({
  "detectorId": null,
  "eventTypeName": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • detectorId required
  • eventTypeName required

Output

• output PutDetectorResult

PutEntityType

amazonaws_frauddetector.PutEntityType({
  "name": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • name required

Output

• output PutEntityTypeResult

PutEventType

amazonaws_frauddetector.PutEventType({
  "name": null,
  "eventVariables": null,
  "entityTypes": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • entityTypes required
    • items string
  • eventVariables required
    • items string
  • labels
    • items string
  • name required

Output

• output PutEventTypeResult

PutExternalModel

amazonaws_frauddetector.PutExternalModel({
  "modelEndpoint": null,
  "modelSource": null,
  "invokeModelEndpointRoleArn": null,
  "inputConfiguration": null,
  "outputConfiguration": null,
  "modelEndpointStatus": null
}, context)

Input

• input object
  • tags
    • items Tag
  • inputConfiguration required
    • csvInputTemplate
    • eventTypeName
    • format
    • jsonInputTemplate
    • useEventVariables required
  • invokeModelEndpointRoleArn required
  • modelEndpoint required
  • modelEndpointStatus required
  • modelSource required
  • outputConfiguration required
    • csvIndexToVariableMap
    • format required
    • jsonKeyToVariableMap

Output

• output PutExternalModelResult

PutKMSEncryptionKey

amazonaws_frauddetector.PutKMSEncryptionKey({
  "kmsEncryptionKeyArn": null
}, context)

Input

• input object
  • kmsEncryptionKeyArn required

Output

• output PutKMSEncryptionKeyResult

PutLabel

amazonaws_frauddetector.PutLabel({
  "name": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • name required

Output

• output PutLabelResult

PutOutcome

amazonaws_frauddetector.PutOutcome({
  "name": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • name required

Output

• output PutOutcomeResult

TagResource

amazonaws_frauddetector.TagResource({
  "resourceARN": null,
  "tags": null
}, context)

Input

• input object
  • tags required
    • items Tag
  • resourceARN required

Output

• output TagResourceResult

UntagResource

amazonaws_frauddetector.UntagResource({
  "resourceARN": null,
  "tagKeys": null
}, context)

Input

• input object
  • resourceARN required
  • tagKeys required
    • items tagKey

Output

• output UntagResourceResult

UpdateDetectorVersion

amazonaws_frauddetector.UpdateDetectorVersion({
  "detectorId": null,
  "detectorVersionId": null,
  "externalModelEndpoints": null,
  "rules": null
}, context)

Input

• input object
  • description
  • detectorId required
  • detectorVersionId required
  • externalModelEndpoints required
    • items string
  • modelVersions
    • items ModelVersion
  • ruleExecutionMode
  • rules required
    • items Rule

Output

• output UpdateDetectorVersionResult

UpdateDetectorVersionMetadata

amazonaws_frauddetector.UpdateDetectorVersionMetadata({
  "detectorId": null,
  "detectorVersionId": null,
  "description": null
}, context)

Input

• input object
  • description required
  • detectorId required
  • detectorVersionId required

Output

• output UpdateDetectorVersionMetadataResult

UpdateDetectorVersionStatus

amazonaws_frauddetector.UpdateDetectorVersionStatus({
  "detectorId": null,
  "detectorVersionId": null,
  "status": null
}, context)

Input

• input object
  • detectorId required
  • detectorVersionId required
  • status required

Output

• output UpdateDetectorVersionStatusResult

UpdateModel

amazonaws_frauddetector.UpdateModel({
  "modelId": null,
  "modelType": null
}, context)

Input

• input object
  • description
  • modelId required
  • modelType required

Output

• output UpdateModelResult

UpdateModelVersion

amazonaws_frauddetector.UpdateModelVersion({
  "modelId": null,
  "modelType": null,
  "majorVersionNumber": null
}, context)

Input

• input object
  • tags
    • items Tag
  • externalEventsDetail
    • dataAccessRoleArn required
    • dataLocation required
  • majorVersionNumber required
  • modelId required
  • modelType required

Output

• output UpdateModelVersionResult

UpdateModelVersionStatus

amazonaws_frauddetector.UpdateModelVersionStatus({
  "modelId": null,
  "modelType": null,
  "modelVersionNumber": null,
  "status": null
}, context)

Input

• input object
  • modelId required
  • modelType required
  • modelVersionNumber required
  • status required

Output

• output UpdateModelVersionStatusResult

UpdateRuleMetadata

amazonaws_frauddetector.UpdateRuleMetadata({
  "rule": null,
  "description": null
}, context)

Input

• input object
  • description required
  • rule required
    • detectorId required
    • ruleId required
    • ruleVersion required

Output

• output UpdateRuleMetadataResult

UpdateRuleVersion

amazonaws_frauddetector.UpdateRuleVersion({
  "rule": null,
  "expression": null,
  "language": null,
  "outcomes": null
}, context)

Input

• input object
  • tags
    • items Tag
  • description
  • expression required
  • language required
  • outcomes required
    • items string
  • rule required
    • detectorId required
    • ruleId required
    • ruleVersion required

Output

• output UpdateRuleVersionResult

UpdateVariable

amazonaws_frauddetector.UpdateVariable({
  "name": null
}, context)

Input

• input object
  • defaultValue
  • description
  • name required
  • variableType

Output

• output UpdateVariableResult

Definitions

AccessDeniedException

BatchCreateVariableError

• BatchCreateVariableError object: Provides the error of the batch create variable API.
  • code
  • message
  • name

BatchCreateVariableErrorList

• BatchCreateVariableErrorList array
  • items BatchCreateVariableError

BatchCreateVariableRequest

• BatchCreateVariableRequest object
  • tags
    • items Tag
  • variableEntries required
    • items VariableEntry

BatchCreateVariableResult

• BatchCreateVariableResult object
  • errors
    • items BatchCreateVariableError

BatchGetVariableError

• BatchGetVariableError object: Provides the error of the batch get variable API.
  • code
  • message
  • name

BatchGetVariableErrorList

• BatchGetVariableErrorList array
  • items BatchGetVariableError

BatchGetVariableRequest

• BatchGetVariableRequest object
  • names required
    • items string

BatchGetVariableResult

• BatchGetVariableResult object
  • errors
    • items BatchGetVariableError
  • variables
    • items Variable

ConflictException

CreateDetectorVersionRequest

• CreateDetectorVersionRequest object
  • tags
    • items Tag
  • description
  • detectorId required
  • externalModelEndpoints
    • items string
  • modelVersions
    • items ModelVersion
  • ruleExecutionMode
  • rules required
    • items Rule

CreateDetectorVersionResult

• CreateDetectorVersionResult object
  • detectorId
  • detectorVersionId
  • status

CreateModelRequest

• CreateModelRequest object
  • tags
    • items Tag
  • description
  • eventTypeName required
  • modelId required
  • modelType required

CreateModelResult

• CreateModelResult object

CreateModelVersionRequest

• CreateModelVersionRequest object
  • tags
    • items Tag
  • externalEventsDetail
    • dataAccessRoleArn required
    • dataLocation required
  • modelId required
  • modelType required
  • trainingDataSchema required
    • labelSchema required LabelSchema
    • modelVariables required
      • items string
  • trainingDataSource required

CreateModelVersionResult

• CreateModelVersionResult object
  • modelId
  • modelType
  • modelVersionNumber
  • status

CreateRuleRequest

• CreateRuleRequest object
  • tags
    • items Tag
  • description
  • detectorId required
  • expression required
  • language required
  • outcomes required
    • items string
  • ruleId required

CreateRuleResult

• CreateRuleResult object
  • rule
    • detectorId required
    • ruleId required
    • ruleVersion required

CreateVariableRequest

• CreateVariableRequest object
  • tags
    • items Tag
  • dataSource required
  • dataType required
  • defaultValue required
  • description
  • name required
  • variableType

CreateVariableResult

• CreateVariableResult object

CsvIndexToVariableMap

• CsvIndexToVariableMap object

DataSource

• DataSource string (values: EVENT, MODEL_SCORE, EXTERNAL_MODEL_SCORE)

DataType

• DataType string (values: STRING, INTEGER, FLOAT, BOOLEAN)

DataValidationMetrics

• DataValidationMetrics object: The model training validation messages.
  • fieldLevelMessages
    • items FieldValidationMessage
  • fileLevelMessages
    • items FileValidationMessage

DeleteDetectorRequest

• DeleteDetectorRequest object
  • detectorId required

DeleteDetectorResult

• DeleteDetectorResult object

DeleteDetectorVersionRequest

• DeleteDetectorVersionRequest object
  • detectorId required
  • detectorVersionId required

DeleteDetectorVersionResult

• DeleteDetectorVersionResult object

DeleteEntityTypeRequest

• DeleteEntityTypeRequest object
  • name required

DeleteEntityTypeResult

• DeleteEntityTypeResult object

DeleteEventRequest

• DeleteEventRequest object
  • eventId required
  • eventTypeName required

DeleteEventResult

• DeleteEventResult object

DeleteEventTypeRequest

• DeleteEventTypeRequest object
  • name required

DeleteEventTypeResult

• DeleteEventTypeResult object

DeleteExternalModelRequest

• DeleteExternalModelRequest object
  • modelEndpoint required

DeleteExternalModelResult

• DeleteExternalModelResult object

DeleteLabelRequest

• DeleteLabelRequest object
  • name required

DeleteLabelResult

• DeleteLabelResult object

DeleteModelRequest

• DeleteModelRequest object
  • modelId required
  • modelType required

DeleteModelResult

• DeleteModelResult object

DeleteModelVersionRequest

• DeleteModelVersionRequest object
  • modelId required
  • modelType required
  • modelVersionNumber required

DeleteModelVersionResult

• DeleteModelVersionResult object

DeleteOutcomeRequest

• DeleteOutcomeRequest object
  • name required

DeleteOutcomeResult

• DeleteOutcomeResult object

DeleteRuleRequest

• DeleteRuleRequest object
  • rule required Rule

DeleteRuleResult

• DeleteRuleResult object

DeleteVariableRequest

• DeleteVariableRequest object
  • name required

DeleteVariableResult

• DeleteVariableResult object

DescribeDetectorRequest

• DescribeDetectorRequest object
  • detectorId required
  • maxResults
  • nextToken

DescribeDetectorResult

• DescribeDetectorResult object
  • arn
  • detectorId
  • detectorVersionSummaries
    • items DetectorVersionSummary
  • nextToken

DescribeModelVersionsRequest

• DescribeModelVersionsRequest object
  • maxResults
  • modelId
  • modelType
  • modelVersionNumber
  • nextToken

DescribeModelVersionsResult

• DescribeModelVersionsResult object
  • modelVersionDetails
    • items ModelVersionDetail
  • nextToken

Detector

• Detector object: The detector.
  • arn
  • createdTime
  • description
  • detectorId
  • eventTypeName
  • lastUpdatedTime

DetectorList

• DetectorList array
  • items Detector

DetectorVersionMaxResults

• DetectorVersionMaxResults integer

DetectorVersionStatus

• DetectorVersionStatus string (values: DRAFT, ACTIVE, INACTIVE)

DetectorVersionSummary

• DetectorVersionSummary object: The summary of the detector version.
  • description
  • detectorVersionId
  • lastUpdatedTime
  • status

DetectorVersionSummaryList

• DetectorVersionSummaryList array
  • items DetectorVersionSummary

DetectorsMaxResults

• DetectorsMaxResults integer

Entity

• Entity object: The entity details.
  • entityId required
  • entityType required

EntityType

• EntityType object: The entity type details.
  • arn
  • createdTime
  • description
  • lastUpdatedTime
  • name

EventType

• EventType object: The event type details.
  • arn
  • createdTime
  • description
  • entityTypes
    • items string
  • eventVariables
    • items string
  • labels
    • items string
  • lastUpdatedTime
  • name

EventVariableMap

• EventVariableMap object

ExternalEventsDetail

• ExternalEventsDetail object: Details for the external events data used for model version training.
  • dataAccessRoleArn required
  • dataLocation required

ExternalModel

• ExternalModel object: The Amazon SageMaker model.
  • arn
  • createdTime
  • inputConfiguration
    • csvInputTemplate
    • eventTypeName
    • format
    • jsonInputTemplate
    • useEventVariables required
  • invokeModelEndpointRoleArn
  • lastUpdatedTime
  • modelEndpoint
  • modelEndpointStatus
  • modelSource
  • outputConfiguration
    • csvIndexToVariableMap
    • format required
    • jsonKeyToVariableMap

ExternalModelEndpointDataBlobMap

• ExternalModelEndpointDataBlobMap object

ExternalModelList

• ExternalModelList array
  • items ExternalModel

ExternalModelsMaxResults

• ExternalModelsMaxResults integer

FieldValidationMessage

• FieldValidationMessage object: The message details.
  • content
  • fieldName
  • identifier
  • title
  • type

FileValidationMessage

• FileValidationMessage object: The message details.
  • content
  • title
  • type

GetDetectorVersionRequest

• GetDetectorVersionRequest object
  • detectorId required
  • detectorVersionId required

GetDetectorVersionResult

• GetDetectorVersionResult object
  • arn
  • createdTime
  • description
  • detectorId
  • detectorVersionId
  • externalModelEndpoints
    • items string
  • lastUpdatedTime
  • modelVersions
    • items ModelVersion
  • ruleExecutionMode
  • rules
    • items Rule
  • status

GetDetectorsRequest

• GetDetectorsRequest object
  • detectorId
  • maxResults
  • nextToken

GetDetectorsResult

• GetDetectorsResult object
  • detectors
    • items Detector
  • nextToken

GetEntityTypesRequest

• GetEntityTypesRequest object
  • maxResults
  • name
  • nextToken

GetEntityTypesResult

• GetEntityTypesResult object
  • entityTypes
    • items EntityType
  • nextToken

GetEventPredictionRequest

• GetEventPredictionRequest object
  • detectorId required
  • detectorVersionId
  • entities required
    • items Entity
  • eventId required
  • eventTimestamp required
  • eventTypeName required
  • eventVariables required
  • externalModelEndpointDataBlobs

GetEventPredictionResult

• GetEventPredictionResult object
  • modelScores
    • items ModelScores
  • ruleResults
    • items RuleResult

GetEventTypesRequest

• GetEventTypesRequest object
  • maxResults
  • name
  • nextToken

GetEventTypesResult

• GetEventTypesResult object
  • eventTypes
    • items EventType
  • nextToken

GetExternalModelsRequest

• GetExternalModelsRequest object
  • maxResults
  • modelEndpoint
  • nextToken

GetExternalModelsResult

• GetExternalModelsResult object
  • externalModels
    • items ExternalModel
  • nextToken

GetKMSEncryptionKeyResult

• GetKMSEncryptionKeyResult object
  • kmsKey
    • kmsEncryptionKeyArn

GetLabelsRequest

• GetLabelsRequest object
  • maxResults
  • name
  • nextToken

GetLabelsResult

• GetLabelsResult object
  • labels
    • items Label
  • nextToken

GetModelVersionRequest

• GetModelVersionRequest object
  • modelId required
  • modelType required
  • modelVersionNumber required

GetModelVersionResult

• GetModelVersionResult object
  • arn
  • externalEventsDetail
    • dataAccessRoleArn required
    • dataLocation required
  • modelId
  • modelType
  • modelVersionNumber
  • status
  • trainingDataSchema
    • labelSchema required LabelSchema
    • modelVariables required
      • items string
  • trainingDataSource

GetModelsRequest

• GetModelsRequest object
  • maxResults
  • modelId
  • modelType
  • nextToken

GetModelsResult

• GetModelsResult object
  • models
    • items Model
  • nextToken

GetOutcomesRequest

• GetOutcomesRequest object
  • maxResults
  • name
  • nextToken

GetOutcomesResult

• GetOutcomesResult object
  • nextToken
  • outcomes
    • items Outcome

GetRulesRequest

• GetRulesRequest object
  • detectorId required
  • maxResults
  • nextToken
  • ruleId
  • ruleVersion

GetRulesResult

• GetRulesResult object
  • nextToken
  • ruleDetails
    • items RuleDetail

GetVariablesRequest

• GetVariablesRequest object
  • maxResults
  • name
  • nextToken

GetVariablesResult

• GetVariablesResult object
  • nextToken
  • variables
    • items Variable

InternalServerException

JsonKeyToVariableMap

• JsonKeyToVariableMap object

KMSKey

• KMSKey object: The KMS key details.
  • kmsEncryptionKeyArn

KmsEncryptionKeyArn

• KmsEncryptionKeyArn string

Label

• Label object: The label details.
  • arn
  • createdTime
  • description
  • lastUpdatedTime
  • name

LabelSchema

• LabelSchema object: The label schema.
  • labelMapper required

Language

• Language string (values: DETECTORPL)

ListOfModelScores

• ListOfModelScores array
  • items ModelScores

ListOfModelVersions

• ListOfModelVersions array
  • items ModelVersion

ListOfRuleResults

• ListOfRuleResults array
  • items RuleResult

ListOfStrings

• ListOfStrings array
  • items string

ListTagsForResourceRequest

• ListTagsForResourceRequest object
  • maxResults
  • nextToken
  • resourceARN required

ListTagsForResourceResult

• ListTagsForResourceResult object
  • tags
    • items Tag
  • nextToken

MetricDataPoint

• MetricDataPoint object: Model performance metrics data points.
  • fpr
  • precision
  • threshold
  • tpr

Model

• Model object: The model.
  • arn
  • createdTime
  • description
  • eventTypeName
  • lastUpdatedTime
  • modelId
  • modelType

ModelEndpointDataBlob

• ModelEndpointDataBlob object: 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.
  • byteBuffer
  • contentType

ModelEndpointStatus

• ModelEndpointStatus string (values: ASSOCIATED, DISSOCIATED)

ModelInputConfiguration

• ModelInputConfiguration object: The Amazon SageMaker model input configuration.
  • csvInputTemplate
  • eventTypeName
  • format
  • jsonInputTemplate
  • useEventVariables required

ModelInputDataFormat

• ModelInputDataFormat string (values: TEXT_CSV, APPLICATION_JSON)

ModelOutputConfiguration

• ModelOutputConfiguration object: Provides the Amazon Sagemaker model output configuration.
  • csvIndexToVariableMap
  • format required
  • jsonKeyToVariableMap

ModelOutputDataFormat

• ModelOutputDataFormat string (values: TEXT_CSV, APPLICATION_JSONLINES)

ModelPredictionMap

• ModelPredictionMap object

ModelScores

• ModelScores object: The fraud prediction scores.
  • modelVersion
    • arn
    • modelId required
    • modelType required
    • modelVersionNumber required
  • scores

ModelSource

• ModelSource string (values: SAGEMAKER)

ModelTypeEnum

• ModelTypeEnum string (values: ONLINE_FRAUD_INSIGHTS)

ModelVersion

• ModelVersion object: The model version.
  • arn
  • modelId required
  • modelType required
  • modelVersionNumber required

ModelVersionDetail

• ModelVersionDetail object: The details of the model version.
  • arn
  • createdTime
  • externalEventsDetail
    • dataAccessRoleArn required
    • dataLocation required
  • lastUpdatedTime
  • modelId
  • modelType
  • modelVersionNumber
  • status
  • trainingDataSchema
    • labelSchema required LabelSchema
    • modelVariables required
      • items string
  • trainingDataSource
  • trainingResult
    • dataValidationMetrics
      • fieldLevelMessages
        • items FieldValidationMessage
      • fileLevelMessages
        • items FileValidationMessage
    • trainingMetrics
      • auc
      • metricDataPoints
        • items MetricDataPoint

ModelVersionStatus

• ModelVersionStatus string (values: ACTIVE, INACTIVE)

NameList

• NameList array
  • items string

NonEmptyListOfStrings

• NonEmptyListOfStrings array
  • items string

Outcome

• Outcome object: The outcome.
  • arn
  • createdTime
  • description
  • lastUpdatedTime
  • name

OutcomeList

• OutcomeList array
  • items Outcome

OutcomesMaxResults

• OutcomesMaxResults integer

PutDetectorRequest

• PutDetectorRequest object
  • tags
    • items Tag
  • description
  • detectorId required
  • eventTypeName required

PutDetectorResult

• PutDetectorResult object

PutEntityTypeRequest

• PutEntityTypeRequest object
  • tags
    • items Tag
  • description
  • name required

PutEntityTypeResult

• PutEntityTypeResult object

PutEventTypeRequest

• PutEventTypeRequest object
  • tags
    • items Tag
  • description
  • entityTypes required
    • items string
  • eventVariables required
    • items string
  • labels
    • items string
  • name required

PutEventTypeResult

• PutEventTypeResult object

PutExternalModelRequest

• PutExternalModelRequest object
  • tags
    • items Tag
  • inputConfiguration required
    • csvInputTemplate
    • eventTypeName
    • format
    • jsonInputTemplate
    • useEventVariables required
  • invokeModelEndpointRoleArn required
  • modelEndpoint required
  • modelEndpointStatus required
  • modelSource required
  • outputConfiguration required
    • csvIndexToVariableMap
    • format required
    • jsonKeyToVariableMap

PutExternalModelResult

• PutExternalModelResult object

PutKMSEncryptionKeyRequest

• PutKMSEncryptionKeyRequest object
  • kmsEncryptionKeyArn required

PutKMSEncryptionKeyResult

• PutKMSEncryptionKeyResult object

PutLabelRequest

• PutLabelRequest object
  • tags
    • items Tag
  • description
  • name required

PutLabelResult

• PutLabelResult object

PutOutcomeRequest

• PutOutcomeRequest object
  • tags
    • items Tag
  • description
  • name required

PutOutcomeResult

• PutOutcomeResult object

ResourceNotFoundException

Rule

• Rule object: A rule.
  • detectorId required
  • ruleId required
  • ruleVersion required

RuleDetail

• RuleDetail object: The details of the rule.
  • arn
  • createdTime
  • description
  • detectorId
  • expression
  • language
  • lastUpdatedTime
  • outcomes
    • items string
  • ruleId
  • ruleVersion

RuleDetailList

• RuleDetailList array
  • items RuleDetail

RuleExecutionMode

• RuleExecutionMode string (values: ALL_MATCHED, FIRST_MATCHED)

RuleList

• RuleList array
  • items Rule

RuleResult

• RuleResult object: The rule results.
  • outcomes
    • items string
  • ruleId

RulesMaxResults

• RulesMaxResults integer

Tag

• Tag object: A key and value pair.
  • key required
  • value required

TagResourceRequest

• TagResourceRequest object
  • tags required
    • items Tag
  • resourceARN required

TagResourceResult

• TagResourceResult object

TagsMaxResults

• TagsMaxResults integer

ThrottlingException

TrainingDataSchema

• TrainingDataSchema object: The training data schema.
  • labelSchema required LabelSchema
  • modelVariables required
    • items string

TrainingDataSourceEnum

• TrainingDataSourceEnum string (values: EXTERNAL_EVENTS)

TrainingMetrics

• TrainingMetrics object: The training metric details.
  • auc
  • metricDataPoints
    • items MetricDataPoint

TrainingResult

• TrainingResult object: The training result details.
  • dataValidationMetrics
    • fieldLevelMessages
      • items FieldValidationMessage
    • fileLevelMessages
      • items FileValidationMessage
  • trainingMetrics
    • auc
    • metricDataPoints
      • items MetricDataPoint

UntagResourceRequest

• UntagResourceRequest object
  • resourceARN required
  • tagKeys required
    • items tagKey

UntagResourceResult

• UntagResourceResult object

UpdateDetectorVersionMetadataRequest

• UpdateDetectorVersionMetadataRequest object
  • description required
  • detectorId required
  • detectorVersionId required

UpdateDetectorVersionMetadataResult

• UpdateDetectorVersionMetadataResult object

UpdateDetectorVersionRequest

• UpdateDetectorVersionRequest object
  • description
  • detectorId required
  • detectorVersionId required
  • externalModelEndpoints required
    • items string
  • modelVersions
    • items ModelVersion
  • ruleExecutionMode
  • rules required
    • items Rule

UpdateDetectorVersionResult

• UpdateDetectorVersionResult object

UpdateDetectorVersionStatusRequest

• UpdateDetectorVersionStatusRequest object
  • detectorId required
  • detectorVersionId required
  • status required

UpdateDetectorVersionStatusResult

• UpdateDetectorVersionStatusResult object

UpdateModelRequest

• UpdateModelRequest object
  • description
  • modelId required
  • modelType required

UpdateModelResult

• UpdateModelResult object

UpdateModelVersionRequest

• UpdateModelVersionRequest object
  • tags
    • items Tag
  • externalEventsDetail
    • dataAccessRoleArn required
    • dataLocation required
  • majorVersionNumber required
  • modelId required
  • modelType required

UpdateModelVersionResult

• UpdateModelVersionResult object
  • modelId
  • modelType
  • modelVersionNumber
  • status

UpdateModelVersionStatusRequest

• UpdateModelVersionStatusRequest object
  • modelId required
  • modelType required
  • modelVersionNumber required
  • status required

UpdateModelVersionStatusResult

• UpdateModelVersionStatusResult object

UpdateRuleMetadataRequest

• UpdateRuleMetadataRequest object
  • description required
  • rule required
    • detectorId required
    • ruleId required
    • ruleVersion required

UpdateRuleMetadataResult

• UpdateRuleMetadataResult object

UpdateRuleVersionRequest

• UpdateRuleVersionRequest object
  • tags
    • items Tag
  • description
  • expression required
  • language required
  • outcomes required
    • items string
  • rule required
    • detectorId required
    • ruleId required
    • ruleVersion required

UpdateRuleVersionResult

• UpdateRuleVersionResult object
  • rule
    • detectorId required
    • ruleId required
    • ruleVersion required

UpdateVariableRequest

• UpdateVariableRequest object
  • defaultValue
  • description
  • name required
  • variableType

UpdateVariableResult

• UpdateVariableResult object

UseEventVariables

• UseEventVariables boolean

ValidationException

Variable

• Variable object: The variable.
  • arn
  • createdTime
  • dataSource
  • dataType
  • defaultValue
  • description
  • lastUpdatedTime
  • name
  • variableType

VariableEntry

• VariableEntry object: A variable in the list of variables for the batch create variable request.
  • dataSource
  • dataType
  • defaultValue
  • description
  • name
  • variableType

VariableEntryList

• VariableEntryList array
  • items VariableEntry

VariableList

• VariableList array
  • items Variable

VariablesMaxResults

• VariablesMaxResults integer

blob

• blob string

contentType

• contentType string

description

• description string

entityTypeList

• entityTypeList array
  • items EntityType

entityTypesMaxResults

• entityTypesMaxResults integer

eventTypeList

• eventTypeList array
  • items EventType

eventTypesMaxResults

• eventTypesMaxResults integer

fieldValidationMessageList

• fieldValidationMessageList array
  • items FieldValidationMessage

fileValidationMessageList

• fileValidationMessageList array
  • items FileValidationMessage

float

• float number

floatVersionString

• floatVersionString string

fraudDetectorArn

• fraudDetectorArn string

iamRoleArn

• iamRoleArn string

identifier

• identifier string

integer

• integer integer

labelList

• labelList array
  • items Label

labelMapper

• labelMapper object

labelsMaxResults

• labelsMaxResults integer

listOfEntities

• listOfEntities array
  • items Entity

metricDataPointsList

• metricDataPointsList array
  • items MetricDataPoint

modelIdentifier

• modelIdentifier string

modelList

• modelList array
  • items Model

modelVersionDetailList

• modelVersionDetailList array
  • items ModelVersionDetail

modelsMaxPageSize

• modelsMaxPageSize integer

nonEmptyString

• nonEmptyString string

ruleExpression

• ruleExpression string

s3BucketLocation

• s3BucketLocation string

sageMakerEndpointIdentifier

• sageMakerEndpointIdentifier string

string

• string string

tagKey

• tagKey string

tagKeyList

• tagKeyList array
  • items tagKey

tagList

• tagList array
  • items Tag

tagValue

• tagValue string

time

• time string

variableName

• variableName string

variableValue

• variableValue string

wholeNumberVersionString

• wholeNumberVersionString string