Package software.amazon.awssdk.services.personalize

Interface PersonalizeAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface PersonalizeAsyncClient
extends AwsClient

Service client for accessing Amazon Personalize asynchronously. This can be created using the static builder() method.

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static PersonalizeAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a PersonalizeAsyncClient.
static PersonalizeAsyncClient	create()	Create a PersonalizeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateBatchInferenceJobResponse>	createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)	Creates a batch inference job.
default CompletableFuture<CreateBatchInferenceJobResponse>	createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)	Creates a batch inference job.
default CompletableFuture<CreateBatchSegmentJobResponse>	createBatchSegmentJob(Consumer<CreateBatchSegmentJobRequest.Builder> createBatchSegmentJobRequest)	Creates a batch segment job.
default CompletableFuture<CreateBatchSegmentJobResponse>	createBatchSegmentJob(CreateBatchSegmentJobRequest createBatchSegmentJobRequest)	Creates a batch segment job.
default CompletableFuture<CreateCampaignResponse>	createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)	Creates a campaign that deploys a solution version.
default CompletableFuture<CreateCampaignResponse>	createCampaign(CreateCampaignRequest createCampaignRequest)	Creates a campaign that deploys a solution version.
default CompletableFuture<CreateDatasetResponse>	createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)	Creates an empty dataset and adds it to the specified dataset group.
default CompletableFuture<CreateDatasetResponse>	createDataset(CreateDatasetRequest createDatasetRequest)	Creates an empty dataset and adds it to the specified dataset group.
default CompletableFuture<CreateDatasetExportJobResponse>	createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest)	Creates a job that exports data from your dataset to an Amazon S3 bucket.
default CompletableFuture<CreateDatasetExportJobResponse>	createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)	Creates a job that exports data from your dataset to an Amazon S3 bucket.
default CompletableFuture<CreateDatasetGroupResponse>	createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)	Creates an empty dataset group.
default CompletableFuture<CreateDatasetGroupResponse>	createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)	Creates an empty dataset group.
default CompletableFuture<CreateDatasetImportJobResponse>	createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest)	Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.
default CompletableFuture<CreateDatasetImportJobResponse>	createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)	Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.
default CompletableFuture<CreateEventTrackerResponse>	createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest)	Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
default CompletableFuture<CreateEventTrackerResponse>	createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)	Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
default CompletableFuture<CreateFilterResponse>	createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest)	Creates a recommendation filter.
default CompletableFuture<CreateFilterResponse>	createFilter(CreateFilterRequest createFilterRequest)	Creates a recommendation filter.
default CompletableFuture<CreateMetricAttributionResponse>	createMetricAttribution(Consumer<CreateMetricAttributionRequest.Builder> createMetricAttributionRequest)	Creates a metric attribution.
default CompletableFuture<CreateMetricAttributionResponse>	createMetricAttribution(CreateMetricAttributionRequest createMetricAttributionRequest)	Creates a metric attribution.
default CompletableFuture<CreateRecommenderResponse>	createRecommender(Consumer<CreateRecommenderRequest.Builder> createRecommenderRequest)	Creates a recommender with the recipe (a Domain dataset group use case) you specify.
default CompletableFuture<CreateRecommenderResponse>	createRecommender(CreateRecommenderRequest createRecommenderRequest)	Creates a recommender with the recipe (a Domain dataset group use case) you specify.
default CompletableFuture<CreateSchemaResponse>	createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)	Creates an Amazon Personalize schema from the specified schema string.
default CompletableFuture<CreateSchemaResponse>	createSchema(CreateSchemaRequest createSchemaRequest)	Creates an Amazon Personalize schema from the specified schema string.
default CompletableFuture<CreateSolutionResponse>	createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest)	Creates the configuration for training a model.
default CompletableFuture<CreateSolutionResponse>	createSolution(CreateSolutionRequest createSolutionRequest)	Creates the configuration for training a model.
default CompletableFuture<CreateSolutionVersionResponse>	createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest)	Trains or retrains an active solution in a Custom dataset group.
default CompletableFuture<CreateSolutionVersionResponse>	createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)	Trains or retrains an active solution in a Custom dataset group.
default CompletableFuture<DeleteCampaignResponse>	deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)	Removes a campaign by deleting the solution deployment.
default CompletableFuture<DeleteCampaignResponse>	deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)	Removes a campaign by deleting the solution deployment.
default CompletableFuture<DeleteDatasetResponse>	deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)	Deletes a dataset.
default CompletableFuture<DeleteDatasetResponse>	deleteDataset(DeleteDatasetRequest deleteDatasetRequest)	Deletes a dataset.
default CompletableFuture<DeleteDatasetGroupResponse>	deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)	Deletes a dataset group.
default CompletableFuture<DeleteDatasetGroupResponse>	deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)	Deletes a dataset group.
default CompletableFuture<DeleteEventTrackerResponse>	deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest)	Deletes the event tracker.
default CompletableFuture<DeleteEventTrackerResponse>	deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)	Deletes the event tracker.
default CompletableFuture<DeleteFilterResponse>	deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest)	Deletes a filter.
default CompletableFuture<DeleteFilterResponse>	deleteFilter(DeleteFilterRequest deleteFilterRequest)	Deletes a filter.
default CompletableFuture<DeleteMetricAttributionResponse>	deleteMetricAttribution(Consumer<DeleteMetricAttributionRequest.Builder> deleteMetricAttributionRequest)	Deletes a metric attribution.
default CompletableFuture<DeleteMetricAttributionResponse>	deleteMetricAttribution(DeleteMetricAttributionRequest deleteMetricAttributionRequest)	Deletes a metric attribution.
default CompletableFuture<DeleteRecommenderResponse>	deleteRecommender(Consumer<DeleteRecommenderRequest.Builder> deleteRecommenderRequest)	Deactivates and removes a recommender.
default CompletableFuture<DeleteRecommenderResponse>	deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest)	Deactivates and removes a recommender.
default CompletableFuture<DeleteSchemaResponse>	deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)	Deletes a schema.
default CompletableFuture<DeleteSchemaResponse>	deleteSchema(DeleteSchemaRequest deleteSchemaRequest)	Deletes a schema.
default CompletableFuture<DeleteSolutionResponse>	deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest)	Deletes all versions of a solution and the Solution object itself.
default CompletableFuture<DeleteSolutionResponse>	deleteSolution(DeleteSolutionRequest deleteSolutionRequest)	Deletes all versions of a solution and the Solution object itself.
default CompletableFuture<DescribeAlgorithmResponse>	describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)	Describes the given algorithm.
default CompletableFuture<DescribeAlgorithmResponse>	describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)	Describes the given algorithm.
default CompletableFuture<DescribeBatchInferenceJobResponse>	describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest)	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.
default CompletableFuture<DescribeBatchInferenceJobResponse>	describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)	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.
default CompletableFuture<DescribeBatchSegmentJobResponse>	describeBatchSegmentJob(Consumer<DescribeBatchSegmentJobRequest.Builder> describeBatchSegmentJobRequest)	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.
default CompletableFuture<DescribeBatchSegmentJobResponse>	describeBatchSegmentJob(DescribeBatchSegmentJobRequest describeBatchSegmentJobRequest)	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.
default CompletableFuture<DescribeCampaignResponse>	describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)	Describes the given campaign, including its status.
default CompletableFuture<DescribeCampaignResponse>	describeCampaign(DescribeCampaignRequest describeCampaignRequest)	Describes the given campaign, including its status.
default CompletableFuture<DescribeDatasetResponse>	describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)	Describes the given dataset.
default CompletableFuture<DescribeDatasetResponse>	describeDataset(DescribeDatasetRequest describeDatasetRequest)	Describes the given dataset.
default CompletableFuture<DescribeDatasetExportJobResponse>	describeDatasetExportJob(Consumer<DescribeDatasetExportJobRequest.Builder> describeDatasetExportJobRequest)	Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
default CompletableFuture<DescribeDatasetExportJobResponse>	describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)	Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
default CompletableFuture<DescribeDatasetGroupResponse>	describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)	Describes the given dataset group.
default CompletableFuture<DescribeDatasetGroupResponse>	describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)	Describes the given dataset group.
default CompletableFuture<DescribeDatasetImportJobResponse>	describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)	Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
default CompletableFuture<DescribeDatasetImportJobResponse>	describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)	Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
default CompletableFuture<DescribeEventTrackerResponse>	describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)	Describes an event tracker.
default CompletableFuture<DescribeEventTrackerResponse>	describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)	Describes an event tracker.
default CompletableFuture<DescribeFeatureTransformationResponse>	describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)	Describes the given feature transformation.
default CompletableFuture<DescribeFeatureTransformationResponse>	describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)	Describes the given feature transformation.
default CompletableFuture<DescribeFilterResponse>	describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)	Describes a filter's properties.
default CompletableFuture<DescribeFilterResponse>	describeFilter(DescribeFilterRequest describeFilterRequest)	Describes a filter's properties.
default CompletableFuture<DescribeMetricAttributionResponse>	describeMetricAttribution(Consumer<DescribeMetricAttributionRequest.Builder> describeMetricAttributionRequest)	Describes a metric attribution.
default CompletableFuture<DescribeMetricAttributionResponse>	describeMetricAttribution(DescribeMetricAttributionRequest describeMetricAttributionRequest)	Describes a metric attribution.
default CompletableFuture<DescribeRecipeResponse>	describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)	Describes a recipe.
default CompletableFuture<DescribeRecipeResponse>	describeRecipe(DescribeRecipeRequest describeRecipeRequest)	Describes a recipe.
default CompletableFuture<DescribeRecommenderResponse>	describeRecommender(Consumer<DescribeRecommenderRequest.Builder> describeRecommenderRequest)	Describes the given recommender, including its status.
default CompletableFuture<DescribeRecommenderResponse>	describeRecommender(DescribeRecommenderRequest describeRecommenderRequest)	Describes the given recommender, including its status.
default CompletableFuture<DescribeSchemaResponse>	describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)	Describes a schema.
default CompletableFuture<DescribeSchemaResponse>	describeSchema(DescribeSchemaRequest describeSchemaRequest)	Describes a schema.
default CompletableFuture<DescribeSolutionResponse>	describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)	Describes a solution.
default CompletableFuture<DescribeSolutionResponse>	describeSolution(DescribeSolutionRequest describeSolutionRequest)	Describes a solution.
default CompletableFuture<DescribeSolutionVersionResponse>	describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)	Describes a specific version of a solution.
default CompletableFuture<DescribeSolutionVersionResponse>	describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)	Describes a specific version of a solution.
default CompletableFuture<GetSolutionMetricsResponse>	getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)	Gets the metrics for the specified solution version.
default CompletableFuture<GetSolutionMetricsResponse>	getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)	Gets the metrics for the specified solution version.
default CompletableFuture<ListBatchInferenceJobsResponse>	listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)	Gets a list of the batch inference jobs that have been performed off of a solution version.
default CompletableFuture<ListBatchInferenceJobsResponse>	listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)	Gets a list of the batch inference jobs that have been performed off of a solution version.
default ListBatchInferenceJobsPublisher	listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)	Gets a list of the batch inference jobs that have been performed off of a solution version.
default ListBatchInferenceJobsPublisher	listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)	Gets a list of the batch inference jobs that have been performed off of a solution version.
default CompletableFuture<ListBatchSegmentJobsResponse>	listBatchSegmentJobs(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest)	Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
default CompletableFuture<ListBatchSegmentJobsResponse>	listBatchSegmentJobs(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest)	Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
default ListBatchSegmentJobsPublisher	listBatchSegmentJobsPaginator(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest)	Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
default ListBatchSegmentJobsPublisher	listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest)	Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
default CompletableFuture<ListCampaignsResponse>	listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)	Returns a list of campaigns that use the given solution.
default CompletableFuture<ListCampaignsResponse>	listCampaigns(ListCampaignsRequest listCampaignsRequest)	Returns a list of campaigns that use the given solution.
default ListCampaignsPublisher	listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)	Returns a list of campaigns that use the given solution.
default ListCampaignsPublisher	listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)	Returns a list of campaigns that use the given solution.
default CompletableFuture<ListDatasetExportJobsResponse>	listDatasetExportJobs(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)	Returns a list of dataset export jobs that use the given dataset.
default CompletableFuture<ListDatasetExportJobsResponse>	listDatasetExportJobs(ListDatasetExportJobsRequest listDatasetExportJobsRequest)	Returns a list of dataset export jobs that use the given dataset.
default ListDatasetExportJobsPublisher	listDatasetExportJobsPaginator(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)	Returns a list of dataset export jobs that use the given dataset.
default ListDatasetExportJobsPublisher	listDatasetExportJobsPaginator(ListDatasetExportJobsRequest listDatasetExportJobsRequest)	Returns a list of dataset export jobs that use the given dataset.
default CompletableFuture<ListDatasetGroupsResponse>	listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)	Returns a list of dataset groups.
default CompletableFuture<ListDatasetGroupsResponse>	listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)	Returns a list of dataset groups.
default ListDatasetGroupsPublisher	listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)	Returns a list of dataset groups.
default ListDatasetGroupsPublisher	listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)	Returns a list of dataset groups.
default CompletableFuture<ListDatasetImportJobsResponse>	listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)	Returns a list of dataset import jobs that use the given dataset.
default CompletableFuture<ListDatasetImportJobsResponse>	listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)	Returns a list of dataset import jobs that use the given dataset.
default ListDatasetImportJobsPublisher	listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)	Returns a list of dataset import jobs that use the given dataset.
default ListDatasetImportJobsPublisher	listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)	Returns a list of dataset import jobs that use the given dataset.
default CompletableFuture<ListDatasetsResponse>	listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)	Returns the list of datasets contained in the given dataset group.
default CompletableFuture<ListDatasetsResponse>	listDatasets(ListDatasetsRequest listDatasetsRequest)	Returns the list of datasets contained in the given dataset group.
default ListDatasetsPublisher	listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)	Returns the list of datasets contained in the given dataset group.
default ListDatasetsPublisher	listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)	Returns the list of datasets contained in the given dataset group.
default CompletableFuture<ListEventTrackersResponse>	listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)	Returns the list of event trackers associated with the account.
default CompletableFuture<ListEventTrackersResponse>	listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)	Returns the list of event trackers associated with the account.
default ListEventTrackersPublisher	listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)	Returns the list of event trackers associated with the account.
default ListEventTrackersPublisher	listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)	Returns the list of event trackers associated with the account.
default CompletableFuture<ListFiltersResponse>	listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest)	Lists all filters that belong to a given dataset group.
default CompletableFuture<ListFiltersResponse>	listFilters(ListFiltersRequest listFiltersRequest)	Lists all filters that belong to a given dataset group.
default ListFiltersPublisher	listFiltersPaginator(Consumer<ListFiltersRequest.Builder> listFiltersRequest)	Lists all filters that belong to a given dataset group.
default ListFiltersPublisher	listFiltersPaginator(ListFiltersRequest listFiltersRequest)	Lists all filters that belong to a given dataset group.
default CompletableFuture<ListMetricAttributionMetricsResponse>	listMetricAttributionMetrics(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)	Lists the metrics for the metric attribution.
default CompletableFuture<ListMetricAttributionMetricsResponse>	listMetricAttributionMetrics(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)	Lists the metrics for the metric attribution.
default ListMetricAttributionMetricsPublisher	listMetricAttributionMetricsPaginator(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)	Lists the metrics for the metric attribution.
default ListMetricAttributionMetricsPublisher	listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)	Lists the metrics for the metric attribution.
default CompletableFuture<ListMetricAttributionsResponse>	listMetricAttributions(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest)	Lists metric attributions.
default CompletableFuture<ListMetricAttributionsResponse>	listMetricAttributions(ListMetricAttributionsRequest listMetricAttributionsRequest)	Lists metric attributions.
default ListMetricAttributionsPublisher	listMetricAttributionsPaginator(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest)	Lists metric attributions.
default ListMetricAttributionsPublisher	listMetricAttributionsPaginator(ListMetricAttributionsRequest listMetricAttributionsRequest)	Lists metric attributions.
default CompletableFuture<ListRecipesResponse>	listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest)	Returns a list of available recipes.
default CompletableFuture<ListRecipesResponse>	listRecipes(ListRecipesRequest listRecipesRequest)	Returns a list of available recipes.
default ListRecipesPublisher	listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest)	Returns a list of available recipes.
default ListRecipesPublisher	listRecipesPaginator(ListRecipesRequest listRecipesRequest)	Returns a list of available recipes.
default CompletableFuture<ListRecommendersResponse>	listRecommenders(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)	Returns a list of recommenders in a given Domain dataset group.
default CompletableFuture<ListRecommendersResponse>	listRecommenders(ListRecommendersRequest listRecommendersRequest)	Returns a list of recommenders in a given Domain dataset group.
default ListRecommendersPublisher	listRecommendersPaginator(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)	Returns a list of recommenders in a given Domain dataset group.
default ListRecommendersPublisher	listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest)	Returns a list of recommenders in a given Domain dataset group.
default CompletableFuture<ListSchemasResponse>	listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest)	Returns the list of schemas associated with the account.
default CompletableFuture<ListSchemasResponse>	listSchemas(ListSchemasRequest listSchemasRequest)	Returns the list of schemas associated with the account.
default ListSchemasPublisher	listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest)	Returns the list of schemas associated with the account.
default ListSchemasPublisher	listSchemasPaginator(ListSchemasRequest listSchemasRequest)	Returns the list of schemas associated with the account.
default CompletableFuture<ListSolutionsResponse>	listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)	Returns a list of solutions that use the given dataset group.
default CompletableFuture<ListSolutionsResponse>	listSolutions(ListSolutionsRequest listSolutionsRequest)	Returns a list of solutions that use the given dataset group.
default ListSolutionsPublisher	listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)	Returns a list of solutions that use the given dataset group.
default ListSolutionsPublisher	listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)	Returns a list of solutions that use the given dataset group.
default CompletableFuture<ListSolutionVersionsResponse>	listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)	Returns a list of solution versions for the given solution.
default CompletableFuture<ListSolutionVersionsResponse>	listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)	Returns a list of solution versions for the given solution.
default ListSolutionVersionsPublisher	listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)	Returns a list of solution versions for the given solution.
default ListSolutionVersionsPublisher	listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)	Returns a list of solution versions for the given solution.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Get a list of tags attached to a resource.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Get a list of tags attached to a resource.
default PersonalizeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
default CompletableFuture<StartRecommenderResponse>	startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest)	Starts a recommender that is INACTIVE.
default CompletableFuture<StartRecommenderResponse>	startRecommender(StartRecommenderRequest startRecommenderRequest)	Starts a recommender that is INACTIVE.
default CompletableFuture<StopRecommenderResponse>	stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest)	Stops a recommender that is ACTIVE.
default CompletableFuture<StopRecommenderResponse>	stopRecommender(StopRecommenderRequest stopRecommenderRequest)	Stops a recommender that is ACTIVE.
default CompletableFuture<StopSolutionVersionCreationResponse>	stopSolutionVersionCreation(Consumer<StopSolutionVersionCreationRequest.Builder> stopSolutionVersionCreationRequest)	Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
default CompletableFuture<StopSolutionVersionCreationResponse>	stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest)	Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
default CompletableFuture<TagResourceResponse>	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Add a list of tags to a resource.
default CompletableFuture<TagResourceResponse>	tagResource(TagResourceRequest tagResourceRequest)	Add a list of tags to a resource.
default CompletableFuture<UntagResourceResponse>	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Remove tags that are attached to a resource.
default CompletableFuture<UntagResourceResponse>	untagResource(UntagResourceRequest untagResourceRequest)	Remove tags that are attached to a resource.
default CompletableFuture<UpdateCampaignResponse>	updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)	Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
default CompletableFuture<UpdateCampaignResponse>	updateCampaign(UpdateCampaignRequest updateCampaignRequest)	Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
default CompletableFuture<UpdateDatasetResponse>	updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)	Update a dataset to replace its schema with a new or existing one.
default CompletableFuture<UpdateDatasetResponse>	updateDataset(UpdateDatasetRequest updateDatasetRequest)	Update a dataset to replace its schema with a new or existing one.
default CompletableFuture<UpdateMetricAttributionResponse>	updateMetricAttribution(Consumer<UpdateMetricAttributionRequest.Builder> updateMetricAttributionRequest)	Updates a metric attribution.
default CompletableFuture<UpdateMetricAttributionResponse>	updateMetricAttribution(UpdateMetricAttributionRequest updateMetricAttributionRequest)	Updates a metric attribution.
default CompletableFuture<UpdateRecommenderResponse>	updateRecommender(Consumer<UpdateRecommenderRequest.Builder> updateRecommenderRequest)	Updates the recommender to modify the recommender configuration.
default CompletableFuture<UpdateRecommenderResponse>	updateRecommender(UpdateRecommenderRequest updateRecommenderRequest)	Updates the recommender to modify the recommender configuration.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createBatchInferenceJob

