@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_PREFIXpublic BatchCreateVariableResult batchCreateVariable(BatchCreateVariableRequest request)
AmazonFraudDetectorCreates a batch of variables.
batchCreateVariable in interface AmazonFraudDetectorpublic BatchGetVariableResult batchGetVariable(BatchGetVariableRequest request)
AmazonFraudDetectorGets a batch of variables.
batchGetVariable in interface AmazonFraudDetectorpublic CancelBatchImportJobResult cancelBatchImportJob(CancelBatchImportJobRequest request)
AmazonFraudDetectorCancels an in-progress batch import job.
cancelBatchImportJob in interface AmazonFraudDetectorpublic CancelBatchPredictionJobResult cancelBatchPredictionJob(CancelBatchPredictionJobRequest request)
AmazonFraudDetectorCancels the specified batch prediction job.
cancelBatchPredictionJob in interface AmazonFraudDetectorpublic CreateBatchImportJobResult createBatchImportJob(CreateBatchImportJobRequest request)
AmazonFraudDetectorCreates a batch import job.
createBatchImportJob in interface AmazonFraudDetectorpublic CreateBatchPredictionJobResult createBatchPredictionJob(CreateBatchPredictionJobRequest request)
AmazonFraudDetectorCreates a batch prediction job.
createBatchPredictionJob in interface AmazonFraudDetectorpublic CreateDetectorVersionResult createDetectorVersion(CreateDetectorVersionRequest request)
AmazonFraudDetector
Creates a detector version. The detector version starts in a DRAFT status.
createDetectorVersion in interface AmazonFraudDetectorpublic CreateListResult createList(CreateListRequest request)
AmazonFraudDetectorCreates a list.
List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.
createList in interface AmazonFraudDetectorpublic CreateModelResult createModel(CreateModelRequest request)
AmazonFraudDetectorCreates a model using the specified model type.
createModel in interface AmazonFraudDetectorpublic CreateModelVersionResult createModelVersion(CreateModelVersionRequest request)
AmazonFraudDetectorCreates a version of the model using the specified model type and model id.
createModelVersion in interface AmazonFraudDetectorpublic CreateRuleResult createRule(CreateRuleRequest request)
AmazonFraudDetectorCreates a rule for use with the specified detector.
createRule in interface AmazonFraudDetectorpublic CreateVariableResult createVariable(CreateVariableRequest request)
AmazonFraudDetectorCreates a variable.
createVariable in interface AmazonFraudDetectorpublic DeleteBatchImportJobResult deleteBatchImportJob(DeleteBatchImportJobRequest request)
AmazonFraudDetectorDeletes the specified batch import job ID record. This action does not delete the data that was batch imported.
deleteBatchImportJob in interface AmazonFraudDetectorpublic DeleteBatchPredictionJobResult deleteBatchPredictionJob(DeleteBatchPredictionJobRequest request)
AmazonFraudDetectorDeletes a batch prediction job.
deleteBatchPredictionJob in interface AmazonFraudDetectorpublic DeleteDetectorResult deleteDetector(DeleteDetectorRequest request)
AmazonFraudDetectorDeletes 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.
deleteDetector in interface AmazonFraudDetectorpublic DeleteDetectorVersionResult deleteDetectorVersion(DeleteDetectorVersionRequest request)
AmazonFraudDetector
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.
deleteDetectorVersion in interface AmazonFraudDetectorpublic DeleteEntityTypeResult deleteEntityType(DeleteEntityTypeRequest request)
AmazonFraudDetectorDeletes 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.
deleteEntityType in interface AmazonFraudDetectorpublic DeleteEventResult deleteEvent(DeleteEventRequest request)
AmazonFraudDetectorDeletes 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. If deleteAuditHistory is True, event data is available
through search for up to 30 seconds after the delete operation is completed.
deleteEvent in interface AmazonFraudDetectorpublic DeleteEventTypeResult deleteEventType(DeleteEventTypeRequest request)
AmazonFraudDetectorDeletes an event type.
You cannot delete an event type that is used in a detector or a model.
When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.
deleteEventType in interface AmazonFraudDetectorpublic DeleteEventsByEventTypeResult deleteEventsByEventType(DeleteEventsByEventTypeRequest request)
AmazonFraudDetectorDeletes all events of a particular event type.
deleteEventsByEventType in interface AmazonFraudDetectorpublic DeleteExternalModelResult deleteExternalModel(DeleteExternalModelRequest request)
AmazonFraudDetectorRemoves 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.
deleteExternalModel in interface AmazonFraudDetectorpublic DeleteLabelResult deleteLabel(DeleteLabelRequest request)
AmazonFraudDetectorDeletes 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.
deleteLabel in interface AmazonFraudDetectorpublic DeleteListResult deleteList(DeleteListRequest request)
AmazonFraudDetectorDeletes the list, provided it is not used in a rule.
When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.
deleteList in interface AmazonFraudDetectorpublic DeleteModelResult deleteModel(DeleteModelRequest request)
AmazonFraudDetectorDeletes 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.
deleteModel in interface AmazonFraudDetectorpublic DeleteModelVersionResult deleteModelVersion(DeleteModelVersionRequest request)
AmazonFraudDetectorDeletes 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.
deleteModelVersion in interface AmazonFraudDetectorpublic DeleteOutcomeResult deleteOutcome(DeleteOutcomeRequest request)
AmazonFraudDetectorDeletes 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.
deleteOutcome in interface AmazonFraudDetectorpublic DeleteRuleResult deleteRule(DeleteRuleRequest request)
AmazonFraudDetector
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.
deleteRule in interface AmazonFraudDetectorpublic DeleteVariableResult deleteVariable(DeleteVariableRequest request)
AmazonFraudDetectorDeletes 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.
deleteVariable in interface AmazonFraudDetectorpublic DescribeDetectorResult describeDetector(DescribeDetectorRequest request)
AmazonFraudDetectorGets all versions for a specified detector.
describeDetector in interface AmazonFraudDetectorpublic DescribeModelVersionsResult describeModelVersions(DescribeModelVersionsRequest request)
AmazonFraudDetectorGets 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 AmazonFraudDetectorpublic GetBatchImportJobsResult getBatchImportJobs(GetBatchImportJobsRequest request)
AmazonFraudDetector
Gets all batch import jobs or a specific job of the specified 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 GetBatchImportJobsResponse as part of your request. A null pagination token fetches
the records from the beginning.
getBatchImportJobs in interface AmazonFraudDetectorpublic GetBatchPredictionJobsResult getBatchPredictionJobs(GetBatchPredictionJobsRequest request)
AmazonFraudDetectorGets 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.
getBatchPredictionJobs in interface AmazonFraudDetectorpublic GetDeleteEventsByEventTypeStatusResult getDeleteEventsByEventTypeStatus(GetDeleteEventsByEventTypeStatusRequest request)
AmazonFraudDetector
Retrieves the status of a DeleteEventsByEventType action.
getDeleteEventsByEventTypeStatus in interface AmazonFraudDetectorpublic GetDetectorVersionResult getDetectorVersion(GetDetectorVersionRequest request)
AmazonFraudDetectorGets a particular detector version.
getDetectorVersion in interface AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic GetEventResult getEvent(GetEventRequest request)
AmazonFraudDetectorRetrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
getEvent in interface AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic GetEventPredictionMetadataResult getEventPredictionMetadata(GetEventPredictionMetadataRequest request)
AmazonFraudDetectorGets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
getEventPredictionMetadata in interface AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic GetKMSEncryptionKeyResult getKMSEncryptionKey(GetKMSEncryptionKeyRequest request)
AmazonFraudDetectorGets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
getKMSEncryptionKey in interface AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic GetListElementsResult getListElements(GetListElementsRequest request)
AmazonFraudDetectorGets all the elements in the specified list.
getListElements in interface AmazonFraudDetectorpublic GetListsMetadataResult getListsMetadata(GetListsMetadataRequest request)
AmazonFraudDetectorGets the metadata of either all the lists under the account or the specified list.
getListsMetadata in interface AmazonFraudDetectorpublic GetModelVersionResult getModelVersion(GetModelVersionRequest request)
AmazonFraudDetectorGets the details of the specified model version.
getModelVersion in interface AmazonFraudDetectorpublic GetModelsResult getModels(GetModelsRequest request)
AmazonFraudDetectorGets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic ListEventPredictionsResult listEventPredictions(ListEventPredictionsRequest request)
AmazonFraudDetectorGets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.
For example, the following filter lists all past predictions for xyz event type -
{ "eventType":{ "value": "xyz" }” }
This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10
records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next
page results, provide the nextToken from the response as part of your request. A null
nextToken fetches the records from the beginning.
listEventPredictions in interface AmazonFraudDetectorpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonFraudDetectorLists 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 AmazonFraudDetectorpublic PutDetectorResult putDetector(PutDetectorRequest request)
AmazonFraudDetectorCreates or updates a detector.
putDetector in interface AmazonFraudDetectorpublic PutEntityTypeResult putEntityType(PutEntityTypeRequest request)
AmazonFraudDetectorCreates 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 AmazonFraudDetectorpublic PutEventTypeResult putEventType(PutEventTypeRequest request)
AmazonFraudDetectorCreates 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 AmazonFraudDetectorpublic PutExternalModelResult putExternalModel(PutExternalModelRequest request)
AmazonFraudDetectorCreates 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 AmazonFraudDetectorpublic PutKMSEncryptionKeyResult putKMSEncryptionKey(PutKMSEncryptionKeyRequest request)
AmazonFraudDetectorSpecifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
putKMSEncryptionKey in interface AmazonFraudDetectorpublic PutLabelResult putLabel(PutLabelRequest request)
AmazonFraudDetectorCreates 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 AmazonFraudDetectorpublic PutOutcomeResult putOutcome(PutOutcomeRequest request)
AmazonFraudDetectorCreates or updates an outcome.
putOutcome in interface AmazonFraudDetectorpublic SendEventResult sendEvent(SendEventRequest request)
AmazonFraudDetector
Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you
can use SendEvent to upload a historical dataset, which you can then later use to train a model.
sendEvent in interface AmazonFraudDetectorpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonFraudDetectorAssigns tags to a resource.
tagResource in interface AmazonFraudDetectorpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonFraudDetectorRemoves tags from a resource.
untagResource in interface AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic 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 AmazonFraudDetectorpublic UpdateEventLabelResult updateEventLabel(UpdateEventLabelRequest request)
AmazonFraudDetectorUpdates the specified event with a new label.
updateEventLabel in interface AmazonFraudDetectorpublic UpdateListResult updateList(UpdateListRequest request)
AmazonFraudDetectorUpdates a list.
updateList in interface AmazonFraudDetectorpublic UpdateModelResult updateModel(UpdateModelRequest request)
AmazonFraudDetectorUpdates model description.
updateModel in interface AmazonFraudDetectorpublic UpdateModelVersionResult updateModelVersion(UpdateModelVersionRequest request)
AmazonFraudDetectorUpdates 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 AmazonFraudDetectorpublic UpdateModelVersionStatusResult updateModelVersionStatus(UpdateModelVersionStatusRequest request)
AmazonFraudDetectorUpdates the status of a model version.
You can perform the following status updates:
Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED.
Change the TRAINING_COMPLETE status to ACTIVE.
Change ACTIVE to INACTIVE.
updateModelVersionStatus in interface AmazonFraudDetectorpublic UpdateRuleMetadataResult updateRuleMetadata(UpdateRuleMetadataRequest request)
AmazonFraudDetectorUpdates a rule's metadata. The description attribute can be updated.
updateRuleMetadata in interface AmazonFraudDetectorpublic UpdateRuleVersionResult updateRuleVersion(UpdateRuleVersionRequest request)
AmazonFraudDetectorUpdates 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 AmazonFraudDetectorpublic UpdateVariableResult updateVariable(UpdateVariableRequest request)
AmazonFraudDetectorUpdates a variable.
updateVariable in interface AmazonFraudDetectorpublic void shutdown()
AmazonFraudDetectorshutdown in interface AmazonFraudDetectorpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonFraudDetectorResponse 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 AmazonFraudDetectorrequest - The originally executed request.