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.
CreateModelResult	createModel(CreateModelRequest createModelRequest) Creates a model using the specified model type.
CreateModelVersionResult	createModelVersion(CreateModelVersionRequest createModelVersionRequest) Creates a version of the model using the specified model type and model id.
CreateRuleResult	createRule(CreateRuleRequest createRuleRequest) Creates a rule for use with the specified detector.
CreateVariableResult	createVariable(CreateVariableRequest createVariableRequest) Creates a variable.
DeleteDetectorResult	deleteDetector(DeleteDetectorRequest deleteDetectorRequest) Deletes the detector.
DeleteDetectorVersionResult	deleteDetectorVersion(DeleteDetectorVersionRequest deleteDetectorVersionRequest) Deletes the detector version.
DeleteEventResult	deleteEvent(DeleteEventRequest deleteEventRequest) Deletes the specified event.
DeleteRuleResult	deleteRule(DeleteRuleRequest deleteRuleRequest) Deletes the rule.
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 detectors or a single detector if a detectorId is specified.
GetDetectorVersionResult	getDetectorVersion(GetDetectorVersionRequest getDetectorVersionRequest) Gets a particular detector version.
GetEntityTypesResult	getEntityTypes(GetEntityTypesRequest getEntityTypesRequest) Gets all entity types or a specific entity type if a name is specified.
GetEventPredictionResult	getEventPrediction(GetEventPredictionRequest getEventPredictionRequest) Evaluates an event against a detector version.
GetEventTypesResult	getEventTypes(GetEventTypesRequest getEventTypesRequest) Gets all event types or a specific event type if name is provided.
GetExternalModelsResult	getExternalModels(GetExternalModelsRequest getExternalModelsRequest) Gets the details for one or more Amazon SageMaker models that have been imported into the service.
GetKMSEncryptionKeyResult	getKMSEncryptionKey(GetKMSEncryptionKeyRequest getKMSEncryptionKeyRequest) 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 getLabelsRequest) Gets all labels or a specific label if name is provided.
GetModelsResult	getModels(GetModelsRequest getModelsRequest) Gets one or more models.
GetModelVersionResult	getModelVersion(GetModelVersionRequest getModelVersionRequest) Gets the details of the specified model version.
GetOutcomesResult	getOutcomes(GetOutcomesRequest getOutcomesRequest) Gets one or more outcomes.
GetRulesResult	getRules(GetRulesRequest getRulesRequest) Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified.
GetVariablesResult	getVariables(GetVariablesRequest getVariablesRequest) Gets all of the variables or the specific variable.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with the resource.
PutDetectorResult	putDetector(PutDetectorRequest putDetectorRequest) Creates or updates a detector.
PutEntityTypeResult	putEntityType(PutEntityTypeRequest putEntityTypeRequest) Creates or updates an entity type.
PutEventTypeResult	putEventType(PutEventTypeRequest putEventTypeRequest) Creates or updates an event type.
PutExternalModelResult	putExternalModel(PutExternalModelRequest putExternalModelRequest) Creates or updates an Amazon SageMaker model endpoint.
PutKMSEncryptionKeyResult	putKMSEncryptionKey(PutKMSEncryptionKeyRequest putKMSEncryptionKeyRequest) Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
PutLabelResult	putLabel(PutLabelRequest putLabelRequest) Creates or updates label.
PutOutcomeResult	putOutcome(PutOutcomeRequest putOutcomeRequest) Creates or updates an outcome.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns tags to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource.
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.
UpdateModelResult	updateModel(UpdateModelRequest updateModelRequest) Updates a model.
UpdateModelVersionResult	updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest) Updates a model version.
UpdateModelVersionStatusResult	updateModelVersionStatus(UpdateModelVersionStatusRequest updateModelVersionStatusRequest) Updates the status of 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

createModel

CreateModelResult createModel(CreateModelRequest createModelRequest)

Creates a model using the specified model type.

Parameters:

createModelRequest -

Returns:

Result of the CreateModel operation returned by the service.

Throws:

ValidationException - An exception indicating a specified value is not allowed.

InternalServerException - An exception indicating an internal server error.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

createModelVersion

CreateModelVersionResult createModelVersion(CreateModelVersionRequest createModelVersionRequest)

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

Parameters:

createModelVersionRequest -

Returns:

Result of the CreateModelVersion 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

InternalServerException - An exception indicating an internal server 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

deleteDetector

DeleteDetectorResult deleteDetector(DeleteDetectorRequest deleteDetectorRequest)

Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.

Parameters:

deleteDetectorRequest -

Returns:

Result of the DeleteDetector operation returned by the service.

Throws:

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.

• DeleteRule: 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

