@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPersonalizeAsyncClient extends AmazonPersonalizeClient implements AmazonPersonalizeAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createBatchInferenceJob, createBatchSegmentJob, createCampaign, createDataset, createDatasetExportJob, createDatasetGroup, createDatasetImportJob, createEventTracker, createFilter, createMetricAttribution, createRecommender, createSchema, createSolution, createSolutionVersion, deleteCampaign, deleteDataset, deleteDatasetGroup, deleteEventTracker, deleteFilter, deleteMetricAttribution, deleteRecommender, deleteSchema, deleteSolution, describeAlgorithm, describeBatchInferenceJob, describeBatchSegmentJob, describeCampaign, describeDataset, describeDatasetExportJob, describeDatasetGroup, describeDatasetImportJob, describeEventTracker, describeFeatureTransformation, describeFilter, describeMetricAttribution, describeRecipe, describeRecommender, describeSchema, describeSolution, describeSolutionVersion, getCachedResponseMetadata, getSolutionMetrics, listBatchInferenceJobs, listBatchSegmentJobs, listCampaigns, listDatasetExportJobs, listDatasetGroups, listDatasetImportJobs, listDatasets, listEventTrackers, listFilters, listMetricAttributionMetrics, listMetricAttributions, listRecipes, listRecommenders, listSchemas, listSolutions, listSolutionVersions, listTagsForResource, startRecommender, stopRecommender, stopSolutionVersionCreation, tagResource, untagResource, updateCampaign, updateMetricAttribution, updateRecommender
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createBatchInferenceJob, createBatchSegmentJob, createCampaign, createDataset, createDatasetExportJob, createDatasetGroup, createDatasetImportJob, createEventTracker, createFilter, createMetricAttribution, createRecommender, createSchema, createSolution, createSolutionVersion, deleteCampaign, deleteDataset, deleteDatasetGroup, deleteEventTracker, deleteFilter, deleteMetricAttribution, deleteRecommender, deleteSchema, deleteSolution, describeAlgorithm, describeBatchInferenceJob, describeBatchSegmentJob, describeCampaign, describeDataset, describeDatasetExportJob, describeDatasetGroup, describeDatasetImportJob, describeEventTracker, describeFeatureTransformation, describeFilter, describeMetricAttribution, describeRecipe, describeRecommender, describeSchema, describeSolution, describeSolutionVersion, getCachedResponseMetadata, getSolutionMetrics, listBatchInferenceJobs, listBatchSegmentJobs, listCampaigns, listDatasetExportJobs, listDatasetGroups, listDatasetImportJobs, listDatasets, listEventTrackers, listFilters, listMetricAttributionMetrics, listMetricAttributions, listRecipes, listRecommenders, listSchemas, listSolutions, listSolutionVersions, listTagsForResource, startRecommender, stopRecommender, stopSolutionVersionCreation, tagResource, untagResource, updateCampaign, updateMetricAttribution, updateRecommender
public static AmazonPersonalizeAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateBatchInferenceJobResult> createBatchInferenceJobAsync(CreateBatchInferenceJobRequest request)
AmazonPersonalizeAsync
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.
createBatchInferenceJobAsync
in interface AmazonPersonalizeAsync
public Future<CreateBatchInferenceJobResult> createBatchInferenceJobAsync(CreateBatchInferenceJobRequest request, AsyncHandler<CreateBatchInferenceJobRequest,CreateBatchInferenceJobResult> asyncHandler)
AmazonPersonalizeAsync
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.
createBatchInferenceJobAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateBatchSegmentJobResult> createBatchSegmentJobAsync(CreateBatchSegmentJobRequest request)
AmazonPersonalizeAsync
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.
createBatchSegmentJobAsync
in interface AmazonPersonalizeAsync
public Future<CreateBatchSegmentJobResult> createBatchSegmentJobAsync(CreateBatchSegmentJobRequest request, AsyncHandler<CreateBatchSegmentJobRequest,CreateBatchSegmentJobResult> asyncHandler)
AmazonPersonalizeAsync
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.
createBatchSegmentJobAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateCampaignResult> createCampaignAsync(CreateCampaignRequest request)
AmazonPersonalizeAsync
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 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
createCampaignAsync
in interface AmazonPersonalizeAsync
public Future<CreateCampaignResult> createCampaignAsync(CreateCampaignRequest request, AsyncHandler<CreateCampaignRequest,CreateCampaignResult> asyncHandler)
AmazonPersonalizeAsync
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 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
createCampaignAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest request)
AmazonPersonalizeAsync
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
createDatasetAsync
in interface AmazonPersonalizeAsync
public Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest request, AsyncHandler<CreateDatasetRequest,CreateDatasetResult> asyncHandler)
AmazonPersonalizeAsync
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
createDatasetAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateDatasetExportJobResult> createDatasetExportJobAsync(CreateDatasetExportJobRequest request)
AmazonPersonalizeAsync
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.
createDatasetExportJobAsync
in interface AmazonPersonalizeAsync
public Future<CreateDatasetExportJobResult> createDatasetExportJobAsync(CreateDatasetExportJobRequest request, AsyncHandler<CreateDatasetExportJobRequest,CreateDatasetExportJobResult> asyncHandler)
AmazonPersonalizeAsync
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.
createDatasetExportJobAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest request)
AmazonPersonalizeAsync
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
Related APIs
createDatasetGroupAsync
in interface AmazonPersonalizeAsync
public Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest request, AsyncHandler<CreateDatasetGroupRequest,CreateDatasetGroupResult> asyncHandler)
AmazonPersonalizeAsync
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
Related APIs
createDatasetGroupAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest request)
AmazonPersonalizeAsync
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
createDatasetImportJobAsync
in interface AmazonPersonalizeAsync
public Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest request, AsyncHandler<CreateDatasetImportJobRequest,CreateDatasetImportJobResult> asyncHandler)
AmazonPersonalizeAsync
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
createDatasetImportJobAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateEventTrackerResult> createEventTrackerAsync(CreateEventTrackerRequest request)
AmazonPersonalizeAsync
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
createEventTrackerAsync
in interface AmazonPersonalizeAsync
public Future<CreateEventTrackerResult> createEventTrackerAsync(CreateEventTrackerRequest request, AsyncHandler<CreateEventTrackerRequest,CreateEventTrackerResult> asyncHandler)
AmazonPersonalizeAsync
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
createEventTrackerAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateFilterResult> createFilterAsync(CreateFilterRequest request)
AmazonPersonalizeAsync
Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
createFilterAsync
in interface AmazonPersonalizeAsync
public Future<CreateFilterResult> createFilterAsync(CreateFilterRequest request, AsyncHandler<CreateFilterRequest,CreateFilterResult> asyncHandler)
AmazonPersonalizeAsync
Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
createFilterAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateMetricAttributionResult> createMetricAttributionAsync(CreateMetricAttributionRequest request)
AmazonPersonalizeAsync
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.
createMetricAttributionAsync
in interface AmazonPersonalizeAsync
public Future<CreateMetricAttributionResult> createMetricAttributionAsync(CreateMetricAttributionRequest request, AsyncHandler<CreateMetricAttributionRequest,CreateMetricAttributionResult> asyncHandler)
AmazonPersonalizeAsync
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.
createMetricAttributionAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateRecommenderResult> createRecommenderAsync(CreateRecommenderRequest request)
AmazonPersonalizeAsync
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
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
createRecommenderAsync
in interface AmazonPersonalizeAsync
public Future<CreateRecommenderResult> createRecommenderAsync(CreateRecommenderRequest request, AsyncHandler<CreateRecommenderRequest,CreateRecommenderResult> asyncHandler)
AmazonPersonalizeAsync
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
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
createRecommenderAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateSchemaResult> createSchemaAsync(CreateSchemaRequest request)
AmazonPersonalizeAsync
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
createSchemaAsync
in interface AmazonPersonalizeAsync
public Future<CreateSchemaResult> createSchemaAsync(CreateSchemaRequest request, AsyncHandler<CreateSchemaRequest,CreateSchemaResult> asyncHandler)
AmazonPersonalizeAsync
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
createSchemaAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateSolutionResult> createSolutionAsync(CreateSolutionRequest request)
AmazonPersonalizeAsync
Creates the configuration for training a model. A trained model is known as a solution. After the configuration
is created, you train the model (create a solution) 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. Alternatively, you
can specify performAutoML
and Amazon Personalize will analyze your data and select the optimum
USER_PERSONALIZATION recipe for you.
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
createSolutionAsync
in interface AmazonPersonalizeAsync
public Future<CreateSolutionResult> createSolutionAsync(CreateSolutionRequest request, AsyncHandler<CreateSolutionRequest,CreateSolutionResult> asyncHandler)
AmazonPersonalizeAsync
Creates the configuration for training a model. A trained model is known as a solution. After the configuration
is created, you train the model (create a solution) 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. Alternatively, you
can specify performAutoML
and Amazon Personalize will analyze your data and select the optimum
USER_PERSONALIZATION recipe for you.
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
createSolutionAsync
in interface AmazonPersonalizeAsync
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.public Future<CreateSolutionVersionResult> createSolutionVersionAsync(CreateSolutionVersionRequest request)
AmazonPersonalizeAsync
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
createSolutionVersionAsync
in interface AmazonPersonalizeAsync
public Future<CreateSolutionVersionResult> createSolutionVersionAsync(CreateSolutionVersionRequest request, AsyncHandler<CreateSolutionVersionRequest,CreateSolutionVersionResult> asyncHandler)
AmazonPersonalizeAsync
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
createSolutionVersionAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteCampaignResult> deleteCampaignAsync(DeleteCampaignRequest request)
AmazonPersonalizeAsync
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.
deleteCampaignAsync
in interface AmazonPersonalizeAsync
public Future<DeleteCampaignResult> deleteCampaignAsync(DeleteCampaignRequest request, AsyncHandler<DeleteCampaignRequest,DeleteCampaignResult> asyncHandler)
AmazonPersonalizeAsync
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.
deleteCampaignAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest request)
AmazonPersonalizeAsync
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.
deleteDatasetAsync
in interface AmazonPersonalizeAsync
public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest request, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
AmazonPersonalizeAsync
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.
deleteDatasetAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest request)
AmazonPersonalizeAsync
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.
deleteDatasetGroupAsync
in interface AmazonPersonalizeAsync
public Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest request, AsyncHandler<DeleteDatasetGroupRequest,DeleteDatasetGroupResult> asyncHandler)
AmazonPersonalizeAsync
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.
deleteDatasetGroupAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteEventTrackerResult> deleteEventTrackerAsync(DeleteEventTrackerRequest request)
AmazonPersonalizeAsync
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
deleteEventTrackerAsync
in interface AmazonPersonalizeAsync
public Future<DeleteEventTrackerResult> deleteEventTrackerAsync(DeleteEventTrackerRequest request, AsyncHandler<DeleteEventTrackerRequest,DeleteEventTrackerResult> asyncHandler)
AmazonPersonalizeAsync
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
deleteEventTrackerAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteFilterResult> deleteFilterAsync(DeleteFilterRequest request)
AmazonPersonalizeAsync
Deletes a filter.
deleteFilterAsync
in interface AmazonPersonalizeAsync
public Future<DeleteFilterResult> deleteFilterAsync(DeleteFilterRequest request, AsyncHandler<DeleteFilterRequest,DeleteFilterResult> asyncHandler)
AmazonPersonalizeAsync
Deletes a filter.
deleteFilterAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteMetricAttributionResult> deleteMetricAttributionAsync(DeleteMetricAttributionRequest request)
AmazonPersonalizeAsync
Deletes a metric attribution.
deleteMetricAttributionAsync
in interface AmazonPersonalizeAsync
public Future<DeleteMetricAttributionResult> deleteMetricAttributionAsync(DeleteMetricAttributionRequest request, AsyncHandler<DeleteMetricAttributionRequest,DeleteMetricAttributionResult> asyncHandler)
AmazonPersonalizeAsync
Deletes a metric attribution.
deleteMetricAttributionAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteRecommenderResult> deleteRecommenderAsync(DeleteRecommenderRequest request)
AmazonPersonalizeAsync
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
deleteRecommenderAsync
in interface AmazonPersonalizeAsync
public Future<DeleteRecommenderResult> deleteRecommenderAsync(DeleteRecommenderRequest request, AsyncHandler<DeleteRecommenderRequest,DeleteRecommenderResult> asyncHandler)
AmazonPersonalizeAsync
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
deleteRecommenderAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteSchemaResult> deleteSchemaAsync(DeleteSchemaRequest request)
AmazonPersonalizeAsync
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSchemaAsync
in interface AmazonPersonalizeAsync
public Future<DeleteSchemaResult> deleteSchemaAsync(DeleteSchemaRequest request, AsyncHandler<DeleteSchemaRequest,DeleteSchemaResult> asyncHandler)
AmazonPersonalizeAsync
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSchemaAsync
in interface AmazonPersonalizeAsync
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.public Future<DeleteSolutionResult> deleteSolutionAsync(DeleteSolutionRequest request)
AmazonPersonalizeAsync
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.
deleteSolutionAsync
in interface AmazonPersonalizeAsync
public Future<DeleteSolutionResult> deleteSolutionAsync(DeleteSolutionRequest request, AsyncHandler<DeleteSolutionRequest,DeleteSolutionResult> asyncHandler)
AmazonPersonalizeAsync
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.
deleteSolutionAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeAlgorithmResult> describeAlgorithmAsync(DescribeAlgorithmRequest request)
AmazonPersonalizeAsync
Describes the given algorithm.
describeAlgorithmAsync
in interface AmazonPersonalizeAsync
public Future<DescribeAlgorithmResult> describeAlgorithmAsync(DescribeAlgorithmRequest request, AsyncHandler<DescribeAlgorithmRequest,DescribeAlgorithmResult> asyncHandler)
AmazonPersonalizeAsync
Describes the given algorithm.
describeAlgorithmAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeBatchInferenceJobResult> describeBatchInferenceJobAsync(DescribeBatchInferenceJobRequest request)
AmazonPersonalizeAsync
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.
describeBatchInferenceJobAsync
in interface AmazonPersonalizeAsync
public Future<DescribeBatchInferenceJobResult> describeBatchInferenceJobAsync(DescribeBatchInferenceJobRequest request, AsyncHandler<DescribeBatchInferenceJobRequest,DescribeBatchInferenceJobResult> asyncHandler)
AmazonPersonalizeAsync
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.
describeBatchInferenceJobAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeBatchSegmentJobResult> describeBatchSegmentJobAsync(DescribeBatchSegmentJobRequest request)
AmazonPersonalizeAsync
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.
describeBatchSegmentJobAsync
in interface AmazonPersonalizeAsync
public Future<DescribeBatchSegmentJobResult> describeBatchSegmentJobAsync(DescribeBatchSegmentJobRequest request, AsyncHandler<DescribeBatchSegmentJobRequest,DescribeBatchSegmentJobResult> asyncHandler)
AmazonPersonalizeAsync
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.
describeBatchSegmentJobAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeCampaignResult> describeCampaignAsync(DescribeCampaignRequest request)
AmazonPersonalizeAsync
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.
describeCampaignAsync
in interface AmazonPersonalizeAsync
public Future<DescribeCampaignResult> describeCampaignAsync(DescribeCampaignRequest request, AsyncHandler<DescribeCampaignRequest,DescribeCampaignResult> asyncHandler)
AmazonPersonalizeAsync
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.
describeCampaignAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request)
AmazonPersonalizeAsync
Describes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetAsync
in interface AmazonPersonalizeAsync
public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
AmazonPersonalizeAsync
Describes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeDatasetExportJobResult> describeDatasetExportJobAsync(DescribeDatasetExportJobRequest request)
AmazonPersonalizeAsync
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
describeDatasetExportJobAsync
in interface AmazonPersonalizeAsync
public Future<DescribeDatasetExportJobResult> describeDatasetExportJobAsync(DescribeDatasetExportJobRequest request, AsyncHandler<DescribeDatasetExportJobRequest,DescribeDatasetExportJobResult> asyncHandler)
AmazonPersonalizeAsync
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
describeDatasetExportJobAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest request)
AmazonPersonalizeAsync
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupAsync
in interface AmazonPersonalizeAsync
public Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest request, AsyncHandler<DescribeDatasetGroupRequest,DescribeDatasetGroupResult> asyncHandler)
AmazonPersonalizeAsync
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest request)
AmazonPersonalizeAsync
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobAsync
in interface AmazonPersonalizeAsync
public Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest request, AsyncHandler<DescribeDatasetImportJobRequest,DescribeDatasetImportJobResult> asyncHandler)
AmazonPersonalizeAsync
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeEventTrackerResult> describeEventTrackerAsync(DescribeEventTrackerRequest request)
AmazonPersonalizeAsync
Describes an event tracker. The response includes the trackingId
and status
of the
event tracker. For more information on event trackers, see CreateEventTracker.
describeEventTrackerAsync
in interface AmazonPersonalizeAsync
public Future<DescribeEventTrackerResult> describeEventTrackerAsync(DescribeEventTrackerRequest request, AsyncHandler<DescribeEventTrackerRequest,DescribeEventTrackerResult> asyncHandler)
AmazonPersonalizeAsync
Describes an event tracker. The response includes the trackingId
and status
of the
event tracker. For more information on event trackers, see CreateEventTracker.
describeEventTrackerAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeFeatureTransformationResult> describeFeatureTransformationAsync(DescribeFeatureTransformationRequest request)
AmazonPersonalizeAsync
Describes the given feature transformation.
describeFeatureTransformationAsync
in interface AmazonPersonalizeAsync
public Future<DescribeFeatureTransformationResult> describeFeatureTransformationAsync(DescribeFeatureTransformationRequest request, AsyncHandler<DescribeFeatureTransformationRequest,DescribeFeatureTransformationResult> asyncHandler)
AmazonPersonalizeAsync
Describes the given feature transformation.
describeFeatureTransformationAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeFilterResult> describeFilterAsync(DescribeFilterRequest request)
AmazonPersonalizeAsync
Describes a filter's properties.
describeFilterAsync
in interface AmazonPersonalizeAsync
public Future<DescribeFilterResult> describeFilterAsync(DescribeFilterRequest request, AsyncHandler<DescribeFilterRequest,DescribeFilterResult> asyncHandler)
AmazonPersonalizeAsync
Describes a filter's properties.
describeFilterAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeMetricAttributionResult> describeMetricAttributionAsync(DescribeMetricAttributionRequest request)
AmazonPersonalizeAsync
Describes a metric attribution.
describeMetricAttributionAsync
in interface AmazonPersonalizeAsync
public Future<DescribeMetricAttributionResult> describeMetricAttributionAsync(DescribeMetricAttributionRequest request, AsyncHandler<DescribeMetricAttributionRequest,DescribeMetricAttributionResult> asyncHandler)
AmazonPersonalizeAsync
Describes a metric attribution.
describeMetricAttributionAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeRecipeResult> describeRecipeAsync(DescribeRecipeRequest request)
AmazonPersonalizeAsync
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.
describeRecipeAsync
in interface AmazonPersonalizeAsync
public Future<DescribeRecipeResult> describeRecipeAsync(DescribeRecipeRequest request, AsyncHandler<DescribeRecipeRequest,DescribeRecipeResult> asyncHandler)
AmazonPersonalizeAsync
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.
describeRecipeAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeRecommenderResult> describeRecommenderAsync(DescribeRecommenderRequest request)
AmazonPersonalizeAsync
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.
describeRecommenderAsync
in interface AmazonPersonalizeAsync
public Future<DescribeRecommenderResult> describeRecommenderAsync(DescribeRecommenderRequest request, AsyncHandler<DescribeRecommenderRequest,DescribeRecommenderResult> asyncHandler)
AmazonPersonalizeAsync
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.
describeRecommenderAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeSchemaResult> describeSchemaAsync(DescribeSchemaRequest request)
AmazonPersonalizeAsync
Describes a schema. For more information on schemas, see CreateSchema.
describeSchemaAsync
in interface AmazonPersonalizeAsync
public Future<DescribeSchemaResult> describeSchemaAsync(DescribeSchemaRequest request, AsyncHandler<DescribeSchemaRequest,DescribeSchemaResult> asyncHandler)
AmazonPersonalizeAsync
Describes a schema. For more information on schemas, see CreateSchema.
describeSchemaAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeSolutionResult> describeSolutionAsync(DescribeSolutionRequest request)
AmazonPersonalizeAsync
Describes a solution. For more information on solutions, see CreateSolution.
describeSolutionAsync
in interface AmazonPersonalizeAsync
public Future<DescribeSolutionResult> describeSolutionAsync(DescribeSolutionRequest request, AsyncHandler<DescribeSolutionRequest,DescribeSolutionResult> asyncHandler)
AmazonPersonalizeAsync
Describes a solution. For more information on solutions, see CreateSolution.
describeSolutionAsync
in interface AmazonPersonalizeAsync
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.public Future<DescribeSolutionVersionResult> describeSolutionVersionAsync(DescribeSolutionVersionRequest request)
AmazonPersonalizeAsync
Describes a specific version of a solution. For more information on solutions, see CreateSolution
describeSolutionVersionAsync
in interface AmazonPersonalizeAsync
public Future<DescribeSolutionVersionResult> describeSolutionVersionAsync(DescribeSolutionVersionRequest request, AsyncHandler<DescribeSolutionVersionRequest,DescribeSolutionVersionResult> asyncHandler)
AmazonPersonalizeAsync
Describes a specific version of a solution. For more information on solutions, see CreateSolution
describeSolutionVersionAsync
in interface AmazonPersonalizeAsync
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.public Future<GetSolutionMetricsResult> getSolutionMetricsAsync(GetSolutionMetricsRequest request)
AmazonPersonalizeAsync
Gets the metrics for the specified solution version.
getSolutionMetricsAsync
in interface AmazonPersonalizeAsync
public Future<GetSolutionMetricsResult> getSolutionMetricsAsync(GetSolutionMetricsRequest request, AsyncHandler<GetSolutionMetricsRequest,GetSolutionMetricsResult> asyncHandler)
AmazonPersonalizeAsync
Gets the metrics for the specified solution version.
getSolutionMetricsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListBatchInferenceJobsResult> listBatchInferenceJobsAsync(ListBatchInferenceJobsRequest request)
AmazonPersonalizeAsync
Gets a list of the batch inference jobs that have been performed off of a solution version.
listBatchInferenceJobsAsync
in interface AmazonPersonalizeAsync
public Future<ListBatchInferenceJobsResult> listBatchInferenceJobsAsync(ListBatchInferenceJobsRequest request, AsyncHandler<ListBatchInferenceJobsRequest,ListBatchInferenceJobsResult> asyncHandler)
AmazonPersonalizeAsync
Gets a list of the batch inference jobs that have been performed off of a solution version.
listBatchInferenceJobsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListBatchSegmentJobsResult> listBatchSegmentJobsAsync(ListBatchSegmentJobsRequest request)
AmazonPersonalizeAsync
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
listBatchSegmentJobsAsync
in interface AmazonPersonalizeAsync
public Future<ListBatchSegmentJobsResult> listBatchSegmentJobsAsync(ListBatchSegmentJobsRequest request, AsyncHandler<ListBatchSegmentJobsRequest,ListBatchSegmentJobsResult> asyncHandler)
AmazonPersonalizeAsync
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
listBatchSegmentJobsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListCampaignsResult> listCampaignsAsync(ListCampaignsRequest request)
AmazonPersonalizeAsync
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.
listCampaignsAsync
in interface AmazonPersonalizeAsync
public Future<ListCampaignsResult> listCampaignsAsync(ListCampaignsRequest request, AsyncHandler<ListCampaignsRequest,ListCampaignsResult> asyncHandler)
AmazonPersonalizeAsync
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.
listCampaignsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListDatasetExportJobsResult> listDatasetExportJobsAsync(ListDatasetExportJobsRequest request)
AmazonPersonalizeAsync
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.
listDatasetExportJobsAsync
in interface AmazonPersonalizeAsync
public Future<ListDatasetExportJobsResult> listDatasetExportJobsAsync(ListDatasetExportJobsRequest request, AsyncHandler<ListDatasetExportJobsRequest,ListDatasetExportJobsResult> asyncHandler)
AmazonPersonalizeAsync
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.
listDatasetExportJobsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest request)
AmazonPersonalizeAsync
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.
listDatasetGroupsAsync
in interface AmazonPersonalizeAsync
public Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest request, AsyncHandler<ListDatasetGroupsRequest,ListDatasetGroupsResult> asyncHandler)
AmazonPersonalizeAsync
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.
listDatasetGroupsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest request)
AmazonPersonalizeAsync
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.
listDatasetImportJobsAsync
in interface AmazonPersonalizeAsync
public Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest request, AsyncHandler<ListDatasetImportJobsRequest,ListDatasetImportJobsResult> asyncHandler)
AmazonPersonalizeAsync
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.
listDatasetImportJobsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request)
AmazonPersonalizeAsync
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.
listDatasetsAsync
in interface AmazonPersonalizeAsync
public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
AmazonPersonalizeAsync
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.
listDatasetsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListEventTrackersResult> listEventTrackersAsync(ListEventTrackersRequest request)
AmazonPersonalizeAsync
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.
listEventTrackersAsync
in interface AmazonPersonalizeAsync
public Future<ListEventTrackersResult> listEventTrackersAsync(ListEventTrackersRequest request, AsyncHandler<ListEventTrackersRequest,ListEventTrackersResult> asyncHandler)
AmazonPersonalizeAsync
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.
listEventTrackersAsync
in interface AmazonPersonalizeAsync
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.public Future<ListFiltersResult> listFiltersAsync(ListFiltersRequest request)
AmazonPersonalizeAsync
Lists all filters that belong to a given dataset group.
listFiltersAsync
in interface AmazonPersonalizeAsync
public Future<ListFiltersResult> listFiltersAsync(ListFiltersRequest request, AsyncHandler<ListFiltersRequest,ListFiltersResult> asyncHandler)
AmazonPersonalizeAsync
Lists all filters that belong to a given dataset group.
listFiltersAsync
in interface AmazonPersonalizeAsync
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.public Future<ListMetricAttributionMetricsResult> listMetricAttributionMetricsAsync(ListMetricAttributionMetricsRequest request)
AmazonPersonalizeAsync
Lists the metrics for the metric attribution.
listMetricAttributionMetricsAsync
in interface AmazonPersonalizeAsync
public Future<ListMetricAttributionMetricsResult> listMetricAttributionMetricsAsync(ListMetricAttributionMetricsRequest request, AsyncHandler<ListMetricAttributionMetricsRequest,ListMetricAttributionMetricsResult> asyncHandler)
AmazonPersonalizeAsync
Lists the metrics for the metric attribution.
listMetricAttributionMetricsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListMetricAttributionsResult> listMetricAttributionsAsync(ListMetricAttributionsRequest request)
AmazonPersonalizeAsync
Lists metric attributions.
listMetricAttributionsAsync
in interface AmazonPersonalizeAsync
public Future<ListMetricAttributionsResult> listMetricAttributionsAsync(ListMetricAttributionsRequest request, AsyncHandler<ListMetricAttributionsRequest,ListMetricAttributionsResult> asyncHandler)
AmazonPersonalizeAsync
Lists metric attributions.
listMetricAttributionsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListRecipesResult> listRecipesAsync(ListRecipesRequest request)
AmazonPersonalizeAsync
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listRecipesAsync
in interface AmazonPersonalizeAsync
public Future<ListRecipesResult> listRecipesAsync(ListRecipesRequest request, AsyncHandler<ListRecipesRequest,ListRecipesResult> asyncHandler)
AmazonPersonalizeAsync
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listRecipesAsync
in interface AmazonPersonalizeAsync
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.public Future<ListRecommendersResult> listRecommendersAsync(ListRecommendersRequest request)
AmazonPersonalizeAsync
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.
listRecommendersAsync
in interface AmazonPersonalizeAsync
public Future<ListRecommendersResult> listRecommendersAsync(ListRecommendersRequest request, AsyncHandler<ListRecommendersRequest,ListRecommendersResult> asyncHandler)
AmazonPersonalizeAsync
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.
listRecommendersAsync
in interface AmazonPersonalizeAsync
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.public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request)
AmazonPersonalizeAsync
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.
listSchemasAsync
in interface AmazonPersonalizeAsync
public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request, AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler)
AmazonPersonalizeAsync
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.
listSchemasAsync
in interface AmazonPersonalizeAsync
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.public Future<ListSolutionVersionsResult> listSolutionVersionsAsync(ListSolutionVersionsRequest request)
AmazonPersonalizeAsync
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).
listSolutionVersionsAsync
in interface AmazonPersonalizeAsync
public Future<ListSolutionVersionsResult> listSolutionVersionsAsync(ListSolutionVersionsRequest request, AsyncHandler<ListSolutionVersionsRequest,ListSolutionVersionsResult> asyncHandler)
AmazonPersonalizeAsync
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).
listSolutionVersionsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListSolutionsResult> listSolutionsAsync(ListSolutionsRequest request)
AmazonPersonalizeAsync
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.
listSolutionsAsync
in interface AmazonPersonalizeAsync
public Future<ListSolutionsResult> listSolutionsAsync(ListSolutionsRequest request, AsyncHandler<ListSolutionsRequest,ListSolutionsResult> asyncHandler)
AmazonPersonalizeAsync
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.
listSolutionsAsync
in interface AmazonPersonalizeAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonPersonalizeAsync
Get a list of tags attached to a resource.
listTagsForResourceAsync
in interface AmazonPersonalizeAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonPersonalizeAsync
Get a list of tags attached to a resource.
listTagsForResourceAsync
in interface AmazonPersonalizeAsync
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.public Future<StartRecommenderResult> startRecommenderAsync(StartRecommenderRequest request)
AmazonPersonalizeAsync
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
startRecommenderAsync
in interface AmazonPersonalizeAsync
public Future<StartRecommenderResult> startRecommenderAsync(StartRecommenderRequest request, AsyncHandler<StartRecommenderRequest,StartRecommenderResult> asyncHandler)
AmazonPersonalizeAsync
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
startRecommenderAsync
in interface AmazonPersonalizeAsync
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.public Future<StopRecommenderResult> stopRecommenderAsync(StopRecommenderRequest request)
AmazonPersonalizeAsync
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
stopRecommenderAsync
in interface AmazonPersonalizeAsync
public Future<StopRecommenderResult> stopRecommenderAsync(StopRecommenderRequest request, AsyncHandler<StopRecommenderRequest,StopRecommenderResult> asyncHandler)
AmazonPersonalizeAsync
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
stopRecommenderAsync
in interface AmazonPersonalizeAsync
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.public Future<StopSolutionVersionCreationResult> stopSolutionVersionCreationAsync(StopSolutionVersionCreationRequest request)
AmazonPersonalizeAsync
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.
stopSolutionVersionCreationAsync
in interface AmazonPersonalizeAsync
public Future<StopSolutionVersionCreationResult> stopSolutionVersionCreationAsync(StopSolutionVersionCreationRequest request, AsyncHandler<StopSolutionVersionCreationRequest,StopSolutionVersionCreationResult> asyncHandler)
AmazonPersonalizeAsync
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.
stopSolutionVersionCreationAsync
in interface AmazonPersonalizeAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonPersonalizeAsync
Add a list of tags to a resource.
tagResourceAsync
in interface AmazonPersonalizeAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonPersonalizeAsync
Add a list of tags to a resource.
tagResourceAsync
in interface AmazonPersonalizeAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonPersonalizeAsync
Remove tags that are attached to a resource.
untagResourceAsync
in interface AmazonPersonalizeAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonPersonalizeAsync
Remove tags that are attached to a resource.
untagResourceAsync
in interface AmazonPersonalizeAsync
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.public Future<UpdateCampaignResult> updateCampaignAsync(UpdateCampaignRequest request)
AmazonPersonalizeAsync
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.
updateCampaignAsync
in interface AmazonPersonalizeAsync
public Future<UpdateCampaignResult> updateCampaignAsync(UpdateCampaignRequest request, AsyncHandler<UpdateCampaignRequest,UpdateCampaignResult> asyncHandler)
AmazonPersonalizeAsync
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.
updateCampaignAsync
in interface AmazonPersonalizeAsync
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.public Future<UpdateMetricAttributionResult> updateMetricAttributionAsync(UpdateMetricAttributionRequest request)
AmazonPersonalizeAsync
Updates a metric attribution.
updateMetricAttributionAsync
in interface AmazonPersonalizeAsync
public Future<UpdateMetricAttributionResult> updateMetricAttributionAsync(UpdateMetricAttributionRequest request, AsyncHandler<UpdateMetricAttributionRequest,UpdateMetricAttributionResult> asyncHandler)
AmazonPersonalizeAsync
Updates a metric attribution.
updateMetricAttributionAsync
in interface AmazonPersonalizeAsync
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.public Future<UpdateRecommenderResult> updateRecommenderAsync(UpdateRecommenderRequest request)
AmazonPersonalizeAsync
Updates the recommender to modify the recommender configuration.
updateRecommenderAsync
in interface AmazonPersonalizeAsync
public Future<UpdateRecommenderResult> updateRecommenderAsync(UpdateRecommenderRequest request, AsyncHandler<UpdateRecommenderRequest,UpdateRecommenderResult> asyncHandler)
AmazonPersonalizeAsync
Updates the recommender to modify the recommender configuration.
updateRecommenderAsync
in interface AmazonPersonalizeAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonPersonalize
shutdown
in class AmazonPersonalizeClient