default CompletableFuture<CreateBatchInferenceJobResponse> createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)

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.

Parameters:

createBatchInferenceJobRequest -

Returns:

A Java Future containing the result of the CreateBatchInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceNotFoundException Could not find the specified resource.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createBatchInferenceJob

default CompletableFuture<CreateBatchInferenceJobResponse> createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)

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.

This is a convenience which creates an instance of the CreateBatchInferenceJobRequest.Builder avoiding the need to create one manually via CreateBatchInferenceJobRequest.builder()

Parameters:

createBatchInferenceJobRequest - A Consumer that will call methods on CreateBatchInferenceJobRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateBatchInferenceJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceNotFoundException Could not find the specified resource.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createBatchSegmentJob

default CompletableFuture<CreateBatchSegmentJobResponse> createBatchSegmentJob(CreateBatchSegmentJobRequest createBatchSegmentJobRequest)

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.

Parameters:

createBatchSegmentJobRequest -

Returns:

A Java Future containing the result of the CreateBatchSegmentJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceNotFoundException Could not find the specified resource.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createBatchSegmentJob

default CompletableFuture<CreateBatchSegmentJobResponse> createBatchSegmentJob(Consumer<CreateBatchSegmentJobRequest.Builder> createBatchSegmentJobRequest)

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.

