Interface PersonalizeClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic PersonalizeClientBuilder
builder()
Create a builder that can be used to configure and create aPersonalizeClient
.static PersonalizeClient
create()
Create aPersonalizeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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) Creates a campaign that deploys a solution version.default CreateCampaignResponse
createCampaign
(CreateCampaignRequest createCampaignRequest) Creates a campaign that deploys a solution version.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) Creates the configuration for training a model.default CreateSolutionResponse
createSolution
(CreateSolutionRequest createSolutionRequest) Creates the configuration for training a model.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 theSolution
object itself.default DeleteSolutionResponse
deleteSolution
(DeleteSolutionRequest deleteSolutionRequest) Deletes all versions of a solution and theSolution
object itself.default DescribeAlgorithmResponse
describeAlgorithm
(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest) Describes the given algorithm.default DescribeAlgorithmResponse
describeAlgorithm
(DescribeAlgorithmRequest describeAlgorithmRequest) Describes the given algorithm.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.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 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.describeFeatureTransformation
(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest) Describes the given feature transformation.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.describeMetricAttribution
(Consumer<DescribeMetricAttributionRequest.Builder> describeMetricAttributionRequest) Describes a metric attribution.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 oflistBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation.default ListBatchInferenceJobsIterable
listBatchInferenceJobsPaginator
(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) This is a variant oflistBatchInferenceJobs(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 oflistBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)
operation.default ListBatchSegmentJobsIterable
listBatchSegmentJobsPaginator
(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest) This is a variant oflistBatchSegmentJobs(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 oflistCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)
operation.default ListCampaignsIterable
listCampaignsPaginator
(ListCampaignsRequest listCampaignsRequest) This is a variant oflistCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)
operation.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 oflistDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)
operation.default ListDatasetExportJobsIterable
listDatasetExportJobsPaginator
(ListDatasetExportJobsRequest listDatasetExportJobsRequest) This is a variant oflistDatasetExportJobs(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 oflistDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation.default ListDatasetGroupsIterable
listDatasetGroupsPaginator
(ListDatasetGroupsRequest listDatasetGroupsRequest) This is a variant oflistDatasetGroups(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 oflistDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation.default ListDatasetImportJobsIterable
listDatasetImportJobsPaginator
(ListDatasetImportJobsRequest listDatasetImportJobsRequest) This is a variant oflistDatasetImportJobs(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 oflistDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation.default ListDatasetsIterable
listDatasetsPaginator
(ListDatasetsRequest listDatasetsRequest) This is a variant oflistDatasets(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 oflistEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation.default ListEventTrackersIterable
listEventTrackersPaginator
(ListEventTrackersRequest listEventTrackersRequest) This is a variant oflistEventTrackers(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 oflistFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)
operation.default ListFiltersIterable
listFiltersPaginator
(ListFiltersRequest listFiltersRequest) This is a variant oflistFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)
operation.listMetricAttributionMetrics
(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest) Lists the metrics for the metric attribution.listMetricAttributionMetrics
(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) Lists the metrics for the metric attribution.listMetricAttributionMetricsPaginator
(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest) This is a variant oflistMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)
operation.listMetricAttributionMetricsPaginator
(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) This is a variant oflistMetricAttributionMetrics(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 oflistMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)
operation.default ListMetricAttributionsIterable
listMetricAttributionsPaginator
(ListMetricAttributionsRequest listMetricAttributionsRequest) This is a variant oflistMetricAttributions(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 oflistRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation.default ListRecipesIterable
listRecipesPaginator
(ListRecipesRequest listRecipesRequest) This is a variant oflistRecipes(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 oflistRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)
operation.default ListRecommendersIterable
listRecommendersPaginator
(ListRecommendersRequest listRecommendersRequest) This is a variant oflistRecommenders(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 oflistSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation.default ListSchemasIterable
listSchemasPaginator
(ListSchemasRequest listSchemasRequest) This is a variant oflistSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation.default ListSolutionsResponse
listSolutions
(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest) Returns a list of solutions that use the given dataset group.default ListSolutionsResponse
listSolutions
(ListSolutionsRequest listSolutionsRequest) Returns a list of solutions that use the given dataset group.default ListSolutionsIterable
listSolutionsPaginator
(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest) This is a variant oflistSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)
operation.default ListSolutionsIterable
listSolutionsPaginator
(ListSolutionsRequest listSolutionsRequest) This is a variant oflistSolutions(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 oflistSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation.default ListSolutionVersionsIterable
listSolutionVersionsPaginator
(ListSolutionVersionsRequest listSolutionVersionsRequest) This is a variant oflistSolutionVersions(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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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.stopSolutionVersionCreation
(Consumer<StopSolutionVersionCreationRequest.Builder> stopSolutionVersionCreationRequest) Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.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) Remove tags that are attached to a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Remove 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'sminProvisionedTPS
, or modify your campaign's configuration, such as the exploration configuration.default UpdateCampaignResponse
updateCampaign
(UpdateCampaignRequest updateCampaignRequest) Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign'sminProvisionedTPS
, or modify your campaign's configuration, such as the exploration 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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
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:
-
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 viaCreateBatchInferenceJobRequest.builder()
- Parameters:
createBatchInferenceJobRequest
- AConsumer
that will call methods onCreateBatchInferenceJobRequest.Builder
to create a request.- Returns:
- Result of the CreateBatchInferenceJob operation returned by the service.
- See Also:
-
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:
-
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 viaCreateBatchSegmentJobRequest.builder()
- Parameters:
createBatchSegmentJobRequest
- AConsumer
that will call methods onCreateBatchSegmentJobRequest.Builder
to create a request.- Returns:
- Result of the CreateBatchSegmentJob operation returned by the service.
- See Also:
-
createCampaign
default CreateCampaignResponse createCampaign(CreateCampaignRequest createCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException 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 forminProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPS
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 singleGetRecommendations
orGetPersonalizedRanking
request. The defaultminProvisionedTPS
is 1.If your TPS increases beyond the
minProvisionedTPS
, Amazon Personalize auto-scales the provisioned capacity up and down, but never belowminProvisionedTPS
. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to theminProvisionedTPS
.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 lowminProvisionedTPS
, track your usage using Amazon CloudWatch metrics, and then increase theminProvisionedTPS
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 isACTIVE
before asking the campaign for recommendations.Related APIs
- Parameters:
createCampaignRequest
-- Returns:
- Result of the CreateCampaign operation returned by the service.
- See Also:
-
-
createCampaign
default CreateCampaignResponse createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException 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 forminProvisionedTPS
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminProvisionedTPS
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 singleGetRecommendations
orGetPersonalizedRanking
request. The defaultminProvisionedTPS
is 1.If your TPS increases beyond the
minProvisionedTPS
, Amazon Personalize auto-scales the provisioned capacity up and down, but never belowminProvisionedTPS
. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to theminProvisionedTPS
.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 lowminProvisionedTPS
, track your usage using Amazon CloudWatch metrics, and then increase theminProvisionedTPS
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 isACTIVE
before asking the campaign for recommendations.Related APIs
This is a convenience which creates an instance of the
CreateCampaignRequest.Builder
avoiding the need to create one manually viaCreateCampaignRequest.builder()
- Parameters:
createCampaignRequest
- AConsumer
that will call methods onCreateCampaignRequest.Builder
to create a request.- Returns:
- Result of the CreateCampaign operation returned by the service.
- See Also:
-
-
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
- Parameters:
createDatasetRequest
-- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
-
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
This is a convenience which creates an instance of the
CreateDatasetRequest.Builder
avoiding the need to create one manually viaCreateDatasetRequest.builder()
- Parameters:
createDatasetRequest
- AConsumer
that will call methods onCreateDatasetRequest.Builder
to create a request.- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
-
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:
-
-
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 viaCreateDatasetExportJobRequest.builder()
- Parameters:
createDatasetExportJobRequest
- AConsumer
that will call methods onCreateDatasetExportJobRequest.Builder
to create a request.- Returns:
- Result of the CreateDatasetExportJob operation returned by the service.
- See Also:
-
-
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 isACTIVE
before adding a dataset to the group.You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
- Parameters:
createDatasetGroupRequest
-- Returns:
- Result of the CreateDatasetGroup operation returned by the service.
- See Also:
-
-
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 isACTIVE
before adding a dataset to the group.You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
This is a convenience which creates an instance of the
CreateDatasetGroupRequest.Builder
avoiding the need to create one manually viaCreateDatasetGroupRequest.builder()
- Parameters:
createDatasetGroupRequest
- AConsumer
that will call methods onCreateDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateDatasetGroup operation returned by the service.
- See Also:
-
-
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
- Parameters:
createDatasetImportJobRequest
-- Returns:
- Result of the CreateDatasetImportJob operation returned by the service.
- See Also:
-
createDatasetImportJob
default CreateDatasetImportJobResponse createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> 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 import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
Status
A dataset import job can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a
failureReason
key, which describes why the job failed.Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
This is a convenience which creates an instance of the
CreateDatasetImportJobRequest.Builder
avoiding the need to create one manually viaCreateDatasetImportJobRequest.builder()
- Parameters:
createDatasetImportJobRequest
- AConsumer
that will call methods onCreateDatasetImportJobRequest.Builder
to create a request.- Returns:
- Result of the CreateDatasetImportJob operation returned by the service.
- See Also:
-
-
createEventTracker
default CreateEventTrackerResponse createEventTracker(CreateEventTrackerRequest createEventTrackerRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
Only one event tracker can be associated with a dataset group. You will get an error if you call
CreateEventTracker
using the same dataset group as an existing event tracker.When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.
The event tracker must be in the ACTIVE state before using the tracking ID.
Related APIs
- Parameters:
createEventTrackerRequest
-- Returns:
- Result of the CreateEventTracker operation returned by the service.
- See Also:
-
-
createEventTracker
default CreateEventTrackerResponse createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
Only one event tracker can be associated with a dataset group. You will get an error if you call
CreateEventTracker
using the same dataset group as an existing event tracker.When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.
The event tracker must be in the ACTIVE state before using the tracking ID.
Related APIs
This is a convenience which creates an instance of the
CreateEventTrackerRequest.Builder
avoiding the need to create one manually viaCreateEventTrackerRequest.builder()
- Parameters:
createEventTrackerRequest
- AConsumer
that will call methods onCreateEventTrackerRequest.Builder
to create a request.- Returns:
- Result of the CreateEventTracker operation returned by the service.
- See Also:
-
-
createFilter
default CreateFilterResponse createFilter(CreateFilterRequest createFilterRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
- Parameters:
createFilterRequest
-- Returns:
- Result of the CreateFilter operation returned by the service.
- See Also:
-
createFilter
default CreateFilterResponse createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
This is a convenience which creates an instance of the
CreateFilterRequest.Builder
avoiding the need to create one manually viaCreateFilterRequest.builder()
- Parameters:
createFilterRequest
- AConsumer
that will call methods onCreateFilterRequest.Builder
to create a request.- Returns:
- Result of the CreateFilter operation returned by the service.
- See Also:
-
createMetricAttribution
default CreateMetricAttributionResponse createMetricAttribution(CreateMetricAttributionRequest createMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
- Parameters:
createMetricAttributionRequest
-- Returns:
- Result of the CreateMetricAttribution operation returned by the service.
- See Also:
-
createMetricAttribution
default CreateMetricAttributionResponse createMetricAttribution(Consumer<CreateMetricAttributionRequest.Builder> createMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.
This is a convenience which creates an instance of the
CreateMetricAttributionRequest.Builder
avoiding the need to create one manually viaCreateMetricAttributionRequest.builder()
- Parameters:
createMetricAttributionRequest
- AConsumer
that will call methods onCreateMetricAttributionRequest.Builder
to create a request.- Returns:
- Result of the CreateMetricAttribution operation returned by the service.
- See Also:
-
createRecommender
default CreateRecommenderResponse createRecommender(CreateRecommenderRequest createRecommenderRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
A high
minRecommendationRequestsPerSecond
will increase your bill. We recommend starting with 1 forminRecommendationRequestsPerSecond
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminRecommendationRequestsPerSecond
as necessary.When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (
minRecommendationRequestsPerSecond
) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is1
. A recommendation request is a singleGetRecommendations
operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.If your requests per second increases beyond
minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales the provisioned capacity up and down, but never belowminRecommendationRequestsPerSecond
. There's a short time delay while the capacity is increased that might cause loss of requests.Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default
minRecommendationRequestsPerSecond
, track your usage using Amazon CloudWatch metrics, and then increase theminRecommendationRequestsPerSecond
as necessary.Status
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the
status
of the recommender isACTIVE
before asking the recommender for recommendations.Related APIs
- Parameters:
createRecommenderRequest
-- Returns:
- Result of the CreateRecommender operation returned by the service.
- See Also:
-
-
createRecommender
default CreateRecommenderResponse createRecommender(Consumer<CreateRecommenderRequest.Builder> createRecommenderRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Minimum recommendation requests per second
A high
minRecommendationRequestsPerSecond
will increase your bill. We recommend starting with 1 forminRecommendationRequestsPerSecond
(the default). Track your usage using Amazon CloudWatch metrics, and increase theminRecommendationRequestsPerSecond
as necessary.When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (
minRecommendationRequestsPerSecond
) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is1
. A recommendation request is a singleGetRecommendations
operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.If your requests per second increases beyond
minRecommendationRequestsPerSecond
, Amazon Personalize auto-scales the provisioned capacity up and down, but never belowminRecommendationRequestsPerSecond
. There's a short time delay while the capacity is increased that might cause loss of requests.Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default
minRecommendationRequestsPerSecond
, track your usage using Amazon CloudWatch metrics, and then increase theminRecommendationRequestsPerSecond
as necessary.Status
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the
status
of the recommender isACTIVE
before asking the recommender for recommendations.Related APIs
This is a convenience which creates an instance of the
CreateRecommenderRequest.Builder
avoiding the need to create one manually viaCreateRecommenderRequest.builder()
- Parameters:
createRecommenderRequest
- AConsumer
that will call methods onCreateRecommenderRequest.Builder
to create a request.- Returns:
- Result of the CreateRecommender operation returned by the service.
- See Also:
-
-
createSchema
default CreateSchemaResponse createSchema(CreateSchemaRequest createSchemaRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
- Parameters:
createSchemaRequest
-- Returns:
- Result of the CreateSchema operation returned by the service.
- See Also:
-
createSchema
default CreateSchemaResponse createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
This is a convenience which creates an instance of the
CreateSchemaRequest.Builder
avoiding the need to create one manually viaCreateSchemaRequest.builder()
- Parameters:
createSchemaRequest
- AConsumer
that will call methods onCreateSchemaRequest.Builder
to create a request.- Returns:
- Result of the CreateSchema operation returned by the service.
- See Also:
-
createSolution
default CreateSolutionResponse createSolution(CreateSolutionRequest createSolutionRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates the configuration for training a model. A trained model is known as a solution version. After the configuration is created, you train the model (create a solution version) by calling the CreateSolutionVersion operation. Every time you call
CreateSolutionVersion
, a new version of the solution is created.After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize.
Amazon Personalize doesn't support configuring the
hpoObjective
for solution hyperparameter optimization at this time.Status
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling
CreateSolutionVersion
.Related APIs
- Parameters:
createSolutionRequest
-- Returns:
- Result of the CreateSolution operation returned by the service.
- See Also:
-
-
createSolution
default CreateSolutionResponse createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException Creates the configuration for training a model. A trained model is known as a solution version. After the configuration is created, you train the model (create a solution version) by calling the CreateSolutionVersion operation. Every time you call
CreateSolutionVersion
, a new version of the solution is created.After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize.
Amazon Personalize doesn't support configuring the
hpoObjective
for solution hyperparameter optimization at this time.Status
A solution can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling
CreateSolutionVersion
.Related APIs
This is a convenience which creates an instance of the
CreateSolutionRequest.Builder
avoiding the need to create one manually viaCreateSolutionRequest.builder()
- Parameters:
createSolutionRequest
- AConsumer
that will call methods onCreateSolutionRequest.Builder
to create a request.- Returns:
- Result of the CreateSolution operation returned by the service.
- See Also:
-
-
createSolutionVersion
default CreateSolutionVersionResponse createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, PersonalizeException Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling
CreateSolutionVersion
. A new version of the solution is created every time you call this operation.Status
A solution version can be in one of the following states:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling
CreateCampaign
.If the status shows as CREATE FAILED, the response includes a
failureReason
key, which describes why the job failed.Related APIs
- Parameters:
createSolutionVersionRequest
-- Returns:
- Result of the CreateSolutionVersion operation returned by the service.
- See Also:
-
-
createSolutionVersion
default CreateSolutionVersionResponse createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, LimitExceededException, ResourceInUseException, TooManyTagsException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, PersonalizeException Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling
CreateSolutionVersion
. A new version of the solution is created every time you call this operation.Status
A solution version can be in one of the following states:
-
CREATE PENDING
-
CREATE IN_PROGRESS
-
ACTIVE
-
CREATE FAILED
-
CREATE STOPPING
-
CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling
CreateCampaign
.If the status shows as CREATE FAILED, the response includes a
failureReason
key, which describes why the job failed.Related APIs
This is a convenience which creates an instance of the
CreateSolutionVersionRequest.Builder
avoiding the need to create one manually viaCreateSolutionVersionRequest.builder()
- Parameters:
createSolutionVersionRequest
- AConsumer
that will call methods onCreateSolutionVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateSolutionVersion operation returned by the service.
- See Also:
-
-
deleteCampaign
default DeleteCampaignResponse deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
- Parameters:
deleteCampaignRequest
-- Returns:
- Result of the DeleteCampaign operation returned by the service.
- See Also:
-
deleteCampaign
default DeleteCampaignResponse deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.
This is a convenience which creates an instance of the
DeleteCampaignRequest.Builder
avoiding the need to create one manually viaDeleteCampaignRequest.builder()
- Parameters:
deleteCampaignRequest
- AConsumer
that will call methods onDeleteCampaignRequest.Builder
to create a request.- Returns:
- Result of the DeleteCampaign operation returned by the service.
- See Also:
-
deleteDataset
default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a dataset. You can't delete a dataset if an associated
DatasetImportJob
orSolutionVersion
is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.- Parameters:
deleteDatasetRequest
-- Returns:
- Result of the DeleteDataset operation returned by the service.
- See Also:
-
deleteDataset
default DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a dataset. You can't delete a dataset if an associated
DatasetImportJob
orSolutionVersion
is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
This is a convenience which creates an instance of the
DeleteDatasetRequest.Builder
avoiding the need to create one manually viaDeleteDatasetRequest.builder()
- Parameters:
deleteDatasetRequest
- AConsumer
that will call methods onDeleteDatasetRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataset operation returned by the service.
- See Also:
-
deleteDatasetGroup
default DeleteDatasetGroupResponse deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a dataset group. Before you delete a dataset group, you must delete the following:
-
All associated event trackers.
-
All associated solutions.
-
All datasets in the dataset group.
- Parameters:
deleteDatasetGroupRequest
-- Returns:
- Result of the DeleteDatasetGroup operation returned by the service.
- See Also:
-
-
deleteDatasetGroup
default DeleteDatasetGroupResponse deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a dataset group. Before you delete a dataset group, you must delete the following:
-
All associated event trackers.
-
All associated solutions.
-
All datasets in the dataset group.
This is a convenience which creates an instance of the
DeleteDatasetGroupRequest.Builder
avoiding the need to create one manually viaDeleteDatasetGroupRequest.builder()
- Parameters:
deleteDatasetGroupRequest
- AConsumer
that will call methods onDeleteDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteDatasetGroup operation returned by the service.
- See Also:
-
-
deleteEventTracker
default DeleteEventTrackerResponse deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
- Parameters:
deleteEventTrackerRequest
-- Returns:
- Result of the DeleteEventTracker operation returned by the service.
- See Also:
-
deleteEventTracker
default DeleteEventTrackerResponse deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.
This is a convenience which creates an instance of the
DeleteEventTrackerRequest.Builder
avoiding the need to create one manually viaDeleteEventTrackerRequest.builder()
- Parameters:
deleteEventTrackerRequest
- AConsumer
that will call methods onDeleteEventTrackerRequest.Builder
to create a request.- Returns:
- Result of the DeleteEventTracker operation returned by the service.
- See Also:
-
deleteFilter
default DeleteFilterResponse deleteFilter(DeleteFilterRequest deleteFilterRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a filter.
- Parameters:
deleteFilterRequest
-- Returns:
- Result of the DeleteFilter operation returned by the service.
- See Also:
-
deleteFilter
default DeleteFilterResponse deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a filter.
This is a convenience which creates an instance of the
DeleteFilterRequest.Builder
avoiding the need to create one manually viaDeleteFilterRequest.builder()
- Parameters:
deleteFilterRequest
- AConsumer
that will call methods onDeleteFilterRequest.Builder
to create a request.- Returns:
- Result of the DeleteFilter operation returned by the service.
- See Also:
-
deleteMetricAttribution
default DeleteMetricAttributionResponse deleteMetricAttribution(DeleteMetricAttributionRequest deleteMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a metric attribution.
- Parameters:
deleteMetricAttributionRequest
-- Returns:
- Result of the DeleteMetricAttribution operation returned by the service.
- See Also:
-
deleteMetricAttribution
default DeleteMetricAttributionResponse deleteMetricAttribution(Consumer<DeleteMetricAttributionRequest.Builder> deleteMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a metric attribution.
This is a convenience which creates an instance of the
DeleteMetricAttributionRequest.Builder
avoiding the need to create one manually viaDeleteMetricAttributionRequest.builder()
- Parameters:
deleteMetricAttributionRequest
- AConsumer
that will call methods onDeleteMetricAttributionRequest.Builder
to create a request.- Returns:
- Result of the DeleteMetricAttribution operation returned by the service.
- See Also:
-
deleteRecommender
default DeleteRecommenderResponse deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
- Parameters:
deleteRecommenderRequest
-- Returns:
- Result of the DeleteRecommender operation returned by the service.
- See Also:
-
deleteRecommender
default DeleteRecommenderResponse deleteRecommender(Consumer<DeleteRecommenderRequest.Builder> deleteRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
This is a convenience which creates an instance of the
DeleteRecommenderRequest.Builder
avoiding the need to create one manually viaDeleteRecommenderRequest.builder()
- Parameters:
deleteRecommenderRequest
- AConsumer
that will call methods onDeleteRecommenderRequest.Builder
to create a request.- Returns:
- Result of the DeleteRecommender operation returned by the service.
- See Also:
-
deleteSchema
default DeleteSchemaResponse deleteSchema(DeleteSchemaRequest deleteSchemaRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
- Parameters:
deleteSchemaRequest
-- Returns:
- Result of the DeleteSchema operation returned by the service.
- See Also:
-
deleteSchema
default DeleteSchemaResponse deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
This is a convenience which creates an instance of the
DeleteSchemaRequest.Builder
avoiding the need to create one manually viaDeleteSchemaRequest.builder()
- Parameters:
deleteSchemaRequest
- AConsumer
that will call methods onDeleteSchemaRequest.Builder
to create a request.- Returns:
- Result of the DeleteSchema operation returned by the service.
- See Also:
-
deleteSolution
default DeleteSolutionResponse deleteSolution(DeleteSolutionRequest deleteSolutionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes all versions of a solution and the
Solution
object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associatedSolutionVersion
is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.- Parameters:
deleteSolutionRequest
-- Returns:
- Result of the DeleteSolution operation returned by the service.
- See Also:
-
deleteSolution
default DeleteSolutionResponse deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Deletes all versions of a solution and the
Solution
object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associatedSolutionVersion
is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
This is a convenience which creates an instance of the
DeleteSolutionRequest.Builder
avoiding the need to create one manually viaDeleteSolutionRequest.builder()
- Parameters:
deleteSolutionRequest
- AConsumer
that will call methods onDeleteSolutionRequest.Builder
to create a request.- Returns:
- Result of the DeleteSolution operation returned by the service.
- See Also:
-
describeAlgorithm
default DescribeAlgorithmResponse describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given algorithm.
- Parameters:
describeAlgorithmRequest
-- Returns:
- Result of the DescribeAlgorithm operation returned by the service.
- See Also:
-
describeAlgorithm
default DescribeAlgorithmResponse describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given algorithm.
This is a convenience which creates an instance of the
DescribeAlgorithmRequest.Builder
avoiding the need to create one manually viaDescribeAlgorithmRequest.builder()
- Parameters:
describeAlgorithmRequest
- AConsumer
that will call methods onDescribeAlgorithmRequest.Builder
to create a request.- Returns:
- Result of the DescribeAlgorithm operation returned by the service.
- See Also:
-
describeBatchInferenceJob
default DescribeBatchInferenceJobResponse describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException 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.
- Parameters:
describeBatchInferenceJobRequest
-- Returns:
- Result of the DescribeBatchInferenceJob operation returned by the service.
- See Also:
-
describeBatchInferenceJob
default DescribeBatchInferenceJobResponse describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException 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.
This is a convenience which creates an instance of the
DescribeBatchInferenceJobRequest.Builder
avoiding the need to create one manually viaDescribeBatchInferenceJobRequest.builder()
- Parameters:
describeBatchInferenceJobRequest
- AConsumer
that will call methods onDescribeBatchInferenceJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeBatchInferenceJob operation returned by the service.
- See Also:
-
describeBatchSegmentJob
default DescribeBatchSegmentJobResponse describeBatchSegmentJob(DescribeBatchSegmentJobRequest describeBatchSegmentJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException 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.
- Parameters:
describeBatchSegmentJobRequest
-- Returns:
- Result of the DescribeBatchSegmentJob operation returned by the service.
- See Also:
-
describeBatchSegmentJob
default DescribeBatchSegmentJobResponse describeBatchSegmentJob(Consumer<DescribeBatchSegmentJobRequest.Builder> describeBatchSegmentJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException 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.
This is a convenience which creates an instance of the
DescribeBatchSegmentJobRequest.Builder
avoiding the need to create one manually viaDescribeBatchSegmentJobRequest.builder()
- Parameters:
describeBatchSegmentJobRequest
- AConsumer
that will call methods onDescribeBatchSegmentJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeBatchSegmentJob operation returned by the service.
- See Also:
-
describeCampaign
default DescribeCampaignResponse describeCampaign(DescribeCampaignRequest describeCampaignRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given campaign, including its status.
A campaign can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
When the
status
isCREATE FAILED
, the response includes thefailureReason
key, which describes why.For more information on campaigns, see CreateCampaign.
- Parameters:
describeCampaignRequest
-- Returns:
- Result of the DescribeCampaign operation returned by the service.
- See Also:
-
-
describeCampaign
default DescribeCampaignResponse describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given campaign, including its status.
A campaign can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
DELETE PENDING > DELETE IN_PROGRESS
When the
status
isCREATE FAILED
, the response includes thefailureReason
key, which describes why.For more information on campaigns, see CreateCampaign.
This is a convenience which creates an instance of the
DescribeCampaignRequest.Builder
avoiding the need to create one manually viaDescribeCampaignRequest.builder()
- Parameters:
describeCampaignRequest
- AConsumer
that will call methods onDescribeCampaignRequest.Builder
to create a request.- Returns:
- Result of the DescribeCampaign operation returned by the service.
- See Also:
-
-
describeDataset
default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given dataset. For more information on datasets, see CreateDataset.
- Parameters:
describeDatasetRequest
-- Returns:
- Result of the DescribeDataset operation returned by the service.
- See Also:
-
describeDataset
default DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given dataset. For more information on datasets, see CreateDataset.
This is a convenience which creates an instance of the
DescribeDatasetRequest.Builder
avoiding the need to create one manually viaDescribeDatasetRequest.builder()
- Parameters:
describeDatasetRequest
- AConsumer
that will call methods onDescribeDatasetRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataset operation returned by the service.
- See Also:
-
describeDatasetExportJob
default DescribeDatasetExportJobResponse describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
- Parameters:
describeDatasetExportJobRequest
-- Returns:
- Result of the DescribeDatasetExportJob operation returned by the service.
- See Also:
-
describeDatasetExportJob
default DescribeDatasetExportJobResponse describeDatasetExportJob(Consumer<DescribeDatasetExportJobRequest.Builder> describeDatasetExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
This is a convenience which creates an instance of the
DescribeDatasetExportJobRequest.Builder
avoiding the need to create one manually viaDescribeDatasetExportJobRequest.builder()
- Parameters:
describeDatasetExportJobRequest
- AConsumer
that will call methods onDescribeDatasetExportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeDatasetExportJob operation returned by the service.
- See Also:
-
describeDatasetGroup
default DescribeDatasetGroupResponse describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
- Parameters:
describeDatasetGroupRequest
-- Returns:
- Result of the DescribeDatasetGroup operation returned by the service.
- See Also:
-
describeDatasetGroup
default DescribeDatasetGroupResponse describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
This is a convenience which creates an instance of the
DescribeDatasetGroupRequest.Builder
avoiding the need to create one manually viaDescribeDatasetGroupRequest.builder()
- Parameters:
describeDatasetGroupRequest
- AConsumer
that will call methods onDescribeDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeDatasetGroup operation returned by the service.
- See Also:
-
describeDatasetImportJob
default DescribeDatasetImportJobResponse describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
- Parameters:
describeDatasetImportJobRequest
-- Returns:
- Result of the DescribeDatasetImportJob operation returned by the service.
- See Also:
-
describeDatasetImportJob
default DescribeDatasetImportJobResponse describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
This is a convenience which creates an instance of the
DescribeDatasetImportJobRequest.Builder
avoiding the need to create one manually viaDescribeDatasetImportJobRequest.builder()
- Parameters:
describeDatasetImportJobRequest
- AConsumer
that will call methods onDescribeDatasetImportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeDatasetImportJob operation returned by the service.
- See Also:
-
describeEventTracker
default DescribeEventTrackerResponse describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes an event tracker. The response includes the
trackingId
andstatus
of the event tracker. For more information on event trackers, see CreateEventTracker.- Parameters:
describeEventTrackerRequest
-- Returns:
- Result of the DescribeEventTracker operation returned by the service.
- See Also:
-
describeEventTracker
default DescribeEventTrackerResponse describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes an event tracker. The response includes the
trackingId
andstatus
of the event tracker. For more information on event trackers, see CreateEventTracker.
This is a convenience which creates an instance of the
DescribeEventTrackerRequest.Builder
avoiding the need to create one manually viaDescribeEventTrackerRequest.builder()
- Parameters:
describeEventTrackerRequest
- AConsumer
that will call methods onDescribeEventTrackerRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventTracker operation returned by the service.
- See Also:
-
describeFeatureTransformation
default DescribeFeatureTransformationResponse describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given feature transformation.
- Parameters:
describeFeatureTransformationRequest
-- Returns:
- Result of the DescribeFeatureTransformation operation returned by the service.
- See Also:
-
describeFeatureTransformation
default DescribeFeatureTransformationResponse describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given feature transformation.
This is a convenience which creates an instance of the
DescribeFeatureTransformationRequest.Builder
avoiding the need to create one manually viaDescribeFeatureTransformationRequest.builder()
- Parameters:
describeFeatureTransformationRequest
- AConsumer
that will call methods onDescribeFeatureTransformationRequest.Builder
to create a request.- Returns:
- Result of the DescribeFeatureTransformation operation returned by the service.
- See Also:
-
describeFilter
default DescribeFilterResponse describeFilter(DescribeFilterRequest describeFilterRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a filter's properties.
- Parameters:
describeFilterRequest
-- Returns:
- Result of the DescribeFilter operation returned by the service.
- See Also:
-
describeFilter
default DescribeFilterResponse describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a filter's properties.
This is a convenience which creates an instance of the
DescribeFilterRequest.Builder
avoiding the need to create one manually viaDescribeFilterRequest.builder()
- Parameters:
describeFilterRequest
- AConsumer
that will call methods onDescribeFilterRequest.Builder
to create a request.- Returns:
- Result of the DescribeFilter operation returned by the service.
- See Also:
-
describeMetricAttribution
default DescribeMetricAttributionResponse describeMetricAttribution(DescribeMetricAttributionRequest describeMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a metric attribution.
- Parameters:
describeMetricAttributionRequest
-- Returns:
- Result of the DescribeMetricAttribution operation returned by the service.
- See Also:
-
describeMetricAttribution
default DescribeMetricAttributionResponse describeMetricAttribution(Consumer<DescribeMetricAttributionRequest.Builder> describeMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a metric attribution.
This is a convenience which creates an instance of the
DescribeMetricAttributionRequest.Builder
avoiding the need to create one manually viaDescribeMetricAttributionRequest.builder()
- Parameters:
describeMetricAttributionRequest
- AConsumer
that will call methods onDescribeMetricAttributionRequest.Builder
to create a request.- Returns:
- Result of the DescribeMetricAttribution operation returned by the service.
- See Also:
-
describeRecipe
default DescribeRecipeResponse describeRecipe(DescribeRecipeRequest describeRecipeRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a recipe.
A recipe contains three items:
-
An algorithm that trains a model.
-
Hyperparameters that govern the training.
-
Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API.
CreateSolution
trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.- Parameters:
describeRecipeRequest
-- Returns:
- Result of the DescribeRecipe operation returned by the service.
- See Also:
-
-
describeRecipe
default DescribeRecipeResponse describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a recipe.
A recipe contains three items:
-
An algorithm that trains a model.
-
Hyperparameters that govern the training.
-
Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API.
CreateSolution
trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
This is a convenience which creates an instance of the
DescribeRecipeRequest.Builder
avoiding the need to create one manually viaDescribeRecipeRequest.builder()
- Parameters:
describeRecipeRequest
- AConsumer
that will call methods onDescribeRecipeRequest.Builder
to create a request.- Returns:
- Result of the DescribeRecipe operation returned by the service.
- See Also:
-
-
describeRecommender
default DescribeRecommenderResponse describeRecommender(DescribeRecommenderRequest describeRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given recommender, including its status.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
When the
status
isCREATE FAILED
, the response includes thefailureReason
key, which describes why.The
modelMetrics
key is null when the recommender is being created or deleted.For more information on recommenders, see CreateRecommender.
- Parameters:
describeRecommenderRequest
-- Returns:
- Result of the DescribeRecommender operation returned by the service.
- See Also:
-
-
describeRecommender
default DescribeRecommenderResponse describeRecommender(Consumer<DescribeRecommenderRequest.Builder> describeRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes the given recommender, including its status.
A recommender can be in one of the following states:
-
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
-
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
-
DELETE PENDING > DELETE IN_PROGRESS
When the
status
isCREATE FAILED
, the response includes thefailureReason
key, which describes why.The
modelMetrics
key is null when the recommender is being created or deleted.For more information on recommenders, see CreateRecommender.
This is a convenience which creates an instance of the
DescribeRecommenderRequest.Builder
avoiding the need to create one manually viaDescribeRecommenderRequest.builder()
- Parameters:
describeRecommenderRequest
- AConsumer
that will call methods onDescribeRecommenderRequest.Builder
to create a request.- Returns:
- Result of the DescribeRecommender operation returned by the service.
- See Also:
-
-
describeSchema
default DescribeSchemaResponse describeSchema(DescribeSchemaRequest describeSchemaRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a schema. For more information on schemas, see CreateSchema.
- Parameters:
describeSchemaRequest
-- Returns:
- Result of the DescribeSchema operation returned by the service.
- See Also:
-
describeSchema
default DescribeSchemaResponse describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a schema. For more information on schemas, see CreateSchema.
This is a convenience which creates an instance of the
DescribeSchemaRequest.Builder
avoiding the need to create one manually viaDescribeSchemaRequest.builder()
- Parameters:
describeSchemaRequest
- AConsumer
that will call methods onDescribeSchemaRequest.Builder
to create a request.- Returns:
- Result of the DescribeSchema operation returned by the service.
- See Also:
-
describeSolution
default DescribeSolutionResponse describeSolution(DescribeSolutionRequest describeSolutionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a solution. For more information on solutions, see CreateSolution.
- Parameters:
describeSolutionRequest
-- Returns:
- Result of the DescribeSolution operation returned by the service.
- See Also:
-
describeSolution
default DescribeSolutionResponse describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a solution. For more information on solutions, see CreateSolution.
This is a convenience which creates an instance of the
DescribeSolutionRequest.Builder
avoiding the need to create one manually viaDescribeSolutionRequest.builder()
- Parameters:
describeSolutionRequest
- AConsumer
that will call methods onDescribeSolutionRequest.Builder
to create a request.- Returns:
- Result of the DescribeSolution operation returned by the service.
- See Also:
-
describeSolutionVersion
default DescribeSolutionVersionResponse describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a specific version of a solution. For more information on solutions, see CreateSolution
- Parameters:
describeSolutionVersionRequest
-- Returns:
- Result of the DescribeSolutionVersion operation returned by the service.
- See Also:
-
describeSolutionVersion
default DescribeSolutionVersionResponse describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException Describes a specific version of a solution. For more information on solutions, see CreateSolution
This is a convenience which creates an instance of the
DescribeSolutionVersionRequest.Builder
avoiding the need to create one manually viaDescribeSolutionVersionRequest.builder()
- Parameters:
describeSolutionVersionRequest
- AConsumer
that will call methods onDescribeSolutionVersionRequest.Builder
to create a request.- Returns:
- Result of the DescribeSolutionVersion operation returned by the service.
- See Also:
-
getSolutionMetrics
default GetSolutionMetricsResponse getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Gets the metrics for the specified solution version.
- Parameters:
getSolutionMetricsRequest
-- Returns:
- Result of the GetSolutionMetrics operation returned by the service.
- See Also:
-
getSolutionMetrics
default GetSolutionMetricsResponse getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Gets the metrics for the specified solution version.
This is a convenience which creates an instance of the
GetSolutionMetricsRequest.Builder
avoiding the need to create one manually viaGetSolutionMetricsRequest.builder()
- Parameters:
getSolutionMetricsRequest
- AConsumer
that will call methods onGetSolutionMetricsRequest.Builder
to create a request.- Returns:
- Result of the GetSolutionMetrics operation returned by the service.
- See Also:
-
listBatchInferenceJobs
default ListBatchInferenceJobsResponse listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Gets a list of the batch inference jobs that have been performed off of a solution version.
- Parameters:
listBatchInferenceJobsRequest
-- Returns:
- Result of the ListBatchInferenceJobs operation returned by the service.
- See Also:
-
listBatchInferenceJobs
default ListBatchInferenceJobsResponse listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Gets a list of the batch inference jobs that have been performed off of a solution version.
This is a convenience which creates an instance of the
ListBatchInferenceJobsRequest.Builder
avoiding the need to create one manually viaListBatchInferenceJobsRequest.builder()
- Parameters:
listBatchInferenceJobsRequest
- AConsumer
that will call methods onListBatchInferenceJobsRequest.Builder
to create a request.- Returns:
- Result of the ListBatchInferenceJobs operation returned by the service.
- See Also:
-
listBatchInferenceJobsPaginator
default ListBatchInferenceJobsIterable listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client .listBatchInferenceJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation.- Parameters:
listBatchInferenceJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchInferenceJobsPaginator
default ListBatchInferenceJobsIterable listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client .listBatchInferenceJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)
operation.
This is a convenience which creates an instance of the
ListBatchInferenceJobsRequest.Builder
avoiding the need to create one manually viaListBatchInferenceJobsRequest.builder()
- Parameters:
listBatchInferenceJobsRequest
- AConsumer
that will call methods onListBatchInferenceJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchSegmentJobs
default ListBatchSegmentJobsResponse listBatchSegmentJobs(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
- Parameters:
listBatchSegmentJobsRequest
-- Returns:
- Result of the ListBatchSegmentJobs operation returned by the service.
- See Also:
-
listBatchSegmentJobs
default ListBatchSegmentJobsResponse listBatchSegmentJobs(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
This is a convenience which creates an instance of the
ListBatchSegmentJobsRequest.Builder
avoiding the need to create one manually viaListBatchSegmentJobsRequest.builder()
- Parameters:
listBatchSegmentJobsRequest
- AConsumer
that will call methods onListBatchSegmentJobsRequest.Builder
to create a request.- Returns:
- Result of the ListBatchSegmentJobs operation returned by the service.
- See Also:
-
listBatchSegmentJobsPaginator
default ListBatchSegmentJobsIterable listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client.listBatchSegmentJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client .listBatchSegmentJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client.listBatchSegmentJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)
operation.- Parameters:
listBatchSegmentJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listBatchSegmentJobsPaginator
default ListBatchSegmentJobsIterable listBatchSegmentJobsPaginator(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client.listBatchSegmentJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client .listBatchSegmentJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client.listBatchSegmentJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)
operation.
This is a convenience which creates an instance of the
ListBatchSegmentJobsRequest.Builder
avoiding the need to create one manually viaListBatchSegmentJobsRequest.builder()
- Parameters:
listBatchSegmentJobsRequest
- AConsumer
that will call methods onListBatchSegmentJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCampaigns
default ListCampaignsResponse listCampaigns(ListCampaignsRequest listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
- Parameters:
listCampaignsRequest
-- Returns:
- Result of the ListCampaigns operation returned by the service.
- See Also:
-
listCampaigns
default ListCampaignsResponse listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builder
avoiding the need to create one manually viaListCampaignsRequest.builder()
- Parameters:
listCampaignsRequest
- AConsumer
that will call methods onListCampaignsRequest.Builder
to create a request.- Returns:
- Result of the ListCampaigns operation returned by the service.
- See Also:
-
listCampaignsPaginator
default ListCampaignsIterable listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client .listCampaignsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)
operation.- Parameters:
listCampaignsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCampaignsPaginator
default ListCampaignsIterable listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client .listCampaignsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)
operation.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builder
avoiding the need to create one manually viaListCampaignsRequest.builder()
- Parameters:
listCampaignsRequest
- AConsumer
that will call methods onListCampaignsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetExportJobs
default ListDatasetExportJobsResponse listDatasetExportJobs(ListDatasetExportJobsRequest listDatasetExportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
- Parameters:
listDatasetExportJobsRequest
-- Returns:
- Result of the ListDatasetExportJobs operation returned by the service.
- See Also:
-
listDatasetExportJobs
default ListDatasetExportJobsResponse listDatasetExportJobs(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
This is a convenience which creates an instance of the
ListDatasetExportJobsRequest.Builder
avoiding the need to create one manually viaListDatasetExportJobsRequest.builder()
- Parameters:
listDatasetExportJobsRequest
- AConsumer
that will call methods onListDatasetExportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasetExportJobs operation returned by the service.
- See Also:
-
listDatasetExportJobsPaginator
default ListDatasetExportJobsIterable listDatasetExportJobsPaginator(ListDatasetExportJobsRequest listDatasetExportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client.listDatasetExportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client .listDatasetExportJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client.listDatasetExportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)
operation.- Parameters:
listDatasetExportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetExportJobsPaginator
default ListDatasetExportJobsIterable listDatasetExportJobsPaginator(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client.listDatasetExportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client .listDatasetExportJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client.listDatasetExportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListDatasetExportJobsRequest.Builder
avoiding the need to create one manually viaListDatasetExportJobsRequest.builder()
- Parameters:
listDatasetExportJobsRequest
- AConsumer
that will call methods onListDatasetExportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetGroups
default ListDatasetGroupsResponse listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
- Parameters:
listDatasetGroupsRequest
-- Returns:
- Result of the ListDatasetGroups operation returned by the service.
- See Also:
-
listDatasetGroups
default ListDatasetGroupsResponse listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
This is a convenience which creates an instance of the
ListDatasetGroupsRequest.Builder
avoiding the need to create one manually viaListDatasetGroupsRequest.builder()
- Parameters:
listDatasetGroupsRequest
- AConsumer
that will call methods onListDatasetGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasetGroups operation returned by the service.
- See Also:
-
listDatasetGroupsPaginator
default ListDatasetGroupsIterable listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client .listDatasetGroupsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation.- Parameters:
listDatasetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetGroupsPaginator
default ListDatasetGroupsIterable listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client .listDatasetGroupsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListDatasetGroupsRequest.Builder
avoiding the need to create one manually viaListDatasetGroupsRequest.builder()
- Parameters:
listDatasetGroupsRequest
- AConsumer
that will call methods onListDatasetGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetImportJobs
default ListDatasetImportJobsResponse listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
- Parameters:
listDatasetImportJobsRequest
-- Returns:
- Result of the ListDatasetImportJobs operation returned by the service.
- See Also:
-
listDatasetImportJobs
default ListDatasetImportJobsResponse listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.
This is a convenience which creates an instance of the
ListDatasetImportJobsRequest.Builder
avoiding the need to create one manually viaListDatasetImportJobsRequest.builder()
- Parameters:
listDatasetImportJobsRequest
- AConsumer
that will call methods onListDatasetImportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasetImportJobs operation returned by the service.
- See Also:
-
listDatasetImportJobsPaginator
default ListDatasetImportJobsIterable listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client .listDatasetImportJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation.- Parameters:
listDatasetImportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetImportJobsPaginator
default ListDatasetImportJobsIterable listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client .listDatasetImportJobsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListDatasetImportJobsRequest.Builder
avoiding the need to create one manually viaListDatasetImportJobsRequest.builder()
- Parameters:
listDatasetImportJobsRequest
- AConsumer
that will call methods onListDatasetImportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasets
default ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
- Parameters:
listDatasetsRequest
-- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasets
default ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builder
avoiding the need to create one manually viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation.- Parameters:
listDatasetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)
operation.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builder
avoiding the need to create one manually viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEventTrackers
default ListEventTrackersResponse listEventTrackers(ListEventTrackersRequest listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
- Parameters:
listEventTrackersRequest
-- Returns:
- Result of the ListEventTrackers operation returned by the service.
- See Also:
-
listEventTrackers
default ListEventTrackersResponse listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
This is a convenience which creates an instance of the
ListEventTrackersRequest.Builder
avoiding the need to create one manually viaListEventTrackersRequest.builder()
- Parameters:
listEventTrackersRequest
- AConsumer
that will call methods onListEventTrackersRequest.Builder
to create a request.- Returns:
- Result of the ListEventTrackers operation returned by the service.
- See Also:
-
listEventTrackersPaginator
default ListEventTrackersIterable listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client .listEventTrackersPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation.- Parameters:
listEventTrackersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEventTrackersPaginator
default ListEventTrackersIterable listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client .listEventTrackersPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)
operation.
This is a convenience which creates an instance of the
ListEventTrackersRequest.Builder
avoiding the need to create one manually viaListEventTrackersRequest.builder()
- Parameters:
listEventTrackersRequest
- AConsumer
that will call methods onListEventTrackersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFilters
default ListFiltersResponse listFilters(ListFiltersRequest listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Lists all filters that belong to a given dataset group.
- Parameters:
listFiltersRequest
-- Returns:
- Result of the ListFilters operation returned by the service.
- See Also:
-
listFilters
default ListFiltersResponse listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Lists all filters that belong to a given dataset group.
This is a convenience which creates an instance of the
ListFiltersRequest.Builder
avoiding the need to create one manually viaListFiltersRequest.builder()
- Parameters:
listFiltersRequest
- AConsumer
that will call methods onListFiltersRequest.Builder
to create a request.- Returns:
- Result of the ListFilters operation returned by the service.
- See Also:
-
listFiltersPaginator
default ListFiltersIterable listFiltersPaginator(ListFiltersRequest listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListFiltersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)
operation.- Parameters:
listFiltersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFiltersPaginator
default ListFiltersIterable listFiltersPaginator(Consumer<ListFiltersRequest.Builder> listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListFiltersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)
operation.
This is a convenience which creates an instance of the
ListFiltersRequest.Builder
avoiding the need to create one manually viaListFiltersRequest.builder()
- Parameters:
listFiltersRequest
- AConsumer
that will call methods onListFiltersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMetricAttributionMetrics
default ListMetricAttributionMetricsResponse listMetricAttributionMetrics(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Lists the metrics for the metric attribution.
- Parameters:
listMetricAttributionMetricsRequest
-- Returns:
- Result of the ListMetricAttributionMetrics operation returned by the service.
- See Also:
-
listMetricAttributionMetrics
default ListMetricAttributionMetricsResponse listMetricAttributionMetrics(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Lists the metrics for the metric attribution.
This is a convenience which creates an instance of the
ListMetricAttributionMetricsRequest.Builder
avoiding the need to create one manually viaListMetricAttributionMetricsRequest.builder()
- Parameters:
listMetricAttributionMetricsRequest
- AConsumer
that will call methods onListMetricAttributionMetricsRequest.Builder
to create a request.- Returns:
- Result of the ListMetricAttributionMetrics operation returned by the service.
- See Also:
-
listMetricAttributionMetricsPaginator
default ListMetricAttributionMetricsIterable listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client.listMetricAttributionMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client .listMetricAttributionMetricsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client.listMetricAttributionMetricsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)
operation.- Parameters:
listMetricAttributionMetricsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMetricAttributionMetricsPaginator
default ListMetricAttributionMetricsIterable listMetricAttributionMetricsPaginator(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client.listMetricAttributionMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client .listMetricAttributionMetricsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client.listMetricAttributionMetricsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)
operation.
This is a convenience which creates an instance of the
ListMetricAttributionMetricsRequest.Builder
avoiding the need to create one manually viaListMetricAttributionMetricsRequest.builder()
- Parameters:
listMetricAttributionMetricsRequest
- AConsumer
that will call methods onListMetricAttributionMetricsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMetricAttributions
default ListMetricAttributionsResponse listMetricAttributions(ListMetricAttributionsRequest listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Lists metric attributions.
- Parameters:
listMetricAttributionsRequest
-- Returns:
- Result of the ListMetricAttributions operation returned by the service.
- See Also:
-
listMetricAttributions
default ListMetricAttributionsResponse listMetricAttributions(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Lists metric attributions.
This is a convenience which creates an instance of the
ListMetricAttributionsRequest.Builder
avoiding the need to create one manually viaListMetricAttributionsRequest.builder()
- Parameters:
listMetricAttributionsRequest
- AConsumer
that will call methods onListMetricAttributionsRequest.Builder
to create a request.- Returns:
- Result of the ListMetricAttributions operation returned by the service.
- See Also:
-
listMetricAttributionsPaginator
default ListMetricAttributionsIterable listMetricAttributionsPaginator(ListMetricAttributionsRequest listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client.listMetricAttributionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client .listMetricAttributionsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client.listMetricAttributionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)
operation.- Parameters:
listMetricAttributionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMetricAttributionsPaginator
default ListMetricAttributionsIterable listMetricAttributionsPaginator(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client.listMetricAttributionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client .listMetricAttributionsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client.listMetricAttributionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)
operation.
This is a convenience which creates an instance of the
ListMetricAttributionsRequest.Builder
avoiding the need to create one manually viaListMetricAttributionsRequest.builder()
- Parameters:
listMetricAttributionsRequest
- AConsumer
that will call methods onListMetricAttributionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecipes
default ListRecipesResponse listRecipes(ListRecipesRequest listRecipesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
- Parameters:
listRecipesRequest
-- Returns:
- Result of the ListRecipes operation returned by the service.
- See Also:
-
listRecipes
default ListRecipesResponse listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
ListRecipesRequest.Builder
avoiding the need to create one manually viaListRecipesRequest.builder()
- Parameters:
listRecipesRequest
- AConsumer
that will call methods onListRecipesRequest.Builder
to create a request.- Returns:
- Result of the ListRecipes operation returned by the service.
- See Also:
-
listRecipesPaginator
default ListRecipesIterable listRecipesPaginator(ListRecipesRequest listRecipesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListRecipesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation.- Parameters:
listRecipesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecipesPaginator
default ListRecipesIterable listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListRecipesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)
operation.
This is a convenience which creates an instance of the
ListRecipesRequest.Builder
avoiding the need to create one manually viaListRecipesRequest.builder()
- Parameters:
listRecipesRequest
- AConsumer
that will call methods onListRecipesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecommenders
default ListRecommendersResponse listRecommenders(ListRecommendersRequest listRecommendersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
- Parameters:
listRecommendersRequest
-- Returns:
- Result of the ListRecommenders operation returned by the service.
- See Also:
-
listRecommenders
default ListRecommendersResponse listRecommenders(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
This is a convenience which creates an instance of the
ListRecommendersRequest.Builder
avoiding the need to create one manually viaListRecommendersRequest.builder()
- Parameters:
listRecommendersRequest
- AConsumer
that will call methods onListRecommendersRequest.Builder
to create a request.- Returns:
- Result of the ListRecommenders operation returned by the service.
- See Also:
-
listRecommendersPaginator
default ListRecommendersIterable listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client .listRecommendersPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListRecommendersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)
operation.- Parameters:
listRecommendersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRecommendersPaginator
default ListRecommendersIterable listRecommendersPaginator(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client .listRecommendersPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListRecommendersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)
operation.
This is a convenience which creates an instance of the
ListRecommendersRequest.Builder
avoiding the need to create one manually viaListRecommendersRequest.builder()
- Parameters:
listRecommendersRequest
- AConsumer
that will call methods onListRecommendersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchemas
default ListSchemasResponse listSchemas(ListSchemasRequest listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
- Parameters:
listSchemasRequest
-- Returns:
- Result of the ListSchemas operation returned by the service.
- See Also:
-
listSchemas
default ListSchemasResponse listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
This is a convenience which creates an instance of the
ListSchemasRequest.Builder
avoiding the need to create one manually viaListSchemasRequest.builder()
- Parameters:
listSchemasRequest
- AConsumer
that will call methods onListSchemasRequest.Builder
to create a request.- Returns:
- Result of the ListSchemas operation returned by the service.
- See Also:
-
listSchemasPaginator
default ListSchemasIterable listSchemasPaginator(ListSchemasRequest listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListSchemasResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation.- Parameters:
listSchemasRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSchemasPaginator
default ListSchemasIterable listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListSchemasResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)
operation.
This is a convenience which creates an instance of the
ListSchemasRequest.Builder
avoiding the need to create one manually viaListSchemasRequest.builder()
- Parameters:
listSchemasRequest
- AConsumer
that will call methods onListSchemasRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSolutionVersions
default ListSolutionVersionsResponse listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).
- Parameters:
listSolutionVersionsRequest
-- Returns:
- Result of the ListSolutionVersions operation returned by the service.
- See Also:
-
listSolutionVersions
default ListSolutionVersionsResponse listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
ListSolutionVersionsRequest.Builder
avoiding the need to create one manually viaListSolutionVersionsRequest.builder()
- Parameters:
listSolutionVersionsRequest
- AConsumer
that will call methods onListSolutionVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListSolutionVersions operation returned by the service.
- See Also:
-
listSolutionVersionsPaginator
default ListSolutionVersionsIterable listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client .listSolutionVersionsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation.- Parameters:
listSolutionVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSolutionVersionsPaginator
default ListSolutionVersionsIterable listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest) throws InvalidInputException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client .listSolutionVersionsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListSolutionVersionsRequest.Builder
avoiding the need to create one manually viaListSolutionVersionsRequest.builder()
- Parameters:
listSolutionVersionsRequest
- AConsumer
that will call methods onListSolutionVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSolutions
default ListSolutionsResponse listSolutions(ListSolutionsRequest listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
- Parameters:
listSolutionsRequest
-- Returns:
- Result of the ListSolutions operation returned by the service.
- See Also:
-
listSolutions
default ListSolutionsResponse listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
This is a convenience which creates an instance of the
ListSolutionsRequest.Builder
avoiding the need to create one manually viaListSolutionsRequest.builder()
- Parameters:
listSolutionsRequest
- AConsumer
that will call methods onListSolutionsRequest.Builder
to create a request.- Returns:
- Result of the ListSolutions operation returned by the service.
- See Also:
-
listSolutionsPaginator
default ListSolutionsIterable listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client .listSolutionsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)
operation.- Parameters:
listSolutionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSolutionsPaginator
default ListSolutionsIterable listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException This is a variant of
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client .listSolutionsPaginator(request); for (software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)
operation.
This is a convenience which creates an instance of the
ListSolutionsRequest.Builder
avoiding the need to create one manually viaListSolutionsRequest.builder()
- Parameters:
listSolutionsRequest
- AConsumer
that will call methods onListSolutionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Get a list of tags attached to a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Get a list of tags attached to a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
startRecommender
default StartRecommenderResponse startRecommender(StartRecommenderRequest startRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
- Parameters:
startRecommenderRequest
-- Returns:
- Result of the StartRecommender operation returned by the service.
- See Also:
-
startRecommender
default StartRecommenderResponse startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
This is a convenience which creates an instance of the
StartRecommenderRequest.Builder
avoiding the need to create one manually viaStartRecommenderRequest.builder()
- Parameters:
startRecommenderRequest
- AConsumer
that will call methods onStartRecommenderRequest.Builder
to create a request.- Returns:
- Result of the StartRecommender operation returned by the service.
- See Also:
-
stopRecommender
default StopRecommenderResponse stopRecommender(StopRecommenderRequest stopRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
- Parameters:
stopRecommenderRequest
-- Returns:
- Result of the StopRecommender operation returned by the service.
- See Also:
-
stopRecommender
default StopRecommenderResponse stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
This is a convenience which creates an instance of the
StopRecommenderRequest.Builder
avoiding the need to create one manually viaStopRecommenderRequest.builder()
- Parameters:
stopRecommenderRequest
- AConsumer
that will call methods onStopRecommenderRequest.Builder
to create a request.- Returns:
- Result of the StopRecommender operation returned by the service.
- See Also:
-
stopSolutionVersionCreation
default StopSolutionVersionCreationResponse stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
Depending on the current state of the solution version, the solution version state changes as follows:
-
CREATE_PENDING > CREATE_STOPPED
or
-
CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
- Parameters:
stopSolutionVersionCreationRequest
-- Returns:
- Result of the StopSolutionVersionCreation operation returned by the service.
- See Also:
-
-
stopSolutionVersionCreation
default StopSolutionVersionCreationResponse stopSolutionVersionCreation(Consumer<StopSolutionVersionCreationRequest.Builder> stopSolutionVersionCreationRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
Depending on the current state of the solution version, the solution version state changes as follows:
-
CREATE_PENDING > CREATE_STOPPED
or
-
CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
This is a convenience which creates an instance of the
StopSolutionVersionCreationRequest.Builder
avoiding the need to create one manually viaStopSolutionVersionCreationRequest.builder()
- Parameters:
stopSolutionVersionCreationRequest
- AConsumer
that will call methods onStopSolutionVersionCreationRequest.Builder
to create a request.- Returns:
- Result of the StopSolutionVersionCreation operation returned by the service.
- See Also:
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidInputException, ResourceNotFoundException, TooManyTagsException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException Add a list of tags to a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidInputException, ResourceNotFoundException, TooManyTagsException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException Add a list of tags to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidInputException, ResourceNotFoundException, TooManyTagKeysException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Remove tags that are attached to a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidInputException, ResourceNotFoundException, TooManyTagKeysException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Remove tags that are attached to a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCampaign
default UpdateCampaignResponse updateCampaign(UpdateCampaignRequest updateCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's
minProvisionedTPS
, or modify your campaign's configuration, such as the exploration configuration.To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is
Active
.For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
- Parameters:
updateCampaignRequest
-- Returns:
- Result of the UpdateCampaign operation returned by the service.
- See Also:
-
updateCampaign
default UpdateCampaignResponse updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's
minProvisionedTPS
, or modify your campaign's configuration, such as the exploration configuration.To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is
Active
.For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.
This is a convenience which creates an instance of the
UpdateCampaignRequest.Builder
avoiding the need to create one manually viaUpdateCampaignRequest.builder()
- Parameters:
updateCampaignRequest
- AConsumer
that will call methods onUpdateCampaignRequest.Builder
to create a request.- Returns:
- Result of the UpdateCampaign operation returned by the service.
- See Also:
-
updateDataset
default UpdateDatasetResponse updateDataset(UpdateDatasetRequest updateDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.
- Parameters:
updateDatasetRequest
-- Returns:
- Result of the UpdateDataset operation returned by the service.
- See Also:
-
updateDataset
default UpdateDatasetResponse updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.
This is a convenience which creates an instance of the
UpdateDatasetRequest.Builder
avoiding the need to create one manually viaUpdateDatasetRequest.builder()
- Parameters:
updateDatasetRequest
- AConsumer
that will call methods onUpdateDatasetRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataset operation returned by the service.
- See Also:
-
updateMetricAttribution
default UpdateMetricAttributionResponse updateMetricAttribution(UpdateMetricAttributionRequest updateMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, PersonalizeException Updates a metric attribution.
- Parameters:
updateMetricAttributionRequest
-- Returns:
- Result of the UpdateMetricAttribution operation returned by the service.
- See Also:
-
updateMetricAttribution
default UpdateMetricAttributionResponse updateMetricAttribution(Consumer<UpdateMetricAttributionRequest.Builder> updateMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, PersonalizeException Updates a metric attribution.
This is a convenience which creates an instance of the
UpdateMetricAttributionRequest.Builder
avoiding the need to create one manually viaUpdateMetricAttributionRequest.builder()
- Parameters:
updateMetricAttributionRequest
- AConsumer
that will call methods onUpdateMetricAttributionRequest.Builder
to create a request.- Returns:
- Result of the UpdateMetricAttribution operation returned by the service.
- See Also:
-
updateRecommender
default UpdateRecommenderResponse updateRecommender(UpdateRecommenderRequest updateRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the
latestRecommenderUpdate
returned in the DescribeRecommender operation.- Parameters:
updateRecommenderRequest
-- Returns:
- Result of the UpdateRecommender operation returned by the service.
- See Also:
-
updateRecommender
default UpdateRecommenderResponse updateRecommender(Consumer<UpdateRecommenderRequest.Builder> updateRecommenderRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the
latestRecommenderUpdate
returned in the DescribeRecommender operation.
This is a convenience which creates an instance of the
UpdateRecommenderRequest.Builder
avoiding the need to create one manually viaUpdateRecommenderRequest.builder()
- Parameters:
updateRecommenderRequest
- AConsumer
that will call methods onUpdateRecommenderRequest.Builder
to create a request.- Returns:
- Result of the UpdateRecommender operation returned by the service.
- See Also:
-
create
Create aPersonalizeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPersonalizeClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-