Open documentation ↗Overview
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
Amazon Personalize is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 66 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2018-05-22
- Endpoints
- 66
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-18
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AmazonPersonalize.CreateBatchInferenceJob | Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see <a href="h |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateBatchSegmentJob | Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see <a href="htt |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateCampaign | <p>Creates a campaign that deploys a solution version. When a client calls the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendati |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateDataset | <p>Creates an empty dataset and adds it to the specified dataset group. Use <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJo |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateDatasetExportJob | <p> Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an servi |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateDatasetGroup | <p>Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateDatasetImportJob | <p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateEventTracker | <p>Creates an event tracker that you use when adding event data to a specified dataset group using the <a href="https://docs.aws.amazon.com/personalize/latest/d |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateFilter | Creates a recommendation filter. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateMetricAttribution | Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateRecommender | <p>Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recom |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateSchema | <p>Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.</p> <p>Amazon Personalize recognize |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateSolution | <p>Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a sol |
| POST | /#X-Amz-Target=AmazonPersonalize.CreateSolutionVersion | <p>Trains or retrains an active solution in a Custom dataset group. A solution is created using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/A |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteCampaign | Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted c |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteDataset | Deletes a dataset. You can't delete a dataset if an associated <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN PROG |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteDatasetGroup | <p>Deletes a dataset group. Before you delete a dataset group, you must delete the following:</p> <ul> <li> <p>All associated event trackers.</p> </li> <li> <p> |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteEventTracker | Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see <a href |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteFilter | Deletes a filter. |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteMetricAttribution | Deletes a metric attribution. |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteRecommender | Deactivates and removes a recommender. A deleted recommender can no longer be specified in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_G |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteSchema | Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see <a href="https://docs.aws. |
| POST | /#X-Amz-Target=AmazonPersonalize.DeleteSolution | Deletes all versions of a solution and the <code>Solution</code> object itself. Before deleting a solution, you must delete all campaigns based on the solution. |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeAlgorithm | Describes the given algorithm. |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeBatchInferenceJob | Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution ve |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeBatchSegmentJob | Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution vers |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeCampaign | <p>Describes the given campaign, including its status.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_P |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeDataset | Describes the given dataset. For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateData |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeDatasetExportJob | Describes the dataset export job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</ |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeDatasetGroup | Describes the given dataset group. For more information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeDatasetImportJob | Describes the dataset import job created by <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</ |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeEventTracker | Describes an event tracker. The response includes the <code>trackingId</code> and <code>status</code> of the event tracker. For more information on event tracke |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeFeatureTransformation | Describes the given feature transformation. |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeFilter | Describes a filter's properties. |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeMetricAttribution | Describes a metric attribution. |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeRecipe | <p>Describes a recipe.</p> <p>A recipe contains three items:</p> <ul> <li> <p>An algorithm that trains a model.</p> </li> <li> <p>Hyperparameters that govern th |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeRecommender | <p>Describes the given recommender, including its status.</p> <p>A recommender can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREAT |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeSchema | Describes a schema. For more information on schemas, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>. |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeSolution | Describes a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution< |
| POST | /#X-Amz-Target=AmazonPersonalize.DescribeSolutionVersion | Describes a specific version of a solution. For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution |
| POST | /#X-Amz-Target=AmazonPersonalize.GetSolutionMetrics | Gets the metrics for the specified solution version. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListBatchInferenceJobs | Gets a list of the batch inference jobs that have been performed off of a solution version. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListBatchSegmentJobs | Gets a list of the batch segment jobs that have been performed off of a solution version that you specify. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListCampaigns | Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The respons |
| POST | /#X-Amz-Target=AmazonPersonalize.ListDatasetExportJobs | Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are l |
| POST | /#X-Amz-Target=AmazonPersonalize.ListDatasetGroups | Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on |
| POST | /#X-Amz-Target=AmazonPersonalize.ListDatasetImportJobs | Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are l |
| POST | /#X-Amz-Target=AmazonPersonalize.ListDatasets | Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (AR |
| POST | /#X-Amz-Target=AmazonPersonalize.ListEventTrackers | Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name |
| POST | /#X-Amz-Target=AmazonPersonalize.ListFilters | Lists all filters that belong to a given dataset group. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListMetricAttributionMetrics | Lists the metrics for the metric attribution. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListMetricAttributions | Lists metric attributions. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListRecipes | Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN). |
| POST | /#X-Amz-Target=AmazonPersonalize.ListRecommenders | Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account a |
| POST | /#X-Amz-Target=AmazonPersonalize.ListSchemas | Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For mor |
| POST | /#X-Amz-Target=AmazonPersonalize.ListSolutionVersions | Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. |
| POST | /#X-Amz-Target=AmazonPersonalize.ListSolutions | Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. T |
| POST | /#X-Amz-Target=AmazonPersonalize.ListTagsForResource | Get a list of <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> attached to a resource. |
| POST | /#X-Amz-Target=AmazonPersonalize.StartRecommender | Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender. |
| POST | /#X-Amz-Target=AmazonPersonalize.StopRecommender | Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender. |
| POST | /#X-Amz-Target=AmazonPersonalize.StopSolutionVersionCreation | <p>Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. </p> <p>Depending on the current state of the solution version, |
| POST | /#X-Amz-Target=AmazonPersonalize.TagResource | Add a list of tags to a resource. |
| POST | /#X-Amz-Target=AmazonPersonalize.UntagResource | Remove <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> that are attached to a resource. |
| POST | /#X-Amz-Target=AmazonPersonalize.UpdateCampaign | <p>Updates a campaign by either deploying a new solution or changing the value of the campaign's <code>minProvisionedTPS</code> parameter.</p> <p>To update a ca |
| POST | /#X-Amz-Target=AmazonPersonalize.UpdateMetricAttribution | Updates a metric attribution. |
| POST | /#X-Amz-Target=AmazonPersonalize.UpdateRecommender | Updates the recommender to modify the recommender configuration. |
Questions
Does the Amazon Personalize API need an API key?
Yes. The Amazon Personalize API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Personalize API support HTTPS?
Yes, the Amazon Personalize API is served over HTTPS.
How many endpoints does the Amazon Personalize API have?
Its OpenAPI description lists 66 endpoints in version 2018-05-22. All of them are shown on this page.
What are alternatives to the Amazon Personalize 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).