This is a convenience which creates an instance of the CreateBatchSegmentJobRequest.Builder avoiding the need to create one manually via CreateBatchSegmentJobRequest.builder()

Parameters:

createBatchSegmentJobRequest - A Consumer that will call methods on CreateBatchSegmentJobRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateBatchSegmentJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceNotFoundException Could not find the specified resource.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createCampaign

default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest)

Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

• ListCampaigns

• DescribeCampaign

• UpdateCampaign

• DeleteCampaign

Parameters:

createCampaignRequest -

Returns:

A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException Could not find the specified resource.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createCampaign

default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)

Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

• ListCampaigns

• DescribeCampaign

• UpdateCampaign

• DeleteCampaign

This is a convenience which creates an instance of the CreateCampaignRequest.Builder avoiding the need to create one manually via CreateCampaignRequest.builder()

Parameters:

createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException Could not find the specified resource.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDataset

default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest)

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

• CreateDatasetGroup

• ListDatasets

• DescribeDataset

• DeleteDataset

Parameters:

createDatasetRequest -

Returns:

A Java Future containing the result of the CreateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException Could not find the specified resource.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDataset

default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)

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

• CreateDatasetGroup

• ListDatasets

• DescribeDataset

• DeleteDataset

This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to create one manually via CreateDatasetRequest.builder()

