Open documentation ↗Overview
<p>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 <a href="https://docs.aws.amazon.com/frauddetector/latest/ug/">Amazon Fraud Detector User Guide</a>.</p> <p>We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.</p> <p>The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter <code>Action</code>. 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, see <a href="https://docs.aws.amazon.com/https:/aws.amazon.com/tools/">Tools to build on AWS</a>. </p>
Amazon Fraud Detector is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 73 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2019-11-15
- Endpoints
- 73
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-18
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.BatchCreateVariable | Creates a batch of variables. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.BatchGetVariable | Gets a batch of variables. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CancelBatchImportJob | Cancels an in-progress batch import job. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CancelBatchPredictionJob | Cancels the specified batch prediction job. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateBatchImportJob | Creates a batch import job. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateBatchPredictionJob | Creates a batch prediction job. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateDetectorVersion | Creates a detector version. The detector version starts in a <code>DRAFT</code> status. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateList | <p> Creates a list. </p> <p>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 detec |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateModel | Creates a model using the specified model type. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateModelVersion | Creates a version of the model using the specified model type and model id. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateRule | Creates a rule for use with the specified detector. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.CreateVariable | Creates a variable. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteBatchImportJob | Deletes the specified batch import job ID record. This action does not delete the data that was batch imported. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteBatchPredictionJob | Deletes a batch prediction job. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteDetector | <p>Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.</p> <p>When you |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteDetectorVersion | <p>Deletes the detector version. You cannot delete detector versions that are in <code>ACTIVE</code> status.</p> <p>When you delete a detector version, Amazon F |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEntityType | <p>Deletes an entity type.</p> <p>You cannot delete an entity type that is included in an event type.</p> <p>When you delete an entity type, Amazon Fraud Detect |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEvent | <p>Deletes the specified event.</p> <p>When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEventType | <p>Deletes an event type.</p> <p>You cannot delete an event type that is used in a detector or a model.</p> <p>When you delete an event type, Amazon Fraud Detec |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteEventsByEventType | Deletes all events of a particular event type. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteExternalModel | <p>Removes a SageMaker model from Amazon Fraud Detector.</p> <p>You can remove an Amazon SageMaker model if it is not associated with a detector version. Removi |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteLabel | <p>Deletes a label.</p> <p>You cannot delete labels that are included in an event type in Amazon Fraud Detector.</p> <p>You cannot delete a label assigned to an |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteList | <p> Deletes the list, provided it is not used in a rule. </p> <p> When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements i |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteModel | <p>Deletes a model.</p> <p>You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.</p> |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteModelVersion | <p>Deletes a model version.</p> <p>You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector vers |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteOutcome | <p>Deletes an outcome.</p> <p>You cannot delete an outcome that is used in a rule version.</p> <p>When you delete an outcome, Amazon Fraud Detector permanently |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteRule | <p>Deletes the rule. You cannot delete a rule if it is used by an <code>ACTIVE</code> or <code>INACTIVE</code> detector version.</p> <p>When you delete a rule, |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DeleteVariable | <p>Deletes a variable.</p> <p>You can't delete variables that are included in an event type in Amazon Fraud Detector.</p> <p>Amazon Fraud Detector automatically |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DescribeDetector | Gets all versions for a specified detector. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.DescribeModelVersions | 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 |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetBatchImportJobs | Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null <code>maxResults</code>, this action retrieves |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetBatchPredictionJobs | 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 max |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetDeleteEventsByEventTypeStatus | Retrieves the status of a <code>DeleteEventsByEventType</code> action. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetDetectorVersion | Gets a particular detector version. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetDetectors | Gets all detectors or a single detector if a <code>detectorId</code> is specified. This is a paginated API. If you provide a null <code>maxResults</code>, this |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetEntityTypes | Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null <code>maxResults</code>, this action retr |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetEvent | Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetEventPrediction | Evaluates an event against a detector version. If a version ID is not provided, the detector’s (<code>ACTIVE</code>) version is used. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetEventPredictionMetadata | 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 |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetEventTypes | Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null <code>maxResults</code>, this action retrieves |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetExternalModels | 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 <code>maxResul |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetKMSEncryptionKey | Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetLabels | Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null <code>maxResults</code>, this action retrieves a maximum |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetListElements | Gets all the elements in the specified list. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetListsMetadata | Gets the metadata of either all the lists under the account or the specified list. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetModelVersion | Gets the details of the specified model version. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetModels | <p>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 Se |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetOutcomes | Gets one or more outcomes. This is a paginated API. If you provide a null <code>maxResults</code>, this actions retrieves a maximum of 100 records per page. If |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetRules | <p>Get all rules for a detector (paginated) if <code>ruleId</code> and <code>ruleVersion</code> are not specified. Gets all rules for the detector and the <code |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.GetVariables | Gets all of the variables or the specific variable. This is a paginated API. Providing null <code>maxSizePerPage</code> results in retrieving maximum of 100 rec |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.ListEventPredictions | <p>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 filte |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.ListTagsForResource | 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 yo |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutDetector | Creates or updates a detector. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutEntityType | 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 speci |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutEventType | 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 f |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutExternalModel | 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 an |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutKMSEncryptionKey | Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutLabel | 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 l |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.PutOutcome | Creates or updates an outcome. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.SendEvent | Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use <code>SendEvent</code> to upload a histor |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.TagResource | Assigns tags to a resource. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UntagResource | Removes tags from a resource. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateDetectorVersion | Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and descri |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateDetectorVersionMetadata | Updates the detector version's description. You can update the metadata for any detector version (<code>DRAFT, ACTIVE,</code> or <code>INACTIVE</code>). |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateDetectorVersionStatus | Updates the detector version’s status. You can perform the following promotions or demotions using <code>UpdateDetectorVersionStatus</code>: <code>DRAFT</code> |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateEventLabel | Updates the specified event with a new label. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateList | Updates a list. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateModel | Updates model description. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateModelVersion | 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. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateModelVersionStatus | <p>Updates the status of a model version.</p> <p>You can perform the following status updates:</p> <ol> <li> <p>Change the <code>TRAINING_IN_PROGRESS</code> sta |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateRuleMetadata | Updates a rule's metadata. The description attribute can be updated. |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateRuleVersion | Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...). |
| POST | /#X-Amz-Target=AWSHawksNestServiceFacade.UpdateVariable | Updates a variable. |
Questions
Does the Amazon Fraud Detector API need an API key?
Yes. The Amazon Fraud Detector API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Fraud Detector API support HTTPS?
Yes, the Amazon Fraud Detector API is served over HTTPS.
How many endpoints does the Amazon Fraud Detector API have?
Its OpenAPI description lists 73 endpoints in version 2019-11-15. All of them are shown on this page.
What are alternatives to the Amazon Fraud Detector API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).