Package-level declarations

Types

Link copied to clipboard
class Algorithm

Describes a custom algorithm.

Link copied to clipboard

Describes an algorithm image.

Link copied to clipboard

When the solution performs AutoML (performAutoML is 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.

Link copied to clipboard

When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.

Link copied to clipboard

The automatic training configuration to use when performAutoTraining is true.

Link copied to clipboard

Contains information on a batch inference job.

Link copied to clipboard

The configuration details of a batch inference job.

Link copied to clipboard

The input configuration of a batch inference job.

Link copied to clipboard
Link copied to clipboard

The output configuration parameters of a batch inference job.

Link copied to clipboard

A truncated version of the BatchInferenceJob. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.

Link copied to clipboard

Contains information on a batch segment job.

Link copied to clipboard

The input configuration of a batch segment job.

Link copied to clipboard

The output configuration parameters of a batch segment job.

Link copied to clipboard

A truncated version of the BatchSegmentJob datatype. ListBatchSegmentJobs operation returns a list of batch segment job summaries.

Link copied to clipboard
class Campaign

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

Link copied to clipboard

The configuration details of a campaign.

Link copied to clipboard

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

Link copied to clipboard

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

Link copied to clipboard

Provides the name and range of a categorical hyperparameter.

Link copied to clipboard

Provides the name and range of a continuous hyperparameter.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see Deleting users.

Link copied to clipboard

Provides a summary of the properties of a data deletion job. For a complete listing, call the DescribeDataDeletionJob API operation.

Link copied to clipboard
class Dataset

Provides metadata for a dataset.

Link copied to clipboard

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

Link copied to clipboard

The output configuration parameters of a dataset export job.

Link copied to clipboard

Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.

Link copied to clipboard

A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). 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.

Link copied to clipboard

Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.

Link copied to clipboard

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

Link copied to clipboard

Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.

Link copied to clipboard

Describes the schema for a dataset. For more information on schemas, see CreateSchema.

Link copied to clipboard

Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.

Link copied to clipboard

Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.

Link copied to clipboard

Describes an update to a dataset.

Link copied to clipboard

Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.

Link copied to clipboard

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).

Link copied to clipboard

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).

Link copied to clipboard

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

Link copied to clipboard

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).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class Domain
Link copied to clipboard

Describes the parameters of events, which are used in solution creation.

Link copied to clipboard

Describes the configuration of events, which are used in solution creation.

Link copied to clipboard

Provides information about an event tracker.

Link copied to clipboard

Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.

Link copied to clipboard

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

Link copied to clipboard

A string to string map of the configuration details for theme generation.

Link copied to clipboard
class Filter

Contains information on a recommendation filter, including its ARN, status, and filter expression.

Link copied to clipboard

A short summary of a filter's attributes.

Link copied to clipboard
Link copied to clipboard
class HpoConfig

Describes the properties for hyperparameter optimization (HPO).

Link copied to clipboard

The metric to optimize during hyperparameter optimization (HPO).

Link copied to clipboard

Describes the resource configuration for hyperparameter optimization (HPO).

Link copied to clipboard

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

Link copied to clipboard
sealed class ImportMode
Link copied to clipboard
sealed class IngestionMode
Link copied to clipboard

Provides the name and range of an integer-valued hyperparameter.

Link copied to clipboard

Provide a valid value for the field or parameter.

Link copied to clipboard

The token is not valid.

Link copied to clipboard

The limit on the number of requests per second has been exceeded.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.

Link copied to clipboard

Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

Link copied to clipboard

The output configuration details for a metric attribution.

Link copied to clipboard

Provides a summary of the properties of a metric attribution. For a complete listing, call the DescribeMetricAttribution.

Link copied to clipboard
Link copied to clipboard

Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.

Link copied to clipboard

Base class for all service related exceptions thrown by the Personalize client

Link copied to clipboard
class Recipe

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.

Link copied to clipboard
sealed class RecipeProvider
Link copied to clipboard

Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.

Link copied to clipboard

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.

Link copied to clipboard

The configuration details of the recommender.

Link copied to clipboard

Provides a summary of the properties of the recommender.

Link copied to clipboard

Provides a summary of the properties of a recommender update. For a complete listing, call the DescribeRecommender API.

Link copied to clipboard

The specified resource already exists.

Link copied to clipboard

The specified resource is in use.

Link copied to clipboard

Could not find the specified resource.

Link copied to clipboard

The configuration details of an Amazon S3 input or output bucket.

Link copied to clipboard
class Solution

By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

Link copied to clipboard

Describes the configuration properties for the solution.

Link copied to clipboard

Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.

Link copied to clipboard

The configuration details of the solution update.

Link copied to clipboard

Provides a summary of the properties of a solution update. For a complete listing, call the DescribeSolution API.

Link copied to clipboard

An object that provides information about a specific version of a Solution in a Custom dataset group.

Link copied to clipboard

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Tag

The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see Tagging Amazon Personalize resources.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The configuration details for generating themes with a batch inference job.

Link copied to clipboard

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

Link copied to clipboard

You have exceeded the maximum number of tags you can apply to this resource.

Link copied to clipboard

The training data configuration to use when creating a domain recommender or custom solution version (trained model).

Link copied to clipboard
sealed class TrainingMode
Link copied to clipboard
sealed class TrainingType
Link copied to clipboard

If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard