/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.personalize; import javax.annotation.Generated; import com.amazonaws.services.personalize.model.*; /** * Interface for accessing Amazon Personalize asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.personalize.AbstractAmazonPersonalizeAsync} instead. *
**
* Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to * customers. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPersonalizeAsync extends AmazonPersonalize { /** ** Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in * JSON format. For more information, see Creating a batch * inference job. *
* * @param createBatchInferenceJobRequest * @return A Java Future containing the result of the CreateBatchInferenceJob operation returned by the service. * @sample AmazonPersonalizeAsync.CreateBatchInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in * JSON format. For more information, see Creating a batch * inference job. *
* * @param createBatchInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateBatchInferenceJob operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.CreateBatchInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createBatchSegmentJobRequest * @return A Java Future containing the result of the CreateBatchSegmentJob operation returned by the service. * @sample AmazonPersonalizeAsync.CreateBatchSegmentJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createBatchSegmentJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateBatchSegmentJob operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.CreateBatchSegmentJob * @see AWS API Documentation */ java.util.concurrent.Future* 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 bill. We recommend starting with 1 for
* minProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase the
* minProvisionedTPS
as necessary.
*
* A transaction is a single GetRecommendations
or GetPersonalizedRanking
call.
* Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
* provisioned TPS (minProvisionedTPS
) specifies the baseline throughput provisioned by Amazon
* Personalize, and thus, the minimum billing charge.
*
* If your TPS increases beyond 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.
*
* The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
* either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
* minProvisionedTPS
, track your usage using Amazon CloudWatch metrics, and then increase the
* minProvisionedTPS
as necessary.
*
* 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 *
** ListCampaigns *
** DescribeCampaign *
** UpdateCampaign *
** DeleteCampaign *
** 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 bill. We recommend starting with 1 for
* minProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase the
* minProvisionedTPS
as necessary.
*
* A transaction is a single GetRecommendations
or GetPersonalizedRanking
call.
* Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
* provisioned TPS (minProvisionedTPS
) specifies the baseline throughput provisioned by Amazon
* Personalize, and thus, the minimum billing charge.
*
* If your TPS increases beyond 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.
*
* The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
* either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
* minProvisionedTPS
, track your usage using Amazon CloudWatch metrics, and then increase the
* minProvisionedTPS
as necessary.
*
* 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 *
** ListCampaigns *
** DescribeCampaign *
** UpdateCampaign *
** DeleteCampaign *
** Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. *
** There are three types of datasets: *
** Interactions *
** Items *
** Users *
*
* Each dataset type has an associated schema with required field types. Only the 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 *
** ListDatasets *
** DescribeDataset *
** DeleteDataset *
** Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. *
** There are three types of datasets: *
** Interactions *
** Items *
** Users *
*
* Each dataset type has an associated schema with required field types. Only the 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 *
** ListDatasets *
** DescribeDataset *
** DeleteDataset *
*
* 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.
*
* 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.
*
* 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: *
** Interactions *
** Items *
** Users *
** 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 *
** CreateDataset *
** CreateSolution *
** Related APIs *
** 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: *
** Interactions *
** Items *
** Users *
** 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 *
** CreateDataset *
** CreateSolution *
** Related APIs *
** 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 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 *
** 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. *
** 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 *
** 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 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 *
** 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 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 *
** Creates a recommendation filter. For more information, see Filtering recommendations and user * segments. *
* * @param createFilterRequest * @return A Java Future containing the result of the CreateFilter operation returned by the service. * @sample AmazonPersonalizeAsync.CreateFilter * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a recommendation filter. For more information, see Filtering recommendations and user * segments. *
* * @param createFilterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateFilter operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.CreateFilter * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param createMetricAttributionRequest * @return A Java Future containing the result of the CreateMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsync.CreateMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param createMetricAttributionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.CreateMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* 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 *
** ListRecommenders *
** 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 *
** ListRecommenders *
** 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 *
** ListSchemas *
** DescribeSchema *
** DeleteSchema *
** 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 *
** ListSchemas *
** DescribeSchema *
** DeleteSchema *
*
* Creates the configuration for training a model. A trained model is known as a solution version. After the
* configuration is created, you train the model (create a solution version) by calling the CreateSolutionVersion
* operation. Every time you call CreateSolutionVersion
, a new version of the solution is created.
*
* After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When * you are satisfied with the version, you deploy it using CreateCampaign. The campaign * provides recommendations to a client through the GetRecommendations * API. *
** To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the * dataset group that you provide in the request. A recipe specifies the training algorithm and a feature * transformation. You can specify one of the predefined recipes provided by Amazon Personalize. *
*
* 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. Wait
* until the status shows as ACTIVE before calling CreateSolutionVersion
.
*
* Related APIs *
** ListSolutions *
** DescribeSolution *
** DeleteSolution *
*
* Creates the configuration for training a model. A trained model is known as a solution version. After the
* configuration is created, you train the model (create a solution version) by calling the CreateSolutionVersion
* operation. Every time you call CreateSolutionVersion
, a new version of the solution is created.
*
* After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When * you are satisfied with the version, you deploy it using CreateCampaign. The campaign * provides recommendations to a client through the GetRecommendations * API. *
** To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the * dataset group that you provide in the request. A recipe specifies the training algorithm and a feature * transformation. You can specify one of the predefined recipes provided by Amazon Personalize. *
*
* 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. Wait
* until the status shows as ACTIVE before calling CreateSolutionVersion
.
*
* Related APIs *
** ListSolutions *
** DescribeSolution *
** DeleteSolution *
*
* 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 *
** ListSolutions *
** CreateSolution *
** DescribeSolution *
** DeleteSolution *
*
* 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 *
** ListSolutions *
** CreateSolution *
** DescribeSolution *
** DeleteSolution *
** 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. *
* * @param deleteCampaignRequest * @return A Java Future containing the result of the DeleteCampaign operation returned by the service. * @sample AmazonPersonalizeAsync.DeleteCampaign * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteCampaignRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteCampaign operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DeleteCampaign * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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. *
** 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. *
** Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For * more information on event trackers, see CreateEventTracker. *
* * @param deleteEventTrackerRequest * @return A Java Future containing the result of the DeleteEventTracker operation returned by the service. * @sample AmazonPersonalizeAsync.DeleteEventTracker * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For * more information on event trackers, see CreateEventTracker. *
* * @param deleteEventTrackerRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteEventTracker operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DeleteEventTracker * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a filter. *
* * @param deleteFilterRequest * @return A Java Future containing the result of the DeleteFilter operation returned by the service. * @sample AmazonPersonalizeAsync.DeleteFilter * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a filter. *
* * @param deleteFilterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteFilter operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DeleteFilter * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a metric attribution. *
* * @param deleteMetricAttributionRequest * @return A Java Future containing the result of the DeleteMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsync.DeleteMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a metric attribution. *
* * @param deleteMetricAttributionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DeleteMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations * request. *
* * @param deleteRecommenderRequest * @return A Java Future containing the result of the DeleteRecommender operation returned by the service. * @sample AmazonPersonalizeAsync.DeleteRecommender * @see AWS * API Documentation */ java.util.concurrent.Future* Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations * request. *
* * @param deleteRecommenderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteRecommender operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DeleteRecommender * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more * information on schemas, see CreateSchema. *
* * @param deleteSchemaRequest * @return A Java Future containing the result of the DeleteSchema operation returned by the service. * @sample AmazonPersonalizeAsync.DeleteSchema * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more * information on schemas, see CreateSchema. *
* * @param deleteSchemaRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteSchema operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DeleteSchema * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Describes the given algorithm. *
* * @param describeAlgorithmRequest * @return A Java Future containing the result of the DescribeAlgorithm operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeAlgorithm * @see AWS * API Documentation */ java.util.concurrent.Future* Describes the given algorithm. *
* * @param describeAlgorithmRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeAlgorithm operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeAlgorithm * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeBatchInferenceJobRequest * @return A Java Future containing the result of the DescribeBatchInferenceJob operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeBatchInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeBatchInferenceJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeBatchInferenceJob operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeBatchInferenceJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeBatchSegmentJobRequest * @return A Java Future containing the result of the DescribeBatchSegmentJob operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeBatchSegmentJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeBatchSegmentJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeBatchSegmentJob operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeBatchSegmentJob * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeCampaignRequest * @return A Java Future containing the result of the DescribeCampaign operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeCampaign * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeCampaignRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeCampaign operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeCampaign * @see AWS * API Documentation */ java.util.concurrent.Future* Describes the given dataset. For more information on datasets, see CreateDataset. *
* * @param describeDatasetRequest * @return A Java Future containing the result of the DescribeDataset operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeDataset * @see AWS * API Documentation */ java.util.concurrent.Future* Describes the given dataset. For more information on datasets, see CreateDataset. *
* * @param describeDatasetRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeDataset operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeDataset * @see AWS * API Documentation */ java.util.concurrent.Future* Describes the dataset export job created by CreateDatasetExportJob, including the export job status. *
* * @param describeDatasetExportJobRequest * @return A Java Future containing the result of the DescribeDatasetExportJob operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeDatasetExportJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the dataset export job created by CreateDatasetExportJob, including the export job status. *
* * @param describeDatasetExportJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeDatasetExportJob operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeDatasetExportJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup. *
* * @param describeDatasetGroupRequest * @return A Java Future containing the result of the DescribeDatasetGroup operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeDatasetGroup * @see AWS API Documentation */ java.util.concurrent.Future* Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup. *
* * @param describeDatasetGroupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeDatasetGroup operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeDatasetGroup * @see AWS API Documentation */ java.util.concurrent.Future* Describes the dataset import job created by CreateDatasetImportJob, including the import job status. *
* * @param describeDatasetImportJobRequest * @return A Java Future containing the result of the DescribeDatasetImportJob operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeDatasetImportJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the dataset import job created by CreateDatasetImportJob, including the import job status. *
* * @param describeDatasetImportJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeDatasetImportJob operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeDatasetImportJob * @see AWS API Documentation */ java.util.concurrent.Future
* Describes an event tracker. The response includes the trackingId
and status
of the
* event tracker. For more information on event trackers, see CreateEventTracker.
*
* Describes an event tracker. The response includes the trackingId
and status
of the
* event tracker. For more information on event trackers, see CreateEventTracker.
*
* Describes the given feature transformation. *
* * @param describeFeatureTransformationRequest * @return A Java Future containing the result of the DescribeFeatureTransformation operation returned by the * service. * @sample AmazonPersonalizeAsync.DescribeFeatureTransformation * @see AWS API Documentation */ java.util.concurrent.Future* Describes the given feature transformation. *
* * @param describeFeatureTransformationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeFeatureTransformation operation returned by the * service. * @sample AmazonPersonalizeAsyncHandler.DescribeFeatureTransformation * @see AWS API Documentation */ java.util.concurrent.Future* Describes a filter's properties. *
* * @param describeFilterRequest * @return A Java Future containing the result of the DescribeFilter operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeFilter * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a filter's properties. *
* * @param describeFilterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeFilter operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeFilter * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a metric attribution. *
* * @param describeMetricAttributionRequest * @return A Java Future containing the result of the DescribeMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* Describes a metric attribution. *
* * @param describeMetricAttributionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* 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. *
* * @param describeRecommenderRequest * @return A Java Future containing the result of the DescribeRecommender operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeRecommender * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeRecommenderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRecommender operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeRecommender * @see AWS API Documentation */ java.util.concurrent.Future* Describes a schema. For more information on schemas, see CreateSchema. *
* * @param describeSchemaRequest * @return A Java Future containing the result of the DescribeSchema operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeSchema * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a schema. For more information on schemas, see CreateSchema. *
* * @param describeSchemaRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSchema operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeSchema * @see AWS API * Documentation */ java.util.concurrent.Future* Describes a solution. For more information on solutions, see CreateSolution. *
* * @param describeSolutionRequest * @return A Java Future containing the result of the DescribeSolution operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeSolution * @see AWS * API Documentation */ java.util.concurrent.Future* Describes a solution. For more information on solutions, see CreateSolution. *
* * @param describeSolutionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSolution operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeSolution * @see AWS * API Documentation */ java.util.concurrent.Future* Describes a specific version of a solution. For more information on solutions, see CreateSolution *
* * @param describeSolutionVersionRequest * @return A Java Future containing the result of the DescribeSolutionVersion operation returned by the service. * @sample AmazonPersonalizeAsync.DescribeSolutionVersion * @see AWS API Documentation */ java.util.concurrent.Future* Describes a specific version of a solution. For more information on solutions, see CreateSolution *
* * @param describeSolutionVersionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSolutionVersion operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.DescribeSolutionVersion * @see AWS API Documentation */ java.util.concurrent.Future* Gets the metrics for the specified solution version. *
* * @param getSolutionMetricsRequest * @return A Java Future containing the result of the GetSolutionMetrics operation returned by the service. * @sample AmazonPersonalizeAsync.GetSolutionMetrics * @see AWS * API Documentation */ java.util.concurrent.Future* Gets the metrics for the specified solution version. *
* * @param getSolutionMetricsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetSolutionMetrics operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.GetSolutionMetrics * @see AWS * API Documentation */ java.util.concurrent.Future* Gets a list of the batch inference jobs that have been performed off of a solution version. *
* * @param listBatchInferenceJobsRequest * @return A Java Future containing the result of the ListBatchInferenceJobs operation returned by the service. * @sample AmazonPersonalizeAsync.ListBatchInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of the batch inference jobs that have been performed off of a solution version. *
* * @param listBatchInferenceJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListBatchInferenceJobs operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListBatchInferenceJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of the batch segment jobs that have been performed off of a solution version that you specify. *
* * @param listBatchSegmentJobsRequest * @return A Java Future containing the result of the ListBatchSegmentJobs operation returned by the service. * @sample AmazonPersonalizeAsync.ListBatchSegmentJobs * @see AWS API Documentation */ java.util.concurrent.Future* Gets a list of the batch segment jobs that have been performed off of a solution version that you specify. *
* * @param listBatchSegmentJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListBatchSegmentJobs operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListBatchSegmentJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listCampaignsRequest * @return A Java Future containing the result of the ListCampaigns operation returned by the service. * @sample AmazonPersonalizeAsync.ListCampaigns * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listCampaignsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCampaigns operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListCampaigns * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetExportJobsRequest * @return A Java Future containing the result of the ListDatasetExportJobs operation returned by the service. * @sample AmazonPersonalizeAsync.ListDatasetExportJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetExportJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDatasetExportJobs operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListDatasetExportJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetGroupsRequest * @return A Java Future containing the result of the ListDatasetGroups operation returned by the service. * @sample AmazonPersonalizeAsync.ListDatasetGroups * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetGroupsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDatasetGroups operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListDatasetGroups * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetImportJobsRequest * @return A Java Future containing the result of the ListDatasetImportJobs operation returned by the service. * @sample AmazonPersonalizeAsync.ListDatasetImportJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetImportJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDatasetImportJobs operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListDatasetImportJobs * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetsRequest * @return A Java Future containing the result of the ListDatasets operation returned by the service. * @sample AmazonPersonalizeAsync.ListDatasets * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatasetsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDatasets operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListDatasets * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listEventTrackersRequest * @return A Java Future containing the result of the ListEventTrackers operation returned by the service. * @sample AmazonPersonalizeAsync.ListEventTrackers * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listEventTrackersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListEventTrackers operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListEventTrackers * @see AWS * API Documentation */ java.util.concurrent.Future* Lists all filters that belong to a given dataset group. *
* * @param listFiltersRequest * @return A Java Future containing the result of the ListFilters operation returned by the service. * @sample AmazonPersonalizeAsync.ListFilters * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all filters that belong to a given dataset group. *
* * @param listFiltersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListFilters operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListFilters * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the metrics for the metric attribution. *
* * @param listMetricAttributionMetricsRequest * @return A Java Future containing the result of the ListMetricAttributionMetrics operation returned by the * service. * @sample AmazonPersonalizeAsync.ListMetricAttributionMetrics * @see AWS API Documentation */ java.util.concurrent.Future* Lists the metrics for the metric attribution. *
* * @param listMetricAttributionMetricsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListMetricAttributionMetrics operation returned by the * service. * @sample AmazonPersonalizeAsyncHandler.ListMetricAttributionMetrics * @see AWS API Documentation */ java.util.concurrent.Future* Lists metric attributions. *
* * @param listMetricAttributionsRequest * @return A Java Future containing the result of the ListMetricAttributions operation returned by the service. * @sample AmazonPersonalizeAsync.ListMetricAttributions * @see AWS API Documentation */ java.util.concurrent.Future* Lists metric attributions. *
* * @param listMetricAttributionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListMetricAttributions operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListMetricAttributions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's * Amazon Resource Name (ARN). *
* * @param listRecipesRequest * @return A Java Future containing the result of the ListRecipes operation returned by the service. * @sample AmazonPersonalizeAsync.ListRecipes * @see AWS API * Documentation */ java.util.concurrent.Future* Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's * Amazon Resource Name (ARN). *
* * @param listRecipesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRecipes operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListRecipes * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listRecommendersRequest * @return A Java Future containing the result of the ListRecommenders operation returned by the service. * @sample AmazonPersonalizeAsync.ListRecommenders * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listRecommendersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRecommenders operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListRecommenders * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listSchemasRequest * @return A Java Future containing the result of the ListSchemas operation returned by the service. * @sample AmazonPersonalizeAsync.ListSchemas * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listSchemasRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSchemas operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListSchemas * @see AWS API * Documentation */ java.util.concurrent.Future* 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). *
* * @param listSolutionVersionsRequest * @return A Java Future containing the result of the ListSolutionVersions operation returned by the service. * @sample AmazonPersonalizeAsync.ListSolutionVersions * @see AWS API Documentation */ java.util.concurrent.Future* 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). *
* * @param listSolutionVersionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSolutionVersions operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListSolutionVersions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the * solutions associated with the account are listed. The response provides the properties for each solution, * including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution. *
* * @param listSolutionsRequest * @return A Java Future containing the result of the ListSolutions operation returned by the service. * @sample AmazonPersonalizeAsync.ListSolutions * @see AWS API * Documentation */ java.util.concurrent.Future* Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the * solutions associated with the account are listed. The response provides the properties for each solution, * including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution. *
* * @param listSolutionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSolutions operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListSolutions * @see AWS API * Documentation */ java.util.concurrent.Future* Get a list of tags * attached to a resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonPersonalizeAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Get a list of tags * attached to a resource. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing * and automatic retraining for the recommender. *
* * @param startRecommenderRequest * @return A Java Future containing the result of the StartRecommender operation returned by the service. * @sample AmazonPersonalizeAsync.StartRecommender * @see AWS * API Documentation */ java.util.concurrent.Future* Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing * and automatic retraining for the recommender. *
* * @param startRecommenderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartRecommender operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.StartRecommender * @see AWS * API Documentation */ java.util.concurrent.Future* Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the * recommender. *
* * @param stopRecommenderRequest * @return A Java Future containing the result of the StopRecommender operation returned by the service. * @sample AmazonPersonalizeAsync.StopRecommender * @see AWS * API Documentation */ java.util.concurrent.Future* Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the * recommender. *
* * @param stopRecommenderRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopRecommender operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.StopRecommender * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param stopSolutionVersionCreationRequest * @return A Java Future containing the result of the StopSolutionVersionCreation operation returned by the service. * @sample AmazonPersonalizeAsync.StopSolutionVersionCreation * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param stopSolutionVersionCreationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StopSolutionVersionCreation operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.StopSolutionVersionCreation * @see AWS API Documentation */ java.util.concurrent.Future* Add a list of tags to a resource. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonPersonalizeAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Add a list of tags to a resource. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Remove tags that are * attached to a resource. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonPersonalizeAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Remove tags that are * attached to a resource. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future
* Updates a campaign by either deploying a new solution or changing the value of the campaign's
* minProvisionedTPS
parameter.
*
* 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 on campaigns, see CreateCampaign. *
* * @param updateCampaignRequest * @return A Java Future containing the result of the UpdateCampaign operation returned by the service. * @sample AmazonPersonalizeAsync.UpdateCampaign * @see AWS API * Documentation */ java.util.concurrent.Future
* Updates a campaign by either deploying a new solution or changing the value of the campaign's
* minProvisionedTPS
parameter.
*
* 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 on campaigns, see CreateCampaign. *
* * @param updateCampaignRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateCampaign operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.UpdateCampaign * @see AWS API * Documentation */ java.util.concurrent.Future* Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's * schema. *
* * @param updateDatasetRequest * @return A Java Future containing the result of the UpdateDataset operation returned by the service. * @sample AmazonPersonalizeAsync.UpdateDataset * @see AWS API * Documentation */ java.util.concurrent.Future* Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's * schema. *
* * @param updateDatasetRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateDataset operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.UpdateDataset * @see AWS API * Documentation */ java.util.concurrent.Future* Updates a metric attribution. *
* * @param updateMetricAttributionRequest * @return A Java Future containing the result of the UpdateMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsync.UpdateMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future* Updates a metric attribution. *
* * @param updateMetricAttributionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateMetricAttribution operation returned by the service. * @sample AmazonPersonalizeAsyncHandler.UpdateMetricAttribution * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*