NAME

Paws::FraudDetector - Perl Interface to AWS Amazon Fraud Detector

SYNOPSIS

use Paws;

my $obj = Paws->service('FraudDetector');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide (https://docs.aws.amazon.com/frauddetector/latest/ug/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15

METHODS

BatchCreateVariable

VariableEntries => ArrayRef[Paws::FraudDetector::VariableEntry]

Each argument is described in detail in: Paws::FraudDetector::BatchCreateVariable

Returns: a Paws::FraudDetector::BatchCreateVariableResult instance

Creates a batch of variables.

BatchGetVariable

Names => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::FraudDetector::BatchGetVariable

Returns: a Paws::FraudDetector::BatchGetVariableResult instance

Gets a batch of variables.

CreateDetectorVersion

DetectorId => Str
Rules => ArrayRef[Paws::FraudDetector::Rule]
[Description => Str]
[ExternalModelEndpoints => ArrayRef[Str|Undef]]
[ModelVersions => ArrayRef[Paws::FraudDetector::ModelVersion]]

Each argument is described in detail in: Paws::FraudDetector::CreateDetectorVersion

Returns: a Paws::FraudDetector::CreateDetectorVersionResult instance

Creates a detector version. The detector version starts in a DRAFT status.

CreateModelVersion

ModelId => Str
ModelType => Str
[Description => Str]

Each argument is described in detail in: Paws::FraudDetector::CreateModelVersion

Returns: a Paws::FraudDetector::CreateModelVersionResult instance

Creates a version of the model using the specified model type.

CreateRule

DetectorId => Str
Expression => Str
Language => Str
Outcomes => ArrayRef[Str|Undef]
RuleId => Str
[Description => Str]

Each argument is described in detail in: Paws::FraudDetector::CreateRule

Returns: a Paws::FraudDetector::CreateRuleResult instance

Creates a rule for use with the specified detector.

CreateVariable

DataSource => Str
DataType => Str
DefaultValue => Str
Name => Str
[Description => Str]
[VariableType => Str]

Each argument is described in detail in: Paws::FraudDetector::CreateVariable

Returns: a Paws::FraudDetector::CreateVariableResult instance

Creates a variable.

DeleteDetectorVersion

DetectorId => Str
DetectorVersionId => Str

Each argument is described in detail in: Paws::FraudDetector::DeleteDetectorVersion

Returns: a Paws::FraudDetector::DeleteDetectorVersionResult instance

Deletes the detector version.

DeleteEvent

EventId => Str

Each argument is described in detail in: Paws::FraudDetector::DeleteEvent

Returns: a Paws::FraudDetector::DeleteEventResult instance

Deletes the specified event.

DescribeDetector

DetectorId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::DescribeDetector

Returns: a Paws::FraudDetector::DescribeDetectorResult instance

Gets all versions for a specified detector.

DescribeModelVersions

[MaxResults => Int]
[ModelId => Str]
[ModelType => Str]
[ModelVersionNumber => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::DescribeModelVersions

Returns: a Paws::FraudDetector::DescribeModelVersionsResult instance

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.

GetDetectors

[DetectorId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::GetDetectors

Returns: a Paws::FraudDetector::GetDetectorsResult instance

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.

GetDetectorVersion

DetectorId => Str
DetectorVersionId => Str

Each argument is described in detail in: Paws::FraudDetector::GetDetectorVersion

Returns: a Paws::FraudDetector::GetDetectorVersionResult instance

Gets a particular detector version.

GetExternalModels

[MaxResults => Int]
[ModelEndpoint => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::GetExternalModels

Returns: a Paws::FraudDetector::GetExternalModelsResult instance

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.

GetModels

[MaxResults => Int]
[ModelId => Str]
[ModelType => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::GetModels

Returns: a Paws::FraudDetector::GetModelsResult instance

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.

GetModelVersion

ModelId => Str
ModelType => Str
ModelVersionNumber => Str

Each argument is described in detail in: Paws::FraudDetector::GetModelVersion

Returns: a Paws::FraudDetector::GetModelVersionResult instance

Gets a model version.

GetOutcomes

[MaxResults => Int]
[Name => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::GetOutcomes

Returns: a Paws::FraudDetector::GetOutcomesResult instance

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.

GetPrediction

DetectorId => Str
EventId => Str
[DetectorVersionId => Str]
[EventAttributes => Paws::FraudDetector::EventAttributeMap]
[ExternalModelEndpointDataBlobs => Paws::FraudDetector::ExternalModelEndpointDataBlobMap]

Each argument is described in detail in: Paws::FraudDetector::GetPrediction

Returns: a Paws::FraudDetector::GetPredictionResult instance

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

GetRules

DetectorId => Str
[MaxResults => Int]
[NextToken => Str]
[RuleId => Str]
[RuleVersion => Str]

Each argument is described in detail in: Paws::FraudDetector::GetRules

Returns: a Paws::FraudDetector::GetRulesResult instance

Gets all rules available for the specified detector.

GetVariables

[MaxResults => Int]
[Name => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::FraudDetector::GetVariables

Returns: a Paws::FraudDetector::GetVariablesResult instance

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.

PutDetector

DetectorId => Str
[Description => Str]

Each argument is described in detail in: Paws::FraudDetector::PutDetector

Returns: a Paws::FraudDetector::PutDetectorResult instance

Creates or updates a detector.

PutExternalModel

InputConfiguration => Paws::FraudDetector::ModelInputConfiguration
ModelEndpoint => Str
ModelEndpointStatus => Str
ModelSource => Str
OutputConfiguration => Paws::FraudDetector::ModelOutputConfiguration
Role => Paws::FraudDetector::Role

Each argument is described in detail in: Paws::FraudDetector::PutExternalModel

Returns: a Paws::FraudDetector::PutExternalModelResult instance

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.

PutModel

LabelSchema => Paws::FraudDetector::LabelSchema
ModelId => Str
ModelType => Str
ModelVariables => ArrayRef[Paws::FraudDetector::ModelVariable]
TrainingDataSource => Paws::FraudDetector::TrainingDataSource
[Description => Str]

Each argument is described in detail in: Paws::FraudDetector::PutModel

Returns: a Paws::FraudDetector::PutModelResult instance

Creates or updates a model.

PutOutcome

Name => Str
[Description => Str]

Each argument is described in detail in: Paws::FraudDetector::PutOutcome

Returns: a Paws::FraudDetector::PutOutcomeResult instance

Creates or updates an outcome.

UpdateDetectorVersion

DetectorId => Str
DetectorVersionId => Str
ExternalModelEndpoints => ArrayRef[Str|Undef]
Rules => ArrayRef[Paws::FraudDetector::Rule]
[Description => Str]
[ModelVersions => ArrayRef[Paws::FraudDetector::ModelVersion]]

Each argument is described in detail in: Paws::FraudDetector::UpdateDetectorVersion

Returns: a Paws::FraudDetector::UpdateDetectorVersionResult instance

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.

UpdateDetectorVersionMetadata

Description => Str
DetectorId => Str
DetectorVersionId => Str

Each argument is described in detail in: Paws::FraudDetector::UpdateDetectorVersionMetadata

Returns: a Paws::FraudDetector::UpdateDetectorVersionMetadataResult instance

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).

UpdateDetectorVersionStatus

DetectorId => Str
DetectorVersionId => Str
Status => Str

Each argument is described in detail in: Paws::FraudDetector::UpdateDetectorVersionStatus

Returns: a Paws::FraudDetector::UpdateDetectorVersionStatusResult instance

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.

UpdateModelVersion

Description => Str
ModelId => Str
ModelType => Str
ModelVersionNumber => Str
Status => Str

Each argument is described in detail in: Paws::FraudDetector::UpdateModelVersion

Returns: a Paws::FraudDetector::UpdateModelVersionResult instance

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_COMPLETE status to ACTIVE
Change ACTIVE back to TRAINING_COMPLETE

UpdateRuleMetadata

Description => Str
Rule => Paws::FraudDetector::Rule

Each argument is described in detail in: Paws::FraudDetector::UpdateRuleMetadata

Returns: a Paws::FraudDetector::UpdateRuleMetadataResult instance

Updates a rule's metadata.

UpdateRuleVersion

Expression => Str
Language => Str
Outcomes => ArrayRef[Str|Undef]
Rule => Paws::FraudDetector::Rule
[Description => Str]

Each argument is described in detail in: Paws::FraudDetector::UpdateRuleVersion

Returns: a Paws::FraudDetector::UpdateRuleVersionResult instance

Updates a rule version resulting in a new rule version.

UpdateVariable

Name => Str
[DefaultValue => Str]
[Description => Str]
[VariableType => Str]

Each argument is described in detail in: Paws::FraudDetector::UpdateVariable

Returns: a Paws::FraudDetector::UpdateVariableResult instance

Updates a variable.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws::SDK::Config

CPAN shell

perl -MCPAN -e shell
install Paws::SDK::Config

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)