Interface PersonalizeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing Amazon Personalize. 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 PersonalizeClientBuilder	builder()	Create a builder that can be used to configure and create a PersonalizeClient.
static PersonalizeClient	create()	Create a PersonalizeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBatchInferenceJobResponse	createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)	Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.
default CreateBatchInferenceJobResponse	createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)	Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.
default CreateBatchSegmentJobResponse	createBatchSegmentJob(Consumer<CreateBatchSegmentJobRequest.Builder> createBatchSegmentJobRequest)	Creates a batch segment job.
default CreateBatchSegmentJobResponse	createBatchSegmentJob(CreateBatchSegmentJobRequest createBatchSegmentJobRequest)	Creates a batch segment job.
default CreateCampaignResponse	createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
default CreateCampaignResponse	createCampaign(CreateCampaignRequest createCampaignRequest)
default CreateDataDeletionJobResponse	createDataDeletionJob(Consumer<CreateDataDeletionJobRequest.Builder> createDataDeletionJobRequest)	Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches.
default CreateDataDeletionJobResponse	createDataDeletionJob(CreateDataDeletionJobRequest createDataDeletionJobRequest)	Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches.
default CreateDatasetResponse	createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)	Creates an empty dataset and adds it to the specified dataset group.
default CreateDatasetResponse	createDataset(CreateDatasetRequest createDatasetRequest)	Creates an empty dataset and adds it to the specified dataset group.
default CreateDatasetExportJobResponse	createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest)	Creates a job that exports data from your dataset to an Amazon S3 bucket.
default CreateDatasetExportJobResponse	createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)	Creates a job that exports data from your dataset to an Amazon S3 bucket.
default CreateDatasetGroupResponse	createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)	Creates an empty dataset group.
default CreateDatasetGroupResponse	createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)	Creates an empty dataset group.
default 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 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 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 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 CreateFilterResponse	createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest)	Creates a recommendation filter.
default CreateFilterResponse	createFilter(CreateFilterRequest createFilterRequest)	Creates a recommendation filter.
default CreateMetricAttributionResponse	createMetricAttribution(Consumer<CreateMetricAttributionRequest.Builder> createMetricAttributionRequest)	Creates a metric attribution.
default CreateMetricAttributionResponse	createMetricAttribution(CreateMetricAttributionRequest createMetricAttributionRequest)	Creates a metric attribution.
default CreateRecommenderResponse	createRecommender(Consumer<CreateRecommenderRequest.Builder> createRecommenderRequest)	Creates a recommender with the recipe (a Domain dataset group use case) you specify.
default CreateRecommenderResponse	createRecommender(CreateRecommenderRequest createRecommenderRequest)	Creates a recommender with the recipe (a Domain dataset group use case) you specify.
default CreateSchemaResponse	createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)	Creates an Amazon Personalize schema from the specified schema string.
default CreateSchemaResponse	createSchema(CreateSchemaRequest createSchemaRequest)	Creates an Amazon Personalize schema from the specified schema string.
default CreateSolutionResponse	createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest)
default CreateSolutionResponse	createSolution(CreateSolutionRequest createSolutionRequest)
default CreateSolutionVersionResponse	createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest)	Trains or retrains an active solution in a Custom dataset group.
default CreateSolutionVersionResponse	createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)	Trains or retrains an active solution in a Custom dataset group.
default DeleteCampaignResponse	deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)	Removes a campaign by deleting the solution deployment.
default DeleteCampaignResponse	deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)	Removes a campaign by deleting the solution deployment.
default DeleteDatasetResponse	deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)	Deletes a dataset.
default DeleteDatasetResponse	deleteDataset(DeleteDatasetRequest deleteDatasetRequest)	Deletes a dataset.
default DeleteDatasetGroupResponse	deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)	Deletes a dataset group.
default DeleteDatasetGroupResponse	deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)	Deletes a dataset group.
default DeleteEventTrackerResponse	deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest)	Deletes the event tracker.
default DeleteEventTrackerResponse	deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)	Deletes the event tracker.
default DeleteFilterResponse	deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest)	Deletes a filter.
default DeleteFilterResponse	deleteFilter(DeleteFilterRequest deleteFilterRequest)	Deletes a filter.
default DeleteMetricAttributionResponse	deleteMetricAttribution(Consumer<DeleteMetricAttributionRequest.Builder> deleteMetricAttributionRequest)	Deletes a metric attribution.
default DeleteMetricAttributionResponse	deleteMetricAttribution(DeleteMetricAttributionRequest deleteMetricAttributionRequest)	Deletes a metric attribution.
default DeleteRecommenderResponse	deleteRecommender(Consumer<DeleteRecommenderRequest.Builder> deleteRecommenderRequest)	Deactivates and removes a recommender.
default DeleteRecommenderResponse	deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest)	Deactivates and removes a recommender.
default DeleteSchemaResponse	deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)	Deletes a schema.
default DeleteSchemaResponse	deleteSchema(DeleteSchemaRequest deleteSchemaRequest)	Deletes a schema.
default DeleteSolutionResponse	deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest)	Deletes all versions of a solution and the Solution object itself.
default DeleteSolutionResponse	deleteSolution(DeleteSolutionRequest deleteSolutionRequest)	Deletes all versions of a solution and the Solution object itself.
default DescribeAlgorithmResponse	describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)	Describes the given algorithm.
default DescribeAlgorithmResponse	describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)	Describes the given algorithm.
default 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 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 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 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 DescribeCampaignResponse	describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)	Describes the given campaign, including its status.
default DescribeCampaignResponse	describeCampaign(DescribeCampaignRequest describeCampaignRequest)	Describes the given campaign, including its status.
default DescribeDataDeletionJobResponse	describeDataDeletionJob(Consumer<DescribeDataDeletionJobRequest.Builder> describeDataDeletionJobRequest)	Describes the data deletion job created by CreateDataDeletionJob, including the job status.
default DescribeDataDeletionJobResponse	describeDataDeletionJob(DescribeDataDeletionJobRequest describeDataDeletionJobRequest)	Describes the data deletion job created by CreateDataDeletionJob, including the job status.
default DescribeDatasetResponse	describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)	Describes the given dataset.
default DescribeDatasetResponse	describeDataset(DescribeDatasetRequest describeDatasetRequest)	Describes the given dataset.
default DescribeDatasetExportJobResponse	describeDatasetExportJob(Consumer<DescribeDatasetExportJobRequest.Builder> describeDatasetExportJobRequest)	Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
default DescribeDatasetExportJobResponse	describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)	Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
default DescribeDatasetGroupResponse	describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)	Describes the given dataset group.
default DescribeDatasetGroupResponse	describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)	Describes the given dataset group.
default DescribeDatasetImportJobResponse	describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)	Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
default DescribeDatasetImportJobResponse	describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)	Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
default DescribeEventTrackerResponse	describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)	Describes an event tracker.
default DescribeEventTrackerResponse	describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)	Describes an event tracker.
default DescribeFeatureTransformationResponse	describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)	Describes the given feature transformation.
default DescribeFeatureTransformationResponse	describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)	Describes the given feature transformation.
default DescribeFilterResponse	describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)	Describes a filter's properties.
default DescribeFilterResponse	describeFilter(DescribeFilterRequest describeFilterRequest)	Describes a filter's properties.
default DescribeMetricAttributionResponse	describeMetricAttribution(Consumer<DescribeMetricAttributionRequest.Builder> describeMetricAttributionRequest)	Describes a metric attribution.
default DescribeMetricAttributionResponse	describeMetricAttribution(DescribeMetricAttributionRequest describeMetricAttributionRequest)	Describes a metric attribution.
default DescribeRecipeResponse	describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)	Describes a recipe.
default DescribeRecipeResponse	describeRecipe(DescribeRecipeRequest describeRecipeRequest)	Describes a recipe.
default DescribeRecommenderResponse	describeRecommender(Consumer<DescribeRecommenderRequest.Builder> describeRecommenderRequest)	Describes the given recommender, including its status.
default DescribeRecommenderResponse	describeRecommender(DescribeRecommenderRequest describeRecommenderRequest)	Describes the given recommender, including its status.
default DescribeSchemaResponse	describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)	Describes a schema.
default DescribeSchemaResponse	describeSchema(DescribeSchemaRequest describeSchemaRequest)	Describes a schema.
default DescribeSolutionResponse	describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)	Describes a solution.
default DescribeSolutionResponse	describeSolution(DescribeSolutionRequest describeSolutionRequest)	Describes a solution.
default DescribeSolutionVersionResponse	describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)	Describes a specific version of a solution.
default DescribeSolutionVersionResponse	describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)	Describes a specific version of a solution.
default GetSolutionMetricsResponse	getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)	Gets the metrics for the specified solution version.
default GetSolutionMetricsResponse	getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)	Gets the metrics for the specified solution version.
default ListBatchInferenceJobsResponse	listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)	Gets a list of the batch inference jobs that have been performed off of a solution version.
default ListBatchInferenceJobsResponse	listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)	Gets a list of the batch inference jobs that have been performed off of a solution version.
default ListBatchInferenceJobsIterable	listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)	This is a variant of listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest) operation.
default ListBatchInferenceJobsIterable	listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)	This is a variant of listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest) operation.
default 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 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 ListBatchSegmentJobsIterable	listBatchSegmentJobsPaginator(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest)	This is a variant of listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest) operation.
default ListBatchSegmentJobsIterable	listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest)	This is a variant of listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest) operation.
default ListCampaignsResponse	listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)	Returns a list of campaigns that use the given solution.
default ListCampaignsResponse	listCampaigns(ListCampaignsRequest listCampaignsRequest)	Returns a list of campaigns that use the given solution.
default ListCampaignsIterable	listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)	This is a variant of listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation.
default ListCampaignsIterable	listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)	This is a variant of listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation.
default ListDataDeletionJobsResponse	listDataDeletionJobs(Consumer<ListDataDeletionJobsRequest.Builder> listDataDeletionJobsRequest)	Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first.
default ListDataDeletionJobsResponse	listDataDeletionJobs(ListDataDeletionJobsRequest listDataDeletionJobsRequest)	Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first.
default ListDatasetExportJobsResponse	listDatasetExportJobs(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)	Returns a list of dataset export jobs that use the given dataset.
default ListDatasetExportJobsResponse	listDatasetExportJobs(ListDatasetExportJobsRequest listDatasetExportJobsRequest)	Returns a list of dataset export jobs that use the given dataset.
default ListDatasetExportJobsIterable	listDatasetExportJobsPaginator(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)	This is a variant of listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest) operation.
default ListDatasetExportJobsIterable	listDatasetExportJobsPaginator(ListDatasetExportJobsRequest listDatasetExportJobsRequest)	This is a variant of listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest) operation.
default ListDatasetGroupsResponse	listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)	Returns a list of dataset groups.
default ListDatasetGroupsResponse	listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)	Returns a list of dataset groups.
default ListDatasetGroupsIterable	listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)	This is a variant of listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation.
default ListDatasetGroupsIterable	listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)	This is a variant of listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation.
default ListDatasetImportJobsResponse	listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)	Returns a list of dataset import jobs that use the given dataset.
default ListDatasetImportJobsResponse	listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)	Returns a list of dataset import jobs that use the given dataset.
default ListDatasetImportJobsIterable	listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)	This is a variant of listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest) operation.
default ListDatasetImportJobsIterable	listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)	This is a variant of listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest) operation.
default ListDatasetsResponse	listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)	Returns the list of datasets contained in the given dataset group.
default ListDatasetsResponse	listDatasets(ListDatasetsRequest listDatasetsRequest)	Returns the list of datasets contained in the given dataset group.
default ListDatasetsIterable	listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)	This is a variant of listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation.
default ListDatasetsIterable	listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)	This is a variant of listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation.
default ListEventTrackersResponse	listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)	Returns the list of event trackers associated with the account.
default ListEventTrackersResponse	listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)	Returns the list of event trackers associated with the account.
default ListEventTrackersIterable	listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)	This is a variant of listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation.
default ListEventTrackersIterable	listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)	This is a variant of listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation.
default ListFiltersResponse	listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest)	Lists all filters that belong to a given dataset group.
default ListFiltersResponse	listFilters(ListFiltersRequest listFiltersRequest)	Lists all filters that belong to a given dataset group.
default ListFiltersIterable	listFiltersPaginator(Consumer<ListFiltersRequest.Builder> listFiltersRequest)	This is a variant of listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest) operation.
default ListFiltersIterable	listFiltersPaginator(ListFiltersRequest listFiltersRequest)	This is a variant of listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest) operation.
default ListMetricAttributionMetricsResponse	listMetricAttributionMetrics(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)	Lists the metrics for the metric attribution.
default ListMetricAttributionMetricsResponse	listMetricAttributionMetrics(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)	Lists the metrics for the metric attribution.
default ListMetricAttributionMetricsIterable	listMetricAttributionMetricsPaginator(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)	This is a variant of listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest) operation.
default ListMetricAttributionMetricsIterable	listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)	This is a variant of listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest) operation.
default ListMetricAttributionsResponse	listMetricAttributions(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest)	Lists metric attributions.
default ListMetricAttributionsResponse	listMetricAttributions(ListMetricAttributionsRequest listMetricAttributionsRequest)	Lists metric attributions.
default ListMetricAttributionsIterable	listMetricAttributionsPaginator(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest)	This is a variant of listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest) operation.
default ListMetricAttributionsIterable	listMetricAttributionsPaginator(ListMetricAttributionsRequest listMetricAttributionsRequest)	This is a variant of listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest) operation.
default ListRecipesResponse	listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest)	Returns a list of available recipes.
default ListRecipesResponse	listRecipes(ListRecipesRequest listRecipesRequest)	Returns a list of available recipes.
default ListRecipesIterable	listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest)	This is a variant of listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation.
default ListRecipesIterable	listRecipesPaginator(ListRecipesRequest listRecipesRequest)	This is a variant of listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation.
default ListRecommendersResponse	listRecommenders(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)	Returns a list of recommenders in a given Domain dataset group.
default ListRecommendersResponse	listRecommenders(ListRecommendersRequest listRecommendersRequest)	Returns a list of recommenders in a given Domain dataset group.
default ListRecommendersIterable	listRecommendersPaginator(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)	This is a variant of listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest) operation.
default ListRecommendersIterable	listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest)	This is a variant of listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest) operation.
default ListSchemasResponse	listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest)	Returns the list of schemas associated with the account.
default ListSchemasResponse	listSchemas(ListSchemasRequest listSchemasRequest)	Returns the list of schemas associated with the account.
default ListSchemasIterable	listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest)	This is a variant of listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation.
default ListSchemasIterable	listSchemasPaginator(ListSchemasRequest listSchemasRequest)	This is a variant of listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation.
default ListSolutionsResponse	listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)	Returns a list of solutions in a given dataset group.
default ListSolutionsResponse	listSolutions(ListSolutionsRequest listSolutionsRequest)	Returns a list of solutions in a given dataset group.
default ListSolutionsIterable	listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)	This is a variant of listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation.
default ListSolutionsIterable	listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)	This is a variant of listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation.
default ListSolutionVersionsResponse	listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)	Returns a list of solution versions for the given solution.
default ListSolutionVersionsResponse	listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)	Returns a list of solution versions for the given solution.
default ListSolutionVersionsIterable	listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)	This is a variant of listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest) operation.
default ListSolutionVersionsIterable	listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)	This is a variant of listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Get a list of tags attached to a resource.
default 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
static ServiceMetadata	serviceMetadata()
default StartRecommenderResponse	startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest)	Starts a recommender that is INACTIVE.
default StartRecommenderResponse	startRecommender(StartRecommenderRequest startRecommenderRequest)	Starts a recommender that is INACTIVE.
default StopRecommenderResponse	stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest)	Stops a recommender that is ACTIVE.
default StopRecommenderResponse	stopRecommender(StopRecommenderRequest stopRecommenderRequest)	Stops a recommender that is ACTIVE.
default StopSolutionVersionCreationResponse	stopSolutionVersionCreation(Consumer<StopSolutionVersionCreationRequest.Builder> stopSolutionVersionCreationRequest)	Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
default StopSolutionVersionCreationResponse	stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest)	Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Add a list of tags to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Add a list of tags to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tags that are attached to a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tags that are attached to a resource.
default UpdateCampaignResponse	updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)	Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration.
default UpdateCampaignResponse	updateCampaign(UpdateCampaignRequest updateCampaignRequest)	Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration.
default UpdateDatasetResponse	updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)	Update a dataset to replace its schema with a new or existing one.
default UpdateDatasetResponse	updateDataset(UpdateDatasetRequest updateDatasetRequest)	Update a dataset to replace its schema with a new or existing one.
default UpdateMetricAttributionResponse	updateMetricAttribution(Consumer<UpdateMetricAttributionRequest.Builder> updateMetricAttributionRequest)	Updates a metric attribution.
default UpdateMetricAttributionResponse	updateMetricAttribution(UpdateMetricAttributionRequest updateMetricAttributionRequest)	Updates a metric attribution.
default UpdateRecommenderResponse	updateRecommender(Consumer<UpdateRecommenderRequest.Builder> updateRecommenderRequest)	Updates the recommender to modify the recommender configuration.
default UpdateRecommenderResponse	updateRecommender(UpdateRecommenderRequest updateRecommenderRequest)	Updates the recommender to modify the recommender configuration.
default UpdateSolutionResponse	updateSolution(Consumer<UpdateSolutionRequest.Builder> updateSolutionRequest)	Updates an Amazon Personalize solution to use a different automatic training configuration.
default UpdateSolutionResponse	updateSolution(UpdateSolutionRequest updateSolutionRequest)	Updates an Amazon Personalize solution to use a different automatic training 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 CreateBatchInferenceJobResponse createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)
                                                         throws InvalidInputException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.

To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.

For more information, see Creating a batch inference job .

If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.

For more information about generating themes, see Batch recommendations with themes from Content Generator .

You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.

Parameters:

createBatchInferenceJobRequest -

Returns:

Result of the CreateBatchInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

createBatchInferenceJob

default CreateBatchInferenceJobResponse createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)
                                                         throws InvalidInputException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.

To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.

For more information, see Creating a batch inference job .

If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.

For more information about generating themes, see Batch recommendations with themes from Content Generator .

You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.

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:

Result of the CreateBatchInferenceJob operation returned by the service.

See Also:

• AWS API Documentation

createBatchSegmentJob

default CreateBatchSegmentJobResponse createBatchSegmentJob(CreateBatchSegmentJobRequest createBatchSegmentJobRequest)
                                                     throws InvalidInputException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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:

Result of the CreateBatchSegmentJob operation returned by the service.

See Also:

• AWS API Documentation

createBatchSegmentJob

default CreateBatchSegmentJobResponse createBatchSegmentJob(Consumer<CreateBatchSegmentJobRequest.Builder> createBatchSegmentJobRequest)
                                                     throws InvalidInputException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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:

Result of the CreateBatchSegmentJob operation returned by the service.

See Also:

• AWS API Documentation

createCampaign

default CreateCampaignResponse createCampaign(CreateCampaignRequest createCampaignRequest)
                                       throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

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

