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]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::BatchCreateVariable
Returns: a Paws::FraudDetector::BatchCreateVariableResult instance
Creates a batch of variables.
BatchGetVariable
Each argument is described in detail in: Paws::FraudDetector::BatchGetVariable
Returns: a Paws::FraudDetector::BatchGetVariableResult instance
Gets a batch of variables.
CancelBatchPredictionJob
Each argument is described in detail in: Paws::FraudDetector::CancelBatchPredictionJob
Returns: a Paws::FraudDetector::CancelBatchPredictionJobResult instance
Cancels the specified batch prediction job.
CreateBatchPredictionJob
- DetectorName => Str
- EventTypeName => Str
- IamRoleArn => Str
- InputPath => Str
- JobId => Str
- OutputPath => Str
- [DetectorVersion => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::CreateBatchPredictionJob
Returns: a Paws::FraudDetector::CreateBatchPredictionJobResult instance
Creates a batch prediction job.
CreateDetectorVersion
- DetectorId => Str
- Rules => ArrayRef[Paws::FraudDetector::Rule]
- [Description => Str]
- [ExternalModelEndpoints => ArrayRef[Str|Undef]]
- [ModelVersions => ArrayRef[Paws::FraudDetector::ModelVersion]]
- [RuleExecutionMode => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
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.
CreateModel
- EventTypeName => Str
- ModelId => Str
- ModelType => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::CreateModel
Returns: a Paws::FraudDetector::CreateModelResult instance
Creates a model using the specified model type.
CreateModelVersion
- ModelId => Str
- ModelType => Str
- TrainingDataSchema => Paws::FraudDetector::TrainingDataSchema
- TrainingDataSource => Str
- [ExternalEventsDetail => Paws::FraudDetector::ExternalEventsDetail]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
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 and model id.
CreateRule
- DetectorId => Str
- Expression => Str
- Language => Str
- Outcomes => ArrayRef[Str|Undef]
- RuleId => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
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]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
- [VariableType => Str]
Each argument is described in detail in: Paws::FraudDetector::CreateVariable
Returns: a Paws::FraudDetector::CreateVariableResult instance
Creates a variable.
DeleteBatchPredictionJob
Each argument is described in detail in: Paws::FraudDetector::DeleteBatchPredictionJob
Returns: a Paws::FraudDetector::DeleteBatchPredictionJobResult instance
Deletes a batch prediction job.
DeleteDetector
Each argument is described in detail in: Paws::FraudDetector::DeleteDetector
Returns: a Paws::FraudDetector::DeleteDetectorResult instance
Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
DeleteDetectorVersion
Each argument is described in detail in: Paws::FraudDetector::DeleteDetectorVersion
Returns: a Paws::FraudDetector::DeleteDetectorVersionResult instance
Deletes the detector version. You cannot delete detector versions that are in ACTIVE
status.
When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
DeleteEntityType
Each argument is described in detail in: Paws::FraudDetector::DeleteEntityType
Returns: a Paws::FraudDetector::DeleteEntityTypeResult instance
Deletes an entity type.
You cannot delete an entity type that is included in an event type.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.
DeleteEvent
Each argument is described in detail in: Paws::FraudDetector::DeleteEvent
Returns: a Paws::FraudDetector::DeleteEventResult instance
Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector.
DeleteEventType
Each argument is described in detail in: Paws::FraudDetector::DeleteEventType
Returns: a Paws::FraudDetector::DeleteEventTypeResult instance
Deletes an event type.
You cannot delete an event type that is used in a detector or a model.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.
DeleteExternalModel
Each argument is described in detail in: Paws::FraudDetector::DeleteExternalModel
Returns: a Paws::FraudDetector::DeleteExternalModelResult instance
Removes a SageMaker model from Amazon Fraud Detector.
You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
DeleteLabel
Each argument is described in detail in: Paws::FraudDetector::DeleteLabel
Returns: a Paws::FraudDetector::DeleteLabelResult instance
Deletes a label.
You cannot delete labels that are included in an event type in Amazon Fraud Detector.
You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.
When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.
DeleteModel
Each argument is described in detail in: Paws::FraudDetector::DeleteModel
Returns: a Paws::FraudDetector::DeleteModelResult instance
Deletes a model.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.
DeleteModelVersion
Each argument is described in detail in: Paws::FraudDetector::DeleteModelVersion
Returns: a Paws::FraudDetector::DeleteModelVersionResult instance
Deletes a model version.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.
DeleteOutcome
Each argument is described in detail in: Paws::FraudDetector::DeleteOutcome
Returns: a Paws::FraudDetector::DeleteOutcomeResult instance
Deletes an outcome.
You cannot delete an outcome that is used in a rule version.
When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.
DeleteRule
- Rule => Paws::FraudDetector::Rule
Each argument is described in detail in: Paws::FraudDetector::DeleteRule
Returns: a Paws::FraudDetector::DeleteRuleResult instance
Deletes the rule. You cannot delete a rule if it is used by an ACTIVE
or INACTIVE
detector version.
When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.
DeleteVariable
Each argument is described in detail in: Paws::FraudDetector::DeleteVariable
Returns: a Paws::FraudDetector::DeleteVariableResult instance
Deletes a variable.
You can't delete variables that are included in an event type in Amazon Fraud Detector.
Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually.
When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.
DescribeDetector
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.
GetBatchPredictionJobs
Each argument is described in detail in: Paws::FraudDetector::GetBatchPredictionJobs
Returns: a Paws::FraudDetector::GetBatchPredictionJobsResult instance
Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
GetDetectors
Each argument is described in detail in: Paws::FraudDetector::GetDetectors
Returns: a Paws::FraudDetector::GetDetectorsResult instance
Gets all detectors or a single detector if a detectorId
is specified. This is a paginated API. If you provide a null maxResults
, this action retrieves a maximum of 10 records per page. If you provide a maxResults
, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse
as part of your request. A null pagination token fetches the records from the beginning.
GetDetectorVersion
Each argument is described in detail in: Paws::FraudDetector::GetDetectorVersion
Returns: a Paws::FraudDetector::GetDetectorVersionResult instance
Gets a particular detector version.
GetEntityTypes
Each argument is described in detail in: Paws::FraudDetector::GetEntityTypes
Returns: a Paws::FraudDetector::GetEntityTypesResult instance
Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults
, this action retrieves a maximum of 10 records per page. If you provide a maxResults
, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse
as part of your request. A null pagination token fetches the records from the beginning.
GetEventPrediction
- DetectorId => Str
- Entities => ArrayRef[Paws::FraudDetector::Entity]
- EventId => Str
- EventTimestamp => Str
- EventTypeName => Str
- EventVariables => Paws::FraudDetector::EventVariableMap
- [DetectorVersionId => Str]
- [ExternalModelEndpointDataBlobs => Paws::FraudDetector::ExternalModelEndpointDataBlobMap]
Each argument is described in detail in: Paws::FraudDetector::GetEventPrediction
Returns: a Paws::FraudDetector::GetEventPredictionResult instance
Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE
) version is used.
GetEventTypes
Each argument is described in detail in: Paws::FraudDetector::GetEventTypes
Returns: a Paws::FraudDetector::GetEventTypesResult instance
Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults
, this action retrieves a maximum of 10 records per page. If you provide a maxResults
, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse
as part of your request. A null pagination token fetches the records from the beginning.
GetExternalModels
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 maxResults
, this actions retrieves a maximum of 10 records per page. If you provide a maxResults
, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult
as part of your request. A null pagination token fetches the records from the beginning.
GetKMSEncryptionKey
Each argument is described in detail in: Paws::FraudDetector::GetKMSEncryptionKey
Returns: a Paws::FraudDetector::GetKMSEncryptionKeyResult instance
Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.
GetLabels
Each argument is described in detail in: Paws::FraudDetector::GetLabels
Returns: a Paws::FraudDetector::GetLabelsResult instance
Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults
, this action retrieves a maximum of 50 records per page. If you provide a maxResults
, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse
as part of your request. A null pagination token fetches the records from the beginning.
GetModels
Each argument is described in detail in: Paws::FraudDetector::GetModels
Returns: a Paws::FraudDetector::GetModelsResult instance
Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.
This is a paginated API. If you provide a null maxResults
, this action retrieves a maximum of 10 records per page. If you provide a maxResults
, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
GetModelVersion
Each argument is described in detail in: Paws::FraudDetector::GetModelVersion
Returns: a Paws::FraudDetector::GetModelVersionResult instance
Gets the details of the specified model version.
GetOutcomes
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 maxResults
, this actions retrieves a maximum of 100 records per page. If you provide a maxResults
, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult
as part of your request. A null pagination token fetches the records from the beginning.
GetRules
Each argument is described in detail in: Paws::FraudDetector::GetRules
Returns: a Paws::FraudDetector::GetRulesResult instance
Get all rules for a detector (paginated) if ruleId
and ruleVersion
are not specified. Gets all rules for the detector and the ruleId
if present (paginated). Gets a specific rule if both the ruleId
and the ruleVersion
are specified.
This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
GetVariables
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.
ListTagsForResource
Each argument is described in detail in: Paws::FraudDetector::ListTagsForResource
Returns: a Paws::FraudDetector::ListTagsForResourceResult instance
Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
PutDetector
- DetectorId => Str
- EventTypeName => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::PutDetector
Returns: a Paws::FraudDetector::PutDetectorResult instance
Creates or updates a detector.
PutEntityType
- Name => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::PutEntityType
Returns: a Paws::FraudDetector::PutEntityTypeResult instance
Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
PutEventType
- EntityTypes => ArrayRef[Str|Undef]
- EventVariables => ArrayRef[Str|Undef]
- Name => Str
- [Description => Str]
- [Labels => ArrayRef[Str|Undef]]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::PutEventType
Returns: a Paws::FraudDetector::PutEventTypeResult instance
Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
PutExternalModel
- InputConfiguration => Paws::FraudDetector::ModelInputConfiguration
- InvokeModelEndpointRoleArn => Str
- ModelEndpoint => Str
- ModelEndpointStatus => Str
- ModelSource => Str
- OutputConfiguration => Paws::FraudDetector::ModelOutputConfiguration
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
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.
PutKMSEncryptionKey
Each argument is described in detail in: Paws::FraudDetector::PutKMSEncryptionKey
Returns: a Paws::FraudDetector::PutKMSEncryptionKeyResult instance
Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
PutLabel
- Name => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::PutLabel
Returns: a Paws::FraudDetector::PutLabelResult instance
Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.
PutOutcome
- Name => Str
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::PutOutcome
Returns: a Paws::FraudDetector::PutOutcomeResult instance
Creates or updates an outcome.
TagResource
- ResourceARN => Str
- Tags => ArrayRef[Paws::FraudDetector::Tag]
Each argument is described in detail in: Paws::FraudDetector::TagResource
Returns: a Paws::FraudDetector::TagResourceResult instance
Assigns tags to a resource.
UntagResource
Each argument is described in detail in: Paws::FraudDetector::UntagResource
Returns: a Paws::FraudDetector::UntagResourceResult instance
Removes tags from a resource.
UpdateDetectorVersion
- DetectorId => Str
- DetectorVersionId => Str
- ExternalModelEndpoints => ArrayRef[Str|Undef]
- Rules => ArrayRef[Paws::FraudDetector::Rule]
- [Description => Str]
- [ModelVersions => ArrayRef[Paws::FraudDetector::ModelVersion]]
- [RuleExecutionMode => Str]
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, rule execution mode, and description. You can only update a DRAFT
detector version.
UpdateDetectorVersionMetadata
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
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
.
UpdateModel
Each argument is described in detail in: Paws::FraudDetector::UpdateModel
Returns: a Paws::FraudDetector::UpdateModelResult instance
Updates a model. You can update the description attribute using this action.
UpdateModelVersion
- MajorVersionNumber => Str
- ModelId => Str
- ModelType => Str
- [ExternalEventsDetail => Paws::FraudDetector::ExternalEventsDetail]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
Each argument is described in detail in: Paws::FraudDetector::UpdateModelVersion
Returns: a Paws::FraudDetector::UpdateModelVersionResult instance
Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.
UpdateModelVersionStatus
Each argument is described in detail in: Paws::FraudDetector::UpdateModelVersionStatus
Returns: a Paws::FraudDetector::UpdateModelVersionStatusResult instance
Updates the status of a model version.
You can perform the following status updates:
Change the
TRAINING_COMPLETE
status toACTIVE
.Change
ACTIVE
toINACTIVE
.
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. The description attribute can be updated.
UpdateRuleVersion
- Expression => Str
- Language => Str
- Outcomes => ArrayRef[Str|Undef]
- Rule => Paws::FraudDetector::Rule
- [Description => Str]
- [Tags => ArrayRef[Paws::FraudDetector::Tag]]
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. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
UpdateVariable
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
SEE ALSO
This service class forms part of Paws
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