Amazon Fraud Detector 2019-11-15

BatchCreateVariable

$result = $client->batchCreateVariable([/* ... */]);
$promise = $client->batchCreateVariableAsync([/* ... */]);

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([/* ... */]);

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',
            '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.

CreateDetectorVersion

$result = $client->createDetectorVersion([/* ... */]);
$promise = $client->createDetectorVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->createDetectorVersion([
    'description' => '<string>',
    'detectorId' => '<string>', // REQUIRED
    'externalModelEndpoints' => ['<string>', ...],
    'modelVersions' => [
        [
            'arn' => '<string>',
            'modelId' => '<string>', // REQUIRED
            'modelType' => 'ONLINE_FRAUD_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.

CreateModel

$result = $client->createModel([/* ... */]);
$promise = $client->createModelAsync([/* ... */]);

Parameter Syntax

$result = $client->createModel([
    'description' => '<string>',
    'eventTypeName' => '<string>', // REQUIRED
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_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.

• 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([/* ... */]);

Parameter Syntax

$result = $client->createModelVersion([
    'externalEventsDetail' => [
        'dataAccessRoleArn' => '<string>', // REQUIRED
        'dataLocation' => '<string>', // REQUIRED
    ],
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'trainingDataSchema' => [ // REQUIRED
        'labelSchema' => [ // REQUIRED
            'labelMapper' => [ // REQUIRED
                '<string>' => ['<string>', ...],
                // ...
            ],
        ],
        'modelVariables' => ['<string>', ...], // REQUIRED
    ],
    'trainingDataSource' => 'EXTERNAL_EVENTS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_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.

• InternalServerException:

  An exception indicating an internal server error.

CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

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([/* ... */]);

Parameter Syntax

$result = $client->createVariable([
    'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE', // REQUIRED
    'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN', // 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.

DeleteDetector

$result = $client->deleteDetector([/* ... */]);
$promise = $client->deleteDetectorAsync([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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.

DeleteEvent

$result = $client->deleteEvent([/* ... */]);
$promise = $client->deleteEventAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteEvent([
    '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([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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.

DeleteExternalModel

$result = $client->deleteExternalModel([/* ... */]);
$promise = $client->deleteExternalModelAsync([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• InternalServerException:

  An exception indicating an internal server error.

DeleteModel

$result = $client->deleteModel([/* ... */]);
$promise = $client->deleteModelAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteModel([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ConflictException:

  An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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.

DeleteModelVersion

$result = $client->deleteModelVersion([/* ... */]);
$promise = $client->deleteModelVersionAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteModelVersion([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_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.

• ConflictException:

  An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

DeleteOutcome

$result = $client->deleteOutcome([/* ... */]);
$promise = $client->deleteOutcomeAsync([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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([/* ... */]);

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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

• 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([/* ... */]);

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([/* ... */]);

Parameter Syntax

$result = $client->describeModelVersions([
    'maxResults' => <integer>,
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'modelVersionDetails' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'externalEventsDetail' => [
                'dataAccessRoleArn' => '<string>',
                'dataLocation' => '<string>',
            ],
            'lastUpdatedTime' => '<string>',
            'modelId' => '<string>',
            'modelType' => 'ONLINE_FRAUD_INSIGHTS',
            'modelVersionNumber' => '<string>',
            'status' => '<string>',
            'trainingDataSchema' => [
                'labelSchema' => [
                    'labelMapper' => [
                        '<string>' => ['<string>', ...],
                        // ...
                    ],
                ],
                'modelVariables' => ['<string>', ...],
            ],
            'trainingDataSource' => 'EXTERNAL_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>,
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        // ...
    ],
    '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.

• 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([/* ... */]);

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',
            '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([/* ... */]);

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([/* ... */]);

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.

• 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([/* ... */]);

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' => [
        '<string>' => [
            'byteBuffer' => <string || resource || Psr\Http\Message\StreamInterface>,
            'contentType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'modelScores' => [
        [
            'modelVersion' => [
                'arn' => '<string>',
                'modelId' => '<string>',
                'modelType' => 'ONLINE_FRAUD_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. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

GetEventTypes

$result = $client->getEventTypes([/* ... */]);
$promise = $client->getEventTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->getEventTypes([
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'eventTypes' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'entityTypes' => ['<string>', ...],
            'eventVariables' => ['<string>', ...],
            '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.

• 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([/* ... */]);

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([/* ... */]);

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.

• 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([/* ... */]);

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.

• 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([/* ... */]);

Parameter Syntax

$result = $client->getModelVersion([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'modelVersionNumber' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'externalEventsDetail' => [
        'dataAccessRoleArn' => '<string>',
        'dataLocation' => '<string>',
    ],
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'status' => '<string>',
    'trainingDataSchema' => [
        'labelSchema' => [
            'labelMapper' => [
                '<string>' => ['<string>', ...],
                // ...
            ],
        ],
        'modelVariables' => ['<string>', ...],
    ],
    'trainingDataSource' => 'EXTERNAL_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.

• 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([/* ... */]);

Parameter Syntax

$result = $client->getModels([
    'maxResults' => <integer>,
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'models' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'eventTypeName' => '<string>',
            'lastUpdatedTime' => '<string>',
            'modelId' => '<string>',
            'modelType' => 'ONLINE_FRAUD_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.

• 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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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',
            '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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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.

• 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([/* ... */]);

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.

PutEntityType

$result = $client->putEntityType([/* ... */]);
$promise = $client->putEntityTypeAsync([/* ... */]);

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.

• 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.

PutEventType

$result = $client->putEventType([/* ... */]);
$promise = $client->putEventTypeAsync([/* ... */]);

Parameter Syntax

$result = $client->putEventType([
    'description' => '<string>',
    'entityTypes' => ['<string>', ...], // 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.

• 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.

PutExternalModel

$result = $client->putExternalModel([/* ... */]);
$promise = $client->putExternalModelAsync([/* ... */]);

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.

PutKMSEncryptionKey

$result = $client->putKMSEncryptionKey([/* ... */]);
$promise = $client->putKMSEncryptionKeyAsync([/* ... */]);

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.

• 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.

PutLabel

$result = $client->putLabel([/* ... */]);
$promise = $client->putLabelAsync([/* ... */]);

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.

• 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.

PutOutcome

$result = $client->putOutcome([/* ... */]);
$promise = $client->putOutcomeAsync([/* ... */]);

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

• 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([/* ... */]);

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.

• 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([/* ... */]);

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', // REQUIRED
            'modelVersionNumber' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
    'rules' => [ // REQUIRED
        [
            'detectorId' => '<string>', // REQUIRED
            'ruleId' => '<string>', // REQUIRED
            'ruleVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details