Minimum Provisioned TPS and Auto-Scaling

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

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second ( minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

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

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

Status

A campaign can be in one of the following states:

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

• DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

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

Related APIs

• ListCampaigns

• DescribeCampaign

• UpdateCampaign

• DeleteCampaign

Parameters:

createCampaignRequest -

Returns:

Result of the CreateCampaign operation returned by the service.

See Also:

• AWS API Documentation

createCampaign

default CreateCampaignResponse createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
                                       throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

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

Minimum Provisioned TPS and Auto-Scaling

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

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second ( minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

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

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

Status

A campaign can be in one of the following states:

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

• DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

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

Related APIs

• 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:

Result of the CreateCampaign operation returned by the service.

See Also:

• AWS API Documentation

createDataDeletionJob

default CreateDataDeletionJobResponse createDataDeletionJob(CreateDataDeletionJobRequest createDataDeletionJobRequest)
                                                     throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users.

• Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3.

• To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.

Status

A data deletion job can have one of the following statuses:

• PENDING > IN_PROGRESS > COMPLETED -or- FAILED

To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

• ListDataDeletionJobs

• DescribeDataDeletionJob

Parameters:

createDataDeletionJobRequest -

Returns:

Result of the CreateDataDeletionJob operation returned by the service.

See Also:

• AWS API Documentation

createDataDeletionJob

default CreateDataDeletionJobResponse createDataDeletionJob(Consumer<CreateDataDeletionJobRequest.Builder> createDataDeletionJobRequest)
                                                     throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users.

• Your input file must be a CSV file with a single USER_ID column that lists the users IDs. For more information about preparing the CSV file, see Preparing your data deletion file and uploading it to Amazon S3.

• To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs GetObject and ListBucket permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.

Status

A data deletion job can have one of the following statuses:

• PENDING > IN_PROGRESS > COMPLETED -or- FAILED

To get the status of the data deletion job, call DescribeDataDeletionJob API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

• ListDataDeletionJobs

• DescribeDataDeletionJob

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

Parameters:

createDataDeletionJobRequest - A Consumer that will call methods on CreateDataDeletionJobRequest.Builder to create a request.

Returns:

Result of the CreateDataDeletionJob operation returned by the service.

See Also:

• AWS API Documentation

createDataset

default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest)
                                     throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are 5 types of datasets:

• Item interactions

• Items

• Users

• Action interactions

• Actions

Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

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

• DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

• CreateDatasetGroup

• ListDatasets

• DescribeDataset

• DeleteDataset

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

See Also:

• AWS API Documentation

createDataset

default CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
                                     throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are 5 types of datasets:

• Item interactions

• Items

• Users

• Action interactions

• Actions

Each dataset type has an associated schema with required field types. Only the Item interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

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

• DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

• 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:

Result of the CreateDataset operation returned by the service.

See Also:

• AWS API Documentation

createDatasetExportJob

default CreateDatasetExportJobResponse createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)
                                                       throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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:

