Amazon Fraud Detector 2019-11-15
- Client: Aws\FraudDetector\FraudDetectorClient
- Service ID: frauddetector
- Version: 2019-11-15
This page describes the parameters and results for the operations of the Amazon Fraud Detector (2019-11-15), and shows how to use the Aws\FraudDetector\FraudDetectorClient object to call the described operations. This documentation is specific to the 2019-11-15 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchCreateVariable ( array $params = [] )
Creates a batch of variables.
- BatchGetVariable ( array $params = [] )
Gets a batch of variables.
- CreateDetectorVersion ( array $params = [] )
Creates a detector version.
- CreateModelVersion ( array $params = [] )
Creates a version of the model using the specified model type.
- CreateRule ( array $params = [] )
Creates a rule for use with the specified detector.
- CreateVariable ( array $params = [] )
Creates a variable.
- DeleteDetectorVersion ( array $params = [] )
Deletes the detector version.
- DeleteEvent ( array $params = [] )
Deletes the specified event.
- DescribeDetector ( array $params = [] )
Gets all versions for a specified detector.
- DescribeModelVersions ( array $params = [] )
Gets all of the model versions for the specified model type or for the specified model type and model ID.
- GetDetectorVersion ( array $params = [] )
Gets a particular detector version.
- GetDetectors ( array $params = [] )
Gets all of detectors.
- GetExternalModels ( array $params = [] )
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
- GetModelVersion ( array $params = [] )
Gets a model version.
- GetModels ( array $params = [] )
Gets all of the models for the AWS account, or the specified model type, or gets a single model for the specified model type, model ID combination.
- GetOutcomes ( array $params = [] )
Gets one or more outcomes.
- GetPrediction ( array $params = [] )
Evaluates an event against a detector version.
- GetRules ( array $params = [] )
Gets all rules available for the specified detector.
- GetVariables ( array $params = [] )
Gets all of the variables or the specific variable.
- PutDetector ( array $params = [] )
Creates or updates a detector.
- PutExternalModel ( array $params = [] )
Creates or updates an Amazon SageMaker model endpoint.
- PutModel ( array $params = [] )
Creates or updates a model.
- PutOutcome ( array $params = [] )
Creates or updates an outcome.
- UpdateDetectorVersion ( array $params = [] )
Updates a detector version.
- UpdateDetectorVersionMetadata ( array $params = [] )
Updates the detector version's description.
- UpdateDetectorVersionStatus ( array $params = [] )
Updates the detector version’s status.
- UpdateModelVersion ( array $params = [] )
Updates a model version.
- UpdateRuleMetadata ( array $params = [] )
Updates a rule's metadata.
- UpdateRuleVersion ( array $params = [] )
Updates a rule version resulting in a new rule version.
- UpdateVariable ( array $params = [] )
Updates a variable.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
BatchCreateVariable
$result = $client->batchCreateVariable([/* ... */]); $promise = $client->batchCreateVariableAsync([/* ... */]);
Creates a batch of variables.
Parameter Syntax
$result = $client->batchCreateVariable([
'variableEntries' => [ // REQUIRED
[
'dataSource' => '<string>',
'dataType' => '<string>',
'defaultValue' => '<string>',
'description' => '<string>',
'name' => '<string>',
'variableType' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- variableEntries
-
- Required: Yes
- Type: Array of VariableEntry structures
The list of variables for the batch create variable request.
Result Syntax
[
'errors' => [
[
'code' => <integer>,
'message' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- errors
-
- Type: Array of BatchCreateVariableError structures
Provides the errors for the
BatchCreateVariablerequest.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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' => [
[
'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
Members
- errors
-
- Type: Array of BatchGetVariableError structures
The errors from the request.
- variables
-
- Type: Array of Variable structures
The returned variables.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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' => [
[
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
],
// ...
],
'rules' => [ // REQUIRED
[
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The description of the detector version.
- detectorId
-
- Required: Yes
- Type: string
The ID of the detector under which you want to create a new version.
- externalModelEndpoints
-
- Type: Array of strings
The Amazon Sagemaker model endpoints to include in the detector version.
- modelVersions
-
- Type: Array of ModelVersion structures
The model versions to include in the detector version.
- rules
-
- Required: Yes
- Type: Array of Rule structures
The rules to include in the detector version.
Result Syntax
[
'detectorId' => '<string>',
'detectorVersionId' => '<string>',
'status' => 'DRAFT|ACTIVE|INACTIVE',
]
Result Details
Members
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
CreateModelVersion
$result = $client->createModelVersion([/* ... */]); $promise = $client->createModelVersionAsync([/* ... */]);
Creates a version of the model using the specified model type.
Parameter Syntax
$result = $client->createModelVersion([
'description' => '<string>',
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'modelVersionNumber' => '<string>',
'status' => '<string>',
]
Result Details
Members
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling 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
]);
Parameter Details
Members
- description
-
- Type: string
The rule description.
- detectorId
-
- Required: Yes
- Type: string
The detector ID for the rule's parent detector.
- expression
-
- Required: Yes
- Type: string
The rule expression.
- language
-
- Required: Yes
- Type: string
The language of the rule.
- outcomes
-
- Required: Yes
- Type: Array of strings
The outcome or outcomes returned when the rule expression matches.
- ruleId
-
- Required: Yes
- Type: string
The rule ID.
Result Syntax
[
'rule' => [
'detectorId' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
]
Result Details
Members
- rule
-
- Type: Rule structure
The created rule.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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', // REQUIRED
'defaultValue' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
'variableType' => '<string>',
]);
Parameter Details
Members
- dataSource
-
- Required: Yes
- Type: string
The source of the data.
- dataType
-
- Required: Yes
- Type: string
The data type.
- defaultValue
-
- Required: Yes
- Type: string
The default value for the variable when no value is received.
- description
-
- Type: string
The description.
- name
-
- Required: Yes
- Type: string
The name of the variable.
- variableType
-
- Type: string
The variable type.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
DeleteDetectorVersion
$result = $client->deleteDetectorVersion([/* ... */]); $promise = $client->deleteDetectorVersionAsync([/* ... */]);
Deletes the detector version.
Parameter Syntax
$result = $client->deleteDetectorVersion([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
DeleteEvent
$result = $client->deleteEvent([/* ... */]); $promise = $client->deleteEventAsync([/* ... */]);
Deletes the specified event.
Parameter Syntax
$result = $client->deleteEvent([
'eventId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
DescribeDetector
$result = $client->describeDetector([/* ... */]); $promise = $client->describeDetectorAsync([/* ... */]);
Gets all versions for a specified detector.
Parameter Syntax
$result = $client->describeDetector([
'detectorId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'detectorId' => '<string>',
'detectorVersionSummaries' => [
[
'description' => '<string>',
'detectorVersionId' => '<string>',
'lastUpdatedTime' => '<string>',
'status' => 'DRAFT|ACTIVE|INACTIVE',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- detectorId
-
- Type: string
The detector ID.
- detectorVersionSummaries
-
- Type: Array of DetectorVersionSummary structures
The status and description for each detector version.
- nextToken
-
- Type: string
The next token to be used for subsequent requests.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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',
'modelVersionNumber' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'modelVersionDetails' => [
[
'createdTime' => '<string>',
'description' => '<string>',
'labelSchema' => [
'labelKey' => '<string>',
'labelMapper' => [
'<string>' => ['<string>', ...],
// ...
],
],
'lastUpdatedTime' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'modelVariables' => [
[
'index' => <integer>,
'name' => '<string>',
],
// ...
],
'modelVersionNumber' => '<string>',
'status' => '<string>',
'trainingDataSource' => [
'dataAccessRoleArn' => '<string>',
'dataLocation' => '<string>',
],
'trainingMetrics' => ['<string>', ...],
'validationMetrics' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- modelVersionDetails
-
- Type: Array of ModelVersionDetail structures
The model version details.
- nextToken
-
- Type: string
The next token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetDetectorVersion
$result = $client->getDetectorVersion([/* ... */]); $promise = $client->getDetectorVersionAsync([/* ... */]);
Gets a particular detector version.
Parameter Syntax
$result = $client->getDetectorVersion([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'createdTime' => '<string>',
'description' => '<string>',
'detectorId' => '<string>',
'detectorVersionId' => '<string>',
'externalModelEndpoints' => ['<string>', ...],
'lastUpdatedTime' => '<string>',
'modelVersions' => [
[
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'modelVersionNumber' => '<string>',
],
// ...
],
'rules' => [
[
'detectorId' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
// ...
],
'status' => 'DRAFT|ACTIVE|INACTIVE',
]
Result Details
Members
- createdTime
-
- Type: string
The timestamp when the detector version was created.
- description
-
- Type: string
The detector version description.
- detectorId
-
- Type: string
The detector ID.
- detectorVersionId
-
- Type: string
The detector version ID.
- externalModelEndpoints
-
- Type: Array of strings
The Amazon SageMaker model endpoints included in the detector version.
- lastUpdatedTime
-
- Type: string
The timestamp when the detector version was last updated.
- modelVersions
-
- Type: Array of ModelVersion structures
The model versions included in the detector version.
- rules
-
- Type: Array of Rule structures
The rules included in the detector version.
- status
-
- Type: string
The status of the detector version.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetDetectors
$result = $client->getDetectors([/* ... */]); $promise = $client->getDetectorsAsync([/* ... */]);
Gets all of detectors. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, 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->getDetectors([
'detectorId' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'detectors' => [
[
'createdTime' => '<string>',
'description' => '<string>',
'detectorId' => '<string>',
'lastUpdatedTime' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- detectors
-
- Type: Array of Detector structures
The detectors.
- nextToken
-
- Type: string
The next page token.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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 maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getExternalModels([
'maxResults' => <integer>,
'modelEndpoint' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'externalModels' => [
[
'createdTime' => '<string>',
'inputConfiguration' => [
'csvInputTemplate' => '<string>',
'format' => 'TEXT_CSV|APPLICATION_JSON',
'isOpaque' => true || false,
'jsonInputTemplate' => '<string>',
],
'lastUpdatedTime' => '<string>',
'modelEndpoint' => '<string>',
'modelEndpointStatus' => 'ASSOCIATED|DISSOCIATED',
'modelSource' => 'SAGEMAKER',
'outputConfiguration' => [
'csvIndexToVariableMap' => ['<string>', ...],
'format' => 'TEXT_CSV|APPLICATION_JSONLINES',
'jsonKeyToVariableMap' => ['<string>', ...],
],
'role' => [
'arn' => '<string>',
'name' => '<string>',
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- externalModels
-
- Type: Array of ExternalModel structures
Gets the Amazon SageMaker models.
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetModelVersion
$result = $client->getModelVersion([/* ... */]); $promise = $client->getModelVersionAsync([/* ... */]);
Gets a model version.
Parameter Syntax
$result = $client->getModelVersion([
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'description' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'modelVersionNumber' => '<string>',
'status' => '<string>',
]
Result Details
Members
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetModels
$result = $client->getModels([/* ... */]); $promise = $client->getModelsAsync([/* ... */]);
Gets all of the models for the AWS account, or the specified model type, or gets a single model for the specified model type, model ID combination.
Parameter Syntax
$result = $client->getModels([
'maxResults' => <integer>,
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'models' => [
[
'createdTime' => '<string>',
'description' => '<string>',
'labelSchema' => [
'labelKey' => '<string>',
'labelMapper' => [
'<string>' => ['<string>', ...],
// ...
],
],
'lastUpdatedTime' => '<string>',
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'modelVariables' => [
[
'index' => <integer>,
'name' => '<string>',
],
// ...
],
'trainingDataSource' => [
'dataAccessRoleArn' => '<string>',
'dataLocation' => '<string>',
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- models
-
- Type: Array of Model structures
The returned models.
- nextToken
-
- Type: string
The next token for subsequent requests.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetOutcomes
$result = $client->getOutcomes([/* ... */]); $promise = $client->getOutcomesAsync([/* ... */]);
Gets one or more outcomes. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getOutcomes([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'outcomes' => [
[
'createdTime' => '<string>',
'description' => '<string>',
'lastUpdatedTime' => '<string>',
'name' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The next page token for subsequent requests.
- outcomes
-
- Type: Array of Outcome structures
The outcomes.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetPrediction
$result = $client->getPrediction([/* ... */]); $promise = $client->getPredictionAsync([/* ... */]);
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->getPrediction([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>',
'eventAttributes' => ['<string>', ...],
'eventId' => '<string>', // REQUIRED
'externalModelEndpointDataBlobs' => [
'<string>' => [
'byteBuffer' => <string || resource || Psr\Http\Message\StreamInterface>,
'contentType' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- detectorId
-
- Required: Yes
- Type: string
The detector ID.
- detectorVersionId
-
- Type: string
The detector version ID.
- eventAttributes
-
- Type: Associative array of custom strings keys (attributeKey) to strings
Names of variables you defined in Amazon Fraud Detector to represent event data elements and their corresponding values for the event you are sending for evaluation.
- eventId
-
- Required: Yes
- Type: string
The unique ID used to identify the event.
- externalModelEndpointDataBlobs
-
- Type: Associative array of custom strings keys (string) to ModelEndpointDataBlob structures
The Amazon SageMaker model endpoint input data blobs.
Result Syntax
[
'modelScores' => [
[
'modelVersion' => [
'modelId' => '<string>',
'modelType' => 'ONLINE_FRAUD_INSIGHTS',
'modelVersionNumber' => '<string>',
],
'scores' => [<float>, ...],
],
// ...
],
'outcomes' => ['<string>', ...],
]
Result Details
Members
- modelScores
-
- Type: Array of ModelScores structures
The model scores for models used in the detector version.
- outcomes
-
- Type: Array of strings
The prediction outcomes.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetRules
$result = $client->getRules([/* ... */]); $promise = $client->getRulesAsync([/* ... */]);
Gets all rules available for the specified detector.
Parameter Syntax
$result = $client->getRules([
'detectorId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'ruleDetails' => [
[
'createdTime' => '<string>',
'description' => '<string>',
'detectorId' => '<string>',
'expression' => '<string>',
'language' => 'DETECTORPL',
'lastUpdatedTime' => '<string>',
'outcomes' => ['<string>', ...],
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
- ruleDetails
-
- Type: Array of RuleDetail structures
The details of the requested rule.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
GetVariables
$result = $client->getVariables([/* ... */]); $promise = $client->getVariablesAsync([/* ... */]);
Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
Parameter Syntax
$result = $client->getVariables([
'maxResults' => <integer>,
'name' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'nextToken' => '<string>',
'variables' => [
[
'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
Members
- nextToken
-
- Type: string
The next page token to be used in subsequent requests.
- variables
-
- Type: Array of Variable structures
The names of the variables returned.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
PutDetector
$result = $client->putDetector([/* ... */]); $promise = $client->putDetectorAsync([/* ... */]);
Creates or updates a detector.
Parameter Syntax
$result = $client->putDetector([
'description' => '<string>',
'detectorId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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>',
'format' => 'TEXT_CSV|APPLICATION_JSON',
'isOpaque' => true || false, // REQUIRED
'jsonInputTemplate' => '<string>',
],
'modelEndpoint' => '<string>', // REQUIRED
'modelEndpointStatus' => 'ASSOCIATED|DISSOCIATED', // REQUIRED
'modelSource' => 'SAGEMAKER', // REQUIRED
'outputConfiguration' => [ // REQUIRED
'csvIndexToVariableMap' => ['<string>', ...],
'format' => 'TEXT_CSV|APPLICATION_JSONLINES', // REQUIRED
'jsonKeyToVariableMap' => ['<string>', ...],
],
'role' => [ // REQUIRED
'arn' => '<string>', // REQUIRED
'name' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- inputConfiguration
-
- Required: Yes
- Type: ModelInputConfiguration structure
The model endpoint input configuration.
- modelEndpoint
-
- Required: Yes
- Type: string
The model endpoints name.
- modelEndpointStatus
-
- Required: Yes
- Type: string
The model endpoint’s status in Amazon Fraud Detector.
- modelSource
-
- Required: Yes
- Type: string
The source of the model.
- outputConfiguration
-
- Required: Yes
- Type: ModelOutputConfiguration structure
The model endpoint output configuration.
- role
-
- Required: Yes
- Type: Role structure
The IAM role used to invoke the model endpoint.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
PutModel
$result = $client->putModel([/* ... */]); $promise = $client->putModelAsync([/* ... */]);
Creates or updates a model.
Parameter Syntax
$result = $client->putModel([
'description' => '<string>',
'labelSchema' => [ // REQUIRED
'labelKey' => '<string>', // REQUIRED
'labelMapper' => [ // REQUIRED
'<string>' => ['<string>', ...],
// ...
],
],
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
'modelVariables' => [ // REQUIRED
[
'index' => <integer>,
'name' => '<string>', // REQUIRED
],
// ...
],
'trainingDataSource' => [ // REQUIRED
'dataAccessRoleArn' => '<string>', // REQUIRED
'dataLocation' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- description
-
- Type: string
The model description.
- labelSchema
-
- Required: Yes
- Type: LabelSchema structure
The label schema.
- modelId
-
- Required: Yes
- Type: string
The model ID.
- modelType
-
- Required: Yes
- Type: string
The model type.
- modelVariables
-
- Required: Yes
- Type: Array of ModelVariable structures
The model input variables.
- trainingDataSource
-
- Required: Yes
- Type: TrainingDataSource structure
The training data source location in Amazon S3.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
PutOutcome
$result = $client->putOutcome([/* ... */]); $promise = $client->putOutcomeAsync([/* ... */]);
Creates or updates an outcome.
Parameter Syntax
$result = $client->putOutcome([
'description' => '<string>',
'name' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
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, 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' => [
[
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
],
// ...
],
'rules' => [ // REQUIRED
[
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- description
-
- Type: string
The detector version description.
- detectorId
-
- Required: Yes
- Type: string
The parent detector ID for the detector version you want to update.
- detectorVersionId
-
- Required: Yes
- Type: string
The detector version ID.
- externalModelEndpoints
-
- Required: Yes
- Type: Array of strings
The Amazon SageMaker model endpoints to include in the detector version.
- modelVersions
-
- Type: Array of ModelVersion structures
The model versions to include in the detector version.
- rules
-
- Required: Yes
- Type: Array of Rule structures
The rules to include in the detector version.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
UpdateDetectorVersionMetadata
$result = $client->updateDetectorVersionMetadata([/* ... */]); $promise = $client->updateDetectorVersionMetadataAsync([/* ... */]);
Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
Parameter Syntax
$result = $client->updateDetectorVersionMetadata([
'description' => '<string>', // REQUIRED
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
UpdateDetectorVersionStatus
$result = $client->updateDetectorVersionStatus([/* ... */]); $promise = $client->updateDetectorVersionStatusAsync([/* ... */]);
Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.
Parameter Syntax
$result = $client->updateDetectorVersionStatus([
'detectorId' => '<string>', // REQUIRED
'detectorVersionId' => '<string>', // REQUIRED
'status' => 'DRAFT|ACTIVE|INACTIVE', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
UpdateModelVersion
$result = $client->updateModelVersion([/* ... */]); $promise = $client->updateModelVersionAsync([/* ... */]);
Updates a model version. You can update the description and status attributes using this action. You can perform the following status updates:
-
Change the
TRAINING_COMPLETEstatus toACTIVE -
Change
ACTIVEback toTRAINING_COMPLETE
Parameter Syntax
$result = $client->updateModelVersion([
'description' => '<string>', // REQUIRED
'modelId' => '<string>', // REQUIRED
'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
'modelVersionNumber' => '<string>', // REQUIRED
'status' => 'TRAINING_IN_PROGRESS|TRAINING_COMPLETE|ACTIVATE_REQUESTED|ACTIVATE_IN_PROGRESS|ACTIVE|INACTIVATE_IN_PROGRESS|INACTIVE|ERROR', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
UpdateRuleMetadata
$result = $client->updateRuleMetadata([/* ... */]); $promise = $client->updateRuleMetadataAsync([/* ... */]);
Updates a rule's metadata.
Parameter Syntax
$result = $client->updateRuleMetadata([
'description' => '<string>', // REQUIRED
'rule' => [ // REQUIRED
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- description
-
- Required: Yes
- Type: string
The rule description.
- rule
-
- Required: Yes
- Type: Rule structure
The rule to update.
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
UpdateRuleVersion
$result = $client->updateRuleVersion([/* ... */]); $promise = $client->updateRuleVersionAsync([/* ... */]);
Updates a rule version resulting in a new rule version.
Parameter Syntax
$result = $client->updateRuleVersion([
'description' => '<string>',
'expression' => '<string>', // REQUIRED
'language' => 'DETECTORPL', // REQUIRED
'outcomes' => ['<string>', ...], // REQUIRED
'rule' => [ // REQUIRED
'detectorId' => '<string>', // REQUIRED
'ruleId' => '<string>', // REQUIRED
'ruleVersion' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- description
-
- Type: string
The description.
- expression
-
- Required: Yes
- Type: string
The rule expression.
- language
-
- Required: Yes
- Type: string
The language.
- outcomes
-
- Required: Yes
- Type: Array of strings
The outcomes.
- rule
-
- Required: Yes
- Type: Rule structure
The rule to update.
Result Syntax
[
'rule' => [
'detectorId' => '<string>',
'ruleId' => '<string>',
'ruleVersion' => '<string>',
],
]
Result Details
Members
- rule
-
- Type: Rule structure
The new rule version that was created.
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
UpdateVariable
$result = $client->updateVariable([/* ... */]); $promise = $client->updateVariableAsync([/* ... */]);
Updates a variable.
Parameter Syntax
$result = $client->updateVariable([
'defaultValue' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'variableType' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
An exception indicating a specified value is not allowed.
-
An exception indicating the specified resource was not found.
-
An exception indicating an internal server error.
-
An exception indicating a throttling error.
Shapes
BatchCreateVariableError
Description
Provides the error of the batch create variable API.
Members
BatchGetVariableError
Description
Provides the error of the batch get variable API.
Members
Detector
Description
The detector.
Members
DetectorVersionSummary
Description
The summary of the detector version.
Members
ExternalModel
Description
The Amazon SageMaker model.
Members
- createdTime
-
- Type: string
Timestamp of when the model was last created.
- inputConfiguration
-
- Type: ModelInputConfiguration structure
The input configuration.
- lastUpdatedTime
-
- Type: string
Timestamp of when the model was last updated.
- modelEndpoint
-
- Type: string
The Amazon SageMaker model endpoints.
- modelEndpointStatus
-
- Type: string
The Amazon Fraud Detector status for the external model endpoint
- modelSource
-
- Type: string
The source of the model.
- outputConfiguration
-
- Type: ModelOutputConfiguration structure
The output configuration.
- role
-
- Type: Role structure
The role used to invoke the model.
InternalServerException
Description
An exception indicating an internal server error.
Members
LabelSchema
Description
The label schema.
Members
- labelKey
-
- Required: Yes
- Type: string
The label key.
- labelMapper
-
- Required: Yes
- Type: Associative array of custom strings keys (string) to stringss
The label mapper maps the Amazon Fraud Detector supported label to the appropriate source labels. For example, if
"FRAUD"and"LEGIT"are Amazon Fraud Detector supported labels, this mapper could be:{"FRAUD" => ["0"], "LEGIT" => ["1"]} or{"FRAUD" => ["false"], "LEGIT" => ["true"]}or{"FRAUD" => ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]}. The value part of the mapper is a list, because you may have multiple variants for a single Amazon Fraud Detector label.
Model
Description
The model.
Members
- createdTime
-
- Type: string
Timestamp of when the model was created.
- description
-
- Type: string
The model description.
- labelSchema
-
- Type: LabelSchema structure
The model label schema.
- lastUpdatedTime
-
- Type: string
Timestamp of last time the model was updated.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVariables
-
- Type: Array of ModelVariable structures
The model input variables.
- trainingDataSource
-
- Type: TrainingDataSource structure
The model training data source in Amazon S3.
ModelEndpointDataBlob
Description
A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.
Members
ModelInputConfiguration
Description
The model input configuration.
Members
- csvInputTemplate
-
- Type: string
Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.
- format
-
- Type: string
The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.
- isOpaque
-
- Required: Yes
- Type: boolean
For an opaque-model, the input to the model will be a ByteBuffer blob provided in the getPrediction request, and will be passed to SageMaker as-is. For non-opaque models, the input will be constructed by Amazon Fraud Detector based on the model-configuration.
- jsonInputTemplate
-
- Type: string
Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.
ModelOutputConfiguration
Description
Provides the model output configuration.
Members
- csvIndexToVariableMap
-
- Type: Associative array of custom strings keys (string) to strings
A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
- format
-
- Required: Yes
- Type: string
The format of the model output configuration.
- jsonKeyToVariableMap
-
- Type: Associative array of custom strings keys (string) to strings
A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
ModelScores
Description
The fraud prediction scores.
Members
- modelVersion
-
- Type: ModelVersion structure
The model version.
- scores
-
- Type: Associative array of custom strings keys (string) to floats
The model's fraud prediction scores.
ModelVariable
Description
The model variable.>
Members
ModelVersion
Description
The model version.
Members
ModelVersionDetail
Description
Provides the model version details.
Members
- createdTime
-
- Type: string
The timestamp when the model was created.
- description
-
- Type: string
The model description.
- labelSchema
-
- Type: LabelSchema structure
The model label schema.
- lastUpdatedTime
-
- Type: string
The timestamp when the model was last updated.
- modelId
-
- Type: string
The model ID.
- modelType
-
- Type: string
The model type.
- modelVariables
-
- Type: Array of ModelVariable structures
The model variables.
- modelVersionNumber
-
- Type: string
The model version.
- status
-
- Type: string
The model status.
- trainingDataSource
-
- Type: TrainingDataSource structure
The model training data source.
- trainingMetrics
-
- Type: Associative array of custom strings keys (string) to strings
The model training metrics.
- validationMetrics
-
- Type: Associative array of custom strings keys (string) to strings
The model validation metrics.
Outcome
Description
The outcome.
Members
ResourceNotFoundException
Description
An exception indicating the specified resource was not found.
Members
Role
Description
The role used to invoke external model endpoints.
Members
Rule
Description
A rule.
Members
RuleDetail
Description
The details of the rule.
Members
- createdTime
-
- Type: string
The timestamp of when the rule was created.
- description
-
- Type: string
The rule description.
- detectorId
-
- Type: string
The detector for which the rule is associated.
- expression
-
- Type: string
The rule expression.
- language
-
- Type: string
The rule language.
- lastUpdatedTime
-
- Type: string
Timestamp of the last time the rule was updated.
- outcomes
-
- Type: Array of strings
The rule outcomes.
- ruleId
-
- Type: string
The rule ID.
- ruleVersion
-
- Type: string
The rule version.
ThrottlingException
TrainingDataSource
Description
The training data source.
Members
ValidationException
Description
An exception indicating a specified value is not allowed.
Members
Variable
Description
The variable.
Members
- createdTime
-
- Type: string
The time when the variable was created.
- dataSource
-
- Type: string
The data source of the variable.
- dataType
-
- Type: string
The data type of the variable.
- defaultValue
-
- Type: string
The default value of the variable.
- description
-
- Type: string
The description of the variable.
- lastUpdatedTime
-
- Type: string
The time when variable was last updated.
- name
-
- Type: string
The name of the variable.
- variableType
-
- Type: string
The variable type of the variable.
VariableEntry
Description
The variable entry in a list.
Members
- dataSource
-
- Type: string
The data source of the variable entry.
- dataType
-
- Type: string
The data type of the variable entry.
- defaultValue
-
- Type: string
The default value of the variable entry.
- description
-
- Type: string
The description of the variable entry.
- name
-
- Type: string
The name of the variable entry.
- variableType
-
- Type: string
The type of the variable entry.
