@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonFraudDetector
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.
We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter
Action
. AWS SDK provides libraries, sample code, tutorials, and other resources for software developers
who prefer to build applications using language-specific APIs instead of submitting a request over HTTP or HTTPS.
These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your
requests, retrying requests, and handling error responses, so that it is easier for you to get started. For more
information about the AWS SDKs, go to Tools to build on AWS
page, scroll down to the SDK section, and choose plus (+) sign to expand the section.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchCreateVariableResult |
batchCreateVariable(BatchCreateVariableRequest batchCreateVariableRequest)
Creates a batch of variables.
|
BatchGetVariableResult |
batchGetVariable(BatchGetVariableRequest batchGetVariableRequest)
Gets a batch of variables.
|
CancelBatchImportJobResult |
cancelBatchImportJob(CancelBatchImportJobRequest cancelBatchImportJobRequest)
Cancels an in-progress batch import job.
|
CancelBatchPredictionJobResult |
cancelBatchPredictionJob(CancelBatchPredictionJobRequest cancelBatchPredictionJobRequest)
Cancels the specified batch prediction job.
|
CreateBatchImportJobResult |
createBatchImportJob(CreateBatchImportJobRequest createBatchImportJobRequest)
Creates a batch import job.
|
CreateBatchPredictionJobResult |
createBatchPredictionJob(CreateBatchPredictionJobRequest createBatchPredictionJobRequest)
Creates a batch prediction job.
|
CreateDetectorVersionResult |
createDetectorVersion(CreateDetectorVersionRequest createDetectorVersionRequest)
Creates a detector version.
|
CreateListResult |
createList(CreateListRequest createListRequest)
Creates a list.
|
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.
|
DeleteBatchImportJobResult |
deleteBatchImportJob(DeleteBatchImportJobRequest deleteBatchImportJobRequest)
Deletes the specified batch import job ID record.
|
DeleteBatchPredictionJobResult |
deleteBatchPredictionJob(DeleteBatchPredictionJobRequest deleteBatchPredictionJobRequest)
Deletes a batch prediction job.
|
DeleteDetectorResult |
deleteDetector(DeleteDetectorRequest deleteDetectorRequest)
Deletes the detector.
|
DeleteDetectorVersionResult |
deleteDetectorVersion(DeleteDetectorVersionRequest deleteDetectorVersionRequest)
Deletes the detector version.
|
DeleteEntityTypeResult |
deleteEntityType(DeleteEntityTypeRequest deleteEntityTypeRequest)
Deletes an entity type.
|
DeleteEventResult |
deleteEvent(DeleteEventRequest deleteEventRequest)
Deletes the specified event.
|
DeleteEventsByEventTypeResult |
deleteEventsByEventType(DeleteEventsByEventTypeRequest deleteEventsByEventTypeRequest)
Deletes all events of a particular event type.
|
DeleteEventTypeResult |
deleteEventType(DeleteEventTypeRequest deleteEventTypeRequest)
Deletes an event type.
|
DeleteExternalModelResult |
deleteExternalModel(DeleteExternalModelRequest deleteExternalModelRequest)
Removes a SageMaker model from Amazon Fraud Detector.
|
DeleteLabelResult |
deleteLabel(DeleteLabelRequest deleteLabelRequest)
Deletes a label.
|
DeleteListResult |
deleteList(DeleteListRequest deleteListRequest)
Deletes the list, provided it is not used in a rule.
|
DeleteModelResult |
deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
|
DeleteModelVersionResult |
deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest)
Deletes a model version.
|
DeleteOutcomeResult |
deleteOutcome(DeleteOutcomeRequest deleteOutcomeRequest)
Deletes an outcome.
|
DeleteRuleResult |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the rule.
|
DeleteVariableResult |
deleteVariable(DeleteVariableRequest deleteVariableRequest)
Deletes a variable.
|
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.
|
GetBatchImportJobsResult |
getBatchImportJobs(GetBatchImportJobsRequest getBatchImportJobsRequest)
Gets all batch import jobs or a specific job of the specified ID.
|
GetBatchPredictionJobsResult |
getBatchPredictionJobs(GetBatchPredictionJobsRequest getBatchPredictionJobsRequest)
Gets all batch prediction jobs or a specific job if you specify a job 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.
|
GetDeleteEventsByEventTypeStatusResult |
getDeleteEventsByEventTypeStatus(GetDeleteEventsByEventTypeStatusRequest getDeleteEventsByEventTypeStatusRequest)
Retrieves the status of a
DeleteEventsByEventType action. |
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.
|
GetEventResult |
getEvent(GetEventRequest getEventRequest)
Retrieves details of events stored with Amazon Fraud Detector.
|
GetEventPredictionResult |
getEventPrediction(GetEventPredictionRequest getEventPredictionRequest)
Evaluates an event against a detector version.
|
GetEventPredictionMetadataResult |
getEventPredictionMetadata(GetEventPredictionMetadataRequest getEventPredictionMetadataRequest)
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector
version ID that was generated in the specified time period.
|
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 KMS key 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.
|
GetListElementsResult |
getListElements(GetListElementsRequest getListElementsRequest)
Gets all the elements in the specified list.
|
GetListsMetadataResult |
getListsMetadata(GetListsMetadataRequest getListsMetadataRequest)
Gets the metadata of either all the lists under the account or the specified list.
|
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.
|
ListEventPredictionsResult |
listEventPredictions(ListEventPredictionsRequest listEventPredictionsRequest)
Gets a list of past predictions.
|
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 KMS key 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.
|
SendEventResult |
sendEvent(SendEventRequest sendEventRequest)
Stores events in Amazon Fraud Detector without generating fraud predictions for those events.
|
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.
|
UpdateEventLabelResult |
updateEventLabel(UpdateEventLabelRequest updateEventLabelRequest)
Updates the specified event with a new label.
|
UpdateListResult |
updateList(UpdateListRequest updateListRequest)
Updates a list.
|
UpdateModelResult |
updateModel(UpdateModelRequest updateModelRequest)
Updates model description.
|
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.
|
static final String ENDPOINT_PREFIX
BatchCreateVariableResult batchCreateVariable(BatchCreateVariableRequest batchCreateVariableRequest)
Creates a batch of variables.
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.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.BatchGetVariableResult batchGetVariable(BatchGetVariableRequest batchGetVariableRequest)
Gets a batch of variables.
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.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.CancelBatchImportJobResult cancelBatchImportJob(CancelBatchImportJobRequest cancelBatchImportJobRequest)
Cancels an in-progress batch import job.
cancelBatchImportJobRequest
- 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.CancelBatchPredictionJobResult cancelBatchPredictionJob(CancelBatchPredictionJobRequest cancelBatchPredictionJobRequest)
Cancels the specified batch prediction job.
cancelBatchPredictionJobRequest
- 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.CreateBatchImportJobResult createBatchImportJob(CreateBatchImportJobRequest createBatchImportJobRequest)
Creates a batch import job.
createBatchImportJobRequest
- 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.CreateBatchPredictionJobResult createBatchPredictionJob(CreateBatchPredictionJobRequest createBatchPredictionJobRequest)
Creates a batch prediction job.
createBatchPredictionJobRequest
- 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.ResourceNotFoundException
- An exception indicating the specified resource was not found.CreateDetectorVersionResult createDetectorVersion(CreateDetectorVersionRequest createDetectorVersionRequest)
Creates a detector version. The detector version starts in a DRAFT
status.
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.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.CreateListResult createList(CreateListRequest createListRequest)
Creates a list.
List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.
createListRequest
- 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.CreateModelResult createModel(CreateModelRequest createModelRequest)
Creates a model using the specified model type.
createModelRequest
- 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.CreateModelVersionResult createModelVersion(CreateModelVersionRequest createModelVersionRequest)
Creates a version of the model using the specified model type and model id.
createModelVersionRequest
- 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.ThrottlingException
- An exception indicating a throttling error.InternalServerException
- An exception indicating an internal server error.CreateRuleResult createRule(CreateRuleRequest createRuleRequest)
Creates a rule for use with the specified detector.
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.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.CreateVariableResult createVariable(CreateVariableRequest createVariableRequest)
Creates a variable.
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.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.DeleteBatchImportJobResult deleteBatchImportJob(DeleteBatchImportJobRequest deleteBatchImportJobRequest)
Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.
deleteBatchImportJobRequest
- 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.DeleteBatchPredictionJobResult deleteBatchPredictionJob(DeleteBatchPredictionJobRequest deleteBatchPredictionJobRequest)
Deletes a batch prediction job.
deleteBatchPredictionJobRequest
- 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.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.
When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
deleteDetectorRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteDetectorVersionResult deleteDetectorVersion(DeleteDetectorVersionRequest deleteDetectorVersionRequest)
Deletes the detector version. You cannot delete detector versions that are in ACTIVE
status.
When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
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.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.DeleteEntityTypeResult deleteEntityType(DeleteEntityTypeRequest deleteEntityTypeRequest)
Deletes an entity type.
You cannot delete an entity type that is included in an event type.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.
deleteEntityTypeRequest
- ValidationException
- An exception indicating a specified value is not allowed.ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteEventResult deleteEvent(DeleteEventRequest deleteEventRequest)
Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer
stored in Amazon Fraud Detector. If deleteAuditHistory
is True
, event data is available
through search for up to 30 seconds after the delete operation is completed.
deleteEventRequest
- 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.ValidationException
- An exception indicating a specified value is not allowed.DeleteEventTypeResult deleteEventType(DeleteEventTypeRequest deleteEventTypeRequest)
Deletes an event type.
You cannot delete an event type that is used in a detector or a model.
When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.
deleteEventTypeRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteEventsByEventTypeResult deleteEventsByEventType(DeleteEventsByEventTypeRequest deleteEventsByEventTypeRequest)
Deletes all events of a particular event type.
deleteEventsByEventTypeRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteExternalModelResult deleteExternalModel(DeleteExternalModelRequest deleteExternalModelRequest)
Removes a SageMaker model from Amazon Fraud Detector.
You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
deleteExternalModelRequest
- ValidationException
- An exception indicating a specified value is not allowed.ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteLabelResult deleteLabel(DeleteLabelRequest deleteLabelRequest)
Deletes a label.
You cannot delete labels that are included in an event type in Amazon Fraud Detector.
You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.
When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.
deleteLabelRequest
- ValidationException
- An exception indicating a specified value is not allowed.ConflictException
- An exception indicating there was a conflict during a delete operation.ThrottlingException
- An exception indicating a throttling error.InternalServerException
- An exception indicating an internal server error.DeleteListResult deleteList(DeleteListRequest deleteListRequest)
Deletes the list, provided it is not used in a rule.
When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.
deleteListRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.
deleteModelRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteModelVersionResult deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest)
Deletes a model version.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.
deleteModelVersionRequest
- 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.ThrottlingException
- An exception indicating a throttling error.ConflictException
- An exception indicating there was a conflict during a delete operation.DeleteOutcomeResult deleteOutcome(DeleteOutcomeRequest deleteOutcomeRequest)
Deletes an outcome.
You cannot delete an outcome that is used in a rule version.
When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.
deleteOutcomeRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the rule. You cannot delete a rule if it is used by an ACTIVE
or INACTIVE
detector version.
When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.
deleteRuleRequest
- ConflictException
- An exception indicating there was a conflict during a delete operation.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.DeleteVariableResult deleteVariable(DeleteVariableRequest deleteVariableRequest)
Deletes a variable.
You can't delete variables that are included in an event type in Amazon Fraud Detector.
Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually.
When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.
deleteVariableRequest
- ValidationException
- An exception indicating a specified value is not allowed.ConflictException
- An exception indicating there was a conflict during a delete operation.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.DescribeDetectorResult describeDetector(DescribeDetectorRequest describeDetectorRequest)
Gets all versions for a specified detector.
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.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.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.
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.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.GetBatchImportJobsResult getBatchImportJobs(GetBatchImportJobsRequest getBatchImportJobsRequest)
Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null
maxResults
, this action retrieves a maximum of 50 records per page. If you provide a
maxResults
, the value must be between 1 and 50. To get the next page results, provide the pagination
token from the GetBatchImportJobsResponse
as part of your request. A null pagination token fetches
the records from the beginning.
getBatchImportJobsRequest
- 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.GetBatchPredictionJobsResult getBatchPredictionJobs(GetBatchPredictionJobsRequest getBatchPredictionJobsRequest)
Gets all batch prediction jobs or a specific job if you specify a job ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
getBatchPredictionJobsRequest
- 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.GetDeleteEventsByEventTypeStatusResult getDeleteEventsByEventTypeStatus(GetDeleteEventsByEventTypeStatusRequest getDeleteEventsByEventTypeStatusRequest)
Retrieves the status of a DeleteEventsByEventType
action.
getDeleteEventsByEventTypeStatusRequest
- 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.GetDetectorVersionResult getDetectorVersion(GetDetectorVersionRequest getDetectorVersionRequest)
Gets a particular detector version.
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.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.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.
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.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.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.
getEntityTypesRequest
- 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.GetEventResult getEvent(GetEventRequest getEventRequest)
Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
getEventRequest
- 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.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.
getEventPredictionRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.ResourceUnavailableException
- An exception indicating that the attached customer-owned (external) model threw an exception when Amazon
Fraud Detector invoked the model.GetEventPredictionMetadataResult getEventPredictionMetadata(GetEventPredictionMetadataRequest getEventPredictionMetadataRequest)
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
getEventPredictionMetadataRequest
- 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.ThrottlingException
- An exception indicating a throttling error.InternalServerException
- An exception indicating an internal server error.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.
getEventTypesRequest
- 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.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.
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.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.GetKMSEncryptionKeyResult getKMSEncryptionKey(GetKMSEncryptionKeyRequest getKMSEncryptionKeyRequest)
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
getKMSEncryptionKeyRequest
- 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.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.
getLabelsRequest
- 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.GetListElementsResult getListElements(GetListElementsRequest getListElementsRequest)
Gets all the elements in the specified list.
getListElementsRequest
- 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.GetListsMetadataResult getListsMetadata(GetListsMetadataRequest getListsMetadataRequest)
Gets the metadata of either all the lists under the account or the specified list.
getListsMetadataRequest
- 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.GetModelVersionResult getModelVersion(GetModelVersionRequest getModelVersionRequest)
Gets the details of the specified model version.
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.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.GetModelsResult getModels(GetModelsRequest getModelsRequest)
Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.
This is a paginated API. If you provide a null maxResults
, this action retrieves a maximum of 10
records per page. If you provide a maxResults
, the value must be between 1 and 10. To get the next
page results, provide the pagination token from the response as part of your request. A null pagination token
fetches the records from the beginning.
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.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.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.
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.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.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.
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.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.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.
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.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.ListEventPredictionsResult listEventPredictions(ListEventPredictionsRequest listEventPredictionsRequest)
Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.
For example, the following filter lists all past predictions for xyz
event type -
{ "eventType":{ "value": "xyz" }” }
This is a paginated API. If you provide a null maxResults
, this action will retrieve a maximum of 10
records per page. If you provide a maxResults
, the value must be between 50 and 100. To get the next
page results, provide the nextToken
from the response as part of your request. A null
nextToken
fetches the records from the beginning.
listEventPredictionsRequest
- ValidationException
- An exception indicating a specified value is not allowed.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.ThrottlingException
- An exception indicating a throttling error.InternalServerException
- An exception indicating an internal server error.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.
listTagsForResourceRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.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.PutDetectorResult putDetector(PutDetectorRequest putDetectorRequest)
Creates or updates a detector.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.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.
putEntityTypeRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.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.
putEventTypeRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.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.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.PutKMSEncryptionKeyResult putKMSEncryptionKey(PutKMSEncryptionKeyRequest putKMSEncryptionKeyRequest)
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
putKMSEncryptionKeyRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.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.
putLabelRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.PutOutcomeResult putOutcome(PutOutcomeRequest putOutcomeRequest)
Creates or updates an outcome.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.SendEventResult sendEvent(SendEventRequest sendEventRequest)
Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you
can use SendEvent
to upload a historical dataset, which you can then later use to train a model.
sendEventRequest
- ValidationException
- An exception indicating a specified value is not allowed.ConflictException
- An exception indicating there was a conflict during a delete operation.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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns tags to a resource.
tagResourceRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
untagResourceRequest
- ValidationException
- An exception indicating a specified value is not allowed.ResourceNotFoundException
- An exception indicating the specified resource was not found.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.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.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateDetectorVersionMetadataResult updateDetectorVersionMetadata(UpdateDetectorVersionMetadataRequest updateDetectorVersionMetadataRequest)
Updates the detector version's description. You can update the metadata for any detector version (
DRAFT, ACTIVE,
or INACTIVE
).
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.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
.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateEventLabelResult updateEventLabel(UpdateEventLabelRequest updateEventLabelRequest)
Updates the specified event with a new label.
updateEventLabelRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateListResult updateList(UpdateListRequest updateListRequest)
Updates a list.
updateListRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Updates model description.
updateModelRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.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.
updateModelVersionRequest
- 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.ThrottlingException
- An exception indicating a throttling error.InternalServerException
- An exception indicating an internal server error.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateModelVersionStatusResult updateModelVersionStatus(UpdateModelVersionStatusRequest updateModelVersionStatusRequest)
Updates the status of a model version.
You can perform the following status updates:
Change the TRAINING_IN_PROGRESS
status to TRAINING_CANCELLED
.
Change the TRAINING_COMPLETE
status to ACTIVE
.
Change ACTIVE
to INACTIVE
.
updateModelVersionStatusRequest
- 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.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateRuleMetadataResult updateRuleMetadata(UpdateRuleMetadataRequest updateRuleMetadataRequest)
Updates a rule's metadata. The description attribute can be updated.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.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 ...).
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.UpdateVariableResult updateVariable(UpdateVariableRequest updateVariableRequest)
Updates a variable.
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.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.ConflictException
- An exception indicating there was a conflict during a delete operation.void shutdown()
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 a request.
request
- The originally executed request.