@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface PersonalizeClient extends AwsClient
builder() method.
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static PersonalizeClientBuilder |
builder()
Create a builder that can be used to configure and create a
PersonalizeClient. |
static PersonalizeClient |
create()
Create a
PersonalizeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateBatchInferenceJobResponse |
createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)
Creates a batch inference job.
|
default CreateBatchInferenceJobResponse |
createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)
Creates a batch inference job.
|
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 the
Solution object itself. |
default DeleteSolutionResponse |
deleteSolution(DeleteSolutionRequest deleteSolutionRequest)
Deletes all versions of a solution and the
Solution object itself. |
default DescribeAlgorithmResponse |
describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)
Describes the given algorithm.
|
default DescribeAlgorithmResponse |
describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
Describes the given algorithm.
|
default DescribeBatchInferenceJobResponse |
describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest)
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output
configurations, and the ARN of the solution version used to generate the recommendations.
|
default DescribeBatchInferenceJobResponse |
describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output
configurations, and the ARN of the solution version used to generate the recommendations.
|
default DescribeBatchSegmentJobResponse |
describeBatchSegmentJob(Consumer<DescribeBatchSegmentJobRequest.Builder> describeBatchSegmentJobRequest)
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output
configurations, and the ARN of the solution version used to generate segments.
|
default DescribeBatchSegmentJobResponse |
describeBatchSegmentJob(DescribeBatchSegmentJobRequest describeBatchSegmentJobRequest)
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output
configurations, and the ARN of the solution version used to generate segments.
|
default DescribeCampaignResponse |
describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
Describes the given campaign, including its status.
|
default DescribeCampaignResponse |
describeCampaign(DescribeCampaignRequest describeCampaignRequest)
Describes the given campaign, including its status.
|
default DescribeDatasetResponse |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Describes the given dataset.
|
default DescribeDatasetResponse |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Describes the given dataset.
|
default DescribeDatasetExportJobResponse |
describeDatasetExportJob(Consumer<DescribeDatasetExportJobRequest.Builder> describeDatasetExportJobRequest)
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
|
default DescribeDatasetExportJobResponse |
describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
|
default DescribeDatasetGroupResponse |
describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)
Describes the given dataset group.
|
default DescribeDatasetGroupResponse |
describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)
Describes the given dataset group.
|
default DescribeDatasetImportJobResponse |
describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
|
default DescribeDatasetImportJobResponse |
describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
|
default DescribeEventTrackerResponse |
describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)
Describes an event tracker.
|
default DescribeEventTrackerResponse |
describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)
Describes an event tracker.
|
default DescribeFeatureTransformationResponse |
describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)
Describes the given feature transformation.
|
default DescribeFeatureTransformationResponse |
describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)
Describes the given feature transformation.
|
default DescribeFilterResponse |
describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)
Describes a filter's properties.
|
default DescribeFilterResponse |
describeFilter(DescribeFilterRequest describeFilterRequest)
Describes a filter's properties.
|
default DescribeMetricAttributionResponse |
describeMetricAttribution(Consumer<DescribeMetricAttributionRequest.Builder> describeMetricAttributionRequest)
Describes a metric attribution.
|
default DescribeMetricAttributionResponse |
describeMetricAttribution(DescribeMetricAttributionRequest describeMetricAttributionRequest)
Describes a metric attribution.
|
default DescribeRecipeResponse |
describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)
Describes a recipe.
|
default DescribeRecipeResponse |
describeRecipe(DescribeRecipeRequest describeRecipeRequest)
Describes a recipe.
|
default DescribeRecommenderResponse |
describeRecommender(Consumer<DescribeRecommenderRequest.Builder> describeRecommenderRequest)
Describes the given recommender, including its status.
|
default DescribeRecommenderResponse |
describeRecommender(DescribeRecommenderRequest describeRecommenderRequest)
Describes the given recommender, including its status.
|
default DescribeSchemaResponse |
describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)
Describes a schema.
|
default DescribeSchemaResponse |
describeSchema(DescribeSchemaRequest describeSchemaRequest)
Describes a schema.
|
default DescribeSolutionResponse |
describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)
Describes a solution.
|
default DescribeSolutionResponse |
describeSolution(DescribeSolutionRequest describeSolutionRequest)
Describes a solution.
|
default DescribeSolutionVersionResponse |
describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)
Describes a specific version of a solution.
|
default DescribeSolutionVersionResponse |
describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)
Describes a specific version of a solution.
|
default GetSolutionMetricsResponse |
getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
|
default GetSolutionMetricsResponse |
getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
|
default ListBatchInferenceJobsResponse |
listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsResponse |
listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsIterable |
listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsIterable |
listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
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)
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
|
default ListBatchSegmentJobsIterable |
listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest)
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
|
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)
Returns a list of campaigns that use the given solution.
|
default ListCampaignsIterable |
listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
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)
Returns a list of dataset export jobs that use the given dataset.
|
default ListDatasetExportJobsIterable |
listDatasetExportJobsPaginator(ListDatasetExportJobsRequest listDatasetExportJobsRequest)
Returns a list of dataset export jobs that use the given dataset.
|
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)
Returns a list of dataset groups.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups.
|
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)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
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)
Returns the list of datasets contained in the given dataset group.
|
default ListDatasetsIterable |
listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
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)
Returns the list of event trackers associated with the account.
|
default ListEventTrackersIterable |
listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
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)
Lists all filters that belong to a given dataset group.
|
default ListFiltersIterable |
listFiltersPaginator(ListFiltersRequest listFiltersRequest)
Lists all filters that belong to a given dataset group.
|
default ListMetricAttributionMetricsResponse |
listMetricAttributionMetrics(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)
Lists the metrics for the metric attribution.
|
default ListMetricAttributionMetricsResponse |
listMetricAttributionMetrics(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)
Lists the metrics for the metric attribution.
|
default ListMetricAttributionMetricsIterable |
listMetricAttributionMetricsPaginator(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)
Lists the metrics for the metric attribution.
|
default ListMetricAttributionMetricsIterable |
listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)
Lists the metrics for the metric attribution.
|
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)
Lists metric attributions.
|
default ListMetricAttributionsIterable |
listMetricAttributionsPaginator(ListMetricAttributionsRequest listMetricAttributionsRequest)
Lists metric attributions.
|
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)
Returns a list of available recipes.
|
default ListRecipesIterable |
listRecipesPaginator(ListRecipesRequest listRecipesRequest)
Returns a list of available recipes.
|
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)
Returns a list of recommenders in a given Domain dataset group.
|
default ListRecommendersIterable |
listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest)
Returns a list of recommenders in a given Domain dataset group.
|
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)
Returns the list of schemas associated with the account.
|
default ListSchemasIterable |
listSchemasPaginator(ListSchemasRequest listSchemasRequest)
Returns the list of schemas associated with the account.
|
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)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionsIterable |
listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
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)
Returns a list of solution versions for the given solution.
|
default ListSolutionVersionsIterable |
listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Get a list of tags
attached to a resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Get a list of tags
attached to a resource.
|
default PersonalizeServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartRecommenderResponse |
startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest)
Starts a recommender that is INACTIVE.
|
default StartRecommenderResponse |
startRecommender(StartRecommenderRequest startRecommenderRequest)
Starts a recommender that is INACTIVE.
|
default StopRecommenderResponse |
stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest)
Stops a recommender that is ACTIVE.
|
default StopRecommenderResponse |
stopRecommender(StopRecommenderRequest stopRecommenderRequest)
Stops a recommender that is ACTIVE.
|
default StopSolutionVersionCreationResponse |
stopSolutionVersionCreation(Consumer<StopSolutionVersionCreationRequest.Builder> stopSolutionVersionCreationRequest)
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
|
default StopSolutionVersionCreationResponse |
stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest)
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add a list of tags to a resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Add a list of tags to a resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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 by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter. |
default UpdateCampaignResponse |
updateCampaign(UpdateCampaignRequest updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter. |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateBatchInferenceJobResponse createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException
Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Creating a batch inference job.
createBatchInferenceJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBatchInferenceJobResponse createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException
Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Creating a batch inference job.
This is a convenience which creates an instance of the CreateBatchInferenceJobRequest.Builder avoiding
the need to create one manually via CreateBatchInferenceJobRequest.builder()
createBatchInferenceJobRequest - A Consumer that will call methods on CreateBatchInferenceJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createBatchSegmentJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBatchSegmentJobResponse createBatchSegmentJob(Consumer<CreateBatchSegmentJobRequest.Builder> createBatchSegmentJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.
This is a convenience which creates an instance of the CreateBatchSegmentJobRequest.Builder avoiding the
need to create one manually via CreateBatchSegmentJobRequest.builder()
createBatchSegmentJobRequest - A Consumer that will call methods on CreateBatchSegmentJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 bill. We recommend starting with 1 for
minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the
minProvisionedTPS as necessary.
A transaction is a single GetRecommendations or GetPersonalizedRanking call.
Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon
Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned
capacity up and down, but never below minProvisionedTPS. There's a short time delay while the
capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the
minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for
recommendations.
Related APIs
createCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 bill. We recommend starting with 1 for
minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the
minProvisionedTPS as necessary.
A transaction is a single GetRecommendations or GetPersonalizedRanking call.
Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon
Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned
capacity up and down, but never below minProvisionedTPS. There's a short time delay while the
capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the
minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for
recommendations.
Related APIs
This is a convenience which creates an instance of the CreateCampaignRequest.Builder avoiding the need to
create one manually via CreateCampaignRequest.builder()
createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 three types of datasets:
Interactions
Items
Users
Each dataset type has an associated schema with required field types. Only the Interactions dataset
is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
createDatasetRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 three types of datasets:
Interactions
Items
Users
Each dataset type has an associated schema with required field types. Only the Interactions dataset
is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to
create one manually via CreateDatasetRequest.builder()
createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createDatasetExportJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetExportJobResponse createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ResourceInUseException, TooManyTagsException, AwsServiceException, SdkClientException, PersonalizeException
Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export
the training data, you must specify an service-linked IAM role that gives Amazon Personalize
PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon
Personalize developer guide.
Status
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset
export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a
failureReason key, which describes why the job failed.
This is a convenience which creates an instance of the CreateDatasetExportJobRequest.Builder avoiding the
need to create one manually via CreateDatasetExportJobRequest.builder()
createDatasetExportJobRequest - A Consumer that will call methods on CreateDatasetExportJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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:
Interactions
Items
Users
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup.
If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why
the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset
to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
createDatasetGroupRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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:
Interactions
Items
Users
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup.
If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why
the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset
to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
This is a convenience which creates an instance of the CreateDatasetGroupRequest.Builder avoiding the
need to create one manually via CreateDatasetGroupRequest.builder()
createDatasetGroupRequest - A Consumer that will call methods on CreateDatasetGroupRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
createDatasetImportJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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 via CreateDatasetImportJobRequest.builder()
createDatasetImportJobRequest - A Consumer that will call methods on CreateDatasetImportJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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
createEventTrackerRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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 via CreateEventTrackerRequest.builder()
createEventTrackerRequest - A Consumer that will call methods on CreateEventTrackerRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createFilterRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateFilterRequest.builder()
createFilterRequest - A Consumer that will call methods on CreateFilterRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createMetricAttributionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateMetricAttributionRequest.builder()
createMetricAttributionRequest - A Consumer that will call methods on CreateMetricAttributionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceAlreadyExistsException - The specified resource already exists.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 for
minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics,
and increase the minRecommendationRequestsPerSecond 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 is 1. A recommendation request is a single
GetRecommendations operation. Request throughput is measured in requests per second and Amazon
Personalize uses your requests per second to derive your requests per hour and the price of your recommender
usage.
If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize
auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond
. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or
the actual number of requests. The actual request throughput used is calculated as the average requests/second
within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond,
track your usage using Amazon CloudWatch metrics, and then increase the
minRecommendationRequestsPerSecond as necessary.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the recommender for
recommendations.
Related APIs
createRecommenderRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 for
minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics,
and increase the minRecommendationRequestsPerSecond 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 is 1. A recommendation request is a single
GetRecommendations operation. Request throughput is measured in requests per second and Amazon
Personalize uses your requests per second to derive your requests per hour and the price of your recommender
usage.
If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize
auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond
. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or
the actual number of requests. The actual request throughput used is calculated as the average requests/second
within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond,
track your usage using Amazon CloudWatch metrics, and then increase the
minRecommendationRequestsPerSecond as necessary.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the recommender for
recommendations.
Related APIs
This is a convenience which creates an instance of the CreateRecommenderRequest.Builder avoiding the need
to create one manually via CreateRecommenderRequest.builder()
createRecommenderRequest - A Consumer that will call methods on CreateRecommenderRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
createSchemaRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateSchemaRequest.builder()
createSchemaRequest - A Consumer that will call methods on CreateSchemaRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
createSolutionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateSolutionRequest.builder()
createSolutionRequest - A Consumer that will call methods on CreateSolutionRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceAlreadyExistsException - The specified resource already exists.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
createSolutionVersionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateSolutionVersionRequest.builder()
createSolutionVersionRequest - A Consumer that will call methods on CreateSolutionVersionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.LimitExceededException - The limit on the number of requests per second has been exceeded.ResourceInUseException - The specified resource is in use.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteCampaignRequest.builder()
deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or
SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see
CreateDataset.
deleteDatasetRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 or
SolutionVersion 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 via DeleteDatasetRequest.builder()
deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteDatasetGroupRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteDatasetGroupRequest.builder()
deleteDatasetGroupRequest - A Consumer that will call methods on DeleteDatasetGroupRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventTrackerResponse deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
deleteEventTrackerRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventTrackerResponse deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes the event tracker. Does not delete the event-interactions dataset from the associated 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 via DeleteEventTrackerRequest.builder()
deleteEventTrackerRequest - A Consumer that will call methods on DeleteEventTrackerRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteFilterResponse deleteFilter(DeleteFilterRequest deleteFilterRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a filter.
deleteFilterRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteFilterRequest.builder()
deleteFilterRequest - A Consumer that will call methods on DeleteFilterRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMetricAttributionResponse deleteMetricAttribution(DeleteMetricAttributionRequest deleteMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Deletes a metric attribution.
deleteMetricAttributionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteMetricAttributionRequest.builder()
deleteMetricAttributionRequest - A Consumer that will call methods on DeleteMetricAttributionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteRecommenderRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteRecommenderRequest.builder()
deleteRecommenderRequest - A Consumer that will call methods on DeleteRecommenderRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteSchemaRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteSchemaRequest.builder()
deleteSchemaRequest - A Consumer that will call methods on DeleteSchemaRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 associated
SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions,
see CreateSolution.
deleteSolutionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 associated
SolutionVersion 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 via DeleteSolutionRequest.builder()
deleteSolutionRequest - A Consumer that will call methods on DeleteSolutionRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAlgorithmResponse describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given algorithm.
describeAlgorithmRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeAlgorithmRequest.builder()
describeAlgorithmRequest - A Consumer that will call methods on DescribeAlgorithmRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeBatchInferenceJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeBatchInferenceJobRequest.builder()
describeBatchInferenceJobRequest - A Consumer that will call methods on DescribeBatchInferenceJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeBatchSegmentJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeBatchSegmentJobRequest.builder()
describeBatchSegmentJobRequest - A Consumer that will call methods on DescribeBatchSegmentJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 is CREATE FAILED, the response includes the failureReason
key, which describes why.
For more information on campaigns, see CreateCampaign.
describeCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 is CREATE FAILED, the response includes the failureReason
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 via DescribeCampaignRequest.builder()
describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeDatasetRequest.builder()
describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetExportJobResponse describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
describeDatasetExportJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeDatasetExportJobRequest.builder()
describeDatasetExportJobRequest - A Consumer that will call methods on DescribeDatasetExportJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeDatasetGroupRequest.builder()
describeDatasetGroupRequest - A Consumer that will call methods on DescribeDatasetGroupRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeDatasetImportJobRequest.builder()
describeDatasetImportJobRequest - A Consumer that will call methods on DescribeDatasetImportJobRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventTrackerResponse describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes an event tracker. The response includes the trackingId and status of the
event tracker. For more information on event trackers, see CreateEventTracker.
describeEventTrackerRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventTrackerResponse describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes an event tracker. The response includes the trackingId and status 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 via DescribeEventTrackerRequest.builder()
describeEventTrackerRequest - A Consumer that will call methods on DescribeEventTrackerRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFeatureTransformationResponse describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes the given feature transformation.
describeFeatureTransformationRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeFeatureTransformationRequest.builder()
describeFeatureTransformationRequest - A Consumer that will call methods on DescribeFeatureTransformationRequest.Builder to
create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFilterResponse describeFilter(DescribeFilterRequest describeFilterRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a filter's properties.
describeFilterRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeFilterRequest.builder()
describeFilterRequest - A Consumer that will call methods on DescribeFilterRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMetricAttributionResponse describeMetricAttribution(DescribeMetricAttributionRequest describeMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a metric attribution.
describeMetricAttributionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeMetricAttributionRequest.builder()
describeMetricAttributionRequest - A Consumer that will call methods on DescribeMetricAttributionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeRecipeRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeRecipeRequest.builder()
describeRecipeRequest - A Consumer that will call methods on DescribeRecipeRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 is CREATE FAILED, the response includes the failureReason
key, which describes why.
The modelMetrics key is null when the recommender is being created or deleted.
For more information on recommenders, see CreateRecommender.
describeRecommenderRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 is CREATE FAILED, the response includes the failureReason
key, which describes why.
The modelMetrics key is null when the recommender is being created or deleted.
For more information on recommenders, see CreateRecommender.
This is a convenience which creates an instance of the DescribeRecommenderRequest.Builder avoiding the
need to create one manually via DescribeRecommenderRequest.builder()
describeRecommenderRequest - A Consumer that will call methods on DescribeRecommenderRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSchemaResponse describeSchema(DescribeSchemaRequest describeSchemaRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a schema. For more information on schemas, see CreateSchema.
describeSchemaRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeSchemaRequest.builder()
describeSchemaRequest - A Consumer that will call methods on DescribeSchemaRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSolutionResponse describeSolution(DescribeSolutionRequest describeSolutionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a solution. For more information on solutions, see CreateSolution.
describeSolutionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeSolutionRequest.builder()
describeSolutionRequest - A Consumer that will call methods on DescribeSolutionRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeSolutionVersionResponse describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, PersonalizeException
Describes a specific version of a solution. For more information on solutions, see CreateSolution
describeSolutionVersionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeSolutionVersionRequest.builder()
describeSolutionVersionRequest - A Consumer that will call methods on DescribeSolutionVersionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSolutionMetricsResponse getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Gets the metrics for the specified solution version.
getSolutionMetricsRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via GetSolutionMetricsRequest.builder()
getSolutionMetricsRequest - A Consumer that will call methods on GetSolutionMetricsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBatchInferenceJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBatchInferenceJobsRequest.builder()
listBatchInferenceJobsRequest - A Consumer that will call methods on ListBatchInferenceJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchInferenceJobsIterable listBatchInferenceJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBatchInferenceJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchInferenceJobsIterable listBatchInferenceJobsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsIterable responses = client.listBatchInferenceJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBatchInferenceJobsRequest.builder()
listBatchInferenceJobsRequest - A Consumer that will call methods on ListBatchInferenceJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listBatchSegmentJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListBatchSegmentJobsRequest.builder()
listBatchSegmentJobsRequest - A Consumer that will call methods on ListBatchSegmentJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchSegmentJobsIterable listBatchSegmentJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client.listBatchSegmentJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listBatchSegmentJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListBatchSegmentJobsIterable listBatchSegmentJobsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsIterable responses = client.listBatchSegmentJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListBatchSegmentJobsRequest.builder()
listBatchSegmentJobsRequest - A Consumer that will call methods on ListBatchSegmentJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listCampaignsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCampaignsIterable listCampaignsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listCampaignsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListCampaignsIterable listCampaignsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListCampaignsIterable responses = client.listCampaignsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListCampaignsRequest.builder()
listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDatasetExportJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListDatasetExportJobsRequest.builder()
listDatasetExportJobsRequest - A Consumer that will call methods on ListDatasetExportJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetExportJobsIterable listDatasetExportJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client.listDatasetExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDatasetExportJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetExportJobsIterable listDatasetExportJobsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsIterable responses = client.listDatasetExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListDatasetExportJobsRequest.builder()
listDatasetExportJobsRequest - A Consumer that will call methods on ListDatasetExportJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDatasetImportJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDatasetImportJobsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDatasetsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDatasetsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listEventTrackersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListEventTrackersRequest.builder()
listEventTrackersRequest - A Consumer that will call methods on ListEventTrackersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventTrackersIterable listEventTrackersPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listEventTrackersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventTrackersIterable listEventTrackersPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersIterable responses = client.listEventTrackersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListEventTrackersRequest.builder()
listEventTrackersRequest - A Consumer that will call methods on ListEventTrackersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFiltersResponse listFilters(ListFiltersRequest listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists all filters that belong to a given dataset group.
listFiltersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListFiltersRequest.builder()
listFiltersRequest - A Consumer that will call methods on ListFiltersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFiltersIterable listFiltersPaginator(ListFiltersRequest listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists all filters that belong to a given dataset group.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listFiltersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFiltersIterable listFiltersPaginator(Consumer<ListFiltersRequest.Builder> listFiltersRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists all filters that belong to a given dataset group.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListFiltersIterable responses = client.listFiltersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListFiltersRequest.builder()
listFiltersRequest - A Consumer that will call methods on ListFiltersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMetricAttributionMetricsResponse listMetricAttributionMetrics(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists the metrics for the metric attribution.
listMetricAttributionMetricsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMetricAttributionMetricsRequest.builder()
listMetricAttributionMetricsRequest - A Consumer that will call methods on ListMetricAttributionMetricsRequest.Builder to create
a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMetricAttributionMetricsIterable listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists the metrics for the metric attribution.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client.listMetricAttributionMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listMetricAttributionMetricsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMetricAttributionMetricsIterable listMetricAttributionMetricsPaginator(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists the metrics for the metric attribution.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsIterable responses = client.listMetricAttributionMetricsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListMetricAttributionMetricsRequest.builder()
listMetricAttributionMetricsRequest - A Consumer that will call methods on ListMetricAttributionMetricsRequest.Builder to create
a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMetricAttributionsResponse listMetricAttributions(ListMetricAttributionsRequest listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists metric attributions.
listMetricAttributionsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListMetricAttributionsRequest.builder()
listMetricAttributionsRequest - A Consumer that will call methods on ListMetricAttributionsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMetricAttributionsIterable listMetricAttributionsPaginator(ListMetricAttributionsRequest listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists metric attributions.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client.listMetricAttributionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listMetricAttributionsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMetricAttributionsIterable listMetricAttributionsPaginator(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest) throws InvalidInputException, InvalidNextTokenException, AwsServiceException, SdkClientException, PersonalizeException
Lists metric attributions.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsIterable responses = client.listMetricAttributionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListMetricAttributionsRequest.builder()
listMetricAttributionsRequest - A Consumer that will call methods on ListMetricAttributionsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
listRecipesRequest - InvalidNextTokenException - The token is not valid.InvalidInputException - Provide a valid value for the field or parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListRecipesRequest.builder()
listRecipesRequest - A Consumer that will call methods on ListRecipesRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.InvalidInputException - Provide a valid value for the field or parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecipesIterable listRecipesPaginator(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).
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listRecipesRequest - InvalidNextTokenException - The token is not valid.InvalidInputException - Provide a valid value for the field or parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecipesIterable listRecipesPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListRecipesIterable responses = client.listRecipesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListRecipesRequest.builder()
listRecipesRequest - A Consumer that will call methods on ListRecipesRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.InvalidInputException - Provide a valid value for the field or parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listRecommendersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListRecommendersRequest.builder()
listRecommendersRequest - A Consumer that will call methods on ListRecommendersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecommendersIterable listRecommendersPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listRecommendersRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRecommendersIterable listRecommendersPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListRecommendersIterable responses = client.listRecommendersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListRecommendersRequest.builder()
listRecommendersRequest - A Consumer that will call methods on ListRecommendersRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listSchemasRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListSchemasRequest.builder()
listSchemasRequest - A Consumer that will call methods on ListSchemasRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchemasIterable listSchemasPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listSchemasRequest - InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSchemasIterable listSchemasPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListSchemasIterable responses = client.listSchemasPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListSchemasRequest.builder()
listSchemasRequest - A Consumer that will call methods on ListSchemasRequest.Builder to create a request.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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).
listSolutionVersionsRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListSolutionVersionsRequest.builder()
listSolutionVersionsRequest - A Consumer that will call methods on ListSolutionVersionsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionVersionsIterable listSolutionVersionsPaginator(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).
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listSolutionVersionsRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionVersionsIterable listSolutionVersionsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsIterable responses = client.listSolutionVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListSolutionVersionsRequest.builder()
listSolutionVersionsRequest - A Consumer that will call methods on ListSolutionVersionsRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listSolutionsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListSolutionsRequest.builder()
listSolutionsRequest - A Consumer that will call methods on ListSolutionsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionsIterable listSolutionsPaginator(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.
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 Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listSolutionsRequest - InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListSolutionsIterable listSolutionsPaginator(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 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 Stream
software.amazon.awssdk.services.personalize.paginators.ListSolutionsIterable responses = client.listSolutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListSolutionsRequest.builder()
listSolutionsRequest - A Consumer that will call methods on ListSolutionsRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.InvalidNextTokenException - The token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Get a list of tags attached to a resource.
listTagsForResourceRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
startRecommenderRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartRecommenderRequest.builder()
startRecommenderRequest - A Consumer that will call methods on StartRecommenderRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
stopRecommenderRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StopRecommenderRequest.builder()
stopRecommenderRequest - A Consumer that will call methods on StopRecommenderRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
stopSolutionVersionCreationRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StopSolutionVersionCreationRequest.builder()
stopSolutionVersionCreationRequest - A Consumer that will call methods on StopSolutionVersionCreationRequest.Builder to create
a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidInputException, ResourceNotFoundException, TooManyTagsException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, PersonalizeException
Add a list of tags to a resource.
tagResourceRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.TooManyTagsException - You have exceeded the maximum number of tags you can apply to this resource.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of requests per second has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidInputException, ResourceNotFoundException, TooManyTagKeysException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Remove tags that are attached to a resource.
untagResourceRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.TooManyTagKeysException - The request contains more tag keys than can be associated with a resource (50 tag keys per resource).ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.TooManyTagKeysException - The request contains more tag keys than can be associated with a resource (50 tag keys per resource).ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCampaignResponse updateCampaign(UpdateCampaignRequest updateCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The campaign will use the
previous solution version and campaign configuration to generate recommendations until the latest campaign update
status is Active.
For more information on campaigns, see CreateCampaign.
updateCampaignRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateCampaignResponse updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, PersonalizeException
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.
You can still get recommendations from a campaign while an update is in progress. The campaign will use the
previous solution version and campaign configuration to generate recommendations until the latest campaign update
status is Active.
For more information on campaigns, see CreateCampaign.
This is a convenience which creates an instance of the UpdateCampaignRequest.Builder avoiding the need to
create one manually via UpdateCampaignRequest.builder()
updateCampaignRequest - A Consumer that will call methods on UpdateCampaignRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMetricAttributionResponse updateMetricAttribution(UpdateMetricAttributionRequest updateMetricAttributionRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, PersonalizeException
Updates a metric attribution.
updateMetricAttributionRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateMetricAttributionRequest.builder()
updateMetricAttributionRequest - A Consumer that will call methods on UpdateMetricAttributionRequest.Builder to create a
request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.ResourceAlreadyExistsException - The specified resource already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateRecommenderRequest - InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateRecommenderRequest.builder()
updateRecommenderRequest - A Consumer that will call methods on UpdateRecommenderRequest.Builder to create a request.InvalidInputException - Provide a valid value for the field or parameter.ResourceNotFoundException - Could not find the specified resource.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.PersonalizeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic PersonalizeClient create()
PersonalizeClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PersonalizeClientBuilder builder()
PersonalizeClient.static ServiceMetadata serviceMetadata()
default PersonalizeServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.