Amazon Fraud Detector 2019-11-15
- Client: Aws\FraudDetector\FraudDetectorClient
- Service ID: frauddetector
- Version: 2019-11-15
This page describes the parameters and results for the operations of the Amazon Fraud Detector (2019-11-15), and shows how to use the Aws\FraudDetector\FraudDetectorClient object to call the described operations. This documentation is specific to the 2019-11-15 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchCreateVariable ( array $params = [] )
Creates a batch of variables.
- BatchGetVariable ( array $params = [] )
Gets a batch of variables.
- CancelBatchImportJob ( array $params = [] )
Cancels an in-progress batch import job.
- CancelBatchPredictionJob ( array $params = [] )
Cancels the specified batch prediction job.
- CreateBatchImportJob ( array $params = [] )
Creates a batch import job.
- CreateBatchPredictionJob ( array $params = [] )
Creates a batch prediction job.
- CreateDetectorVersion ( array $params = [] )
Creates a detector version.
- CreateList ( array $params = [] )
Creates a list.
- CreateModel ( array $params = [] )
Creates a model using the specified model type.
- CreateModelVersion ( array $params = [] )
Creates a version of the model using the specified model type and model id.
- CreateRule ( array $params = [] )
Creates a rule for use with the specified detector.
- CreateVariable ( array $params = [] )
Creates a variable.
- DeleteBatchImportJob ( array $params = [] )
Deletes the specified batch import job ID record.
- DeleteBatchPredictionJob ( array $params = [] )
Deletes a batch prediction job.
- DeleteDetector ( array $params = [] )
Deletes the detector.
- DeleteDetectorVersion ( array $params = [] )
Deletes the detector version.
- DeleteEntityType ( array $params = [] )
Deletes an entity type.
- DeleteEvent ( array $params = [] )
Deletes the specified event.
- DeleteEventType ( array $params = [] )
Deletes an event type.
- DeleteEventsByEventType ( array $params = [] )
Deletes all events of a particular event type.
- DeleteExternalModel ( array $params = [] )
Removes a SageMaker model from Amazon Fraud Detector.
- DeleteLabel ( array $params = [] )
Deletes a label.
- DeleteList ( array $params = [] )
Deletes the list, provided it is not used in a rule.
- DeleteModel ( array $params = [] )
Deletes a model.
- DeleteModelVersion ( array $params = [] )
Deletes a model version.
- DeleteOutcome ( array $params = [] )
Deletes an outcome.
- DeleteRule ( array $params = [] )
Deletes the rule.
- DeleteVariable ( array $params = [] )
Deletes a variable.
- DescribeDetector ( array $params = [] )
Gets all versions for a specified detector.
- DescribeModelVersions ( array $params = [] )
Gets all of the model versions for the specified model type or for the specified model type and model ID.
- GetBatchImportJobs ( array $params = [] )
Gets all batch import jobs or a specific job of the specified ID.
- GetBatchPredictionJobs ( array $params = [] )
Gets all batch prediction jobs or a specific job if you specify a job ID.
- GetDeleteEventsByEventTypeStatus ( array $params = [] )
Retrieves the status of a DeleteEventsByEventType action.
- GetDetectorVersion ( array $params = [] )
Gets a particular detector version.
- GetDetectors ( array $params = [] )
Gets all detectors or a single detector if a detectorId is specified.
- GetEntityTypes ( array $params = [] )
Gets all entity types or a specific entity type if a name is specified.
- GetEvent ( array $params = [] )
Retrieves details of events stored with Amazon Fraud Detector.
- GetEventPrediction ( array $params = [] )
Evaluates an event against a detector version.
- GetEventPredictionMetadata ( array $params = [] )
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
- GetEventTypes ( array $params = [] )
Gets all event types or a specific event type if name is provided.
- GetExternalModels ( array $params = [] )
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
- GetKMSEncryptionKey ( array $params = [] )
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
- GetLabels ( array $params = [] )
Gets all labels or a specific label if name is provided.
- GetListElements ( array $params = [] )
Gets all the elements in the specified list.
- GetListsMetadata ( array $params = [] )
Gets the metadata of either all the lists under the account or the specified list.
- GetModelVersion ( array $params = [] )
Gets the details of the specified model version.
- GetModels ( array $params = [] )
Gets one or more models.
- GetOutcomes ( array $params = [] )
Gets one or more outcomes.
- GetRules ( array $params = [] )
Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified.
- GetVariables ( array $params = [] )
Gets all of the variables or the specific variable.
- ListEventPredictions ( array $params = [] )
Gets a list of past predictions.
- ListTagsForResource ( array $params = [] )
Lists all tags associated with the resource.
- PutDetector ( array $params = [] )
Creates or updates a detector.
- PutEntityType ( array $params = [] )
Creates or updates an entity type.
- PutEventType ( array $params = [] )
Creates or updates an event type.
- PutExternalModel ( array $params = [] )
Creates or updates an Amazon SageMaker model endpoint.
- PutKMSEncryptionKey ( array $params = [] )
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
- PutLabel ( array $params = [] )
Creates or updates label.
- PutOutcome ( array $params = [] )
Creates or updates an outcome.
- SendEvent ( array $params = [] )
Stores events in Amazon Fraud Detector without generating fraud predictions for those events.
- TagResource ( array $params = [] )
Assigns tags to a resource.
- UntagResource ( array $params = [] )
Removes tags from a resource.
- UpdateDetectorVersion ( array $params = [] )
Updates a detector version.
- UpdateDetectorVersionMetadata ( array $params = [] )
Updates the detector version's description.
- UpdateDetectorVersionStatus ( array $params = [] )
Updates the detector version’s status.
- UpdateEventLabel ( array $params = [] )
Updates the specified event with a new label.
- UpdateList ( array $params = [] )
Updates a list.
- UpdateModel ( array $params = [] )
Updates model description.
- UpdateModelVersion ( array $params = [] )
Updates a model version.
- UpdateModelVersionStatus ( array $params = [] )
Updates the status of a model version.
- UpdateRuleMetadata ( array $params = [] )
Updates a rule's metadata.
- UpdateRuleVersion ( array $params = [] )
Updates a rule version resulting in a new rule version.
- UpdateVariable ( array $params = [] )
Updates a variable.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchCreateVariable
$result = $client->batchCreateVariable([/* ... */]); $promise = $client->batchCreateVariableAsync([/* ... */]);
Creates a batch of variables.
Parameter Syntax
$result = $client->batchCreateVariable([
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'variableEntries' => [ // REQUIRED
[
'dataSource' => '<string>',
'dataType' => '<string>',
'defaultValue' => '<string>',
'description' => '<string>',
'name' => '<string>',
'variableType' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
- variableEntries
-
- Required: Yes
- Type: Array of VariableEntry structures
The list of variables for the batch create variable request.
Result Syntax
[
'errors' => [
[
'code' => <integer>,
'message' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- errors
-
- Type: Array of BatchCreateVariableError structures
Provides the errors for the
BatchCreateVariablerequest.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
BatchGetVariable
$result = $client->batchGetVariable([/* ... */]); $promise = $client->batchGetVariableAsync([/* ... */]);
Gets a batch of variables.
Parameter Syntax
$result = $client->batchGetVariable([
'names' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- names
-
- Required: Yes
- Type: Array of strings
The list of variable names to get.
Result Syntax
[
'errors' => [
[
'code' => <integer>,
'message' => '<string>',
'name' => '<string>',
],
// ...
],
'variables' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE',
'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN|DATETIME',
'defaultValue' => '<string>',
'description' => '<string>',
'lastUpdatedTime' => '<string>',
'name' => '<string>',
'variableType' => '<string>',
],
// ...
],
]
Result Details
Members
- errors
-
- Type: Array of BatchGetVariableError structures
The errors from the request.
- variables
-
- Type: Array of Variable structures
The returned variables.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CancelBatchImportJob
$result = $client->cancelBatchImportJob([/* ... */]); $promise = $client->cancelBatchImportJobAsync([/* ... */]);
Cancels an in-progress batch import job.
Parameter Syntax
$result = $client->cancelBatchImportJob([
'jobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- jobId
-
- Required: Yes
- Type: string
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, orCOMPLETEDstate.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CancelBatchPredictionJob
$result = $client->cancelBatchPredictionJob([/* ... */]); $promise = $client->cancelBatchPredictionJobAsync([/* ... */]);
Cancels the specified batch prediction job.
Parameter Syntax
$result = $client->cancelBatchPredictionJob([
'jobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- jobId
-
- Required: Yes
- Type: string
The ID of the batch prediction job to cancel.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CreateBatchImportJob
$result = $client->createBatchImportJob([/* ... */]); $promise = $client->createBatchImportJobAsync([/* ... */]);
Creates a batch import job.
Parameter Syntax
$result = $client->createBatchImportJob([
'eventTypeName' => '<string>', // REQUIRED
'iamRoleArn' => '<string>', // REQUIRED
'inputPath' => '<string>', // REQUIRED
'jobId' => '<string>', // REQUIRED
'outputPath' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- eventTypeName
-
- Required: Yes
- Type: string
The name of the event type.
- iamRoleArn
-
- Required: Yes
- Type: string
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.
- inputPath
-
- Required: Yes
- Type: string
The URI that points to the Amazon S3 location of your data file.
- jobId
-
- Required: Yes
- Type: string
The ID of the batch import job. The ID cannot be of a past job, unless the job exists in
CREATE_FAILEDstate. - outputPath
-
- Required: Yes
- Type: string
The URI that points to the Amazon S3 location for storing your results.
- tags
-
- Type: Array of Tag structures
A collection of key-value pairs associated with this request.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CreateBatchPredictionJob
$result = $client->createBatchPredictionJob([/* ... */]); $promise = $client->createBatchPredictionJobAsync([/* ... */]);
Creates a batch prediction job.
Parameter Syntax
$result = $client->createBatchPredictionJob([
'detectorName' => '<string>', // REQUIRED
'detectorVersion' => '<string>',
'eventTypeName' => '<string>', // REQUIRED
'iamRoleArn' => '<string>', // REQUIRED
'inputPath' => '<string>', // REQUIRED
'jobId' => '<string>', // REQUIRED
'outputPath' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- detectorName
-
- Required: Yes
- Type: string
The name of the detector.
- detectorVersion
-
- Type: string
The detector version.
- eventTypeName
-
- Required: Yes
- Type: string
The name of the event type.
- iamRoleArn
-
- Required: Yes
- Type: string
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.
- inputPath
-
- Required: Yes
- Type: string
The Amazon S3 location of your training file.
- jobId
-
- Required: Yes
- Type: string
The ID of the batch prediction job.
- outputPath
-
- Required: Yes
- Type: string
The Amazon S3 location of your output file.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating the specified resource was not found.
CreateDetectorVersion
$result = $client->createDetectorVersion([/* ... */]); $promise = $client->createDetectorVersionAsync([/* ... */]);
Creates a detector version. The detector version starts in a DRAFT status.
Parameter Syntax
$result = $client->createDetectorVersion([
'description' => '<string>',
'detectorId' => '<string>', // REQUIRED
'externalModelEndpoints' => ['<string>', ...],
'modelVersions' => [
[
'arn' => '<string>',
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
],
// ...
],
'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
'rules' => [ // REQUIRED
[
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
// ...
],
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The description of the detector version.
- detectorId
-
- Required: Yes
- Type: string
The ID of the detector under which you want to create a new version.
- externalModelEndpoints
-
- Type: Array of strings
The Amazon Sagemaker model endpoints to include in the detector version.
- modelVersions
-
- Type: Array of ModelVersion structures
The model versions to include in the detector version.
- ruleExecutionMode
-
- Type: string
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. - rules
-
- Required: Yes
- Type: Array of Rule structures
The rules to include in the detector version.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[
'detectorId' => '<string>',
'detectorVersionId' => '<string>',
'status' => 'DRAFT|ACTIVE|INACTIVE',
]
Result Details
Members
- detectorId
-
- Type: string
The ID for the created version's parent detector.
- detectorVersionId
-
- Type: string
The ID for the created detector.
- status
-
- Type: string
The status of the detector version.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CreateList
$result = $client->createList([/* ... */]); $promise = $client->createListAsync([/* ... */]);
Creates a list.
List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.
Parameter Syntax
$result = $client->createList([
'description' => '<string>',
'elements' => ['<string>', ...],
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'variableType' => '<string>',
]);
Parameter Details
Members
- description
-
- Type: string
The description of the list.
- elements
-
- Type: Array of strings
The names of the elements, if providing. You can also create an empty list and add elements later using the UpdateList API.
- name
-
- Required: Yes
- Type: string
The name of the list.
- tags
-
- Type: Array of Tag structures
A collection of the key and value pairs.
- variableType
-
- Type: string
The variable type of the list. You can only assign the variable type with String data type. For more information, see Variable types.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CreateModel
$result = $client->createModel([/* ... */]); $promise = $client->createModelAsync([/* ... */]);
Creates a model using the specified model type.
Parameter Syntax
$result = $client->createModel([
'description' => '<string>',
'eventTypeName' => '<string>', // REQUIRED
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The model description.
- eventTypeName
-
- Required: Yes
- Type: string
The name of the event type.
- modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CreateModelVersion
$result = $client->createModelVersion([/* ... */]); $promise = $client->createModelVersionAsync([/* ... */]);
Creates a version of the model using the specified model type and model id.
Parameter Syntax
$result = $client->createModelVersion([
'externalEventsDetail' => [
'dataAccessRoleArn' => '<string>', // REQUIRED
'dataLocation' => '<string>', // REQUIRED
],
'ingestedEventsDetail' => [
'ingestedEventsTimeWindow' => [ // REQUIRED
'endTime' => '<string>', // REQUIRED
'startTime' => '<string>', // REQUIRED
],
],
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'trainingDataSchema' => [ // REQUIRED
'labelSchema' => [
'labelMapper' => [
'<string>' => ['<string>', ...],
// ...
],
'unlabeledEventsTreatment' => 'IGNORE|FRAUD|LEGIT|AUTO',
],
'modelVariables' => ['<string>', ...], // REQUIRED
],
'trainingDataSource' => 'EXTERNAL_EVENTS|INGESTED_EVENTS', // REQUIRED
]);
Parameter Details
Members
- externalEventsDetail
-
- Type: ExternalEventsDetail structure
Details of the external events data used for model version training. Required if
trainingDataSourceisEXTERNAL_EVENTS. - ingestedEventsDetail
-
- Type: IngestedEventsDetail structure
Details of the ingested events data used for model version training. Required if
trainingDataSourceisINGESTED_EVENTS. - modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
- trainingDataSchema
-
- Required: Yes
- Type: TrainingDataSchema structure
The training data schema.
- trainingDataSource
-
- Required: Yes
- Type: string
The training data source location in Amazon S3.
Result Syntax
[
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
'status' => '<string>',
]
Result Details
Members
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVersionNumber
-
- Type: string
The model version number of the model version created.
- status
-
- Type: string
The model version status.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
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. -
An exception indicating a throttling error.
-
An exception indicating an internal server error.
CreateRule
$result = $client->createRule([/* ... */]); $promise = $client->createRuleAsync([/* ... */]);
Creates a rule for use with the specified detector.
Parameter Syntax
$result = $client->createRule([
'description' => '<string>',
'detectorId' => '<string>', // REQUIRED
'expression' => '<string>', // REQUIRED
'language' => 'DETECTORPL', // REQUIRED
'outcomes' => ['<string>', ...], // REQUIRED
'ruleId' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The rule description.
- detectorId
-
- Required: Yes
- Type: string
The detector ID for the rule's parent detector.
- expression
-
- Required: Yes
- Type: string
The rule expression.
- language
-
- Required: Yes
- Type: string
The language of the rule.
- outcomes
-
- Required: Yes
- Type: Array of strings
The outcome or outcomes returned when the rule expression matches.
- ruleId
-
- Required: Yes
- Type: string
The rule ID.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[
'rule' => [
'detectorId' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
]
Result Details
Members
- rule
-
- Type: Rule structure
The created rule.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
CreateVariable
$result = $client->createVariable([/* ... */]); $promise = $client->createVariableAsync([/* ... */]);
Creates a variable.
Parameter Syntax
$result = $client->createVariable([
'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE', // REQUIRED
'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN|DATETIME', // REQUIRED
'defaultValue' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
'variableType' => '<string>',
]);
Parameter Details
Members
- dataSource
-
- Required: Yes
- Type: string
The source of the data.
- dataType
-
- Required: Yes
- Type: string
The data type of the variable.
- defaultValue
-
- Required: Yes
- Type: string
The default value for the variable when no value is received.
- description
-
- Type: string
The description.
- name
-
- Required: Yes
- Type: string
The name of the variable.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
- variableType
-
- Type: string
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
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteBatchImportJob
$result = $client->deleteBatchImportJob([/* ... */]); $promise = $client->deleteBatchImportJobAsync([/* ... */]);
Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.
Parameter Syntax
$result = $client->deleteBatchImportJob([
'jobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- jobId
-
- Required: Yes
- Type: string
The ID of the batch import job to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteBatchPredictionJob
$result = $client->deleteBatchPredictionJob([/* ... */]); $promise = $client->deleteBatchPredictionJobAsync([/* ... */]);
Deletes a batch prediction job.
Parameter Syntax
$result = $client->deleteBatchPredictionJob([
'jobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- jobId
-
- Required: Yes
- Type: string
The ID of the batch prediction job to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteDetector
$result = $client->deleteDetector([/* ... */]); $promise = $client->deleteDetectorAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDetector([
'detectorId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The ID of the detector to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteDetectorVersion
$result = $client->deleteDetectorVersion([/* ... */]); $promise = $client->deleteDetectorVersionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteDetectorVersion([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The ID of the parent detector for the detector version to delete.
- detectorVersionId
-
- Required: Yes
- Type: string
The ID of the detector version to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
An exception indicating there was a conflict during a delete operation.
-
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.
DeleteEntityType
$result = $client->deleteEntityType([/* ... */]); $promise = $client->deleteEntityTypeAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteEntityType([
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the entity type to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteEvent
$result = $client->deleteEvent([/* ... */]); $promise = $client->deleteEventAsync([/* ... */]);
Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.
Parameter Syntax
$result = $client->deleteEvent([
'deleteAuditHistory' => true || false,
'eventId' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- deleteAuditHistory
-
- Type: boolean
Specifies whether or not to delete any predictions associated with the event. If set to
True, - eventId
-
- Required: Yes
- Type: string
The ID of the event to delete.
- eventTypeName
-
- Required: Yes
- Type: string
The name of the event type.
Result Syntax
[]
Result Details
Errors
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating a specified value is not allowed.
DeleteEventType
$result = $client->deleteEventType([/* ... */]); $promise = $client->deleteEventTypeAsync([/* ... */]);
Deletes an event type.
You cannot delete an event type that is used in a detector or a model.
When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteEventType([
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the event type to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteEventsByEventType
$result = $client->deleteEventsByEventType([/* ... */]); $promise = $client->deleteEventsByEventTypeAsync([/* ... */]);
Deletes all events of a particular event type.
Parameter Syntax
$result = $client->deleteEventsByEventType([
'eventTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- eventTypeName
-
- Required: Yes
- Type: string
The name of the event type.
Result Syntax
[
'eventTypeName' => '<string>',
'eventsDeletionStatus' => '<string>',
]
Result Details
Members
- eventTypeName
-
- Type: string
Name of event type for which to delete the events.
- eventsDeletionStatus
-
- Type: string
The status of the delete request.
Errors
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteExternalModel
$result = $client->deleteExternalModel([/* ... */]); $promise = $client->deleteExternalModelAsync([/* ... */]);
Removes a SageMaker model from Amazon Fraud Detector.
You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
Parameter Syntax
$result = $client->deleteExternalModel([
'modelEndpoint' => '<string>', // REQUIRED
]);
Parameter Details
Members
- modelEndpoint
-
- Required: Yes
- Type: string
The endpoint of the Amazon Sagemaker model to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteLabel
$result = $client->deleteLabel([/* ... */]); $promise = $client->deleteLabelAsync([/* ... */]);
Deletes a label.
You cannot delete labels that are included in an event type in Amazon Fraud Detector.
You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.
When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteLabel([
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the label to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating a throttling error.
-
An exception indicating an internal server error.
DeleteList
$result = $client->deleteList([/* ... */]); $promise = $client->deleteListAsync([/* ... */]);
Deletes the list, provided it is not used in a rule.
When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.
Parameter Syntax
$result = $client->deleteList([
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the list to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
DeleteModel
$result = $client->deleteModel([/* ... */]); $promise = $client->deleteModelAsync([/* ... */]);
Deletes a model.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteModel([
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
]);
Parameter Details
Members
- modelId
-
- Required: Yes
- Type: string
The model ID of the model to delete.
- modelType
-
- Required: Yes
- Type: string
The model type of the model to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteModelVersion
$result = $client->deleteModelVersion([/* ... */]); $promise = $client->deleteModelVersionAsync([/* ... */]);
Deletes a model version.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteModelVersion([
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
]);
Parameter Details
Members
- modelId
-
- Required: Yes
- Type: string
The model ID of the model version to delete.
- modelType
-
- Required: Yes
- Type: string
The model type of the model version to delete.
- modelVersionNumber
-
- Required: Yes
- Type: string
The model version number of the model version to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
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. -
An exception indicating a throttling error.
-
An exception indicating there was a conflict during a delete operation.
DeleteOutcome
$result = $client->deleteOutcome([/* ... */]); $promise = $client->deleteOutcomeAsync([/* ... */]);
Deletes an outcome.
You cannot delete an outcome that is used in a rule version.
When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteOutcome([
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the outcome to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
An exception indicating there was a conflict during a delete operation.
-
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.
DeleteRule
$result = $client->deleteRule([/* ... */]); $promise = $client->deleteRuleAsync([/* ... */]);
Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.
When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteRule([
'rule' => [ // REQUIRED
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- rule
-
- Required: Yes
- Type: Rule structure
A rule.
Result Syntax
[]
Result Details
Errors
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DeleteVariable
$result = $client->deleteVariable([/* ... */]); $promise = $client->deleteVariableAsync([/* ... */]);
Deletes a variable.
You can't delete variables that are included in an event type in Amazon Fraud Detector.
Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually.
When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.
Parameter Syntax
$result = $client->deleteVariable([
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The name of the variable to delete.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DescribeDetector
$result = $client->describeDetector([/* ... */]); $promise = $client->describeDetectorAsync([/* ... */]);
Gets all versions for a specified detector.
Parameter Syntax
$result = $client->describeDetector([
'detectorId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- maxResults
-
- Type: int
The maximum number of results to return for the request.
- nextToken
-
- Type: string
The next token from the previous response.
Result Syntax
[
'arn' => '<string>',
'detectorId' => '<string>',
'detectorVersionSummaries' => [
[
'description' => '<string>',
'detectorVersionId' => '<string>',
'lastUpdatedTime' => '<string>',
'status' => 'DRAFT|ACTIVE|INACTIVE',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- arn
-
- Type: string
The detector ARN.
- detectorId
-
- Type: string
The detector ID.
- detectorVersionSummaries
-
- Type: Array of DetectorVersionSummary structures
The status and description for each detector version.
- nextToken
-
- Type: string
The next token to be used for subsequent requests.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
DescribeModelVersions
$result = $client->describeModelVersions([/* ... */]); $promise = $client->describeModelVersionsAsync([/* ... */]);
Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.
Parameter Syntax
$result = $client->describeModelVersions([
'maxResults' => <integer>,
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVersionNumber
-
- Type: string
The model version number.
- nextToken
-
- Type: string
The next token from the previous results.
Result Syntax
[
'modelVersionDetails' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'externalEventsDetail' => [
'dataAccessRoleArn' => '<string>',
'dataLocation' => '<string>',
],
'ingestedEventsDetail' => [
'ingestedEventsTimeWindow' => [
'endTime' => '<string>',
'startTime' => '<string>',
],
],
'lastUpdatedTime' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
'status' => '<string>',
'trainingDataSchema' => [
'labelSchema' => [
'labelMapper' => [
'<string>' => ['<string>', ...],
// ...
],
'unlabeledEventsTreatment' => 'IGNORE|FRAUD|LEGIT|AUTO',
],
'modelVariables' => ['<string>', ...],
],
'trainingDataSource' => 'EXTERNAL_EVENTS|INGESTED_EVENTS',
'trainingResult' => [
'dataValidationMetrics' => [
'fieldLevelMessages' => [
[
'content' => '<string>',
'fieldName' => '<string>',
'identifier' => '<string>',
'title' => '<string>',
'type' => '<string>',
],
// ...
],
'fileLevelMessages' => [
[
'content' => '<string>',
'title' => '<string>',
'type' => '<string>',
],
// ...
],
],
'trainingMetrics' => [
'auc' => <float>,
'metricDataPoints' => [
[
'fpr' => <float>,
'precision' => <float>,
'threshold' => <float>,
'tpr' => <float>,
],
// ...
],
],
'variableImportanceMetrics' => [
'logOddsMetrics' => [
[
'variableImportance' => <float>,
'variableName' => '<string>',
'variableType' => '<string>',
],
// ...
],
],
],
'trainingResultV2' => [
'aggregatedVariablesImportanceMetrics' => [
'logOddsMetrics' => [
[
'aggregatedVariablesImportance' => <float>,
'variableNames' => ['<string>', ...],
],
// ...
],
],
'dataValidationMetrics' => [
'fieldLevelMessages' => [
[
'content' => '<string>',
'fieldName' => '<string>',
'identifier' => '<string>',
'title' => '<string>',
'type' => '<string>',
],
// ...
],
'fileLevelMessages' => [
[
'content' => '<string>',
'title' => '<string>',
'type' => '<string>',
],
// ...
],
],
'trainingMetricsV2' => [
'ati' => [
'metricDataPoints' => [
[
'adr' => <float>,
'atodr' => <float>,
'cr' => <float>,
'threshold' => <float>,
],
// ...
],
'modelPerformance' => [
'asi' => <float>,
],
],
'ofi' => [
'metricDataPoints' => [
[
'fpr' => <float>,
'precision' => <float>,
'threshold' => <float>,
'tpr' => <float>,
],
// ...
],
'modelPerformance' => [
'auc' => <float>,
'uncertaintyRange' => [
'lowerBoundValue' => <float>,
'upperBoundValue' => <float>,
],
],
],
'tfi' => [
'metricDataPoints' => [
[
'fpr' => <float>,
'precision' => <float>,
'threshold' => <float>,
'tpr' => <float>,
],
// ...
],
'modelPerformance' => [
'auc' => <float>,
'uncertaintyRange' => [
'lowerBoundValue' => <float>,
'upperBoundValue' => <float>,
],
],
],
],
'variableImportanceMetrics' => [
'logOddsMetrics' => [
[
'variableImportance' => <float>,
'variableName' => '<string>',
'variableType' => '<string>',
],
// ...
],
],
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- modelVersionDetails
-
- Type: Array of ModelVersionDetail structures
The model version details.
- nextToken
-
- Type: string
The next token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetBatchImportJobs
$result = $client->getBatchImportJobs([/* ... */]); $promise = $client->getBatchImportJobsAsync([/* ... */]);
Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getBatchImportJobs([
'jobId' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- jobId
-
- Type: string
The ID of the batch import job to get.
- maxResults
-
- Type: int
The maximum number of objects to return for request.
- nextToken
-
- Type: string
The next token from the previous request.
Result Syntax
[
'batchImports' => [
[
'arn' => '<string>',
'completionTime' => '<string>',
'eventTypeName' => '<string>',
'failedRecordsCount' => <integer>,
'failureReason' => '<string>',
'iamRoleArn' => '<string>',
'inputPath' => '<string>',
'jobId' => '<string>',
'outputPath' => '<string>',
'processedRecordsCount' => <integer>,
'startTime' => '<string>',
'status' => 'IN_PROGRESS_INITIALIZING|IN_PROGRESS|CANCEL_IN_PROGRESS|CANCELED|COMPLETE|FAILED',
'totalRecordsCount' => <integer>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- batchImports
-
- Type: Array of BatchImport structures
An array containing the details of each batch import job.
- nextToken
-
- Type: string
The next token for the subsequent resquest.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetBatchPredictionJobs
$result = $client->getBatchPredictionJobs([/* ... */]); $promise = $client->getBatchPredictionJobsAsync([/* ... */]);
Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getBatchPredictionJobs([
'jobId' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- jobId
-
- Type: string
The batch prediction job for which to get the details.
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- nextToken
-
- Type: string
The next token from the previous request.
Result Syntax
[
'batchPredictions' => [
[
'arn' => '<string>',
'completionTime' => '<string>',
'detectorName' => '<string>',
'detectorVersion' => '<string>',
'eventTypeName' => '<string>',
'failureReason' => '<string>',
'iamRoleArn' => '<string>',
'inputPath' => '<string>',
'jobId' => '<string>',
'lastHeartbeatTime' => '<string>',
'outputPath' => '<string>',
'processedRecordsCount' => <integer>,
'startTime' => '<string>',
'status' => 'IN_PROGRESS_INITIALIZING|IN_PROGRESS|CANCEL_IN_PROGRESS|CANCELED|COMPLETE|FAILED',
'totalRecordsCount' => <integer>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- batchPredictions
-
- Type: Array of BatchPrediction structures
An array containing the details of each batch prediction job.
- nextToken
-
- Type: string
The next token for the subsequent request.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetDeleteEventsByEventTypeStatus
$result = $client->getDeleteEventsByEventTypeStatus([/* ... */]); $promise = $client->getDeleteEventsByEventTypeStatusAsync([/* ... */]);
Retrieves the status of a DeleteEventsByEventType action.
Parameter Syntax
$result = $client->getDeleteEventsByEventTypeStatus([
'eventTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- eventTypeName
-
- Required: Yes
- Type: string
Name of event type for which to get the deletion status.
Result Syntax
[
'eventTypeName' => '<string>',
'eventsDeletionStatus' => 'IN_PROGRESS_INITIALIZING|IN_PROGRESS|CANCEL_IN_PROGRESS|CANCELED|COMPLETE|FAILED',
]
Result Details
Members
- eventTypeName
-
- Type: string
The event type name.
- eventsDeletionStatus
-
- Type: string
The deletion status.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetDetectorVersion
$result = $client->getDetectorVersion([/* ... */]); $promise = $client->getDetectorVersionAsync([/* ... */]);
Gets a particular detector version.
Parameter Syntax
$result = $client->getDetectorVersion([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- detectorVersionId
-
- Required: Yes
- Type: string
The detector version ID.
Result Syntax
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'detectorId' => '<string>',
'detectorVersionId' => '<string>',
'externalModelEndpoints' => ['<string>', ...],
'lastUpdatedTime' => '<string>',
'modelVersions' => [
[
'arn' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
],
// ...
],
'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
'rules' => [
[
'detectorId' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
// ...
],
'status' => 'DRAFT|ACTIVE|INACTIVE',
]
Result Details
Members
- arn
-
- Type: string
The detector version ARN.
- createdTime
-
- Type: string
The timestamp when the detector version was created.
- description
-
- Type: string
The detector version description.
- detectorId
-
- Type: string
The detector ID.
- detectorVersionId
-
- Type: string
The detector version ID.
- externalModelEndpoints
-
- Type: Array of strings
The Amazon SageMaker model endpoints included in the detector version.
- lastUpdatedTime
-
- Type: string
The timestamp when the detector version was last updated.
- modelVersions
-
- Type: Array of ModelVersion structures
The model versions included in the detector version.
- ruleExecutionMode
-
- Type: string
The execution mode of the rule in the dectector
FIRST_MATCHEDindicates 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_MATCHEDindicates 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. - rules
-
- Type: Array of Rule structures
The rules included in the detector version.
- status
-
- Type: string
The status of the detector version.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetDetectors
$result = $client->getDetectors([/* ... */]); $promise = $client->getDetectorsAsync([/* ... */]);
Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getDetectors([
'detectorId' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- detectorId
-
- Type: string
The detector ID.
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'detectors' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'detectorId' => '<string>',
'eventTypeName' => '<string>',
'lastUpdatedTime' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- detectors
-
- Type: Array of Detector structures
The detectors.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetEntityTypes
$result = $client->getEntityTypes([/* ... */]); $promise = $client->getEntityTypesAsync([/* ... */]);
Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getEntityTypes([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- name
-
- Type: string
The name.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'entityTypes' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'lastUpdatedTime' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entityTypes
-
- Type: Array of EntityType structures
An array of entity types.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetEvent
$result = $client->getEvent([/* ... */]); $promise = $client->getEventAsync([/* ... */]);
Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
Parameter Syntax
$result = $client->getEvent([
'eventId' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- eventId
-
- Required: Yes
- Type: string
The ID of the event to retrieve.
- eventTypeName
-
- Required: Yes
- Type: string
The event type of the event to retrieve.
Result Syntax
[
'event' => [
'currentLabel' => '<string>',
'entities' => [
[
'entityId' => '<string>',
'entityType' => '<string>',
],
// ...
],
'eventId' => '<string>',
'eventTimestamp' => '<string>',
'eventTypeName' => '<string>',
'eventVariables' => ['<string>', ...],
'labelTimestamp' => '<string>',
],
]
Result Details
Members
- event
-
- Type: Event structure
The details of the event.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetEventPrediction
$result = $client->getEventPrediction([/* ... */]); $promise = $client->getEventPredictionAsync([/* ... */]);
Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
Parameter Syntax
$result = $client->getEventPrediction([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>',
'entities' => [ // REQUIRED
[
'entityId' => '<string>', // REQUIRED
'entityType' => '<string>', // REQUIRED
],
// ...
],
'eventId' => '<string>', // REQUIRED
'eventTimestamp' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
'eventVariables' => ['<string>', ...], // REQUIRED
'externalModelEndpointDataBlobs' => [
'<sageMakerEndpointIdentifier>' => [
'byteBuffer' => <string || resource || Psr\Http\Message\StreamInterface>,
'contentType' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- detectorVersionId
-
- Type: string
The detector version ID.
- entities
-
- Required: Yes
- Type: Array of Entity structures
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."
- eventId
-
- Required: Yes
- Type: string
The unique ID used to identify the event.
- eventTimestamp
-
- Required: Yes
- Type: string
Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
- eventTypeName
-
- Required: Yes
- Type: string
The event type associated with the detector specified for the prediction.
- eventVariables
-
- Required: Yes
- Type: Associative array of custom strings keys (variableName) to strings
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.
- externalModelEndpointDataBlobs
-
- Type: Associative array of custom strings keys (sageMakerEndpointIdentifier) to ModelEndpointDataBlob structures
The Amazon SageMaker model endpoint input data blobs.
Result Syntax
[
'externalModelOutputs' => [
[
'externalModel' => [
'modelEndpoint' => '<string>',
'modelSource' => 'SAGEMAKER',
],
'outputs' => ['<string>', ...],
],
// ...
],
'modelScores' => [
[
'modelVersion' => [
'arn' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
],
'scores' => [<float>, ...],
],
// ...
],
'ruleResults' => [
[
'outcomes' => ['<string>', ...],
'ruleId' => '<string>',
],
// ...
],
]
Result Details
Members
- externalModelOutputs
-
- Type: Array of ExternalModelOutputs structures
The model scores for Amazon SageMaker models.
- modelScores
-
- Type: Array of ModelScores structures
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.
- ruleResults
-
- Type: Array of RuleResult structures
The results from the rules.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
-
An exception indicating that the attached customer-owned (external) model threw an exception when Amazon Fraud Detector invoked the model.
GetEventPredictionMetadata
$result = $client->getEventPredictionMetadata([/* ... */]); $promise = $client->getEventPredictionMetadataAsync([/* ... */]);
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
Parameter Syntax
$result = $client->getEventPredictionMetadata([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
'eventId' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
'predictionTimestamp' => '<string>', // REQUIRED
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- detectorVersionId
-
- Required: Yes
- Type: string
The detector version ID.
- eventId
-
- Required: Yes
- Type: string
The event ID.
- eventTypeName
-
- Required: Yes
- Type: string
The event type associated with the detector specified for the prediction.
- predictionTimestamp
-
- Required: Yes
- Type: string
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
predictionTimestampvalue in the response to provide an accurate prediction timestamp value.
Result Syntax
[
'detectorId' => '<string>',
'detectorVersionId' => '<string>',
'detectorVersionStatus' => '<string>',
'entityId' => '<string>',
'entityType' => '<string>',
'evaluatedExternalModels' => [
[
'inputVariables' => ['<string>', ...],
'modelEndpoint' => '<string>',
'outputVariables' => ['<string>', ...],
'useEventVariables' => true || false,
],
// ...
],
'evaluatedModelVersions' => [
[
'evaluations' => [
[
'evaluationScore' => '<string>',
'outputVariableName' => '<string>',
'predictionExplanations' => [
'aggregatedVariablesImpactExplanations' => [
[
'eventVariableNames' => ['<string>', ...],
'logOddsImpact' => <float>,
'relativeImpact' => '<string>',
],
// ...
],
'variableImpactExplanations' => [
[
'eventVariableName' => '<string>',
'logOddsImpact' => <float>,
'relativeImpact' => '<string>',
],
// ...
],
],
],
// ...
],
'modelId' => '<string>',
'modelType' => '<string>',
'modelVersion' => '<string>',
],
// ...
],
'eventId' => '<string>',
'eventTimestamp' => '<string>',
'eventTypeName' => '<string>',
'eventVariables' => [
[
'name' => '<string>',
'source' => '<string>',
'value' => '<string>',
],
// ...
],
'outcomes' => ['<string>', ...],
'predictionTimestamp' => '<string>',
'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
'rules' => [
[
'evaluated' => true || false,
'expression' => '<string>',
'expressionWithValues' => '<string>',
'matched' => true || false,
'outcomes' => ['<string>', ...],
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
// ...
],
]
Result Details
Members
- detectorId
-
- Type: string
The detector ID.
- detectorVersionId
-
- Type: string
The detector version ID.
- detectorVersionStatus
-
- Type: string
The status of the detector version.
- entityId
-
- Type: string
The entity ID.
- entityType
-
- Type: string
The entity type.
- evaluatedExternalModels
-
- Type: Array of EvaluatedExternalModel structures
External (Amazon SageMaker) models that were evaluated for generating predictions.
- evaluatedModelVersions
-
- Type: Array of EvaluatedModelVersion structures
Model versions that were evaluated for generating predictions.
- eventId
-
- Type: string
The event ID.
- eventTimestamp
-
- Type: string
The timestamp for when the prediction was generated for the associated event ID.
- eventTypeName
-
- Type: string
The event type associated with the detector specified for this prediction.
- eventVariables
-
- Type: Array of EventVariableSummary structures
A list of event variables that influenced the prediction scores.
- outcomes
-
- Type: Array of strings
The outcomes of the matched rule, based on the rule execution mode.
- predictionTimestamp
-
- Type: string
The timestamp that defines when the prediction was generated.
- ruleExecutionMode
-
- Type: string
The execution mode of the rule used for evaluating variable values.
- rules
-
- Type: Array of EvaluatedRule structures
List of rules associated with the detector version that were used for evaluating variable values.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
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. -
An exception indicating a throttling error.
-
An exception indicating an internal server error.
GetEventTypes
$result = $client->getEventTypes([/* ... */]); $promise = $client->getEventTypesAsync([/* ... */]);
Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getEventTypes([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- name
-
- Type: string
The name.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'eventTypes' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'entityTypes' => ['<string>', ...],
'eventIngestion' => 'ENABLED|DISABLED',
'eventOrchestration' => [
'eventBridgeEnabled' => true || false,
],
'eventVariables' => ['<string>', ...],
'ingestedEventStatistics' => [
'eventDataSizeInBytes' => <integer>,
'lastUpdatedTime' => '<string>',
'leastRecentEvent' => '<string>',
'mostRecentEvent' => '<string>',
'numberOfEvents' => <integer>,
],
'labels' => ['<string>', ...],
'lastUpdatedTime' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- eventTypes
-
- Type: Array of EventType structures
An array of event types.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetExternalModels
$result = $client->getExternalModels([/* ... */]); $promise = $client->getExternalModelsAsync([/* ... */]);
Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getExternalModels([
'maxResults' => <integer>,
'modelEndpoint' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- modelEndpoint
-
- Type: string
The Amazon SageMaker model endpoint.
- nextToken
-
- Type: string
The next page token for the request.
Result Syntax
[
'externalModels' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'inputConfiguration' => [
'csvInputTemplate' => '<string>',
'eventTypeName' => '<string>',
'format' => 'TEXT_CSV|APPLICATION_JSON',
'jsonInputTemplate' => '<string>',
'useEventVariables' => true || false,
],
'invokeModelEndpointRoleArn' => '<string>',
'lastUpdatedTime' => '<string>',
'modelEndpoint' => '<string>',
'modelEndpointStatus' => 'ASSOCIATED|DISSOCIATED',
'modelSource' => 'SAGEMAKER',
'outputConfiguration' => [
'csvIndexToVariableMap' => ['<string>', ...],
'format' => 'TEXT_CSV|APPLICATION_JSONLINES',
'jsonKeyToVariableMap' => ['<string>', ...],
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- externalModels
-
- Type: Array of ExternalModel structures
Gets the Amazon SageMaker models.
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetKMSEncryptionKey
$result = $client->getKMSEncryptionKey([/* ... */]); $promise = $client->getKMSEncryptionKeyAsync([/* ... */]);
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
Parameter Syntax
$result = $client->getKMSEncryptionKey([ ]);
Parameter Details
Members
Result Syntax
[
'kmsKey' => [
'kmsEncryptionKeyArn' => '<string>',
],
]
Result Details
Members
- kmsKey
-
- Type: KMSKey structure
The KMS encryption key.
Errors
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetLabels
$result = $client->getLabels([/* ... */]); $promise = $client->getLabelsAsync([/* ... */]);
Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getLabels([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- name
-
- Type: string
The name of the label or labels to get.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'labels' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'lastUpdatedTime' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- labels
-
- Type: Array of Label structures
An array of labels.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetListElements
$result = $client->getListElements([/* ... */]); $promise = $client->getListElementsAsync([/* ... */]);
Gets all the elements in the specified list.
Parameter Syntax
$result = $client->getListElements([
'maxResults' => <integer>,
'name' => '<string>', // REQUIRED
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- name
-
- Required: Yes
- Type: string
The name of the list.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'elements' => ['<string>', ...],
'nextToken' => '<string>',
]
Result Details
Members
- elements
-
- Type: Array of strings
The list elements.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetListsMetadata
$result = $client->getListsMetadata([/* ... */]); $promise = $client->getListsMetadataAsync([/* ... */]);
Gets the metadata of either all the lists under the account or the specified list.
Parameter Syntax
$result = $client->getListsMetadata([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- name
-
- Type: string
The name of the list.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'lists' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'name' => '<string>',
'updatedTime' => '<string>',
'variableType' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- lists
-
- Type: Array of AllowDenyList structures
The metadata of the specified list or all lists under the account.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetModelVersion
$result = $client->getModelVersion([/* ... */]); $promise = $client->getModelVersionAsync([/* ... */]);
Gets the details of the specified model version.
Parameter Syntax
$result = $client->getModelVersion([
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
]);
Parameter Details
Members
- modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
- modelVersionNumber
-
- Required: Yes
- Type: string
The model version number.
Result Syntax
[
'arn' => '<string>',
'externalEventsDetail' => [
'dataAccessRoleArn' => '<string>',
'dataLocation' => '<string>',
],
'ingestedEventsDetail' => [
'ingestedEventsTimeWindow' => [
'endTime' => '<string>',
'startTime' => '<string>',
],
],
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
'status' => '<string>',
'trainingDataSchema' => [
'labelSchema' => [
'labelMapper' => [
'<string>' => ['<string>', ...],
// ...
],
'unlabeledEventsTreatment' => 'IGNORE|FRAUD|LEGIT|AUTO',
],
'modelVariables' => ['<string>', ...],
],
'trainingDataSource' => 'EXTERNAL_EVENTS|INGESTED_EVENTS',
]
Result Details
Members
- arn
-
- Type: string
The model version ARN.
- externalEventsDetail
-
- Type: ExternalEventsDetail structure
The details of the external events data used for training the model version. This will be populated if the
trainingDataSourceisEXTERNAL_EVENTS - ingestedEventsDetail
-
- Type: IngestedEventsDetail structure
The details of the ingested events data used for training the model version. This will be populated if the
trainingDataSourceisINGESTED_EVENTS. - modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVersionNumber
-
- Type: string
The model version number.
- status
-
- Type: string
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
- trainingDataSchema
-
- Type: TrainingDataSchema structure
The training data schema.
- trainingDataSource
-
- Type: string
The training data source.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetModels
$result = $client->getModels([/* ... */]); $promise = $client->getModelsAsync([/* ... */]);
Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.
This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getModels([
'maxResults' => <integer>,
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- nextToken
-
- Type: string
The next token for the subsequent request.
Result Syntax
[
'models' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'eventTypeName' => '<string>',
'lastUpdatedTime' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- models
-
- Type: Array of Model structures
The array of models.
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetOutcomes
$result = $client->getOutcomes([/* ... */]); $promise = $client->getOutcomesAsync([/* ... */]);
Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getOutcomes([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- name
-
- Type: string
The name of the outcome or outcomes to get.
- nextToken
-
- Type: string
The next page token for the request.
Result Syntax
[
'nextToken' => '<string>',
'outcomes' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'lastUpdatedTime' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The next page token for subsequent requests.
- outcomes
-
- Type: Array of Outcome structures
The outcomes.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetRules
$result = $client->getRules([/* ... */]); $promise = $client->getRulesAsync([/* ... */]);
Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified.
This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getRules([
'detectorId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- maxResults
-
- Type: int
The maximum number of rules to return for the request.
- nextToken
-
- Type: string
The next page token.
- ruleId
-
- Type: string
The rule ID.
- ruleVersion
-
- Type: string
The rule version.
Result Syntax
[
'nextToken' => '<string>',
'ruleDetails' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'description' => '<string>',
'detectorId' => '<string>',
'expression' => '<string>',
'language' => 'DETECTORPL',
'lastUpdatedTime' => '<string>',
'outcomes' => ['<string>', ...],
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
- ruleDetails
-
- Type: Array of RuleDetail structures
The details of the requested rule.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
GetVariables
$result = $client->getVariables([/* ... */]); $promise = $client->getVariablesAsync([/* ... */]);
Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getVariables([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The max size per page determined for the get variable request.
- name
-
- Type: string
The name of the variable.
- nextToken
-
- Type: string
The next page token of the get variable request.
Result Syntax
[
'nextToken' => '<string>',
'variables' => [
[
'arn' => '<string>',
'createdTime' => '<string>',
'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE',
'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN|DATETIME',
'defaultValue' => '<string>',
'description' => '<string>',
'lastUpdatedTime' => '<string>',
'name' => '<string>',
'variableType' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
- variables
-
- Type: Array of Variable structures
The names of the variables returned.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
ListEventPredictions
$result = $client->listEventPredictions([/* ... */]); $promise = $client->listEventPredictionsAsync([/* ... */]);
Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.
For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” }
This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.
Parameter Syntax
$result = $client->listEventPredictions([
'detectorId' => [
'value' => '<string>',
],
'detectorVersionId' => [
'value' => '<string>',
],
'eventId' => [
'value' => '<string>',
],
'eventType' => [
'value' => '<string>',
],
'maxResults' => <integer>,
'nextToken' => '<string>',
'predictionTimeRange' => [
'endTime' => '<string>', // REQUIRED
'startTime' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- detectorId
-
- Type: FilterCondition structure
The detector ID.
- detectorVersionId
-
- Type: FilterCondition structure
The detector version ID.
- eventId
-
- Type: FilterCondition structure
The event ID.
- eventType
-
- Type: FilterCondition structure
The event type associated with the detector.
- maxResults
-
- Type: int
The maximum number of predictions to return for the request.
- nextToken
-
- Type: string
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.
- predictionTimeRange
-
- Type: PredictionTimeRange structure
The time period for when the predictions were generated.
Result Syntax
[
'eventPredictionSummaries' => [
[
'detectorId' => '<string>',
'detectorVersionId' => '<string>',
'eventId' => '<string>',
'eventTimestamp' => '<string>',
'eventTypeName' => '<string>',
'predictionTimestamp' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- eventPredictionSummaries
-
- Type: Array of EventPredictionSummary structures
The summary of the past predictions.
- nextToken
-
- Type: string
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.
Errors
-
An exception indicating a specified value is not allowed.
-
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. -
An exception indicating a throttling error.
-
An exception indicating an internal server error.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->listTagsForResource([
'maxResults' => <integer>,
'nextToken' => '<string>',
'resourceARN' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of objects to return for the request.
- nextToken
-
- Type: string
The next token from the previous results.
- resourceARN
-
- Required: Yes
- Type: string
The ARN that specifies the resource whose tags you want to list.
Result Syntax
[
'nextToken' => '<string>',
'tags' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The next token for subsequent requests.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating a throttling error.
-
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.
PutDetector
$result = $client->putDetector([/* ... */]); $promise = $client->putDetectorAsync([/* ... */]);
Creates or updates a detector.
Parameter Syntax
$result = $client->putDetector([
'description' => '<string>',
'detectorId' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The description of the detector.
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- eventTypeName
-
- Required: Yes
- Type: string
The name of the event type.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
PutEntityType
$result = $client->putEntityType([/* ... */]); $promise = $client->putEntityTypeAsync([/* ... */]);
Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
Parameter Syntax
$result = $client->putEntityType([
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The description.
- name
-
- Required: Yes
- Type: string
The name of the entity type.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
PutEventType
$result = $client->putEventType([/* ... */]); $promise = $client->putEventTypeAsync([/* ... */]);
Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
Parameter Syntax
$result = $client->putEventType([
'description' => '<string>',
'entityTypes' => ['<string>', ...], // REQUIRED
'eventIngestion' => 'ENABLED|DISABLED',
'eventOrchestration' => [
'eventBridgeEnabled' => true || false, // REQUIRED
],
'eventVariables' => ['<string>', ...], // REQUIRED
'labels' => ['<string>', ...],
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The description of the event type.
- entityTypes
-
- Required: Yes
- Type: Array of strings
The entity type for the event type. Example entity types: customer, merchant, account.
- eventIngestion
-
- Type: string
Specifies if ingestion is enabled or disabled.
- eventOrchestration
-
- Type: EventOrchestration structure
Enables or disables event orchestration. If enabled, you can send event predictions to select AWS services for downstream processing of the events.
- eventVariables
-
- Required: Yes
- Type: Array of strings
The event type variables.
- labels
-
- Type: Array of strings
The event type labels.
- name
-
- Required: Yes
- Type: string
The name.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
PutExternalModel
$result = $client->putExternalModel([/* ... */]); $promise = $client->putExternalModelAsync([/* ... */]);
Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
Parameter Syntax
$result = $client->putExternalModel([
'inputConfiguration' => [ // REQUIRED
'csvInputTemplate' => '<string>',
'eventTypeName' => '<string>',
'format' => 'TEXT_CSV|APPLICATION_JSON',
'jsonInputTemplate' => '<string>',
'useEventVariables' => true || false, // REQUIRED
],
'invokeModelEndpointRoleArn' => '<string>', // REQUIRED
'modelEndpoint' => '<string>', // REQUIRED
'modelEndpointStatus' => 'ASSOCIATED|DISSOCIATED', // REQUIRED
'modelSource' => 'SAGEMAKER', // REQUIRED
'outputConfiguration' => [ // REQUIRED
'csvIndexToVariableMap' => ['<string>', ...],
'format' => 'TEXT_CSV|APPLICATION_JSONLINES', // REQUIRED
'jsonKeyToVariableMap' => ['<string>', ...],
],
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- inputConfiguration
-
- Required: Yes
- Type: ModelInputConfiguration structure
The model endpoint input configuration.
- invokeModelEndpointRoleArn
-
- Required: Yes
- Type: string
The IAM role used to invoke the model endpoint.
- modelEndpoint
-
- Required: Yes
- Type: string
The model endpoints name.
- modelEndpointStatus
-
- Required: Yes
- Type: string
The model endpoint’s status in Amazon Fraud Detector.
- modelSource
-
- Required: Yes
- Type: string
The source of the model.
- outputConfiguration
-
- Required: Yes
- Type: ModelOutputConfiguration structure
The model endpoint output configuration.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
PutKMSEncryptionKey
$result = $client->putKMSEncryptionKey([/* ... */]); $promise = $client->putKMSEncryptionKeyAsync([/* ... */]);
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
Parameter Syntax
$result = $client->putKMSEncryptionKey([
'kmsEncryptionKeyArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- kmsEncryptionKeyArn
-
- Required: Yes
- Type: string
The KMS encryption key ARN.
The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
PutLabel
$result = $client->putLabel([/* ... */]); $promise = $client->putLabelAsync([/* ... */]);
Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.
Parameter Syntax
$result = $client->putLabel([
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The label description.
- name
-
- Required: Yes
- Type: string
The label name.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
PutOutcome
$result = $client->putOutcome([/* ... */]); $promise = $client->putOutcomeAsync([/* ... */]);
Creates or updates an outcome.
Parameter Syntax
$result = $client->putOutcome([
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The outcome description.
- name
-
- Required: Yes
- Type: string
The name of the outcome.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
SendEvent
$result = $client->sendEvent([/* ... */]); $promise = $client->sendEventAsync([/* ... */]);
Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.
Parameter Syntax
$result = $client->sendEvent([
'assignedLabel' => '<string>',
'entities' => [ // REQUIRED
[
'entityId' => '<string>', // REQUIRED
'entityType' => '<string>', // REQUIRED
],
// ...
],
'eventId' => '<string>', // REQUIRED
'eventTimestamp' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
'eventVariables' => ['<string>', ...], // REQUIRED
'labelTimestamp' => '<string>',
]);
Parameter Details
Members
- assignedLabel
-
- Type: string
The label to associate with the event. Required if specifying
labelTimestamp. - entities
-
- Required: Yes
- Type: Array of Entity structures
An array of entities.
- eventId
-
- Required: Yes
- Type: string
The event ID to upload.
- eventTimestamp
-
- Required: Yes
- Type: string
The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
- eventTypeName
-
- Required: Yes
- Type: string
The event type name of the event.
- eventVariables
-
- Required: Yes
- Type: Associative array of custom strings keys (variableName) to strings
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.
- labelTimestamp
-
- Type: string
The timestamp associated with the label. Required if specifying
assignedLabel.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating there was a conflict during a delete operation.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Assigns tags to a resource.
Parameter Syntax
$result = $client->tagResource([
'resourceARN' => '<string>', // REQUIRED
'tags' => [ // REQUIRED
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The resource ARN.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to assign to the resource.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating a throttling error.
-
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.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'resourceARN' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The ARN of the resource from which to remove the tag.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The resource ARN.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating a throttling error.
-
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.
UpdateDetectorVersion
$result = $client->updateDetectorVersion([/* ... */]); $promise = $client->updateDetectorVersionAsync([/* ... */]);
Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.
Parameter Syntax
$result = $client->updateDetectorVersion([
'description' => '<string>',
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
'externalModelEndpoints' => ['<string>', ...], // REQUIRED
'modelVersions' => [
[
'arn' => '<string>',
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
],
// ...
],
'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
'rules' => [ // REQUIRED
[
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The detector version description.
- detectorId
-
- Required: Yes
- Type: string
The parent detector ID for the detector version you want to update.
- detectorVersionId
-
- Required: Yes
- Type: string
The detector version ID.
- externalModelEndpoints
-
- Required: Yes
- Type: Array of strings
The Amazon SageMaker model endpoints to include in the detector version.
- modelVersions
-
- Type: Array of ModelVersion structures
The model versions to include in the detector version.
- ruleExecutionMode
-
- Type: string
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. - rules
-
- Required: Yes
- Type: Array of Rule structures
The rules to include in the detector version.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateDetectorVersionMetadata
$result = $client->updateDetectorVersionMetadata([/* ... */]); $promise = $client->updateDetectorVersionMetadataAsync([/* ... */]);
Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
Parameter Syntax
$result = $client->updateDetectorVersionMetadata([
'description' => '<string>', // REQUIRED
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- description
-
- Required: Yes
- Type: string
The description.
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- detectorVersionId
-
- Required: Yes
- Type: string
The detector version ID.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateDetectorVersionStatus
$result = $client->updateDetectorVersionStatus([/* ... */]); $promise = $client->updateDetectorVersionStatusAsync([/* ... */]);
Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.
Parameter Syntax
$result = $client->updateDetectorVersionStatus([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
'status' => 'DRAFT|ACTIVE|INACTIVE', // REQUIRED
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- detectorVersionId
-
- Required: Yes
- Type: string
The detector version ID.
- status
-
- Required: Yes
- Type: string
The new status.
The only supported values are
ACTIVEandINACTIVE
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateEventLabel
$result = $client->updateEventLabel([/* ... */]); $promise = $client->updateEventLabelAsync([/* ... */]);
Updates the specified event with a new label.
Parameter Syntax
$result = $client->updateEventLabel([
'assignedLabel' => '<string>', // REQUIRED
'eventId' => '<string>', // REQUIRED
'eventTypeName' => '<string>', // REQUIRED
'labelTimestamp' => '<string>', // REQUIRED
]);
Parameter Details
Members
- assignedLabel
-
- Required: Yes
- Type: string
The new label to assign to the event.
- eventId
-
- Required: Yes
- Type: string
The ID of the event associated with the label to update.
- eventTypeName
-
- Required: Yes
- Type: string
The event type of the event associated with the label to update.
- labelTimestamp
-
- Required: Yes
- Type: string
The timestamp associated with the label. The timestamp must be specified using ISO 8601 standard in UTC.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateList
$result = $client->updateList([/* ... */]); $promise = $client->updateListAsync([/* ... */]);
Updates a list.
Parameter Syntax
$result = $client->updateList([
'description' => '<string>',
'elements' => ['<string>', ...],
'name' => '<string>', // REQUIRED
'updateMode' => 'REPLACE|APPEND|REMOVE',
'variableType' => '<string>',
]);
Parameter Details
Members
- description
-
- Type: string
The new description.
- elements
-
- Type: Array of strings
One or more list elements to add or replace. If you are providing the elements, make sure to specify the
updateModeto use.If you are deleting all elements from the list, use
REPLACEfor theupdateModeand provide an empty list (0 elements). - name
-
- Required: Yes
- Type: string
The name of the list to update.
- updateMode
-
- Type: string
The update mode (type).
-
Use
APPENDif you are adding elements to the list. -
Use
REPLACEif you replacing existing elements in the list. -
Use
REMOVEif you are removing elements from the list.
- variableType
-
- Type: string
The variable type you want to assign to the list.
You cannot update a variable type of a list that already has a variable type assigned to it. You can assign a variable type to a list only if the list does not already have a variable type.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateModel
$result = $client->updateModel([/* ... */]); $promise = $client->updateModelAsync([/* ... */]);
Updates model description.
Parameter Syntax
$result = $client->updateModel([
'description' => '<string>',
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
]);
Parameter Details
Members
- description
-
- Type: string
The new model description.
- modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateModelVersion
$result = $client->updateModelVersion([/* ... */]); $promise = $client->updateModelVersionAsync([/* ... */]);
Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.
Parameter Syntax
$result = $client->updateModelVersion([
'externalEventsDetail' => [
'dataAccessRoleArn' => '<string>', // REQUIRED
'dataLocation' => '<string>', // REQUIRED
],
'ingestedEventsDetail' => [
'ingestedEventsTimeWindow' => [ // REQUIRED
'endTime' => '<string>', // REQUIRED
'startTime' => '<string>', // REQUIRED
],
],
'majorVersionNumber' => '<string>', // REQUIRED
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- externalEventsDetail
-
- Type: ExternalEventsDetail structure
The details of the external events data used for training the model version. Required if
trainingDataSourceisEXTERNAL_EVENTS. - ingestedEventsDetail
-
- Type: IngestedEventsDetail structure
The details of the ingested event used for training the model version. Required if your
trainingDataSourceisINGESTED_EVENTS. - majorVersionNumber
-
- Required: Yes
- Type: string
The major version number.
- modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
- tags
-
- Type: Array of Tag structures
A collection of key and value pairs.
Result Syntax
[
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
'modelVersionNumber' => '<string>',
'status' => '<string>',
]
Result Details
Members
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVersionNumber
-
- Type: string
The model version number of the model version updated.
- status
-
- Type: string
The status of the updated model version.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
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. -
An exception indicating a throttling error.
-
An exception indicating an internal server error.
-
An exception indicating there was a conflict during a delete operation.
UpdateModelVersionStatus
$result = $client->updateModelVersionStatus([/* ... */]); $promise = $client->updateModelVersionStatusAsync([/* ... */]);
Updates the status of a model version.
You can perform the following status updates:
-
Change the
TRAINING_IN_PROGRESSstatus toTRAINING_CANCELLED. -
Change the
TRAINING_COMPLETEstatus toACTIVE. -
Change
ACTIVEtoINACTIVE.
Parameter Syntax
$result = $client->updateModelVersionStatus([
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
'status' => 'ACTIVE|INACTIVE|TRAINING_CANCELLED', // REQUIRED
]);
Parameter Details
Members
- modelId
-
- Required: Yes
- Type: string
The model ID of the model version to update.
- modelType
-
- Required: Yes
- Type: string
The model type.
- modelVersionNumber
-
- Required: Yes
- Type: string
The model version number.
- status
-
- Required: Yes
- Type: string
The model version status.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateRuleMetadata
$result = $client->updateRuleMetadata([/* ... */]); $promise = $client->updateRuleMetadataAsync([/* ... */]);
Updates a rule's metadata. The description attribute can be updated.
Parameter Syntax
$result = $client->updateRuleMetadata([
'description' => '<string>', // REQUIRED
'rule' => [ // REQUIRED
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- description
-
- Required: Yes
- Type: string
The rule description.
- rule
-
- Required: Yes
- Type: Rule structure
The rule to update.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateRuleVersion
$result = $client->updateRuleVersion([/* ... */]); $promise = $client->updateRuleVersionAsync([/* ... */]);
Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
Parameter Syntax
$result = $client->updateRuleVersion([
'description' => '<string>',
'expression' => '<string>', // REQUIRED
'language' => 'DETECTORPL', // REQUIRED
'outcomes' => ['<string>', ...], // REQUIRED
'rule' => [ // REQUIRED
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
'tags' => [
[
'key' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The description.
- expression
-
- Required: Yes
- Type: string
The rule expression.
- language
-
- Required: Yes
- Type: string
The language.
- outcomes
-
- Required: Yes
- Type: Array of strings
The outcomes.
- rule
-
- Required: Yes
- Type: Rule structure
The rule to update.
- tags
-
- Type: Array of Tag structures
The tags to assign to the rule version.
Result Syntax
[
'rule' => [
'detectorId' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
]
Result Details
Members
- rule
-
- Type: Rule structure
The new rule version that was created.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
UpdateVariable
$result = $client->updateVariable([/* ... */]); $promise = $client->updateVariableAsync([/* ... */]);
Updates a variable.
Parameter Syntax
$result = $client->updateVariable([
'defaultValue' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'variableType' => '<string>',
]);
Parameter Details
Members
- defaultValue
-
- Type: string
The new default value of the variable.
- description
-
- Type: string
The new description.
- name
-
- Required: Yes
- Type: string
The name of the variable.
- variableType
-
- Type: string
The variable type. For more information see Variable types.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
-
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. -
An exception indicating there was a conflict during a delete operation.
Shapes
ATIMetricDataPoint
Description
The Account Takeover Insights (ATI) model performance metrics data points.
Members
- adr
-
- Type: float
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.
- atodr
-
- Type: float
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.
- cr
-
- Type: float
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.
- threshold
-
- Type: float
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
Description
The Account Takeover Insights (ATI) model performance score.
Members
- asi
-
- Type: float
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
Description
The Account Takeover Insights (ATI) model training metric details.
Members
- metricDataPoints
-
- Type: Array of ATIMetricDataPoint structures
The model's performance metrics data points.
- modelPerformance
-
- Type: ATIModelPerformance structure
The model's overall performance scores.
AccessDeniedException
Description
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.
Members
- message
-
- Required: Yes
- Type: string
AggregatedLogOddsMetric
Description
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.
Members
- aggregatedVariablesImportance
-
- Required: Yes
- Type: float
The relative importance of the variables in the list to the other event variable.
- variableNames
-
- Required: Yes
- Type: Array of strings
The names of all the variables.
AggregatedVariablesImpactExplanation
Description
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.
Members
- eventVariableNames
-
- Type: Array of strings
The names of all the event variables that were used to derive the aggregated variables.
- logOddsImpact
-
- Type: float
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.
- relativeImpact
-
- Type: string
The relative impact of the aggregated variables in terms of magnitude on the prediction scores.
AggregatedVariablesImportanceMetrics
Description
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.
Members
- logOddsMetrics
-
- Type: Array of AggregatedLogOddsMetric structures
List of variables' metrics.
AllowDenyList
Description
The metadata of a list.
Members
- arn
-
- Type: string
The ARN of the list.
- createdTime
-
- Type: string
The time the list was created.
- description
-
- Type: string
The description of the list.
- name
-
- Required: Yes
- Type: string
The name of the list.
- updatedTime
-
- Type: string
The time the list was last updated.
- variableType
-
- Type: string
The variable type of the list.
BatchCreateVariableError
Description
Provides the error of the batch create variable API.
Members
- code
-
- Type: int
The error code.
- message
-
- Type: string
The error message.
- name
-
- Type: string
The name.
BatchGetVariableError
Description
Provides the error of the batch get variable API.
Members
- code
-
- Type: int
The error code.
- message
-
- Type: string
The error message.
- name
-
- Type: string
The error name.
BatchImport
Description
The batch import job details.
Members
- arn
-
- Type: string
The ARN of the batch import job.
- completionTime
-
- Type: string
Timestamp of when batch import job completed.
- eventTypeName
-
- Type: string
The name of the event type.
- failedRecordsCount
-
- Type: int
The number of records that failed to import.
- failureReason
-
- Type: string
The reason batch import job failed.
- iamRoleArn
-
- Type: string
The ARN of the IAM role to use for this job request.
- inputPath
-
- Type: string
The Amazon S3 location of your data file for batch import.
- jobId
-
- Type: string
The ID of the batch import job.
- outputPath
-
- Type: string
The Amazon S3 location of your output file.
- processedRecordsCount
-
- Type: int
The number of records processed by batch import job.
- startTime
-
- Type: string
Timestamp of when the batch import job started.
- status
-
- Type: string
The status of the batch import job.
- totalRecordsCount
-
- Type: int
The total number of records in the batch import job.
BatchPrediction
Description
The batch prediction details.
Members
- arn
-
- Type: string
The ARN of batch prediction job.
- completionTime
-
- Type: string
Timestamp of when the batch prediction job completed.
- detectorName
-
- Type: string
The name of the detector.
- detectorVersion
-
- Type: string
The detector version.
- eventTypeName
-
- Type: string
The name of the event type.
- failureReason
-
- Type: string
The reason a batch prediction job failed.
- iamRoleArn
-
- Type: string
The ARN of the IAM role to use for this job request.
- inputPath
-
- Type: string
The Amazon S3 location of your training file.
- jobId
-
- Type: string
The job ID for the batch prediction.
- lastHeartbeatTime
-
- Type: string
Timestamp of most recent heartbeat indicating the batch prediction job was making progress.
- outputPath
-
- Type: string
The Amazon S3 location of your output file.
- processedRecordsCount
-
- Type: int
The number of records processed by the batch prediction job.
- startTime
-
- Type: string
Timestamp of when the batch prediction job started.
- status
-
- Type: string
The batch prediction status.
- totalRecordsCount
-
- Type: int
The total number of records in the batch prediction job.
ConflictException
Description
An exception indicating there was a conflict during a delete operation.
Members
- message
-
- Required: Yes
- Type: string
DataValidationMetrics
Description
The model training data validation metrics.
Members
- fieldLevelMessages
-
- Type: Array of FieldValidationMessage structures
The field-specific model training validation messages.
- fileLevelMessages
-
- Type: Array of FileValidationMessage structures
The file-specific model training data validation messages.
Detector
Description
The detector.
Members
- arn
-
- Type: string
The detector ARN.
- createdTime
-
- Type: string
Timestamp of when the detector was created.
- description
-
- Type: string
The detector description.
- detectorId
-
- Type: string
The detector ID.
- eventTypeName
-
- Type: string
The name of the event type.
- lastUpdatedTime
-
- Type: string
Timestamp of when the detector was last updated.
DetectorVersionSummary
Description
The summary of the detector version.
Members
- description
-
- Type: string
The detector version description.
- detectorVersionId
-
- Type: string
The detector version ID.
- lastUpdatedTime
-
- Type: string
Timestamp of when the detector version was last updated.
- status
-
- Type: string
The detector version status.
Entity
Description
The entity details.
Members
- entityId
-
- Required: Yes
- Type: string
The entity ID. If you do not know the
entityId, you can passunknown, which is areserved string literal. - entityType
-
- Required: Yes
- Type: string
The entity type.
EntityType
Description
The entity type details.
Members
- arn
-
- Type: string
The entity type ARN.
- createdTime
-
- Type: string
Timestamp of when the entity type was created.
- description
-
- Type: string
The entity type description.
- lastUpdatedTime
-
- Type: string
Timestamp of when the entity type was last updated.
- name
-
- Type: string
The entity type name.
EvaluatedExternalModel
Description
The details of the external (Amazon Sagemaker) model evaluated for generating predictions.
Members
- inputVariables
-
- Type: Associative array of custom strings keys (string) to strings
Input variables use for generating predictions.
- modelEndpoint
-
- Type: string
The endpoint of the external (Amazon Sagemaker) model.
- outputVariables
-
- Type: Associative array of custom strings keys (string) to strings
Output variables.
- useEventVariables
-
- Type: boolean
Indicates whether event variables were used to generate predictions.
EvaluatedModelVersion
Description
The model version evaluated for generating prediction.
Members
- evaluations
-
- Type: Array of ModelVersionEvaluation structures
Evaluations generated for the model version.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
Valid values:
ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS - modelVersion
-
- Type: string
The model version.
EvaluatedRule
Description
The details of the rule used for evaluating variable values.
Members
- evaluated
-
- Type: boolean
Indicates whether the rule was evaluated.
- expression
-
- Type: string
The rule expression.
- expressionWithValues
-
- Type: string
The rule expression value.
- matched
-
- Type: boolean
Indicates whether the rule matched.
- outcomes
-
- Type: Array of strings
The rule outcome.
- ruleId
-
- Type: string
The rule ID.
- ruleVersion
-
- Type: string
The rule version.
Event
Description
The event details.
Members
- currentLabel
-
- Type: string
The label associated with the event.
- entities
-
- Type: Array of Entity structures
The event entities.
- eventId
-
- Type: string
The event ID.
- eventTimestamp
-
- Type: string
The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
- eventTypeName
-
- Type: string
The event type.
- eventVariables
-
- Type: Associative array of custom strings keys (attributeKey) to strings
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.
- labelTimestamp
-
- Type: string
The timestamp associated with the label to update. The timestamp must be specified using ISO 8601 standard in UTC.
EventOrchestration
Description
The event orchestration status.
Members
- eventBridgeEnabled
-
- Required: Yes
- Type: boolean
Specifies if event orchestration is enabled through Amazon EventBridge.
EventPredictionSummary
Description
Information about the summary of an event prediction.
Members
- detectorId
-
- Type: string
The detector ID.
- detectorVersionId
-
- Type: string
The detector version ID.
- eventId
-
- Type: string
The event ID.
- eventTimestamp
-
- Type: string
The timestamp of the event.
- eventTypeName
-
- Type: string
The event type.
- predictionTimestamp
-
- Type: string
The timestamp when the prediction was generated.
EventType
Description
The event type details.
Members
- arn
-
- Type: string
The entity type ARN.
- createdTime
-
- Type: string
Timestamp of when the event type was created.
- description
-
- Type: string
The event type description.
- entityTypes
-
- Type: Array of strings
The event type entity types.
- eventIngestion
-
- Type: string
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 asINGESTED_EVENTS, to train your model and improve fraud predictions. - eventOrchestration
-
- Type: EventOrchestration structure
The event orchestration status.
- eventVariables
-
- Type: Array of strings
The event type event variables.
- ingestedEventStatistics
-
- Type: IngestedEventStatistics structure
Data about the stored events.
- labels
-
- Type: Array of strings
The event type labels.
- lastUpdatedTime
-
- Type: string
Timestamp of when the event type was last updated.
- name
-
- Type: string
The event type name.
EventVariableSummary
Description
Information about the summary of an event variable that was evaluated for generating prediction.
Members
- name
-
- Type: string
The event variable name.
- source
-
- Type: string
The event variable source.
- value
-
- Type: string
The value of the event variable.
ExternalEventsDetail
Description
Details for the external events data used for model version training.
Members
- dataAccessRoleArn
-
- Required: Yes
- Type: string
The ARN of the role that provides Amazon Fraud Detector access to the data location.
- dataLocation
-
- Required: Yes
- Type: string
The Amazon S3 bucket location for the data.
ExternalModel
Description
The Amazon SageMaker model.
Members
- arn
-
- Type: string
The model ARN.
- createdTime
-
- Type: string
Timestamp of when the model was last created.
- inputConfiguration
-
- Type: ModelInputConfiguration structure
The input configuration.
- invokeModelEndpointRoleArn
-
- Type: string
The role used to invoke the model.
- lastUpdatedTime
-
- Type: string
Timestamp of when the model was last updated.
- modelEndpoint
-
- Type: string
The Amazon SageMaker model endpoints.
- modelEndpointStatus
-
- Type: string
The Amazon Fraud Detector status for the external model endpoint
- modelSource
-
- Type: string
The source of the model.
- outputConfiguration
-
- Type: ModelOutputConfiguration structure
The output configuration.
ExternalModelOutputs
Description
The fraud prediction scores from Amazon SageMaker model.
Members
- externalModel
-
- Type: ExternalModelSummary structure
The Amazon SageMaker model.
- outputs
-
- Type: Associative array of custom strings keys (string) to strings
The fraud prediction scores from Amazon SageMaker model.
ExternalModelSummary
Description
The Amazon SageMaker model.
Members
- modelEndpoint
-
- Type: string
The endpoint of the Amazon SageMaker model.
- modelSource
-
- Type: string
The source of the model.
FieldValidationMessage
Description
The message details.
Members
- content
-
- Type: string
The message content.
- fieldName
-
- Type: string
The field name.
- identifier
-
- Type: string
The message ID.
- title
-
- Type: string
The message title.
- type
-
- Type: string
The message type.
FileValidationMessage
Description
The message details.
Members
- content
-
- Type: string
The message content.
- title
-
- Type: string
The message title.
- type
-
- Type: string
The message type.
FilterCondition
Description
A conditional statement for filtering a list of past predictions.
Members
- value
-
- Type: string
A statement containing a resource property and a value to specify filter condition.
IngestedEventStatistics
Description
Data about the stored events.
Members
- eventDataSizeInBytes
-
- Type: long (int|float)
The total size of the stored events.
- lastUpdatedTime
-
- Type: string
Timestamp of when the stored event was last updated.
- leastRecentEvent
-
- Type: string
The oldest stored event.
- mostRecentEvent
-
- Type: string
The newest stored event.
- numberOfEvents
-
- Type: long (int|float)
The number of stored events.
IngestedEventsDetail
Description
The details of the ingested event.
Members
- ingestedEventsTimeWindow
-
- Required: Yes
- Type: IngestedEventsTimeWindow structure
The start and stop time of the ingested events.
IngestedEventsTimeWindow
Description
The start and stop time of the ingested events.
Members
- endTime
-
- Required: Yes
- Type: string
Timestamp of the final ingested event.
- startTime
-
- Required: Yes
- Type: string
Timestamp of the first ingensted event.
InternalServerException
Description
An exception indicating an internal server error.
Members
- message
-
- Required: Yes
- Type: string
KMSKey
Description
The KMS key details.
Members
- kmsEncryptionKeyArn
-
- Type: string
The encryption key ARN.
Label
Description
The label details.
Members
- arn
-
- Type: string
The label ARN.
- createdTime
-
- Type: string
Timestamp of when the event type was created.
- description
-
- Type: string
The label description.
- lastUpdatedTime
-
- Type: string
Timestamp of when the label was last updated.
- name
-
- Type: string
The label name.
LabelSchema
Description
The label schema.
Members
- labelMapper
-
- Type: Associative array of custom strings keys (string) to stringss
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. - unlabeledEventsTreatment
-
- Type: string
The action to take for unlabeled events.
-
Use
IGNOREif you want the unlabeled events to be ignored. This is recommended when the majority of the events in the dataset are labeled. -
Use
FRAUDif you want to categorize all unlabeled events as “Fraud”. This is recommended when most of the events in your dataset are fraudulent. -
Use
LEGITif you want to categorize all unlabeled events as “Legit”. This is recommended when most of the events in your dataset are legitimate. -
Use
AUTOif you want Amazon Fraud Detector to decide how to use the unlabeled data. This is recommended when there is significant unlabeled events in the dataset.
By default, Amazon Fraud Detector ignores the unlabeled data.
LogOddsMetric
Description
The log odds metric details.
Members
- variableImportance
-
- Required: Yes
- Type: float
The relative importance of the variable. For more information, see Model variable importance.
- variableName
-
- Required: Yes
- Type: string
The name of the variable.
- variableType
-
- Required: Yes
- Type: string
The type of variable.
MetricDataPoint
Description
Model performance metrics data points.
Members
- fpr
-
- Type: float
The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
- precision
-
- Type: float
The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
- threshold
-
- Type: float
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.
- tpr
-
- Type: float
The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
Model
Description
The model.
Members
- arn
-
- Type: string
The ARN of the model.
- createdTime
-
- Type: string
Timestamp of when the model was created.
- description
-
- Type: string
The model description.
- eventTypeName
-
- Type: string
The name of the event type.
- lastUpdatedTime
-
- Type: string
Timestamp of last time the model was updated.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
ModelEndpointDataBlob
Description
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.
Members
- byteBuffer
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The byte buffer of the Amazon SageMaker model endpoint input data blob.
- contentType
-
- Type: string
The content type of the Amazon SageMaker model endpoint input data blob.
ModelInputConfiguration
Description
The Amazon SageMaker model input configuration.
Members
- csvInputTemplate
-
- Type: string
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.
- eventTypeName
-
- Type: string
The event type name.
- format
-
- Type: string
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.
- jsonInputTemplate
-
- Type: string
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.
- useEventVariables
-
- Required: Yes
- Type: boolean
The event variables.
ModelOutputConfiguration
Description
Provides the Amazon Sagemaker model output configuration.
Members
- csvIndexToVariableMap
-
- Type: Associative array of custom strings keys (string) to strings
A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
- format
-
- Required: Yes
- Type: string
The format of the model output configuration.
- jsonKeyToVariableMap
-
- Type: Associative array of custom strings keys (string) to strings
A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
ModelScores
Description
The fraud prediction scores.
Members
- modelVersion
-
- Type: ModelVersion structure
The model version.
- scores
-
- Type: Associative array of custom strings keys (string) to floats
The model's fraud prediction scores.
ModelVersion
Description
The model version.
Members
- arn
-
- Type: string
The model version ARN.
- modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
- modelVersionNumber
-
- Required: Yes
- Type: string
The model version number.
ModelVersionDetail
Description
The details of the model version.
Members
- arn
-
- Type: string
The model version ARN.
- createdTime
-
- Type: string
The timestamp when the model was created.
- externalEventsDetail
-
- Type: ExternalEventsDetail structure
The external events data details. This will be populated if the
trainingDataSourcefor the model version is specified asEXTERNAL_EVENTS. - ingestedEventsDetail
-
- Type: IngestedEventsDetail structure
The ingested events data details. This will be populated if the
trainingDataSourcefor the model version is specified asINGESTED_EVENTS. - lastUpdatedTime
-
- Type: string
The timestamp when the model was last updated.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVersionNumber
-
- Type: string
The model version number.
- status
-
- Type: string
The status of the model version.
- trainingDataSchema
-
- Type: TrainingDataSchema structure
The training data schema.
- trainingDataSource
-
- Type: string
The model version training data source.
- trainingResult
-
- Type: TrainingResult structure
The training results.
- trainingResultV2
-
- Type: TrainingResultV2 structure
The training result details. The details include the relative importance of the variables.
ModelVersionEvaluation
Description
The model version evalutions.
Members
- evaluationScore
-
- Type: string
The evaluation score generated for the model version.
- outputVariableName
-
- Type: string
The output variable name.
- predictionExplanations
-
- Type: PredictionExplanations structure
The prediction explanations generated for the model version.
OFIMetricDataPoint
Description
The Online Fraud Insights (OFI) model performance metrics data points.
Members
- fpr
-
- Type: float
The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
- precision
-
- Type: float
The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
- threshold
-
- Type: float
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.
- tpr
-
- Type: float
The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
OFIModelPerformance
Description
The Online Fraud Insights (OFI) model performance score.
Members
- auc
-
- Type: float
The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
- uncertaintyRange
-
- Type: UncertaintyRange structure
Indicates the range of area under curve (auc) expected from the OFI model. A range greater than 0.1 indicates higher model uncertainity.
OFITrainingMetricsValue
Description
The Online Fraud Insights (OFI) model training metric details.
Members
- metricDataPoints
-
- Type: Array of OFIMetricDataPoint structures
The model's performance metrics data points.
- modelPerformance
-
- Type: OFIModelPerformance structure
The model's overall performance score.
Outcome
Description
The outcome.
Members
- arn
-
- Type: string
The outcome ARN.
- createdTime
-
- Type: string
The timestamp when the outcome was created.
- description
-
- Type: string
The outcome description.
- lastUpdatedTime
-
- Type: string
The timestamp when the outcome was last updated.
- name
-
- Type: string
The outcome name.
PredictionExplanations
Description
The prediction explanations that provide insight into how each event variable impacted the model version's fraud prediction score.
Members
- aggregatedVariablesImpactExplanations
-
- Type: Array of AggregatedVariablesImpactExplanation structures
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 addressanduser. - variableImpactExplanations
-
- Type: Array of VariableImpactExplanation structures
The details of the event variable's impact on the prediction score.
PredictionTimeRange
Description
The time period for when the predictions were generated.
Members
- endTime
-
- Required: Yes
- Type: string
The end time of the time period for when the predictions were generated.
- startTime
-
- Required: Yes
- Type: string
The start time of the time period for when the predictions were generated.
ResourceNotFoundException
Description
An exception indicating the specified resource was not found.
Members
- message
-
- Required: Yes
- Type: string
ResourceUnavailableException
Description
An exception indicating that the attached customer-owned (external) model threw an exception when Amazon Fraud Detector invoked the model.
Members
- message
-
- Type: string
Rule
Description
A rule.
Members
- detectorId
-
- Required: Yes
- Type: string
The detector for which the rule is associated.
- ruleId
-
- Required: Yes
- Type: string
The rule ID.
- ruleVersion
-
- Required: Yes
- Type: string
The rule version.
RuleDetail
Description
The details of the rule.
Members
- arn
-
- Type: string
The rule ARN.
- createdTime
-
- Type: string
The timestamp of when the rule was created.
- description
-
- Type: string
The rule description.
- detectorId
-
- Type: string
The detector for which the rule is associated.
- expression
-
- Type: string
The rule expression.
- language
-
- Type: string
The rule language.
- lastUpdatedTime
-
- Type: string
Timestamp of the last time the rule was updated.
- outcomes
-
- Type: Array of strings
The rule outcomes.
- ruleId
-
- Type: string
The rule ID.
- ruleVersion
-
- Type: string
The rule version.
RuleResult
Description
The rule results.
Members
- outcomes
-
- Type: Array of strings
The outcomes of the matched rule, based on the rule execution mode.
- ruleId
-
- Type: string
The rule ID that was matched, based on the rule execution mode.
TFIMetricDataPoint
Description
The performance metrics data points for Transaction Fraud Insights (TFI) model.
Members
- fpr
-
- Type: float
The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
- precision
-
- Type: float
The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
- threshold
-
- Type: float
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.
- tpr
-
- Type: float
The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
TFIModelPerformance
Description
The Transaction Fraud Insights (TFI) model performance score.
Members
- auc
-
- Type: float
The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
- uncertaintyRange
-
- Type: UncertaintyRange structure
Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates higher model uncertainity.
TFITrainingMetricsValue
Description
The Transaction Fraud Insights (TFI) model training metric details.
Members
- metricDataPoints
-
- Type: Array of TFIMetricDataPoint structures
The model's performance metrics data points.
- modelPerformance
-
- Type: TFIModelPerformance structure
The model performance score.
Tag
Description
A key and value pair.
Members
- key
-
- Required: Yes
- Type: string
A tag key.
- value
-
- Required: Yes
- Type: string
A value assigned to a tag key.
ThrottlingException
Description
An exception indicating a throttling error.
Members
- message
-
- Required: Yes
- Type: string
TrainingDataSchema
Description
The training data schema.
Members
- labelSchema
-
- Type: LabelSchema structure
The label schema.
- modelVariables
-
- Required: Yes
- Type: Array of strings
The training data schema variables.
TrainingMetrics
Description
The training metric details.
Members
- auc
-
- Type: float
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.
- metricDataPoints
-
- Type: Array of MetricDataPoint structures
The data points details.
TrainingMetricsV2
Description
The training metrics details.
Members
- ati
-
- Type: ATITrainingMetricsValue structure
The Account Takeover Insights (ATI) model training metric details.
- ofi
-
- Type: OFITrainingMetricsValue structure
The Online Fraud Insights (OFI) model training metric details.
- tfi
-
- Type: TFITrainingMetricsValue structure
The Transaction Fraud Insights (TFI) model training metric details.
TrainingResult
Description
The training result details.
Members
- dataValidationMetrics
-
- Type: DataValidationMetrics structure
The validation metrics.
- trainingMetrics
-
- Type: TrainingMetrics structure
The training metric details.
- variableImportanceMetrics
-
- Type: VariableImportanceMetrics structure
The variable importance metrics.
TrainingResultV2
Description
The training result details.
Members
- aggregatedVariablesImportanceMetrics
-
- Type: AggregatedVariablesImportanceMetrics structure
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 addressanduser. - dataValidationMetrics
-
- Type: DataValidationMetrics structure
The model training data validation metrics.
- trainingMetricsV2
-
- Type: TrainingMetricsV2 structure
The training metric details.
- variableImportanceMetrics
-
- Type: VariableImportanceMetrics structure
The variable importance metrics details.
UncertaintyRange
Description
Range of area under curve (auc) expected from the model. A range greater than 0.1 indicates higher model uncertainity. A range is the difference between upper and lower bound of auc.
Members
- lowerBoundValue
-
- Required: Yes
- Type: float
The lower bound value of the area under curve (auc).
- upperBoundValue
-
- Required: Yes
- Type: float
The upper bound value of the area under curve (auc).
ValidationException
Description
An exception indicating a specified value is not allowed.
Members
- message
-
- Required: Yes
- Type: string
Variable
Description
The variable.
Members
- arn
-
- Type: string
The ARN of the variable.
- createdTime
-
- Type: string
The time when the variable was created.
- dataSource
-
- Type: string
The data source of the variable.
- dataType
-
- Type: string
The data type of the variable. For more information see Variable types.
- defaultValue
-
- Type: string
The default value of the variable.
- description
-
- Type: string
The description of the variable.
- lastUpdatedTime
-
- Type: string
The time when variable was last updated.
- name
-
- Type: string
The name of the variable.
- variableType
-
- Type: string
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
Description
A variable in the list of variables for the batch create variable request.
Members
- dataSource
-
- Type: string
The data source of the variable.
- dataType
-
- Type: string
The data type of the variable.
- defaultValue
-
- Type: string
The default value of the variable.
- description
-
- Type: string
The description of the variable.
- name
-
- Type: string
The name of the variable.
- variableType
-
- Type: string
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
Description
The details of the event variable's impact on the prediction score.
Members
- eventVariableName
-
- Type: string
The event variable name.
- logOddsImpact
-
- Type: float
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.
- relativeImpact
-
- Type: string
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
Description
The variable importance metrics details.
Members
- logOddsMetrics
-
- Type: Array of LogOddsMetric structures
List of variable metrics.