@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonFraudDetectorClient extends AmazonWebServiceClient implements AmazonFraudDetector
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonFraudDetectorClientBuilder builder()
public BatchCreateVariableResult batchCreateVariable(BatchCreateVariableRequest request)
Creates a batch of variables.
batchCreateVariable
in interface AmazonFraudDetector
batchCreateVariableRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public BatchGetVariableResult batchGetVariable(BatchGetVariableRequest request)
Gets a batch of variables.
batchGetVariable
in interface AmazonFraudDetector
batchGetVariableRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public CreateDetectorVersionResult createDetectorVersion(CreateDetectorVersionRequest request)
Creates a detector version. The detector version starts in a DRAFT
status.
createDetectorVersion
in interface AmazonFraudDetector
createDetectorVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public CreateModelVersionResult createModelVersion(CreateModelVersionRequest request)
Creates a version of the model using the specified model type.
createModelVersion
in interface AmazonFraudDetector
createModelVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public CreateRuleResult createRule(CreateRuleRequest request)
Creates a rule for use with the specified detector.
createRule
in interface AmazonFraudDetector
createRuleRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public CreateVariableResult createVariable(CreateVariableRequest request)
Creates a variable.
createVariable
in interface AmazonFraudDetector
createVariableRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public DeleteDetectorResult deleteDetector(DeleteDetectorRequest request)
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
deleteDetectorRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation. The following delete operations
can cause a conflict exception:
DeleteDetector: A conflict exception will occur if the detector has associated Rules
or
DetectorVersions
. You can only delete a detector if it has no Rules
or
DetectorVersions
.
DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion
status is
ACTIVE
.
DeleteRuleVersion: A conflict exception will occur if the RuleVersion
is in use by an
associated ACTIVE
or INACTIVE DetectorVersion
.
ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public DeleteDetectorVersionResult deleteDetectorVersion(DeleteDetectorVersionRequest request)
Deletes the detector version. You cannot delete detector versions that are in ACTIVE
status.
deleteDetectorVersion
in interface AmazonFraudDetector
deleteDetectorVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.ConflictException
- An exception indicating there was a conflict during a delete operation. The following delete operations
can cause a conflict exception:
DeleteDetector: A conflict exception will occur if the detector has associated Rules
or
DetectorVersions
. You can only delete a detector if it has no Rules
or
DetectorVersions
.
DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion
status is
ACTIVE
.
DeleteRuleVersion: A conflict exception will occur if the RuleVersion
is in use by an
associated ACTIVE
or INACTIVE DetectorVersion
.
public DeleteEventResult deleteEvent(DeleteEventRequest request)
Deletes the specified event.
deleteEvent
in interface AmazonFraudDetector
deleteEventRequest
- InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public DeleteRuleVersionResult deleteRuleVersion(DeleteRuleVersionRequest request)
Deletes the rule version. You cannot delete a rule version if it is used by an ACTIVE
or
INACTIVE
detector version.
deleteRuleVersion
in interface AmazonFraudDetector
deleteRuleVersionRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation. The following delete operations
can cause a conflict exception:
DeleteDetector: A conflict exception will occur if the detector has associated Rules
or
DetectorVersions
. You can only delete a detector if it has no Rules
or
DetectorVersions
.
DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion
status is
ACTIVE
.
DeleteRuleVersion: A conflict exception will occur if the RuleVersion
is in use by an
associated ACTIVE
or INACTIVE DetectorVersion
.
ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public DescribeDetectorResult describeDetector(DescribeDetectorRequest request)
Gets all versions for a specified detector.
describeDetector
in interface AmazonFraudDetector
describeDetectorRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public DescribeModelVersionsResult describeModelVersions(DescribeModelVersionsRequest request)
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
describeModelVersionsRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetDetectorVersionResult getDetectorVersion(GetDetectorVersionRequest request)
Gets a particular detector version.
getDetectorVersion
in interface AmazonFraudDetector
getDetectorVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetDetectorsResult getDetectors(GetDetectorsRequest request)
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.
getDetectors
in interface AmazonFraudDetector
getDetectorsRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetExternalModelsResult getExternalModels(GetExternalModelsRequest request)
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.
getExternalModels
in interface AmazonFraudDetector
getExternalModelsRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetModelVersionResult getModelVersion(GetModelVersionRequest request)
Gets a model version.
getModelVersion
in interface AmazonFraudDetector
getModelVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetModelsResult getModels(GetModelsRequest request)
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.
getModels
in interface AmazonFraudDetector
getModelsRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetOutcomesResult getOutcomes(GetOutcomesRequest request)
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.
getOutcomes
in interface AmazonFraudDetector
getOutcomesRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetPredictionResult getPrediction(GetPredictionRequest request)
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
getPredictionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetRulesResult getRules(GetRulesRequest request)
Gets all rules available for the specified detector.
getRules
in interface AmazonFraudDetector
getRulesRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public GetVariablesResult getVariables(GetVariablesRequest request)
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
getVariablesRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public PutDetectorResult putDetector(PutDetectorRequest request)
Creates or updates a detector.
putDetector
in interface AmazonFraudDetector
putDetectorRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public PutExternalModelResult putExternalModel(PutExternalModelRequest request)
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
putExternalModelRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public PutModelResult putModel(PutModelRequest request)
Creates or updates a model.
putModel
in interface AmazonFraudDetector
putModelRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public PutOutcomeResult putOutcome(PutOutcomeRequest request)
Creates or updates an outcome.
putOutcome
in interface AmazonFraudDetector
putOutcomeRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateDetectorVersionResult updateDetectorVersion(UpdateDetectorVersionRequest request)
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.
updateDetectorVersion
in interface AmazonFraudDetector
updateDetectorVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateDetectorVersionMetadataResult updateDetectorVersionMetadata(UpdateDetectorVersionMetadataRequest request)
Updates the detector version's description. You can update the metadata for any detector version (
DRAFT, ACTIVE,
or INACTIVE
).
updateDetectorVersionMetadata
in interface AmazonFraudDetector
updateDetectorVersionMetadataRequest
- ValidationException
- An exception indicating a specified value is not allowed.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateDetectorVersionStatusResult updateDetectorVersionStatus(UpdateDetectorVersionStatusRequest request)
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
updateDetectorVersionStatusRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateModelVersionResult updateModelVersion(UpdateModelVersionRequest request)
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
updateModelVersion
in interface AmazonFraudDetector
updateModelVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateRuleMetadataResult updateRuleMetadata(UpdateRuleMetadataRequest request)
Updates a rule's metadata.
updateRuleMetadata
in interface AmazonFraudDetector
updateRuleMetadataRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateRuleVersionResult updateRuleVersion(UpdateRuleVersionRequest request)
Updates a rule version resulting in a new rule version.
updateRuleVersion
in interface AmazonFraudDetector
updateRuleVersionRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public UpdateVariableResult updateVariable(UpdateVariableRequest request)
Updates a variable.
updateVariable
in interface AmazonFraudDetector
updateVariableRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.InternalServerException
- An exception indicating an internal server error.ThrottlingException
- An exception indicating a throttling error.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonFraudDetector
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.