AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
Loading...
Searching...
No Matches
AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <PersonalizeClient.h>
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
Definition at line 22 of file PersonalizeClient.h.
Definition at line 25 of file PersonalizeClient.h.
Definition at line 29 of file PersonalizeClient.h.
Definition at line 30 of file PersonalizeClient.h.
Aws::Personalize::PersonalizeClientConfiguration(),
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::Personalize::PersonalizeClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::Personalize::PersonalizeClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Generates 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 batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.
For more information, see Creating a batch inference job .
If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.
For more information about generating themes, see Batch recommendations with themes from Content Generator .
You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
nullptr
An Async wrapper for CreateBatchInferenceJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 117 of file PersonalizeClient.h.
A Callable wrapper for CreateBatchInferenceJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 108 of file PersonalizeClient.h.
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 Getting batch recommendations and user segments.
nullptr
An Async wrapper for CreateBatchSegmentJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 145 of file PersonalizeClient.h.
A Callable wrapper for CreateBatchSegmentJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 136 of file PersonalizeClient.h.
You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.
Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.
When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.
If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS.
You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
For more information about campaign costs, see Amazon Personalize pricing.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.
Related APIs
nullptr
An Async wrapper for CreateCampaign that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 218 of file PersonalizeClient.h.
A Callable wrapper for CreateCampaign that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 209 of file PersonalizeClient.h.
Creates 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 CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users.
Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3.
To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.
Status
A data deletion job can have one of the following statuses:
PENDING > IN_PROGRESS > COMPLETED -or- FAILED
To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed.
Related APIs
nullptr
An Async wrapper for CreateDataDeletionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 278 of file PersonalizeClient.h.
A Callable wrapper for CreateDataDeletionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 269 of file PersonalizeClient.h.
Creates 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 of datasets:
Item interactions
Items
Users
Action interactions
Actions
Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
nullptr
An Async wrapper for CreateDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 324 of file PersonalizeClient.h.
A Callable wrapper for CreateDataset that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 315 of file PersonalizeClient.h.
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 service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.
Status
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
nullptr
An Async wrapper for CreateDatasetExportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 362 of file PersonalizeClient.h.
A Callable wrapper for CreateDatasetExportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 353 of file PersonalizeClient.h.
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 each type of dataset:
Item interactions
Items
Users
Actions
Action interactions
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
nullptr
An Async wrapper for CreateDatasetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 422 of file PersonalizeClient.h.
A Callable wrapper for CreateDatasetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 413 of file PersonalizeClient.h.
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 the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
Status
A dataset import job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
nullptr
An Async wrapper for CreateDatasetImportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 477 of file PersonalizeClient.h.
A Callable wrapper for CreateDatasetImportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 468 of file PersonalizeClient.h.
Creates 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 with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.
When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.
The event tracker must be in the ACTIVE state before using the tracking ID.
Related APIs
nullptr
An Async wrapper for CreateEventTracker that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 526 of file PersonalizeClient.h.
A Callable wrapper for CreateEventTracker that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 517 of file PersonalizeClient.h.
Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
nullptr
An Async wrapper for CreateFilter that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 553 of file PersonalizeClient.h.
A Callable wrapper for CreateFilter that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 544 of file PersonalizeClient.h.
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, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
nullptr
An Async wrapper for CreateMetricAttribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 583 of file PersonalizeClient.h.
A Callable wrapper for CreateMetricAttribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 574 of file PersonalizeClient.h.
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 recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.
When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.
If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.
Related APIs
nullptr
An Async wrapper for CreateRecommender that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 655 of file PersonalizeClient.h.
A Callable wrapper for CreateRecommender that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 646 of file PersonalizeClient.h.
Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
nullptr
An Async wrapper for CreateSchema that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 693 of file PersonalizeClient.h.
A Callable wrapper for CreateSchema that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 684 of file PersonalizeClient.h.
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.
Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.
By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.
To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.
After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.
After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.
Related APIs
nullptr
An Async wrapper for CreateSolution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 774 of file PersonalizeClient.h.
A Callable wrapper for CreateSolution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 765 of file PersonalizeClient.h.
Trains 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 before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.
Status
A solution version can be in one of the following states:
CREATE PENDING
CREATE IN_PROGRESS
ACTIVE
CREATE FAILED
CREATE STOPPING
CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.
If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Related APIs
nullptr
An Async wrapper for CreateSolutionVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 825 of file PersonalizeClient.h.
A Callable wrapper for CreateSolutionVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 816 of file PersonalizeClient.h.
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 campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
nullptr
An Async wrapper for DeleteCampaign that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 856 of file PersonalizeClient.h.
A Callable wrapper for DeleteCampaign that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 847 of file PersonalizeClient.h.
Deletes 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 information on datasets, see CreateDataset.
nullptr
An Async wrapper for DeleteDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 885 of file PersonalizeClient.h.
A Callable wrapper for DeleteDataset that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 876 of file PersonalizeClient.h.
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
All associated event trackers.
All associated solutions.
All datasets in the dataset group.
nullptr
An Async wrapper for DeleteDatasetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 913 of file PersonalizeClient.h.
A Callable wrapper for DeleteDatasetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 904 of file PersonalizeClient.h.
Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
nullptr
An Async wrapper for DeleteEventTracker that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 941 of file PersonalizeClient.h.
A Callable wrapper for DeleteEventTracker that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 932 of file PersonalizeClient.h.
nullptr
An Async wrapper for DeleteFilter that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 966 of file PersonalizeClient.h.
A Callable wrapper for DeleteFilter that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 957 of file PersonalizeClient.h.
nullptr
An Async wrapper for DeleteMetricAttribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 991 of file PersonalizeClient.h.
A Callable wrapper for DeleteMetricAttribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 982 of file PersonalizeClient.h.
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
nullptr
An Async wrapper for DeleteRecommender that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1019 of file PersonalizeClient.h.
A Callable wrapper for DeleteRecommender that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1010 of file PersonalizeClient.h.
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
nullptr
An Async wrapper for DeleteSchema that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1047 of file PersonalizeClient.h.
A Callable wrapper for DeleteSchema that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1038 of file PersonalizeClient.h.
Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
nullptr
An Async wrapper for DeleteSolution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1080 of file PersonalizeClient.h.
A Callable wrapper for DeleteSolution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1071 of file PersonalizeClient.h.
nullptr
An Async wrapper for DescribeAlgorithm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1105 of file PersonalizeClient.h.
A Callable wrapper for DescribeAlgorithm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1096 of file PersonalizeClient.h.
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 version used to generate the recommendations.
nullptr
An Async wrapper for DescribeBatchInferenceJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1132 of file PersonalizeClient.h.
A Callable wrapper for DescribeBatchInferenceJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1123 of file PersonalizeClient.h.
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 version used to generate segments.
nullptr
An Async wrapper for DescribeBatchSegmentJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1159 of file PersonalizeClient.h.
A Callable wrapper for DescribeBatchSegmentJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1150 of file PersonalizeClient.h.
Describes the given campaign, including its status.
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
For more information on campaigns, see CreateCampaign.
nullptr
An Async wrapper for DescribeCampaign that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1191 of file PersonalizeClient.h.
A Callable wrapper for DescribeCampaign that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1182 of file PersonalizeClient.h.
Describes the data deletion job created by CreateDataDeletionJob, including the job status.
nullptr
An Async wrapper for DescribeDataDeletionJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1218 of file PersonalizeClient.h.
A Callable wrapper for DescribeDataDeletionJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1209 of file PersonalizeClient.h.
Describes the given dataset. For more information on datasets, see CreateDataset.
nullptr
An Async wrapper for DescribeDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1245 of file PersonalizeClient.h.
A Callable wrapper for DescribeDataset that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1236 of file PersonalizeClient.h.
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
nullptr
An Async wrapper for DescribeDatasetExportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1272 of file PersonalizeClient.h.
A Callable wrapper for DescribeDatasetExportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1263 of file PersonalizeClient.h.
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
nullptr
An Async wrapper for DescribeDatasetGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1300 of file PersonalizeClient.h.
A Callable wrapper for DescribeDatasetGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1291 of file PersonalizeClient.h.
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
nullptr
An Async wrapper for DescribeDatasetImportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1327 of file PersonalizeClient.h.
A Callable wrapper for DescribeDatasetImportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1318 of file PersonalizeClient.h.
Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.
nullptr
An Async wrapper for DescribeEventTracker that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1356 of file PersonalizeClient.h.
A Callable wrapper for DescribeEventTracker that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1347 of file PersonalizeClient.h.
nullptr
An Async wrapper for DescribeFeatureTransformation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1381 of file PersonalizeClient.h.
A Callable wrapper for DescribeFeatureTransformation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1372 of file PersonalizeClient.h.
nullptr
An Async wrapper for DescribeFilter that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1406 of file PersonalizeClient.h.
A Callable wrapper for DescribeFilter that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1397 of file PersonalizeClient.h.
nullptr
An Async wrapper for DescribeMetricAttribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1431 of file PersonalizeClient.h.
A Callable wrapper for DescribeMetricAttribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1422 of file PersonalizeClient.h.
Describes a recipe.
A recipe contains three items:
An algorithm that trains a model.
Hyperparameters that govern the training.
Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
nullptr
An Async wrapper for DescribeRecipe that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1467 of file PersonalizeClient.h.
A Callable wrapper for DescribeRecipe that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1458 of file PersonalizeClient.h.
Describes the given recommender, including its status.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
The modelMetrics key is null when the recommender is being created or deleted.
For more information on recommenders, see CreateRecommender.
nullptr
An Async wrapper for DescribeRecommender that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1502 of file PersonalizeClient.h.
A Callable wrapper for DescribeRecommender that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1493 of file PersonalizeClient.h.
nullptr
An Async wrapper for DescribeSchema that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1529 of file PersonalizeClient.h.
A Callable wrapper for DescribeSchema that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1520 of file PersonalizeClient.h.
Describes a solution. For more information on solutions, see CreateSolution.
nullptr
An Async wrapper for DescribeSolution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1556 of file PersonalizeClient.h.
A Callable wrapper for DescribeSolution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1547 of file PersonalizeClient.h.
Describes a specific version of a solution. For more information on solutions, see CreateSolution
nullptr
An Async wrapper for DescribeSolutionVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1584 of file PersonalizeClient.h.
A Callable wrapper for DescribeSolutionVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1575 of file PersonalizeClient.h.
nullptr
An Async wrapper for GetSolutionMetrics that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1610 of file PersonalizeClient.h.
A Callable wrapper for GetSolutionMetrics that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1601 of file PersonalizeClient.h.
{})
const
Gets a list of the batch inference jobs that have been performed off of a solution version.
nullptr,
{}
An Async wrapper for ListBatchInferenceJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1636 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListBatchInferenceJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1627 of file PersonalizeClient.h.
{})
const
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
nullptr,
{}
An Async wrapper for ListBatchSegmentJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1662 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListBatchSegmentJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1653 of file PersonalizeClient.h.
{})
const
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 response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
nullptr,
{}
An Async wrapper for ListCampaigns that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1692 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListCampaigns that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1683 of file PersonalizeClient.h.
{})
const
Returns 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 data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.
nullptr,
{}
An Async wrapper for ListDataDeletionJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1723 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListDataDeletionJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1714 of file PersonalizeClient.h.
{})
const
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 listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
nullptr,
{}
An Async wrapper for ListDatasetExportJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1756 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListDatasetExportJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1747 of file PersonalizeClient.h.
{})
const
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 dataset groups, see CreateDatasetGroup.
nullptr,
{}
An Async wrapper for ListDatasetGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1785 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListDatasetGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1776 of file PersonalizeClient.h.
{})
const
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 listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
nullptr,
{}
An Async wrapper for ListDatasetImportJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1818 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListDatasetImportJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1809 of file PersonalizeClient.h.
{})
const
Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
nullptr,
{}
An Async wrapper for ListDatasets that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1847 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListDatasets that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1838 of file PersonalizeClient.h.
{})
const
Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
nullptr,
{}
An Async wrapper for ListEventTrackers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1876 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListEventTrackers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1867 of file PersonalizeClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListFilters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1902 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListFilters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1893 of file PersonalizeClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListMetricAttributionMetrics that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1927 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListMetricAttributionMetrics that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1918 of file PersonalizeClient.h.
{})
const
nullptr,
{}
An Async wrapper for ListMetricAttributions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1952 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListMetricAttributions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1943 of file PersonalizeClient.h.
{})
const
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
nullptr,
{}
An Async wrapper for ListRecipes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1979 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListRecipes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1970 of file PersonalizeClient.h.
{})
const
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 are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
nullptr,
{}
An Async wrapper for ListRecommenders that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2009 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListRecommenders that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2000 of file PersonalizeClient.h.
{})
const
Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
nullptr,
{}
An Async wrapper for ListSchemas that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2038 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListSchemas that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2029 of file PersonalizeClient.h.
{})
const
Returns 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 response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
nullptr,
{}
An Async wrapper for ListSolutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2096 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListSolutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2087 of file PersonalizeClient.h.
{})
const
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. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).
nullptr,
{}
An Async wrapper for ListSolutionVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2066 of file PersonalizeClient.h.
{})
const
A Callable wrapper for ListSolutionVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2057 of file PersonalizeClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2123 of file PersonalizeClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2114 of file PersonalizeClient.h.
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
nullptr
An Async wrapper for StartRecommender that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2150 of file PersonalizeClient.h.
A Callable wrapper for StartRecommender that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2141 of file PersonalizeClient.h.
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
nullptr
An Async wrapper for StopRecommender that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2176 of file PersonalizeClient.h.
A Callable wrapper for StopRecommender that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2167 of file PersonalizeClient.h.
Stops 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 solution version state changes as follows:
CREATE_PENDING > CREATE_STOPPED
or
CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
nullptr
An Async wrapper for StopSolutionVersionCreation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2208 of file PersonalizeClient.h.
A Callable wrapper for StopSolutionVersionCreation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2199 of file PersonalizeClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2233 of file PersonalizeClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2224 of file PersonalizeClient.h.
Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2261 of file PersonalizeClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2252 of file PersonalizeClient.h.
Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.
To update a campaign to start automatically using the latest solution version, specify the following:
For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format.
In the campaignConfig, set syncWithLatestSolutionVersion to true.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.
For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
nullptr
An Async wrapper for UpdateCampaign that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2307 of file PersonalizeClient.h.
A Callable wrapper for UpdateCampaign that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2298 of file PersonalizeClient.h.
Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.
nullptr
An Async wrapper for UpdateDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2335 of file PersonalizeClient.h.
A Callable wrapper for UpdateDataset that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2326 of file PersonalizeClient.h.
{})
const
nullptr,
{}
An Async wrapper for UpdateMetricAttribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2360 of file PersonalizeClient.h.
{})
const
A Callable wrapper for UpdateMetricAttribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2351 of file PersonalizeClient.h.
Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.
nullptr
An Async wrapper for UpdateRecommender that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2393 of file PersonalizeClient.h.
A Callable wrapper for UpdateRecommender that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2384 of file PersonalizeClient.h.
Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution.
A solution update can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of a solution update, call the DescribeSolution API operation and find the status in the latestSolutionUpdate.
nullptr
An Async wrapper for UpdateSolution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2428 of file PersonalizeClient.h.
A Callable wrapper for UpdateSolution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2419 of file PersonalizeClient.h.
Definition at line 2435 of file PersonalizeClient.h.
1.9.8