Parameters:

createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException Could not find the specified resource.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDatasetExportJob

default CompletableFuture<CreateDatasetExportJobResponse> createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)

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.

Parameters:

createDatasetExportJobRequest -

Returns:

A Java Future containing the result of the CreateDatasetExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException Could not find the specified resource.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDatasetExportJob

default CompletableFuture<CreateDatasetExportJobResponse> createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest)

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.

This is a convenience which creates an instance of the CreateDatasetExportJobRequest.Builder avoiding the need to create one manually via CreateDatasetExportJobRequest.builder()

Parameters:

createDatasetExportJobRequest - A Consumer that will call methods on CreateDatasetExportJobRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateDatasetExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceNotFoundException Could not find the specified resource.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• ResourceInUseException The specified resource is in use.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDatasetGroup

default CompletableFuture<CreateDatasetGroupResponse> createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)

Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:

• Interactions

• Items

• Users

A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.

A dataset group can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

• CreateDataset

• CreateEventTracker

• CreateSolution

Related APIs

• ListDatasetGroups

• DescribeDatasetGroup

• DeleteDatasetGroup

Parameters:

createDatasetGroupRequest -

Returns:

A Java Future containing the result of the CreateDatasetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDatasetGroup

default CompletableFuture<CreateDatasetGroupResponse> createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)

Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:

• Interactions

• Items

• Users

A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.

A dataset group can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

• DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

• CreateDataset

• CreateEventTracker

• CreateSolution

Related APIs

• ListDatasetGroups

• DescribeDatasetGroup

• DeleteDatasetGroup

This is a convenience which creates an instance of the CreateDatasetGroupRequest.Builder avoiding the need to create one manually via CreateDatasetGroupRequest.builder()

Parameters:

createDatasetGroupRequest - A Consumer that will call methods on CreateDatasetGroupRequest.Builder to create a request.

Returns:

A Java Future containing the result of the CreateDatasetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidInputException Provide a valid value for the field or parameter.
• ResourceAlreadyExistsException The specified resource already exists.
• LimitExceededException The limit on the number of requests per second has been exceeded.
• TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

• AWS API Documentation

createDatasetImportJob

default CompletableFuture<CreateDatasetImportJobResponse> createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)

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

• ListDatasetImportJobs

• DescribeDatasetImportJob