com.amazonaws.services.frauddetector

Interface AmazonFraudDetector

All Known Subinterfaces:

AmazonFraudDetectorAsync

All Known Implementing Classes:

AbstractAmazonFraudDetector, AbstractAmazonFraudDetectorAsync, AmazonFraudDetectorAsyncClient, AmazonFraudDetectorClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonFraudDetector

Interface for accessing Amazon Fraud Detector.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonFraudDetector instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchCreateVariableResult	batchCreateVariable(BatchCreateVariableRequest batchCreateVariableRequest) Creates a batch of variables.
BatchGetVariableResult	batchGetVariable(BatchGetVariableRequest batchGetVariableRequest) Gets a batch of variables.
CreateDetectorVersionResult	createDetectorVersion(CreateDetectorVersionRequest createDetectorVersionRequest) Creates a detector version.
CreateModelVersionResult	createModelVersion(CreateModelVersionRequest createModelVersionRequest) Creates a version of the model using the specified model type.
CreateRuleResult	createRule(CreateRuleRequest createRuleRequest) Creates a rule for use with the specified detector.
CreateVariableResult	createVariable(CreateVariableRequest createVariableRequest) Creates a variable.
DeleteDetectorVersionResult	deleteDetectorVersion(DeleteDetectorVersionRequest deleteDetectorVersionRequest) Deletes the detector version.
DeleteEventResult	deleteEvent(DeleteEventRequest deleteEventRequest) Deletes the specified event.
DescribeDetectorResult	describeDetector(DescribeDetectorRequest describeDetectorRequest) Gets all versions for a specified detector.
DescribeModelVersionsResult	describeModelVersions(DescribeModelVersionsRequest describeModelVersionsRequest) 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 getDetectorsRequest) Gets all of detectors.
GetDetectorVersionResult	getDetectorVersion(GetDetectorVersionRequest getDetectorVersionRequest) Gets a particular detector version.
GetExternalModelsResult	getExternalModels(GetExternalModelsRequest getExternalModelsRequest) Gets the details for one or more Amazon SageMaker models that have been imported into the service.
GetModelsResult	getModels(GetModelsRequest getModelsRequest) 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.
GetModelVersionResult	getModelVersion(GetModelVersionRequest getModelVersionRequest) Gets a model version.
GetOutcomesResult	getOutcomes(GetOutcomesRequest getOutcomesRequest) Gets one or more outcomes.
GetPredictionResult	getPrediction(GetPredictionRequest getPredictionRequest) Evaluates an event against a detector version.
GetRulesResult	getRules(GetRulesRequest getRulesRequest) Gets all rules available for the specified detector.
GetVariablesResult	getVariables(GetVariablesRequest getVariablesRequest) Gets all of the variables or the specific variable.
PutDetectorResult	putDetector(PutDetectorRequest putDetectorRequest) Creates or updates a detector.
PutExternalModelResult	putExternalModel(PutExternalModelRequest putExternalModelRequest) Creates or updates an Amazon SageMaker model endpoint.
PutModelResult	putModel(PutModelRequest putModelRequest) Creates or updates a model.
PutOutcomeResult	putOutcome(PutOutcomeRequest putOutcomeRequest) Creates or updates an outcome.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateDetectorVersionResult	updateDetectorVersion(UpdateDetectorVersionRequest updateDetectorVersionRequest) Updates a detector version.
UpdateDetectorVersionMetadataResult	updateDetectorVersionMetadata(UpdateDetectorVersionMetadataRequest updateDetectorVersionMetadataRequest) Updates the detector version's description.
UpdateDetectorVersionStatusResult	updateDetectorVersionStatus(UpdateDetectorVersionStatusRequest updateDetectorVersionStatusRequest) Updates the detector version’s status.
UpdateModelVersionResult	updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest) Updates a model version.
UpdateRuleMetadataResult	updateRuleMetadata(UpdateRuleMetadataRequest updateRuleMetadataRequest) Updates a rule's metadata.
UpdateRuleVersionResult	updateRuleVersion(UpdateRuleVersionRequest updateRuleVersionRequest) Updates a rule version resulting in a new rule version.
UpdateVariableResult	updateVariable(UpdateVariableRequest updateVariableRequest) Updates a variable.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchCreateVariable

BatchCreateVariableResult batchCreateVariable(BatchCreateVariableRequest batchCreateVariableRequest)

Creates a batch of variables.

Parameters:

batchCreateVariableRequest -

Returns:

Result of the BatchCreateVariable operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchGetVariable

BatchGetVariableResult batchGetVariable(BatchGetVariableRequest batchGetVariableRequest)

Gets a batch of variables.

Parameters:

batchGetVariableRequest -

Returns:

Result of the BatchGetVariable operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDetectorVersion

CreateDetectorVersionResult createDetectorVersion(CreateDetectorVersionRequest createDetectorVersionRequest)

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

Parameters:

createDetectorVersionRequest -

Returns:

Result of the CreateDetectorVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createModelVersion

CreateModelVersionResult createModelVersion(CreateModelVersionRequest createModelVersionRequest)

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

Parameters:

createModelVersionRequest -

Returns:

Result of the CreateModelVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createRule

CreateRuleResult createRule(CreateRuleRequest createRuleRequest)

Creates a rule for use with the specified detector.

Parameters:

createRuleRequest -

Returns:

Result of the CreateRule operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createVariable

CreateVariableResult createVariable(CreateVariableRequest createVariableRequest)

Creates a variable.

Parameters:

createVariableRequest -

Returns:

Result of the CreateVariable operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDetectorVersion

DeleteDetectorVersionResult deleteDetectorVersion(DeleteDetectorVersionRequest deleteDetectorVersionRequest)

