Amazon Web Services, Inc.

Amazon Personalize

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

AI & machine learning#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

Amazon Personalize is a machine learning service that makes it easy to add individualized
recommendations to customers.

Endpoints 71

  • POSTCreate batch inference job/#X-Amz-Target=AmazonPersonalize.CreateBatchInferenceJobGenerates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate…
  • POSTCreate batch segment job/#X-Amz-Target=AmazonPersonalize.CreateBatchSegmentJobCreates 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 Getting…
  • POSTCreate campaign/#X-Amz-Target=AmazonPersonalize.CreateCampaignYou incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about…
  • POSTCreate data deletion job/#X-Amz-Target=AmazonPersonalize.CreateDataDeletionJobCreates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a…
  • POSTCreate dataset/#X-Amz-Target=AmazonPersonalize.CreateDatasetCreates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are 5 types…
  • POSTCreate dataset export job/#X-Amz-Target=AmazonPersonalize.CreateDatasetExportJobCreates 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…
  • POSTCreate dataset group/#X-Amz-Target=AmazonPersonalize.CreateDatasetGroupCreates 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…
  • POSTCreate dataset import job/#X-Amz-Target=AmazonPersonalize.CreateDatasetImportJobCreates 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…
  • POSTCreate event tracker/#X-Amz-Target=AmazonPersonalize.CreateEventTrackerCreates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API. Only one event tracker can be associated…
  • POSTCreate filter/#X-Amz-Target=AmazonPersonalize.CreateFilterCreates a recommendation filter. For more information, see Filtering recommendations and user segments .
  • POSTCreate metric attribution/#X-Amz-Target=AmazonPersonalize.CreateMetricAttributionCreates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the…
  • POSTCreate recommender/#X-Amz-Target=AmazonPersonalize.CreateRecommenderCreates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the…
  • POSTCreate schema/#X-Amz-Target=AmazonPersonalize.CreateSchemaCreates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format. Amazon Personalize recognizes three…
  • POSTCreate solution/#X-Amz-Target=AmazonPersonalize.CreateSolutionBy default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary…
  • POSTCreate solution version/#X-Amz-Target=AmazonPersonalize.CreateSolutionVersionTrains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state…
  • POSTDelete campaign/#X-Amz-Target=AmazonPersonalize.DeleteCampaignRemoves 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…
  • POSTDelete dataset/#X-Amz-Target=AmazonPersonalize.DeleteDatasetDeletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more…
  • POSTDelete dataset group/#X-Amz-Target=AmazonPersonalize.DeleteDatasetGroupDeletes a dataset group. Before you delete a dataset group, you must delete the following: All associated event trackers. All associated solutions. All…
  • POSTDelete event tracker/#X-Amz-Target=AmazonPersonalize.DeleteEventTrackerDeletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker .
  • POSTDelete filter/#X-Amz-Target=AmazonPersonalize.DeleteFilterDeletes a filter.
  • POSTDelete metric attribution/#X-Amz-Target=AmazonPersonalize.DeleteMetricAttributionDeletes a metric attribution.
  • POSTDelete recommender/#X-Amz-Target=AmazonPersonalize.DeleteRecommenderDeactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
  • POSTDelete schema/#X-Amz-Target=AmazonPersonalize.DeleteSchemaDeletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema .
  • POSTDelete solution/#X-Amz-Target=AmazonPersonalize.DeleteSolutionDeletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To…
  • POSTDescribe algorithm/#X-Amz-Target=AmazonPersonalize.DescribeAlgorithmDescribes the given algorithm.
  • POSTDescribe batch inference job/#X-Amz-Target=AmazonPersonalize.DescribeBatchInferenceJobGets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution…
  • POSTDescribe batch segment job/#X-Amz-Target=AmazonPersonalize.DescribeBatchSegmentJobGets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution…
  • POSTDescribe campaign/#X-Amz-Target=AmazonPersonalize.DescribeCampaignDescribes the given campaign, including its status. A campaign can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE…
  • POSTDescribe data deletion job/#X-Amz-Target=AmazonPersonalize.DescribeDataDeletionJobDescribes the data deletion job created by CreateDataDeletionJob , including the job status.
  • POSTDescribe dataset/#X-Amz-Target=AmazonPersonalize.DescribeDatasetDescribes the given dataset. For more information on datasets, see CreateDataset .
  • POSTDescribe dataset export job/#X-Amz-Target=AmazonPersonalize.DescribeDatasetExportJobDescribes the dataset export job created by CreateDatasetExportJob , including the export job status.
  • POSTDescribe dataset group/#X-Amz-Target=AmazonPersonalize.DescribeDatasetGroupDescribes the given dataset group. For more information on dataset groups, see CreateDatasetGroup .
  • POSTDescribe dataset import job/#X-Amz-Target=AmazonPersonalize.DescribeDatasetImportJobDescribes the dataset import job created by CreateDatasetImportJob , including the import job status.
  • POSTDescribe event tracker/#X-Amz-Target=AmazonPersonalize.DescribeEventTrackerDescribes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see…
  • POSTDescribe feature transformation/#X-Amz-Target=AmazonPersonalize.DescribeFeatureTransformationDescribes the given feature transformation.
  • POSTDescribe filter/#X-Amz-Target=AmazonPersonalize.DescribeFilterDescribes a filter's properties.
  • POSTDescribe metric attribution/#X-Amz-Target=AmazonPersonalize.DescribeMetricAttributionDescribes a metric attribution.
  • POSTDescribe recipe/#X-Amz-Target=AmazonPersonalize.DescribeRecipeDescribes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that govern the training. Feature transformation…
  • POSTDescribe recommender/#X-Amz-Target=AmazonPersonalize.DescribeRecommenderDescribes the given recommender, including its status. A recommender can be in one of the following states: CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or-…
  • POSTDescribe schema/#X-Amz-Target=AmazonPersonalize.DescribeSchemaDescribes a schema. For more information on schemas, see CreateSchema .
  • POSTDescribe solution/#X-Amz-Target=AmazonPersonalize.DescribeSolutionDescribes a solution. For more information on solutions, see CreateSolution .
  • POSTDescribe solution version/#X-Amz-Target=AmazonPersonalize.DescribeSolutionVersionDescribes a specific version of a solution. For more information on solutions, see CreateSolution
  • POSTGet solution metrics/#X-Amz-Target=AmazonPersonalize.GetSolutionMetricsGets the metrics for the specified solution version.
  • POSTList batch inference jobs/#X-Amz-Target=AmazonPersonalize.ListBatchInferenceJobsGets a list of the batch inference jobs that have been performed off of a solution version.
  • POSTList batch segment jobs/#X-Amz-Target=AmazonPersonalize.ListBatchSegmentJobsGets a list of the batch segment jobs that have been performed off of a solution version that you specify.
  • POSTList campaigns/#X-Amz-Target=AmazonPersonalize.ListCampaignsReturns 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…
  • POSTList data deletion jobs/#X-Amz-Target=AmazonPersonalize.ListDataDeletionJobsReturns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the…
  • POSTList dataset export jobs/#X-Amz-Target=AmazonPersonalize.ListDatasetExportJobsReturns 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…
  • POSTList dataset groups/#X-Amz-Target=AmazonPersonalize.ListDatasetGroupsReturns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information…
  • POSTList dataset import jobs/#X-Amz-Target=AmazonPersonalize.ListDatasetImportJobsReturns 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…
  • POSTList datasets/#X-Amz-Target=AmazonPersonalize.ListDatasetsReturns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name…
  • POSTList event trackers/#X-Amz-Target=AmazonPersonalize.ListEventTrackersReturns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource…
  • POSTList filters/#X-Amz-Target=AmazonPersonalize.ListFiltersLists all filters that belong to a given dataset group.
  • POSTList metric attribution metrics/#X-Amz-Target=AmazonPersonalize.ListMetricAttributionMetricsLists the metrics for the metric attribution.
  • POSTList metric attributions/#X-Amz-Target=AmazonPersonalize.ListMetricAttributionsLists metric attributions.
  • POSTList recipes/#X-Amz-Target=AmazonPersonalize.ListRecipesReturns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
  • POSTList recommenders/#X-Amz-Target=AmazonPersonalize.ListRecommendersReturns 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…
  • POSTList schemas/#X-Amz-Target=AmazonPersonalize.ListSchemasReturns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For…
  • POSTList solution versions/#X-Amz-Target=AmazonPersonalize.ListSolutionVersionsReturns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are…
  • POSTList solutions/#X-Amz-Target=AmazonPersonalize.ListSolutionsReturns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The…
  • POSTList tags for resource/#X-Amz-Target=AmazonPersonalize.ListTagsForResourceGet a list of tags attached to a resource.
  • POSTStart recommender/#X-Amz-Target=AmazonPersonalize.StartRecommenderStarts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
  • POSTStop recommender/#X-Amz-Target=AmazonPersonalize.StopRecommenderStops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
  • POSTStop solution version creation/#X-Amz-Target=AmazonPersonalize.StopSolutionVersionCreationStops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on the current state of the solution version, the…
  • POSTTag resource/#X-Amz-Target=AmazonPersonalize.TagResourceAdd a list of tags to a resource.
  • POSTUntag resource/#X-Amz-Target=AmazonPersonalize.UntagResourceRemoves the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources .
  • POSTUpdate campaign/#X-Amz-Target=AmazonPersonalize.UpdateCampaignUpdates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS , or modify your campaign's…
  • POSTUpdate dataset/#X-Amz-Target=AmazonPersonalize.UpdateDatasetUpdate a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema .
  • POSTUpdate metric attribution/#X-Amz-Target=AmazonPersonalize.UpdateMetricAttributionUpdates a metric attribution.
  • POSTUpdate recommender/#X-Amz-Target=AmazonPersonalize.UpdateRecommenderUpdates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize…
  • POSTUpdate solution/#X-Amz-Target=AmazonPersonalize.UpdateSolutionUpdates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution…

API details

Base URL
https://personalize.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
71 operations on 71 pathsPOST 71
Description format
AWS Smithy model, API version 2018-05-22

How to test the Amazon Personalize 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 Personalize 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 “Create batch inference job” (POST /#X-Amz-Target=AmazonPersonalize.CreateBatchInferenceJob), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Personalize?

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers. It is listed under AI & machine learning and has 71 endpoints.

Who publishes the Amazon Personalize?

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 Personalize?

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

How do I authenticate with the Amazon Personalize?

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

How many endpoints does the Amazon Personalize have?

71 operations on 71 paths (71 POST).

Is forking the Amazon Personalize 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.