deleteDetectorVersion

DeleteDetectorVersionResult deleteDetectorVersion(DeleteDetectorVersionRequest deleteDetectorVersionRequest)

Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.

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.

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.

• DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

deleteRule

DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)

Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.

Parameters:

deleteRuleRequest -

Returns:

Result of the DeleteRule operation returned by the service.

Throws:

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.

• DeleteRule: 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getDetectors

GetDetectorsResult getDetectors(GetDetectorsRequest getDetectorsRequest)

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.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getEntityTypes

GetEntityTypesResult getEntityTypes(GetEntityTypesRequest getEntityTypesRequest)

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.

Parameters:

getEntityTypesRequest -

Returns:

Result of the GetEntityTypes 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getEventPrediction

GetEventPredictionResult getEventPrediction(GetEventPredictionRequest getEventPredictionRequest)

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

Parameters:

getEventPredictionRequest -

Returns:

Result of the GetEventPrediction 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getEventTypes

GetEventTypesResult getEventTypes(GetEventTypesRequest getEventTypesRequest)

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.

Parameters:

getEventTypesRequest -

Returns:

Result of the GetEventTypes 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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 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.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getKMSEncryptionKey

GetKMSEncryptionKeyResult getKMSEncryptionKey(GetKMSEncryptionKeyRequest getKMSEncryptionKeyRequest)

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.

Parameters:

getKMSEncryptionKeyRequest -

Returns:

Result of the GetKMSEncryptionKey operation returned by the service.

Throws:

ResourceNotFoundException - An exception indicating the specified resource was not found.

InternalServerException - An exception indicating an internal server error.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getLabels

GetLabelsResult getLabels(GetLabelsRequest getLabelsRequest)

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.

Parameters:

getLabelsRequest -

Returns:

Result of the GetLabels 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getModelVersion

GetModelVersionResult getModelVersion(GetModelVersionRequest getModelVersionRequest)

Gets the details of the specified 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getModels

GetModelsResult getModels(GetModelsRequest getModelsRequest)

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.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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 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.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

getRules

GetRulesResult getRules(GetRulesRequest getRulesRequest)

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.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

putEntityType

PutEntityTypeResult putEntityType(PutEntityTypeRequest putEntityTypeRequest)

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.

Parameters:

putEntityTypeRequest -

Returns:

Result of the PutEntityType operation returned by the service.

Throws:

ValidationException - An exception indicating a specified value is not allowed.

InternalServerException - An exception indicating an internal server error.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

putEventType

PutEventTypeResult putEventType(PutEventTypeRequest putEventTypeRequest)

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.

Parameters:

putEventTypeRequest -

Returns:

Result of the PutEventType operation returned by the service.

Throws:

ValidationException - An exception indicating a specified value is not allowed.

InternalServerException - An exception indicating an internal server error.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

putKMSEncryptionKey

PutKMSEncryptionKeyResult putKMSEncryptionKey(PutKMSEncryptionKeyRequest putKMSEncryptionKeyRequest)

Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.

Parameters:

putKMSEncryptionKeyRequest -

Returns:

Result of the PutKMSEncryptionKey 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

putLabel

PutLabelResult putLabel(PutLabelRequest putLabelRequest)

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.

Parameters:

putLabelRequest -

Returns:

Result of the PutLabel operation returned by the service.

Throws:

ValidationException - An exception indicating a specified value is not allowed.

InternalServerException - An exception indicating an internal server error.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Assigns tags to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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, rule execution mode, 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

updateModel

UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)

Updates a model. You can update the description attribute using this action.

Parameters:

updateModelRequest -

Returns:

Result of the UpdateModel 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

updateModelVersion

UpdateModelVersionResult updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest)

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.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

InternalServerException - An exception indicating an internal server error.

See Also:

AWS API Documentation

updateModelVersionStatus

UpdateModelVersionStatusResult updateModelVersionStatus(UpdateModelVersionStatusRequest updateModelVersionStatusRequest)

Updates the status of a model version.

You can perform the following status updates:

1. Change the TRAINING_COMPLETE status to ACTIVE.

2. Change ACTIVEto INACTIVE.

Parameters:

updateModelVersionStatusRequest -

Returns:

Result of the UpdateModelVersionStatus 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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

updateRuleMetadata

UpdateRuleMetadataResult updateRuleMetadata(UpdateRuleMetadataRequest updateRuleMetadataRequest)

Updates a rule's metadata. The description attribute can be updated.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

See Also:

AWS API Documentation

updateRuleVersion

UpdateRuleVersionResult updateRuleVersion(UpdateRuleVersionRequest updateRuleVersionRequest)

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.

AccessDeniedException - An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

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.