Required: Yes
externalModelEndpoints (p. 20)
The Amazon Sagemaker model endpoints to include in the detector version.
Type: Array of strings Required: No
modelVersions (p. 20)
The model versions to include in the detector version.
Type: Array of ModelVersion (p. 243) objects Required: No
ruleExecutionMode (p. 20)
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.
Type: String
Valid Values: ALL_MATCHED | FIRST_MATCHED Required: No
rules (p. 20)
The rules to include in the detector version.
Type: Array of Rule (p. 253) objects Required: Yes
tags (p. 20)
A collection of key and value pairs.
Type: Array of Tag (p. 257) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{ "detectorId": "string",
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
detectorId (p. 21)
The ID for the created version's parent detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
detectorVersionId (p. 21)
The ID for the created detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: ^([1-9][0-9]*)$
status (p. 21)
The status of the detector version.
Type: String
Valid Values: DRAFT | ACTIVE | INACTIVE
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ResourceNotFoundException
An exception indicating the specified resource was not found.
HTTP Status Code: 400 ThrottlingException
An exception indicating a throttling error.
API Version 2019-11-15 22
See Also
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateModel
Creates a model using the specified model type.
Request Syntax
{ "description": "string", "eventTypeName": "string", "modelId": "string", "modelType": "string", "tags": [
{
"key": "string", "value": "string"
} ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
description (p. 24)
The model description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No eventTypeName (p. 24)
The name of the event type.
Type: String Required: Yes modelId (p. 24)
The model ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_]+$
Required: Yes modelType (p. 24)
The model type.
Type: String
API Version 2019-11-15 24
Response Elements
Valid Values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS Required: Yes
tags (p. 24)
A collection of key and value pairs.
Type: Array of Tag (p. 257) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
An exception indicating a throttling error.
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 26
CreateModelVersion
CreateModelVersion
Creates a version of the model using the specified model type and model id.
Request Syntax
{
"externalEventsDetail": { "dataAccessRoleArn": "string", "dataLocation": "string"
},
"ingestedEventsDetail": { "ingestedEventsTimeWindow": { "endTime": "string",
"startTime": "string"
} },
"modelId": "string", "modelType": "string", "tags": [
"trainingDataSchema": { "labelSchema": { "labelMapper": {
"string" : [ "string" ] },
"unlabeledEventsTreatment": "string"
},
"modelVariables": [ "string" ] },
"trainingDataSource": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
externalEventsDetail (p. 27)
Details of the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.
Type: ExternalEventsDetail (p. 218) object Required: No
ingestedEventsDetail (p. 27)
Details of the ingested events data used for model version training. Required if trainingDataSource is INGESTED_EVENTS.
Required: No modelId (p. 27)
The model ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_]+$
Required: Yes modelType (p. 27)
The model type.
Type: String
Valid Values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS Required: Yes
tags (p. 27)
A collection of key and value pairs.
Type: Array of Tag (p. 257) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
trainingDataSchema (p. 27) The training data schema.
Type: TrainingDataSchema (p. 258) object Required: Yes
trainingDataSource (p. 27)
The training data source location in Amazon S3.
Type: String
Valid Values: EXTERNAL_EVENTS | INGESTED_EVENTS Required: Yes
Response Syntax
{ "modelId": "string", "modelType": "string",
"modelVersionNumber": "string", "status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
API Version 2019-11-15 28
Errors
The following data is returned in JSON format by the service.
modelId (p. 28) The model ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_]+$
modelType (p. 28) The model type.
Type: String
Valid Values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS modelVersionNumber (p. 28)
The model version number of the model version created.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 7.
Pattern: ^[1-9][0-9]{0,3}\.[0-9]{1,2}$
status (p. 28)
The model version status.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ResourceNotFoundException
An exception indicating the specified resource was not found.
HTTP Status Code: 400 ThrottlingException
An exception indicating a throttling error.
ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 30
CreateRule
CreateRule
Creates a rule for use with the specified detector.
Request Syntax
{ "description": "string", "detectorId": "string", "expression": "string", "language": "string", "outcomes": [ "string" ], "ruleId": "string", "tags": [
{
"key": "string", "value": "string"
} ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
description (p. 31) The rule description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No detectorId (p. 31)
The detector ID for the rule's parent detector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes expression (p. 31)
The rule expression.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
language (p. 31)
The language of the rule.
Type: String
Valid Values: DETECTORPL Required: Yes
outcomes (p. 31)
The outcome or outcomes returned when the rule expression matches.
Type: Array of strings
Array Members: Minimum number of 1 item.
Required: Yes ruleId (p. 31)
The rule ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes tags (p. 31)
A collection of key and value pairs.
Type: Array of Tag (p. 257) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{
"rule": {
"detectorId": "string", "ruleId": "string", "ruleVersion": "string"
} }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
rule (p. 32)
The created rule.
API Version 2019-11-15 32
Errors
Type: Rule (p. 253) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
An exception indicating a throttling error.
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateVariable
Creates a variable.
Request Syntax
{
"dataSource": "string", "dataType": "string", "defaultValue": "string", "description": "string", "name": "string",
"tags": [
"variableType": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
dataSource (p. 34)
The source of the data.
Type: String
Valid Values: EVENT | MODEL_SCORE | EXTERNAL_MODEL_SCORE Required: Yes
dataType (p. 34) The data type.
Type: String
Valid Values: STRING | INTEGER | FLOAT | BOOLEAN Required: Yes
defaultValue (p. 34)
The default value for the variable when no value is received.
Type: String Required: Yes description (p. 34)
The description.
Type: String
API Version 2019-11-15 34
Response Elements
Required: No name (p. 34)
The name of the variable.
Type: String Required: Yes tags (p. 34)
A collection of key and value pairs.
Type: Array of Tag (p. 257) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No variableType (p. 34)
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
Type: String Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 36
DeleteBatchImportJob
DeleteBatchImportJob
Deletes data that was batch imported to Amazon Fraud Detector.
Request Syntax
{ "jobId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
jobId (p. 37)
The ID of the batch import job to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
An exception indicating a throttling error.
ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 38
DeleteBatchPredictionJob
DeleteBatchPredictionJob
Deletes a batch prediction job.
Request Syntax
{ "jobId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
jobId (p. 39)
The ID of the batch prediction job to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
An exception indicating a throttling error.
ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 40
DeleteDetector
DeleteDetector
Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
Request Syntax
{ "detectorId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
detectorId (p. 41)
The ID of the detector to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 ConflictException
An exception indicating there was a conflict during a delete operation.
InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
An exception indicating a throttling error.
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 42
DeleteDetectorVersion
DeleteDetectorVersion
Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
Request Syntax
{ "detectorId": "string", "detectorVersionId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
detectorId (p. 43)
The ID of the parent detector for the detector version to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes
detectorVersionId (p. 43)
The ID of the detector version to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: ^([1-9][0-9]*)$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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
HTTP Status Code: 400 ConflictException
An exception indicating there was a conflict during a delete operation.
HTTP Status Code: 400 InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ResourceNotFoundException
An exception indicating the specified resource was not found.
HTTP Status Code: 400 ThrottlingException
An exception indicating a throttling error.
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
API Version 2019-11-15 44
DeleteEntityType
DeleteEntityType
Deletes an entity type.
You cannot delete an entity type that is included in an event type.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.
Request Syntax
{ "name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 267).
The request accepts the following data in JSON format.
name (p. 45)
The name of the entity type to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^[0-9a-z_-]+$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 269).
AccessDeniedException
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.
HTTP Status Code: 400 ConflictException
An exception indicating there was a conflict during a delete operation.
InternalServerException
An exception indicating an internal server error.
HTTP Status Code: 500 ThrottlingException
An exception indicating a throttling error.
HTTP Status Code: 400 ValidationException
An exception indicating a specified value is not allowed.
An exception indicating a specified value is not allowed.