@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonPersonalizeAsync extends AbstractAmazonPersonalize implements AmazonPersonalizeAsync
AmazonPersonalizeAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIXcreateBatchInferenceJob, createCampaign, createDataset, createDatasetExportJob, createDatasetGroup, createDatasetImportJob, createEventTracker, createFilter, createSchema, createSolution, createSolutionVersion, deleteCampaign, deleteDataset, deleteDatasetGroup, deleteEventTracker, deleteFilter, deleteSchema, deleteSolution, describeAlgorithm, describeBatchInferenceJob, describeCampaign, describeDataset, describeDatasetExportJob, describeDatasetGroup, describeDatasetImportJob, describeEventTracker, describeFeatureTransformation, describeFilter, describeRecipe, describeSchema, describeSolution, describeSolutionVersion, getCachedResponseMetadata, getSolutionMetrics, listBatchInferenceJobs, listCampaigns, listDatasetExportJobs, listDatasetGroups, listDatasetImportJobs, listDatasets, listEventTrackers, listFilters, listRecipes, listSchemas, listSolutions, listSolutionVersions, shutdown, stopSolutionVersionCreation, updateCampaignequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateBatchInferenceJob, createCampaign, createDataset, createDatasetExportJob, createDatasetGroup, createDatasetImportJob, createEventTracker, createFilter, createSchema, createSolution, createSolutionVersion, deleteCampaign, deleteDataset, deleteDatasetGroup, deleteEventTracker, deleteFilter, deleteSchema, deleteSolution, describeAlgorithm, describeBatchInferenceJob, describeCampaign, describeDataset, describeDatasetExportJob, describeDatasetGroup, describeDatasetImportJob, describeEventTracker, describeFeatureTransformation, describeFilter, describeRecipe, describeSchema, describeSolution, describeSolutionVersion, getCachedResponseMetadata, getSolutionMetrics, listBatchInferenceJobs, listCampaigns, listDatasetExportJobs, listDatasetGroups, listDatasetImportJobs, listDatasets, listEventTrackers, listFilters, listRecipes, listSchemas, listSolutions, listSolutionVersions, shutdown, stopSolutionVersionCreation, updateCampaignpublic Future<CreateBatchInferenceJobResult> createBatchInferenceJobAsync(CreateBatchInferenceJobRequest request)
AmazonPersonalizeAsyncCreates 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 recommendations-batch.
createBatchInferenceJobAsync in interface AmazonPersonalizeAsyncpublic Future<CreateBatchInferenceJobResult> createBatchInferenceJobAsync(CreateBatchInferenceJobRequest request, AsyncHandler<CreateBatchInferenceJobRequest,CreateBatchInferenceJobResult> asyncHandler)
AmazonPersonalizeAsyncCreates 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 recommendations-batch.
createBatchInferenceJobAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates a campaign by deploying 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 AmazonPersonalizeAsyncpublic Future<CreateCampaignResult> createCampaignAsync(CreateCampaignRequest request, AsyncHandler<CreateCampaignRequest,CreateCampaignResult> asyncHandler)
AmazonPersonalizeAsyncCreates a campaign by deploying 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates 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 AmazonPersonalizeAsyncpublic Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest request, AsyncHandler<CreateDatasetRequest,CreateDatasetResult> asyncHandler)
AmazonPersonalizeAsyncCreates 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 AmazonPersonalizeAsyncasyncHandler - 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 AmazonPersonalizeAsyncpublic 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
To train a model (create a solution), a dataset group that contains an Interactions dataset is
required. Call CreateDataset to add a dataset to the group.
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 AmazonPersonalizeAsyncpublic Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest request, AsyncHandler<CreateDatasetGroupRequest,CreateDatasetGroupResult> asyncHandler)
AmazonPersonalizeAsyncCreates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
To train a model (create a solution), a dataset group that contains an Interactions dataset is
required. Call CreateDataset to add a dataset to the group.
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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates 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 AmazonPersonalizeAsyncpublic Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest request, AsyncHandler<CreateDatasetImportJobRequest,CreateDatasetImportJobResult> asyncHandler)
AmazonPersonalizeAsyncCreates 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.
The dataset import job replaces any existing data in the dataset that you imported in bulk.
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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates 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 AmazonPersonalizeAsyncpublic Future<CreateEventTrackerResult> createEventTrackerAsync(CreateEventTrackerRequest request, AsyncHandler<CreateEventTrackerRequest,CreateEventTrackerResult> asyncHandler)
AmazonPersonalizeAsyncCreates 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates a recommendation filter. For more information, see filter.
createFilterAsync in interface AmazonPersonalizeAsyncpublic Future<CreateFilterResult> createFilterAsync(CreateFilterRequest request, AsyncHandler<CreateFilterRequest,CreateFilterResult> asyncHandler)
AmazonPersonalizeAsyncCreates a recommendation filter. For more information, see filter.
createFilterAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncCreates 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. You specify a schema when you call CreateDataset.
Related APIs
createSchemaAsync in interface AmazonPersonalizeAsyncpublic Future<CreateSchemaResult> createSchemaAsync(CreateSchemaRequest request, AsyncHandler<CreateSchemaRequest,CreateSchemaResult> asyncHandler)
AmazonPersonalizeAsyncCreates 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. You specify a schema when you call CreateDataset.
Related APIs
createSchemaAsync in interface AmazonPersonalizeAsyncasyncHandler - 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 AmazonPersonalizeAsyncpublic 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 AmazonPersonalizeAsyncasyncHandler - 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. 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 AmazonPersonalizeAsyncpublic Future<CreateSolutionVersionResult> createSolutionVersionAsync(CreateSolutionVersionRequest request, AsyncHandler<CreateSolutionVersionRequest,CreateSolutionVersionResult> asyncHandler)
AmazonPersonalizeAsync
Trains or retrains an active solution. 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncRemoves 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 more information on campaigns, see CreateCampaign.
deleteCampaignAsync in interface AmazonPersonalizeAsyncpublic Future<DeleteCampaignResult> deleteCampaignAsync(DeleteCampaignRequest request, AsyncHandler<DeleteCampaignRequest,DeleteCampaignResult> asyncHandler)
AmazonPersonalizeAsyncRemoves 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 more information on campaigns, see CreateCampaign.
deleteCampaignAsync in interface AmazonPersonalizeAsyncasyncHandler - 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 AmazonPersonalizeAsyncpublic 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDeletes 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 AmazonPersonalizeAsyncpublic Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest request, AsyncHandler<DeleteDatasetGroupRequest,DeleteDatasetGroupResult> asyncHandler)
AmazonPersonalizeAsyncDeletes 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDeletes 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 AmazonPersonalizeAsyncpublic Future<DeleteEventTrackerResult> deleteEventTrackerAsync(DeleteEventTrackerRequest request, AsyncHandler<DeleteEventTrackerRequest,DeleteEventTrackerResult> asyncHandler)
AmazonPersonalizeAsyncDeletes 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDeletes a filter.
deleteFilterAsync in interface AmazonPersonalizeAsyncpublic Future<DeleteFilterResult> deleteFilterAsync(DeleteFilterRequest request, AsyncHandler<DeleteFilterRequest,DeleteFilterResult> asyncHandler)
AmazonPersonalizeAsyncDeletes a filter.
deleteFilterAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDeletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSchemaAsync in interface AmazonPersonalizeAsyncpublic Future<DeleteSchemaResult> deleteSchemaAsync(DeleteSchemaRequest request, AsyncHandler<DeleteSchemaRequest,DeleteSchemaResult> asyncHandler)
AmazonPersonalizeAsyncDeletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSchemaAsync in interface AmazonPersonalizeAsyncasyncHandler - 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 AmazonPersonalizeAsyncpublic 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes the given algorithm.
describeAlgorithmAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeAlgorithmResult> describeAlgorithmAsync(DescribeAlgorithmRequest request, AsyncHandler<DescribeAlgorithmRequest,DescribeAlgorithmResult> asyncHandler)
AmazonPersonalizeAsyncDescribes the given algorithm.
describeAlgorithmAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncGets 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 AmazonPersonalizeAsyncpublic Future<DescribeBatchInferenceJobResult> describeBatchInferenceJobAsync(DescribeBatchInferenceJobRequest request, AsyncHandler<DescribeBatchInferenceJobRequest,DescribeBatchInferenceJobResult> asyncHandler)
AmazonPersonalizeAsyncGets 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes 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 AmazonPersonalizeAsyncpublic Future<DescribeCampaignResult> describeCampaignAsync(DescribeCampaignRequest request, AsyncHandler<DescribeCampaignRequest,DescribeCampaignResult> asyncHandler)
AmazonPersonalizeAsyncDescribes 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
AmazonPersonalizeAsyncDescribes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes the dataset export job created by CreateDatasetExportJob, including the export job status.
describeDatasetExportJobAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeDatasetExportJobResult> describeDatasetExportJobAsync(DescribeDatasetExportJobRequest request, AsyncHandler<DescribeDatasetExportJobRequest,DescribeDatasetExportJobResult> asyncHandler)
AmazonPersonalizeAsyncDescribes the dataset export job created by CreateDatasetExportJob, including the export job status.
describeDatasetExportJobAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest request, AsyncHandler<DescribeDatasetGroupRequest,DescribeDatasetGroupResult> asyncHandler)
AmazonPersonalizeAsyncDescribes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest request, AsyncHandler<DescribeDatasetImportJobRequest,DescribeDatasetImportJobResult> asyncHandler)
AmazonPersonalizeAsyncDescribes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobAsync in interface AmazonPersonalizeAsyncasyncHandler - 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 AmazonPersonalizeAsyncpublic 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes the given feature transformation.
describeFeatureTransformationAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeFeatureTransformationResult> describeFeatureTransformationAsync(DescribeFeatureTransformationRequest request, AsyncHandler<DescribeFeatureTransformationRequest,DescribeFeatureTransformationResult> asyncHandler)
AmazonPersonalizeAsyncDescribes the given feature transformation.
describeFeatureTransformationAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes a filter's properties.
describeFilterAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeFilterResult> describeFilterAsync(DescribeFilterRequest request, AsyncHandler<DescribeFilterRequest,DescribeFilterResult> asyncHandler)
AmazonPersonalizeAsyncDescribes a filter's properties.
describeFilterAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes 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 AmazonPersonalizeAsyncpublic Future<DescribeRecipeResult> describeRecipeAsync(DescribeRecipeRequest request, AsyncHandler<DescribeRecipeRequest,DescribeRecipeResult> asyncHandler)
AmazonPersonalizeAsyncDescribes 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes a schema. For more information on schemas, see CreateSchema.
describeSchemaAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeSchemaResult> describeSchemaAsync(DescribeSchemaRequest request, AsyncHandler<DescribeSchemaRequest,DescribeSchemaResult> asyncHandler)
AmazonPersonalizeAsyncDescribes a schema. For more information on schemas, see CreateSchema.
describeSchemaAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes a solution. For more information on solutions, see CreateSolution.
describeSolutionAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeSolutionResult> describeSolutionAsync(DescribeSolutionRequest request, AsyncHandler<DescribeSolutionRequest,DescribeSolutionResult> asyncHandler)
AmazonPersonalizeAsyncDescribes a solution. For more information on solutions, see CreateSolution.
describeSolutionAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncDescribes a specific version of a solution. For more information on solutions, see CreateSolution.
describeSolutionVersionAsync in interface AmazonPersonalizeAsyncpublic Future<DescribeSolutionVersionResult> describeSolutionVersionAsync(DescribeSolutionVersionRequest request, AsyncHandler<DescribeSolutionVersionRequest,DescribeSolutionVersionResult> asyncHandler)
AmazonPersonalizeAsyncDescribes a specific version of a solution. For more information on solutions, see CreateSolution.
describeSolutionVersionAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncGets the metrics for the specified solution version.
getSolutionMetricsAsync in interface AmazonPersonalizeAsyncpublic Future<GetSolutionMetricsResult> getSolutionMetricsAsync(GetSolutionMetricsRequest request, AsyncHandler<GetSolutionMetricsRequest,GetSolutionMetricsResult> asyncHandler)
AmazonPersonalizeAsyncGets the metrics for the specified solution version.
getSolutionMetricsAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncGets a list of the batch inference jobs that have been performed off of a solution version.
listBatchInferenceJobsAsync in interface AmazonPersonalizeAsyncpublic Future<ListBatchInferenceJobsResult> listBatchInferenceJobsAsync(ListBatchInferenceJobsRequest request, AsyncHandler<ListBatchInferenceJobsRequest,ListBatchInferenceJobsResult> asyncHandler)
AmazonPersonalizeAsyncGets a list of the batch inference jobs that have been performed off of a solution version.
listBatchInferenceJobsAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListCampaignsResult> listCampaignsAsync(ListCampaignsRequest request, AsyncHandler<ListCampaignsRequest,ListCampaignsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListDatasetExportJobsResult> listDatasetExportJobsAsync(ListDatasetExportJobsRequest request, AsyncHandler<ListDatasetExportJobsRequest,ListDatasetExportJobsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest request, AsyncHandler<ListDatasetGroupsRequest,ListDatasetGroupsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest request, AsyncHandler<ListDatasetImportJobsRequest,ListDatasetImportJobsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListEventTrackersResult> listEventTrackersAsync(ListEventTrackersRequest request, AsyncHandler<ListEventTrackersRequest,ListEventTrackersResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncLists all filters that belong to a given dataset group.
listFiltersAsync in interface AmazonPersonalizeAsyncpublic Future<ListFiltersResult> listFiltersAsync(ListFiltersRequest request, AsyncHandler<ListFiltersRequest,ListFiltersResult> asyncHandler)
AmazonPersonalizeAsyncLists all filters that belong to a given dataset group.
listFiltersAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listRecipesAsync in interface AmazonPersonalizeAsyncpublic Future<ListRecipesResult> listRecipesAsync(ListRecipesRequest request, AsyncHandler<ListRecipesRequest,ListRecipesResult> asyncHandler)
AmazonPersonalizeAsyncReturns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listRecipesAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request, AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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). For more information on solutions, see CreateSolution.
listSolutionVersionsAsync in interface AmazonPersonalizeAsyncpublic Future<ListSolutionVersionsResult> listSolutionVersionsAsync(ListSolutionVersionsRequest request, AsyncHandler<ListSolutionVersionsRequest,ListSolutionVersionsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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). For more information on solutions, see CreateSolution.
listSolutionVersionsAsync in interface AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncpublic Future<ListSolutionsResult> listSolutionsAsync(ListSolutionsRequest request, AsyncHandler<ListSolutionsRequest,ListSolutionsResult> asyncHandler)
AmazonPersonalizeAsyncReturns 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 AmazonPersonalizeAsyncasyncHandler - 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)
AmazonPersonalizeAsyncStops 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 AmazonPersonalizeAsyncpublic Future<StopSolutionVersionCreationResult> stopSolutionVersionCreationAsync(StopSolutionVersionCreationRequest request, AsyncHandler<StopSolutionVersionCreationRequest,StopSolutionVersionCreationResult> asyncHandler)
AmazonPersonalizeAsyncStops 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 AmazonPersonalizeAsyncasyncHandler - 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 API.
You must wait until the status of the updated campaign is ACTIVE before asking the
campaign for recommendations.
For more information on campaigns, see CreateCampaign.
updateCampaignAsync in interface AmazonPersonalizeAsyncpublic 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 API.
You must wait until the status of the updated campaign is ACTIVE before asking the
campaign for recommendations.
For more information on campaigns, see CreateCampaign.
updateCampaignAsync in interface AmazonPersonalizeAsyncasyncHandler - 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.