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

Result Syntax

[
    'errors' => [
        [
            'code' => <integer>,
            'message' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

BatchGetVariable

$result = $client->batchGetVariable([/* ... */]);
$promise = $client->batchGetVariableAsync([/* ... */]);

Gets a batch of variables.

Parameter Syntax

$result = $client->batchGetVariable([
    'names' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

CancelBatchImportJob

$result = $client->cancelBatchImportJob([/* ... */]);
$promise = $client->cancelBatchImportJobAsync([/* ... */]);

Cancels an in-progress batch import job.

Parameter Syntax

$result = $client->cancelBatchImportJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

CancelBatchPredictionJob

$result = $client->cancelBatchPredictionJob([/* ... */]);
$promise = $client->cancelBatchPredictionJobAsync([/* ... */]);

Cancels the specified batch prediction job.

Parameter Syntax

$result = $client->cancelBatchPredictionJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ResourceNotFoundException:

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

Result Syntax

[
    'detectorId' => '<string>',
    'detectorVersionId' => '<string>',
    'status' => 'DRAFT|ACTIVE|INACTIVE',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS|TRANSACTION_FRAUD_INSIGHTS|ACCOUNT_TAKEOVER_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'status' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ThrottlingException:

An exception indicating a throttling error.

InternalServerException:

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

Result Syntax

[
    'rule' => [
        'detectorId' => '<string>',
        'ruleId' => '<string>',
        'ruleVersion' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteBatchPredictionJob

$result = $client->deleteBatchPredictionJob([/* ... */]);
$promise = $client->deleteBatchPredictionJobAsync([/* ... */]);

Deletes a batch prediction job.

Parameter Syntax

$result = $client->deleteBatchPredictionJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ConflictException:

An exception indicating there was a conflict during a delete operation.

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

ConflictException:

An exception indicating there was a conflict during a delete operation.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ConflictException:

An exception indicating there was a conflict during a delete operation.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ValidationException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

An exception indicating there was a conflict during a delete operation.

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'eventTypeName' => '<string>',
    'eventsDeletionStatus' => '<string>',
]

Result Details

Errors

ConflictException:

An exception indicating there was a conflict during a delete operation.

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ConflictException:

An exception indicating there was a conflict during a delete operation.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ConflictException:

An exception indicating there was a conflict during a delete operation.

ThrottlingException:

An exception indicating a throttling error.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

An exception indicating there was a conflict during a delete operation.

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ThrottlingException:

An exception indicating a throttling error.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

ConflictException:

An exception indicating there was a conflict during a delete operation.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ConflictException:

An exception indicating there was a conflict during a delete operation.

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ConflictException:

An exception indicating there was a conflict during a delete operation.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'arn' => '<string>',
    'detectorId' => '<string>',
    'detectorVersionSummaries' => [
        [
            'description' => '<string>',
            'detectorVersionId' => '<string>',
            'lastUpdatedTime' => '<string>',
            'status' => 'DRAFT|ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetDeleteEventsByEventTypeStatus

$result = $client->getDeleteEventsByEventTypeStatus([/* ... */]);
$promise = $client->getDeleteEventsByEventTypeStatusAsync([/* ... */]);

Retrieves the status of a DeleteEventsByEventType action.

Parameter Syntax

$result = $client->getDeleteEventsByEventTypeStatus([
    'eventTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'eventTypeName' => '<string>',
    'eventsDeletionStatus' => 'IN_PROGRESS_INITIALIZING|IN_PROGRESS|CANCEL_IN_PROGRESS|CANCELED|COMPLETE|FAILED',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'detectors' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'detectorId' => '<string>',
            'eventTypeName' => '<string>',
            'lastUpdatedTime' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'entityTypes' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'event' => [
        'currentLabel' => '<string>',
        'entities' => [
            [
                'entityId' => '<string>',
                'entityType' => '<string>',
            ],
            // ...
        ],
        'eventId' => '<string>',
        'eventTimestamp' => '<string>',
        'eventTypeName' => '<string>',
        'eventVariables' => ['<string>', ...],
        'labelTimestamp' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

An exception indicating there was a conflict during a delete operation.

ResourceUnavailableException:

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ThrottlingException:

An exception indicating a throttling error.

InternalServerException:

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'kmsKey' => [
        'kmsEncryptionKeyArn' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'labels' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'elements' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'lists' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'updatedTime' => '<string>',
            'variableType' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'nextToken' => '<string>',
    'outcomes' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

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

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[
    'eventPredictionSummaries' => [
        [
            'detectorId' => '<string>',
            'detectorVersionId' => '<string>',
            'eventId' => '<string>',
            'eventTimestamp' => '<string>',
            'eventTypeName' => '<string>',
            'predictionTimestamp' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ThrottlingException:

An exception indicating a throttling error.

InternalServerException:

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

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ConflictException:

An exception indicating there was a conflict during a delete operation.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

An exception indicating a specified value is not allowed.

ResourceNotFoundException:

An exception indicating the specified resource was not found.

InternalServerException:

An exception indicating an internal server error.

ThrottlingException:

An exception indicating a throttling error.

AccessDeniedException:

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ConflictException:

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