Result of the CreateDatasetExportJob operation returned by the service.

See Also:

• AWS API Documentation

createDatasetExportJob

default CreateDatasetExportJobResponse createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest)
                                                       throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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:

Result of the CreateDatasetExportJob operation returned by the service.

See Also:

• AWS API Documentation

createDatasetGroup

default CreateDatasetGroupResponse createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)
                                               throws InvalidInputException,
ResourceAlreadyExistsException,
LimitExceededException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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

• Item interactions

• Items

• Users

• Actions

• Action interactions

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

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

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

• DELETE PENDING

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

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

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

APIs that require a dataset group ARN in the request

• CreateDataset

• CreateEventTracker

• CreateSolution

Related APIs

• ListDatasetGroups

• DescribeDatasetGroup

• DeleteDatasetGroup

Parameters:

createDatasetGroupRequest -

Returns:

Result of the CreateDatasetGroup operation returned by the service.

See Also:

• AWS API Documentation

createDatasetGroup

default CreateDatasetGroupResponse createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)
                                               throws InvalidInputException,
ResourceAlreadyExistsException,
LimitExceededException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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

• Item interactions

• Items

• Users

• Actions

• Action interactions

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

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

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

• DELETE PENDING

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

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

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

APIs that require a dataset group ARN in the request

• 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:

Result of the CreateDatasetGroup operation returned by the service.

See Also:

• AWS API Documentation

createDatasetImportJob

default CreateDatasetImportJobResponse createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)
                                                       throws InvalidInputException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
ResourceInUseException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
PersonalizeException

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