Expand description
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
If you’re using the service, you’re probably looking for PersonalizeClient and Personalize.
Structs§
- Algorithm
Describes a custom algorithm.
- Algorithm
Image Describes an algorithm image.
- AutoML
Config When the solution performs AutoML (
performAutoMLis true in CreateSolution), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.- AutoML
Result When the solution performs AutoML (
performAutoMLis true in CreateSolution), specifies the recipe that best optimized the specified metric.- Batch
Inference Job Contains information on a batch inference job.
- Batch
Inference JobConfig The configuration details of a batch inference job.
- Batch
Inference JobInput The input configuration of a batch inference job.
- Batch
Inference JobOutput The output configuration parameters of a batch inference job.
- Batch
Inference JobSummary A truncated version of the BatchInferenceJob datatype. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.
- Campaign
Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.
- Campaign
Config The configuration details of a campaign.
- Campaign
Summary Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
- Campaign
Update Summary Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
- Categorical
Hyper Parameter Range Provides the name and range of a categorical hyperparameter.
- Continuous
Hyper Parameter Range Provides the name and range of a continuous hyperparameter.
- Create
Batch Inference JobRequest - Create
Batch Inference JobResponse - Create
Campaign Request - Create
Campaign Response - Create
Dataset Export JobRequest - Create
Dataset Export JobResponse - Create
Dataset Group Request - Create
Dataset Group Response - Create
Dataset Import JobRequest - Create
Dataset Import JobResponse - Create
Dataset Request - Create
Dataset Response - Create
Event Tracker Request - Create
Event Tracker Response - Create
Filter Request - Create
Filter Response - Create
Schema Request - Create
Schema Response - Create
Solution Request - Create
Solution Response - Create
Solution Version Request - Create
Solution Version Response - Data
Source Describes the data source that contains the data to upload to a dataset.
- Dataset
Provides metadata for a dataset.
- Dataset
Export Job Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.
A dataset export job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
- Dataset
Export JobOutput The output configuration parameters of a dataset export job.
- Dataset
Export JobSummary Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.
- Dataset
Group A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.
You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.
- Dataset
Group Summary Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
- Dataset
Import Job Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.
A dataset import job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
- Dataset
Import JobSummary Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.
- Dataset
Schema Describes the schema for a dataset. For more information on schemas, see CreateSchema.
- Dataset
Schema Summary Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
- Dataset
Summary Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.
- Default
Categorical Hyper Parameter Range Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
- Default
Continuous Hyper Parameter Range Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
- Default
Hyper Parameter Ranges Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.
- Default
Integer Hyper Parameter Range Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
- Delete
Campaign Request - Delete
Dataset Group Request - Delete
Dataset Request - Delete
Event Tracker Request - Delete
Filter Request - Delete
Schema Request - Delete
Solution Request - Describe
Algorithm Request - Describe
Algorithm Response - Describe
Batch Inference JobRequest - Describe
Batch Inference JobResponse - Describe
Campaign Request - Describe
Campaign Response - Describe
Dataset Export JobRequest - Describe
Dataset Export JobResponse - Describe
Dataset Group Request - Describe
Dataset Group Response - Describe
Dataset Import JobRequest - Describe
Dataset Import JobResponse - Describe
Dataset Request - Describe
Dataset Response - Describe
Event Tracker Request - Describe
Event Tracker Response - Describe
Feature Transformation Request - Describe
Feature Transformation Response - Describe
Filter Request - Describe
Filter Response - Describe
Recipe Request - Describe
Recipe Response - Describe
Schema Request - Describe
Schema Response - Describe
Solution Request - Describe
Solution Response - Describe
Solution Version Request - Describe
Solution Version Response - Event
Tracker Provides information about an event tracker.
- Event
Tracker Summary Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.
- Feature
Transformation Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.
- Filter
Contains information on a recommendation filter, including its ARN, status, and filter expression.
- Filter
Summary A short summary of a filter's attributes.
- GetSolution
Metrics Request - GetSolution
Metrics Response - HPOConfig
Describes the properties for hyperparameter optimization (HPO).
- HPOObjective
The metric to optimize during hyperparameter optimization (HPO).
Amazon Personalize doesn't support configuring the
hpoObjectiveat this time.- HPOResource
Config Describes the resource configuration for hyperparameter optimization (HPO).
- Hyper
Parameter Ranges Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.
- Integer
Hyper Parameter Range Provides the name and range of an integer-valued hyperparameter.
- List
Batch Inference Jobs Request - List
Batch Inference Jobs Response - List
Campaigns Request - List
Campaigns Response - List
Dataset Export Jobs Request - List
Dataset Export Jobs Response - List
Dataset Groups Request - List
Dataset Groups Response - List
Dataset Import Jobs Request - List
Dataset Import Jobs Response - List
Datasets Request - List
Datasets Response - List
Event Trackers Request - List
Event Trackers Response - List
Filters Request - List
Filters Response - List
Recipes Request - List
Recipes Response - List
Schemas Request - List
Schemas Response - List
Solution Versions Request - List
Solution Versions Response - List
Solutions Request - List
Solutions Response - Optimization
Objective Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
- Personalize
Client - A client for the Amazon Personalize API.
- Recipe
Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.
- Recipe
Summary Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
- S3Data
Config The configuration details of an Amazon S3 input or output bucket.
- Solution
An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.
- Solution
Config Describes the configuration properties for the solution.
- Solution
Summary Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.
- Solution
Version An object that provides information about a specific version of a Solution.
- Solution
Version Summary Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.
- Stop
Solution Version Creation Request - TunedHPO
Params If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.
- Update
Campaign Request - Update
Campaign Response
Enums§
- Create
Batch Inference JobError - Errors returned by CreateBatchInferenceJob
- Create
Campaign Error - Errors returned by CreateCampaign
- Create
Dataset Error - Errors returned by CreateDataset
- Create
Dataset Export JobError - Errors returned by CreateDatasetExportJob
- Create
Dataset Group Error - Errors returned by CreateDatasetGroup
- Create
Dataset Import JobError - Errors returned by CreateDatasetImportJob
- Create
Event Tracker Error - Errors returned by CreateEventTracker
- Create
Filter Error - Errors returned by CreateFilter
- Create
Schema Error - Errors returned by CreateSchema
- Create
Solution Error - Errors returned by CreateSolution
- Create
Solution Version Error - Errors returned by CreateSolutionVersion
- Delete
Campaign Error - Errors returned by DeleteCampaign
- Delete
Dataset Error - Errors returned by DeleteDataset
- Delete
Dataset Group Error - Errors returned by DeleteDatasetGroup
- Delete
Event Tracker Error - Errors returned by DeleteEventTracker
- Delete
Filter Error - Errors returned by DeleteFilter
- Delete
Schema Error - Errors returned by DeleteSchema
- Delete
Solution Error - Errors returned by DeleteSolution
- Describe
Algorithm Error - Errors returned by DescribeAlgorithm
- Describe
Batch Inference JobError - Errors returned by DescribeBatchInferenceJob
- Describe
Campaign Error - Errors returned by DescribeCampaign
- Describe
Dataset Error - Errors returned by DescribeDataset
- Describe
Dataset Export JobError - Errors returned by DescribeDatasetExportJob
- Describe
Dataset Group Error - Errors returned by DescribeDatasetGroup
- Describe
Dataset Import JobError - Errors returned by DescribeDatasetImportJob
- Describe
Event Tracker Error - Errors returned by DescribeEventTracker
- Describe
Feature Transformation Error - Errors returned by DescribeFeatureTransformation
- Describe
Filter Error - Errors returned by DescribeFilter
- Describe
Recipe Error - Errors returned by DescribeRecipe
- Describe
Schema Error - Errors returned by DescribeSchema
- Describe
Solution Error - Errors returned by DescribeSolution
- Describe
Solution Version Error - Errors returned by DescribeSolutionVersion
- GetSolution
Metrics Error - Errors returned by GetSolutionMetrics
- List
Batch Inference Jobs Error - Errors returned by ListBatchInferenceJobs
- List
Campaigns Error - Errors returned by ListCampaigns
- List
Dataset Export Jobs Error - Errors returned by ListDatasetExportJobs
- List
Dataset Groups Error - Errors returned by ListDatasetGroups
- List
Dataset Import Jobs Error - Errors returned by ListDatasetImportJobs
- List
Datasets Error - Errors returned by ListDatasets
- List
Event Trackers Error - Errors returned by ListEventTrackers
- List
Filters Error - Errors returned by ListFilters
- List
Recipes Error - Errors returned by ListRecipes
- List
Schemas Error - Errors returned by ListSchemas
- List
Solution Versions Error - Errors returned by ListSolutionVersions
- List
Solutions Error - Errors returned by ListSolutions
- Stop
Solution Version Creation Error - Errors returned by StopSolutionVersionCreation
- Update
Campaign Error - Errors returned by UpdateCampaign
Traits§
- Personalize
- Trait representing the capabilities of the Amazon Personalize API. Amazon Personalize clients implement this trait.