@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonFraudDetector extends Object implements AmazonFraudDetector
AmazonFraudDetector
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchCreateVariableResult |
batchCreateVariable(BatchCreateVariableRequest request)
Creates a batch of variables.
|
BatchGetVariableResult |
batchGetVariable(BatchGetVariableRequest request)
Gets a batch of variables.
|
CreateDetectorVersionResult |
createDetectorVersion(CreateDetectorVersionRequest request)
Creates a detector version.
|
CreateModelResult |
createModel(CreateModelRequest request)
Creates a model using the specified model type.
|
CreateModelVersionResult |
createModelVersion(CreateModelVersionRequest request)
Creates a version of the model using the specified model type and model id.
|
CreateRuleResult |
createRule(CreateRuleRequest request)
Creates a rule for use with the specified detector.
|
CreateVariableResult |
createVariable(CreateVariableRequest request)
Creates a variable.
|
DeleteDetectorResult |
deleteDetector(DeleteDetectorRequest request)
Deletes the detector.
|
DeleteDetectorVersionResult |
deleteDetectorVersion(DeleteDetectorVersionRequest request)
Deletes the detector version.
|
DeleteEventResult |
deleteEvent(DeleteEventRequest request)
Deletes the specified event.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest request)
Deletes the rule.
|
DescribeDetectorResult |
describeDetector(DescribeDetectorRequest request)
Gets all versions for a specified detector.
|
DescribeModelVersionsResult |
describeModelVersions(DescribeModelVersionsRequest request)
Gets all of the model versions for the specified model type or for the specified model type and model ID.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDetectorsResult |
getDetectors(GetDetectorsRequest request)
Gets all detectors or a single detector if a
detectorId is specified. |
GetDetectorVersionResult |
getDetectorVersion(GetDetectorVersionRequest request)
Gets a particular detector version.
|
GetEntityTypesResult |
getEntityTypes(GetEntityTypesRequest request)
Gets all entity types or a specific entity type if a name is specified.
|
GetEventPredictionResult |
getEventPrediction(GetEventPredictionRequest request)
Evaluates an event against a detector version.
|
GetEventTypesResult |
getEventTypes(GetEventTypesRequest request)
Gets all event types or a specific event type if name is provided.
|
GetExternalModelsResult |
getExternalModels(GetExternalModelsRequest request)
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
|
GetKMSEncryptionKeyResult |
getKMSEncryptionKey(GetKMSEncryptionKeyRequest request)
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.
|
GetLabelsResult |
getLabels(GetLabelsRequest request)
Gets all labels or a specific label if name is provided.
|
GetModelsResult |
getModels(GetModelsRequest request)
Gets one or more models.
|
GetModelVersionResult |
getModelVersion(GetModelVersionRequest request)
Gets the details of the specified model version.
|
GetOutcomesResult |
getOutcomes(GetOutcomesRequest request)
Gets one or more outcomes.
|
GetPredictionResult |
getPrediction(GetPredictionRequest request)
Evaluates an event against a detector version.
|
GetRulesResult |
getRules(GetRulesRequest request)
Get all rules for a detector (paginated) if
ruleId and ruleVersion are not specified. |
GetVariablesResult |
getVariables(GetVariablesRequest request)
Gets all of the variables or the specific variable.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with the resource.
|
PutDetectorResult |
putDetector(PutDetectorRequest request)
Creates or updates a detector.
|
PutEntityTypeResult |
putEntityType(PutEntityTypeRequest request)
Creates or updates an entity type.
|
PutEventTypeResult |
putEventType(PutEventTypeRequest request)
Creates or updates an event type.
|
PutExternalModelResult |
putExternalModel(PutExternalModelRequest request)
Creates or updates an Amazon SageMaker model endpoint.
|
PutKMSEncryptionKeyResult |
putKMSEncryptionKey(PutKMSEncryptionKeyRequest request)
Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon
Fraud Detector.
|
PutLabelResult |
putLabel(PutLabelRequest request)
Creates or updates label.
|
PutOutcomeResult |
putOutcome(PutOutcomeRequest request)
Creates or updates an outcome.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a resource.
|
UpdateDetectorVersionResult |
updateDetectorVersion(UpdateDetectorVersionRequest request)
Updates a detector version.
|
UpdateDetectorVersionMetadataResult |
updateDetectorVersionMetadata(UpdateDetectorVersionMetadataRequest request)
Updates the detector version's description.
|
UpdateDetectorVersionStatusResult |
updateDetectorVersionStatus(UpdateDetectorVersionStatusRequest request)
Updates the detector version’s status.
|
UpdateModelResult |
updateModel(UpdateModelRequest request)
Updates a model.
|
UpdateModelVersionResult |
updateModelVersion(UpdateModelVersionRequest request)
Updates a model version.
|
UpdateModelVersionStatusResult |
updateModelVersionStatus(UpdateModelVersionStatusRequest request)
Updates the status of a model version.
|
UpdateRuleMetadataResult |
updateRuleMetadata(UpdateRuleMetadataRequest request)
Updates a rule's metadata.
|
UpdateRuleVersionResult |
updateRuleVersion(UpdateRuleVersionRequest request)
Updates a rule version resulting in a new rule version.
|
UpdateVariableResult |
updateVariable(UpdateVariableRequest request)
Updates a variable.
|
public BatchCreateVariableResult batchCreateVariable(BatchCreateVariableRequest request)
AmazonFraudDetector
Creates a batch of variables.
batchCreateVariable
in interface AmazonFraudDetector
public BatchGetVariableResult batchGetVariable(BatchGetVariableRequest request)
AmazonFraudDetector
Gets a batch of variables.
batchGetVariable
in interface AmazonFraudDetector
public CreateDetectorVersionResult createDetectorVersion(CreateDetectorVersionRequest request)
AmazonFraudDetector
Creates a detector version. The detector version starts in a DRAFT
status.
createDetectorVersion
in interface AmazonFraudDetector
public CreateModelResult createModel(CreateModelRequest request)
AmazonFraudDetector
Creates a model using the specified model type.
createModel
in interface AmazonFraudDetector
public CreateModelVersionResult createModelVersion(CreateModelVersionRequest request)
AmazonFraudDetector
Creates a version of the model using the specified model type and model id.
createModelVersion
in interface AmazonFraudDetector
public CreateRuleResult createRule(CreateRuleRequest request)
AmazonFraudDetector
Creates a rule for use with the specified detector.
createRule
in interface AmazonFraudDetector
public CreateVariableResult createVariable(CreateVariableRequest request)
AmazonFraudDetector
Creates a variable.
createVariable
in interface AmazonFraudDetector
public DeleteDetectorResult deleteDetector(DeleteDetectorRequest request)
AmazonFraudDetector
Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
deleteDetector
in interface AmazonFraudDetector
public DeleteDetectorVersionResult deleteDetectorVersion(DeleteDetectorVersionRequest request)
AmazonFraudDetector
Deletes the detector version. You cannot delete detector versions that are in ACTIVE
status.
deleteDetectorVersion
in interface AmazonFraudDetector
public DeleteEventResult deleteEvent(DeleteEventRequest request)
AmazonFraudDetector
Deletes the specified event.
deleteEvent
in interface AmazonFraudDetector
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
AmazonFraudDetector
Deletes the rule. You cannot delete a rule if it is used by an ACTIVE
or INACTIVE
detector version.
deleteRule
in interface AmazonFraudDetector
public DescribeDetectorResult describeDetector(DescribeDetectorRequest request)
AmazonFraudDetector
Gets all versions for a specified detector.
describeDetector
in interface AmazonFraudDetector
public DescribeModelVersionsResult describeModelVersions(DescribeModelVersionsRequest request)
AmazonFraudDetector
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.
describeModelVersions
in interface AmazonFraudDetector
public GetDetectorVersionResult getDetectorVersion(GetDetectorVersionRequest request)
AmazonFraudDetector
Gets a particular detector version.
getDetectorVersion
in interface AmazonFraudDetector
public GetDetectorsResult getDetectors(GetDetectorsRequest request)
AmazonFraudDetector
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.
getDetectors
in interface AmazonFraudDetector
public GetEntityTypesResult getEntityTypes(GetEntityTypesRequest request)
AmazonFraudDetector
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.
getEntityTypes
in interface AmazonFraudDetector
public GetEventPredictionResult getEventPrediction(GetEventPredictionRequest request)
AmazonFraudDetector
Evaluates an event against a detector version. If a version ID is not provided, the detector’s (
ACTIVE
) version is used.
getEventPrediction
in interface AmazonFraudDetector
public GetEventTypesResult getEventTypes(GetEventTypesRequest request)
AmazonFraudDetector
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.
getEventTypes
in interface AmazonFraudDetector
public GetExternalModelsResult getExternalModels(GetExternalModelsRequest request)
AmazonFraudDetector
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.
getExternalModels
in interface AmazonFraudDetector
public GetKMSEncryptionKeyResult getKMSEncryptionKey(GetKMSEncryptionKeyRequest request)
AmazonFraudDetector
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.
getKMSEncryptionKey
in interface AmazonFraudDetector
public GetLabelsResult getLabels(GetLabelsRequest request)
AmazonFraudDetector
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.
getLabels
in interface AmazonFraudDetector
public GetModelVersionResult getModelVersion(GetModelVersionRequest request)
AmazonFraudDetector
Gets the details of the specified model version.
getModelVersion
in interface AmazonFraudDetector
public GetModelsResult getModels(GetModelsRequest request)
AmazonFraudDetector
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.
getModels
in interface AmazonFraudDetector
public GetOutcomesResult getOutcomes(GetOutcomesRequest request)
AmazonFraudDetector
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.
getOutcomes
in interface AmazonFraudDetector
public GetPredictionResult getPrediction(GetPredictionRequest request)
AmazonFraudDetector
Evaluates an event against a detector version. If a version ID is not provided, the detector’s (
ACTIVE
) version is used.
getPrediction
in interface AmazonFraudDetector
public GetRulesResult getRules(GetRulesRequest request)
AmazonFraudDetector
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.
getRules
in interface AmazonFraudDetector
public GetVariablesResult getVariables(GetVariablesRequest request)
AmazonFraudDetector
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.
getVariables
in interface AmazonFraudDetector
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonFraudDetector
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.
listTagsForResource
in interface AmazonFraudDetector
public PutDetectorResult putDetector(PutDetectorRequest request)
AmazonFraudDetector
Creates or updates a detector.
putDetector
in interface AmazonFraudDetector
public PutEntityTypeResult putEntityType(PutEntityTypeRequest request)
AmazonFraudDetector
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.
putEntityType
in interface AmazonFraudDetector
public PutEventTypeResult putEventType(PutEventTypeRequest request)
AmazonFraudDetector
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.
putEventType
in interface AmazonFraudDetector
public PutExternalModelResult putExternalModel(PutExternalModelRequest request)
AmazonFraudDetector
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.
putExternalModel
in interface AmazonFraudDetector
public PutKMSEncryptionKeyResult putKMSEncryptionKey(PutKMSEncryptionKeyRequest request)
AmazonFraudDetector
Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
putKMSEncryptionKey
in interface AmazonFraudDetector
public PutLabelResult putLabel(PutLabelRequest request)
AmazonFraudDetector
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.
putLabel
in interface AmazonFraudDetector
public PutOutcomeResult putOutcome(PutOutcomeRequest request)
AmazonFraudDetector
Creates or updates an outcome.
putOutcome
in interface AmazonFraudDetector
public TagResourceResult tagResource(TagResourceRequest request)
AmazonFraudDetector
Assigns tags to a resource.
tagResource
in interface AmazonFraudDetector
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonFraudDetector
Removes tags from a resource.
untagResource
in interface AmazonFraudDetector
public UpdateDetectorVersionResult updateDetectorVersion(UpdateDetectorVersionRequest request)
AmazonFraudDetector
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.
updateDetectorVersion
in interface AmazonFraudDetector
public UpdateDetectorVersionMetadataResult updateDetectorVersionMetadata(UpdateDetectorVersionMetadataRequest request)
AmazonFraudDetector
Updates the detector version's description. You can update the metadata for any detector version (
DRAFT, ACTIVE,
or INACTIVE
).
updateDetectorVersionMetadata
in interface AmazonFraudDetector
public UpdateDetectorVersionStatusResult updateDetectorVersionStatus(UpdateDetectorVersionStatusRequest request)
AmazonFraudDetector
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
.
updateDetectorVersionStatus
in interface AmazonFraudDetector
public UpdateModelResult updateModel(UpdateModelRequest request)
AmazonFraudDetector
Updates a model. You can update the description attribute using this action.
updateModel
in interface AmazonFraudDetector
public UpdateModelVersionResult updateModelVersion(UpdateModelVersionRequest request)
AmazonFraudDetector
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.
updateModelVersion
in interface AmazonFraudDetector
public UpdateModelVersionStatusResult updateModelVersionStatus(UpdateModelVersionStatusRequest request)
AmazonFraudDetector
Updates the status of a model version.
You can perform the following status updates:
Change the TRAINING_COMPLETE
status to ACTIVE
.
Change ACTIVE
to INACTIVE
.
updateModelVersionStatus
in interface AmazonFraudDetector
public UpdateRuleMetadataResult updateRuleMetadata(UpdateRuleMetadataRequest request)
AmazonFraudDetector
Updates a rule's metadata. The description attribute can be updated.
updateRuleMetadata
in interface AmazonFraudDetector
public UpdateRuleVersionResult updateRuleVersion(UpdateRuleVersionRequest request)
AmazonFraudDetector
Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
updateRuleVersion
in interface AmazonFraudDetector
public UpdateVariableResult updateVariable(UpdateVariableRequest request)
AmazonFraudDetector
Updates a variable.
updateVariable
in interface AmazonFraudDetector
public void shutdown()
AmazonFraudDetector
shutdown
in interface AmazonFraudDetector
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonFraudDetector
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonFraudDetector
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.