Amazon Web Services, Inc.

Amazon Fraud Detector

This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data…

Identity & security#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 73

  • POSTBatch create variable/#X-Amz-Target=AWSHawksNestServiceFacade.BatchCreateVariableCreates a batch of variables.
  • POSTBatch get variable/#X-Amz-Target=AWSHawksNestServiceFacade.BatchGetVariableGets a batch of variables.
  • POSTCancel batch import job/#X-Amz-Target=AWSHawksNestServiceFacade.CancelBatchImportJobCancels an in-progress batch import job.
  • POSTCancel batch prediction job/#X-Amz-Target=AWSHawksNestServiceFacade.CancelBatchPredictionJobCancels the specified batch prediction job.
  • POSTCreate batch import job/#X-Amz-Target=AWSHawksNestServiceFacade.CreateBatchImportJobCreates a batch import job.
  • POSTCreate batch prediction job/#X-Amz-Target=AWSHawksNestServiceFacade.CreateBatchPredictionJobCreates a batch prediction job.
  • POSTCreate detector version/#X-Amz-Target=AWSHawksNestServiceFacade.CreateDetectorVersionCreates a detector version. The detector version starts in a DRAFT status.
  • POSTCreate list/#X-Amz-Target=AWSHawksNestServiceFacade.CreateListCreates 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…
  • POSTCreate model/#X-Amz-Target=AWSHawksNestServiceFacade.CreateModelCreates a model using the specified model type.
  • POSTCreate model version/#X-Amz-Target=AWSHawksNestServiceFacade.CreateModelVersionCreates a version of the model using the specified model type and model id.
  • POSTCreate rule/#X-Amz-Target=AWSHawksNestServiceFacade.CreateRuleCreates a rule for use with the specified detector.
  • POSTCreate variable/#X-Amz-Target=AWSHawksNestServiceFacade.CreateVariableCreates a variable.
  • POSTDelete batch import job/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteBatchImportJobDeletes the specified batch import job ID record. This action does not delete the data that was batch imported.
  • POSTDelete batch prediction job/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteBatchPredictionJobDeletes a batch prediction job.
  • POSTDelete detector/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteDetectorDeletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector. When you delete…
  • POSTDelete detector version/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteDetectorVersionDeletes the detector version. You cannot delete detector versions that are in ACTIVE status. When you delete a detector version, Amazon Fraud Detector…
  • POSTDelete entity type/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEntityTypeDeletes 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…
  • POSTDelete event/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEventDeletes 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…
  • POSTDelete event type/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEventTypeDeletes 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…
  • POSTDelete events by event type/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEventsByEventTypeDeletes all events of a particular event type.
  • POSTDelete external model/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteExternalModelRemoves 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…
  • POSTDelete label/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteLabelDeletes 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…
  • POSTDelete list/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteListDeletes 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.
  • POSTDelete model/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteModelDeletes 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…
  • POSTDelete model version/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteModelVersionDeletes a model version. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.…
  • POSTDelete outcome/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteOutcomeDeletes 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…
  • POSTDelete rule/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteRuleDeletes 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…
  • POSTDelete variable/#X-Amz-Target=AWSHawksNestServiceFacade.DeleteVariableDeletes a variable. You can't delete variables that are included in an event type in Amazon Fraud Detector. Amazon Fraud Detector automatically deletes model…
  • POSTDescribe detector/#X-Amz-Target=AWSHawksNestServiceFacade.DescribeDetectorGets all versions for a specified detector.
  • POSTDescribe model versions/#X-Amz-Target=AWSHawksNestServiceFacade.DescribeModelVersionsGets 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…
  • POSTGet batch import jobs/#X-Amz-Target=AWSHawksNestServiceFacade.GetBatchImportJobsGets 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…
  • POSTGet batch prediction jobs/#X-Amz-Target=AWSHawksNestServiceFacade.GetBatchPredictionJobsGets 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…
  • POSTGet delete events by event type status/#X-Amz-Target=AWSHawksNestServiceFacade.GetDeleteEventsByEventTypeStatusRetrieves the status of a DeleteEventsByEventType action.
  • POSTGet detector version/#X-Amz-Target=AWSHawksNestServiceFacade.GetDetectorVersionGets a particular detector version.
  • POSTGet detectors/#X-Amz-Target=AWSHawksNestServiceFacade.GetDetectorsGets 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…
  • POSTGet entity types/#X-Amz-Target=AWSHawksNestServiceFacade.GetEntityTypesGets 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…
  • POSTGet event/#X-Amz-Target=AWSHawksNestServiceFacade.GetEventRetrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
  • POSTGet event prediction/#X-Amz-Target=AWSHawksNestServiceFacade.GetEventPredictionEvaluates an event against a detector version. If a version ID is not provided, the detector’s ( ACTIVE ) version is used.
  • POSTGet event prediction metadata/#X-Amz-Target=AWSHawksNestServiceFacade.GetEventPredictionMetadataGets 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…
  • POSTGet event types/#X-Amz-Target=AWSHawksNestServiceFacade.GetEventTypesGets 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…
  • POSTGet external models/#X-Amz-Target=AWSHawksNestServiceFacade.GetExternalModelsGets 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 ,…
  • POSTGet kMS encryption key/#X-Amz-Target=AWSHawksNestServiceFacade.GetKMSEncryptionKeyGets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
  • POSTGet labels/#X-Amz-Target=AWSHawksNestServiceFacade.GetLabelsGets 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…
  • POSTGet list elements/#X-Amz-Target=AWSHawksNestServiceFacade.GetListElementsGets all the elements in the specified list.
  • POSTGet lists metadata/#X-Amz-Target=AWSHawksNestServiceFacade.GetListsMetadataGets the metadata of either all the lists under the account or the specified list.
  • POSTGet model version/#X-Amz-Target=AWSHawksNestServiceFacade.GetModelVersionGets the details of the specified model version.
  • POSTGet models/#X-Amz-Target=AWSHawksNestServiceFacade.GetModelsGets 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…
  • POSTGet outcomes/#X-Amz-Target=AWSHawksNestServiceFacade.GetOutcomesGets 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…
  • POSTGet rules/#X-Amz-Target=AWSHawksNestServiceFacade.GetRulesGet 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).…
  • POSTGet variables/#X-Amz-Target=AWSHawksNestServiceFacade.GetVariablesGets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per…
  • POSTList event predictions/#X-Amz-Target=AWSHawksNestServiceFacade.ListEventPredictionsGets 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…
  • POSTList tags for resource/#X-Amz-Target=AWSHawksNestServiceFacade.ListTagsForResourceLists 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…
  • POSTPut detector/#X-Amz-Target=AWSHawksNestServiceFacade.PutDetectorCreates or updates a detector.
  • POSTPut entity type/#X-Amz-Target=AWSHawksNestServiceFacade.PutEntityTypeCreates 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…
  • POSTPut event type/#X-Amz-Target=AWSHawksNestServiceFacade.PutEventTypeCreates 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…
  • POSTPut external model/#X-Amz-Target=AWSHawksNestServiceFacade.PutExternalModelCreates 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…
  • POSTPut kMS encryption key/#X-Amz-Target=AWSHawksNestServiceFacade.PutKMSEncryptionKeySpecifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
  • POSTPut label/#X-Amz-Target=AWSHawksNestServiceFacade.PutLabelCreates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine…
  • POSTPut outcome/#X-Amz-Target=AWSHawksNestServiceFacade.PutOutcomeCreates or updates an outcome.
  • POSTSend event/#X-Amz-Target=AWSHawksNestServiceFacade.SendEventStores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical…
  • POSTTag resource/#X-Amz-Target=AWSHawksNestServiceFacade.TagResourceAssigns tags to a resource.
  • POSTUntag resource/#X-Amz-Target=AWSHawksNestServiceFacade.UntagResourceRemoves tags from a resource.
  • POSTUpdate detector version/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateDetectorVersionUpdates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and…
  • POSTUpdate detector version metadata/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateDetectorVersionMetadataUpdates the detector version's description. You can update the metadata for any detector version ( DRAFT, ACTIVE, or INACTIVE ).
  • POSTUpdate detector version status/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateDetectorVersionStatusUpdates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus : DRAFT to ACTIVE , ACTIVE to…
  • POSTUpdate event label/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateEventLabelUpdates the specified event with a new label.
  • POSTUpdate list/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateListUpdates a list.
  • POSTUpdate model/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateModelUpdates model description.
  • POSTUpdate model version/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateModelVersionUpdates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the…
  • POSTUpdate model version status/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateModelVersionStatusUpdates the status of a model version. You can perform the following status updates: Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED . Change the…
  • POSTUpdate rule metadata/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateRuleMetadataUpdates a rule's metadata. The description attribute can be updated.
  • POSTUpdate rule version/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateRuleVersionUpdates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
  • POSTUpdate variable/#X-Amz-Target=AWSHawksNestServiceFacade.UpdateVariableUpdates a variable.

API details

Base URL
https://frauddetector.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
73 operations on 73 pathsPOST 73
Description format
AWS Smithy model, API version 2019-11-15

How to test the Amazon Fraud Detector in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Fraud Detector collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Batch create variable” (POST /#X-Amz-Target=AWSHawksNestServiceFacade.BatchCreateVariable), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Fraud Detector?

This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data… It is listed under Identity & security and has 73 endpoints.

Who publishes the Amazon Fraud Detector?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Fraud Detector?

Requests go to https://frauddetector.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Fraud Detector?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Fraud Detector have?

73 operations on 73 paths (73 POST).

Is forking the Amazon Fraud Detector free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.