Deletes the detector version.

Parameters:

deleteDetectorVersionRequest -

Returns:

Result of the DeleteDetectorVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteEvent

DeleteEventResult deleteEvent(DeleteEventRequest deleteEventRequest)

Deletes the specified event.

Parameters:

deleteEventRequest -

Returns:

Result of the DeleteEvent operation returned by the service.

Throws:

InternalServerException - An exception indicating an internal server error.

ThrottlingException - An exception indicating a throttling error.

See Also:

AWS API Documentation

describeDetector

DescribeDetectorResult describeDetector(DescribeDetectorRequest describeDetectorRequest)

Gets all versions for a specified detector.

Parameters:

describeDetectorRequest -

Returns:

Result of the DescribeDetector operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeModelVersions

DescribeModelVersionsResult describeModelVersions(DescribeModelVersionsRequest describeModelVersionsRequest)

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.

Parameters:

describeModelVersionsRequest -

Returns:

Result of the DescribeModelVersions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDetectorVersion

GetDetectorVersionResult getDetectorVersion(GetDetectorVersionRequest getDetectorVersionRequest)

Gets a particular detector version.

Parameters:

getDetectorVersionRequest -

Returns:

Result of the GetDetectorVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDetectors

GetDetectorsResult getDetectors(GetDetectorsRequest getDetectorsRequest)

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.

Parameters:

getDetectorsRequest -

Returns:

Result of the GetDetectors operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getExternalModels

GetExternalModelsResult getExternalModels(GetExternalModelsRequest getExternalModelsRequest)

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.

Parameters:

getExternalModelsRequest -

Returns:

Result of the GetExternalModels operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getModelVersion

GetModelVersionResult getModelVersion(GetModelVersionRequest getModelVersionRequest)

Gets a model version.

Parameters:

getModelVersionRequest -

Returns:

Result of the GetModelVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getModels

GetModelsResult getModels(GetModelsRequest getModelsRequest)

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.

Parameters:

getModelsRequest -

Returns:

Result of the GetModels operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getOutcomes

GetOutcomesResult getOutcomes(GetOutcomesRequest getOutcomesRequest)

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.

Parameters:

getOutcomesRequest -

Returns:

Result of the GetOutcomes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getPrediction

GetPredictionResult getPrediction(GetPredictionRequest getPredictionRequest)

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

Parameters:

getPredictionRequest -

Returns:

Result of the GetPrediction operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRules

GetRulesResult getRules(GetRulesRequest getRulesRequest)

Gets all rules available for the specified detector.

Parameters:

getRulesRequest -

Returns:

Result of the GetRules operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getVariables

GetVariablesResult getVariables(GetVariablesRequest getVariablesRequest)

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.

Parameters:

getVariablesRequest -

Returns:

Result of the GetVariables operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putDetector

PutDetectorResult putDetector(PutDetectorRequest putDetectorRequest)

Creates or updates a detector.

Parameters:

putDetectorRequest -

Returns:

Result of the PutDetector operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putExternalModel

PutExternalModelResult putExternalModel(PutExternalModelRequest putExternalModelRequest)

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.

Parameters:

putExternalModelRequest -

Returns:

Result of the PutExternalModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putModel

PutModelResult putModel(PutModelRequest putModelRequest)

Creates or updates a model.

Parameters:

putModelRequest -

Returns:

Result of the PutModel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putOutcome

PutOutcomeResult putOutcome(PutOutcomeRequest putOutcomeRequest)

Creates or updates an outcome.

Parameters:

putOutcomeRequest -

Returns:

Result of the PutOutcome operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDetectorVersion

UpdateDetectorVersionResult updateDetectorVersion(UpdateDetectorVersionRequest updateDetectorVersionRequest)

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.

Parameters:

updateDetectorVersionRequest -

Returns:

Result of the UpdateDetectorVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDetectorVersionMetadata

UpdateDetectorVersionMetadataResult updateDetectorVersionMetadata(UpdateDetectorVersionMetadataRequest updateDetectorVersionMetadataRequest)

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

Parameters:

updateDetectorVersionMetadataRequest -

Returns:

Result of the UpdateDetectorVersionMetadata operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDetectorVersionStatus

UpdateDetectorVersionStatusResult updateDetectorVersionStatus(UpdateDetectorVersionStatusRequest updateDetectorVersionStatusRequest)

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.

Parameters:

updateDetectorVersionStatusRequest -

Returns:

Result of the UpdateDetectorVersionStatus operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateModelVersion

UpdateModelVersionResult updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest)

Updates a model version. You can update the description and status attributes using this action. You can perform the following status updates:

1. Change the TRAINING_COMPLETE status to ACTIVE

2. Change ACTIVE back to TRAINING_COMPLETE

Parameters:

updateModelVersionRequest -

Returns:

Result of the UpdateModelVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateRuleMetadata

UpdateRuleMetadataResult updateRuleMetadata(UpdateRuleMetadataRequest updateRuleMetadataRequest)

Updates a rule's metadata.

Parameters:

updateRuleMetadataRequest -

Returns:

Result of the UpdateRuleMetadata operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateRuleVersion

UpdateRuleVersionResult updateRuleVersion(UpdateRuleVersionRequest updateRuleVersionRequest)

Updates a rule version resulting in a new rule version.

Parameters:

updateRuleVersionRequest -

Returns:

Result of the UpdateRuleVersion operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateVariable

UpdateVariableResult updateVariable(UpdateVariableRequest updateVariableRequest)

Updates a variable.

Parameters:

updateVariableRequest -

Returns:

Result of the UpdateVariable operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.