@Generated(value="software.amazon.awssdk:codegen") public interface PersonalizeAsyncClient extends SdkClient
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 PersonalizeAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
PersonalizeAsyncClient. |
static PersonalizeAsyncClient |
create()
Create a
PersonalizeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateBatchInferenceJobResponse> |
createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)
Creates a batch inference job.
|
default CompletableFuture<CreateBatchInferenceJobResponse> |
createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)
Creates a batch inference job.
|
default CompletableFuture<CreateCampaignResponse> |
createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
Creates a campaign by deploying a solution version.
|
default CompletableFuture<CreateCampaignResponse> |
createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a campaign by deploying a solution version.
|
default CompletableFuture<CreateDatasetResponse> |
createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
Creates an empty dataset and adds it to the specified dataset group.
|
default CompletableFuture<CreateDatasetResponse> |
createDataset(CreateDatasetRequest createDatasetRequest)
Creates an empty dataset and adds it to the specified dataset group.
|
default CompletableFuture<CreateDatasetGroupResponse> |
createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)
Creates an empty dataset group.
|
default CompletableFuture<CreateDatasetGroupResponse> |
createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)
Creates an empty dataset group.
|
default CompletableFuture<CreateDatasetImportJobResponse> |
createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest)
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize
dataset.
|
default CompletableFuture<CreateDatasetImportJobResponse> |
createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize
dataset.
|
default CompletableFuture<CreateEventTrackerResponse> |
createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest)
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
|
default CompletableFuture<CreateEventTrackerResponse> |
createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
|
default CompletableFuture<CreateFilterResponse> |
createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest)
Creates a recommendation filter.
|
default CompletableFuture<CreateFilterResponse> |
createFilter(CreateFilterRequest createFilterRequest)
Creates a recommendation filter.
|
default CompletableFuture<CreateSchemaResponse> |
createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)
Creates an Amazon Personalize schema from the specified schema string.
|
default CompletableFuture<CreateSchemaResponse> |
createSchema(CreateSchemaRequest createSchemaRequest)
Creates an Amazon Personalize schema from the specified schema string.
|
default CompletableFuture<CreateSolutionResponse> |
createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest)
Creates the configuration for training a model.
|
default CompletableFuture<CreateSolutionResponse> |
createSolution(CreateSolutionRequest createSolutionRequest)
Creates the configuration for training a model.
|
default CompletableFuture<CreateSolutionVersionResponse> |
createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest)
Trains or retrains an active solution.
|
default CompletableFuture<CreateSolutionVersionResponse> |
createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)
Trains or retrains an active solution.
|
default CompletableFuture<DeleteCampaignResponse> |
deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)
Removes a campaign by deleting the solution deployment.
|
default CompletableFuture<DeleteCampaignResponse> |
deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Removes a campaign by deleting the solution deployment.
|
default CompletableFuture<DeleteDatasetResponse> |
deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
Deletes a dataset.
|
default CompletableFuture<DeleteDatasetResponse> |
deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes a dataset.
|
default CompletableFuture<DeleteDatasetGroupResponse> |
deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)
Deletes a dataset group.
|
default CompletableFuture<DeleteDatasetGroupResponse> |
deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)
Deletes a dataset group.
|
default CompletableFuture<DeleteEventTrackerResponse> |
deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest)
Deletes the event tracker.
|
default CompletableFuture<DeleteEventTrackerResponse> |
deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)
Deletes the event tracker.
|
default CompletableFuture<DeleteFilterResponse> |
deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest)
Deletes a filter.
|
default CompletableFuture<DeleteFilterResponse> |
deleteFilter(DeleteFilterRequest deleteFilterRequest)
Deletes a filter.
|
default CompletableFuture<DeleteSchemaResponse> |
deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)
Deletes a schema.
|
default CompletableFuture<DeleteSchemaResponse> |
deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a schema.
|
default CompletableFuture<DeleteSolutionResponse> |
deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest)
Deletes all versions of a solution and the
Solution object itself. |
default CompletableFuture<DeleteSolutionResponse> |
deleteSolution(DeleteSolutionRequest deleteSolutionRequest)
Deletes all versions of a solution and the
Solution object itself. |
default CompletableFuture<DescribeAlgorithmResponse> |
describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)
Describes the given algorithm.
|
default CompletableFuture<DescribeAlgorithmResponse> |
describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
Describes the given algorithm.
|
default CompletableFuture<DescribeBatchInferenceJobResponse> |
describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest)
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output
configurations, and the ARN of the solution version used to generate the recommendations.
|
default CompletableFuture<DescribeBatchInferenceJobResponse> |
describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output
configurations, and the ARN of the solution version used to generate the recommendations.
|
default CompletableFuture<DescribeCampaignResponse> |
describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
Describes the given campaign, including its status.
|
default CompletableFuture<DescribeCampaignResponse> |
describeCampaign(DescribeCampaignRequest describeCampaignRequest)
Describes the given campaign, including its status.
|
default CompletableFuture<DescribeDatasetResponse> |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Describes the given dataset.
|
default CompletableFuture<DescribeDatasetResponse> |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Describes the given dataset.
|
default CompletableFuture<DescribeDatasetGroupResponse> |
describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)
Describes the given dataset group.
|
default CompletableFuture<DescribeDatasetGroupResponse> |
describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)
Describes the given dataset group.
|
default CompletableFuture<DescribeDatasetImportJobResponse> |
describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
|
default CompletableFuture<DescribeDatasetImportJobResponse> |
describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
|
default CompletableFuture<DescribeEventTrackerResponse> |
describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)
Describes an event tracker.
|
default CompletableFuture<DescribeEventTrackerResponse> |
describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)
Describes an event tracker.
|
default CompletableFuture<DescribeFeatureTransformationResponse> |
describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)
Describes the given feature transformation.
|
default CompletableFuture<DescribeFeatureTransformationResponse> |
describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)
Describes the given feature transformation.
|
default CompletableFuture<DescribeFilterResponse> |
describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)
Describes a filter's properties.
|
default CompletableFuture<DescribeFilterResponse> |
describeFilter(DescribeFilterRequest describeFilterRequest)
Describes a filter's properties.
|
default CompletableFuture<DescribeRecipeResponse> |
describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)
Describes a recipe.
|
default CompletableFuture<DescribeRecipeResponse> |
describeRecipe(DescribeRecipeRequest describeRecipeRequest)
Describes a recipe.
|
default CompletableFuture<DescribeSchemaResponse> |
describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)
Describes a schema.
|
default CompletableFuture<DescribeSchemaResponse> |
describeSchema(DescribeSchemaRequest describeSchemaRequest)
Describes a schema.
|
default CompletableFuture<DescribeSolutionResponse> |
describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)
Describes a solution.
|
default CompletableFuture<DescribeSolutionResponse> |
describeSolution(DescribeSolutionRequest describeSolutionRequest)
Describes a solution.
|
default CompletableFuture<DescribeSolutionVersionResponse> |
describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)
Describes a specific version of a solution.
|
default CompletableFuture<DescribeSolutionVersionResponse> |
describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)
Describes a specific version of a solution.
|
default CompletableFuture<GetSolutionMetricsResponse> |
getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
|
default CompletableFuture<GetSolutionMetricsResponse> |
getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
|
default CompletableFuture<ListBatchInferenceJobsResponse> |
listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default CompletableFuture<ListBatchInferenceJobsResponse> |
listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsPublisher |
listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default ListBatchInferenceJobsPublisher |
listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
|
default CompletableFuture<ListCampaignsResponse> |
listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default CompletableFuture<ListCampaignsResponse> |
listCampaigns(ListCampaignsRequest listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default ListCampaignsPublisher |
listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default ListCampaignsPublisher |
listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
Returns a list of campaigns that use the given solution.
|
default CompletableFuture<ListDatasetGroupsResponse> |
listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default CompletableFuture<ListDatasetGroupsResponse> |
listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default ListDatasetGroupsPublisher |
listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default ListDatasetGroupsPublisher |
listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups.
|
default CompletableFuture<ListDatasetImportJobsResponse> |
listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default CompletableFuture<ListDatasetImportJobsResponse> |
listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetImportJobsPublisher |
listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default ListDatasetImportJobsPublisher |
listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs that use the given dataset.
|
default CompletableFuture<ListDatasetsResponse> |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default CompletableFuture<ListDatasetsResponse> |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default ListDatasetsPublisher |
listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default ListDatasetsPublisher |
listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
Returns the list of datasets contained in the given dataset group.
|
default CompletableFuture<ListEventTrackersResponse> |
listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default CompletableFuture<ListEventTrackersResponse> |
listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default ListEventTrackersPublisher |
listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default ListEventTrackersPublisher |
listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)
Returns the list of event trackers associated with the account.
|
default CompletableFuture<ListFiltersResponse> |
listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest)
Lists all filters that belong to a given dataset group.
|
default CompletableFuture<ListFiltersResponse> |
listFilters(ListFiltersRequest listFiltersRequest)
Lists all filters that belong to a given dataset group.
|
default CompletableFuture<ListRecipesResponse> |
listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest)
Returns a list of available recipes.
|
default CompletableFuture<ListRecipesResponse> |
listRecipes(ListRecipesRequest listRecipesRequest)
Returns a list of available recipes.
|
default ListRecipesPublisher |
listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest)
Returns a list of available recipes.
|
default ListRecipesPublisher |
listRecipesPaginator(ListRecipesRequest listRecipesRequest)
Returns a list of available recipes.
|
default CompletableFuture<ListSchemasResponse> |
listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest)
Returns the list of schemas associated with the account.
|
default CompletableFuture<ListSchemasResponse> |
listSchemas(ListSchemasRequest listSchemasRequest)
Returns the list of schemas associated with the account.
|
default ListSchemasPublisher |
listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest)
Returns the list of schemas associated with the account.
|
default ListSchemasPublisher |
listSchemasPaginator(ListSchemasRequest listSchemasRequest)
Returns the list of schemas associated with the account.
|
default CompletableFuture<ListSolutionsResponse> |
listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default CompletableFuture<ListSolutionsResponse> |
listSolutions(ListSolutionsRequest listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionsPublisher |
listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default ListSolutionsPublisher |
listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)
Returns a list of solutions that use the given dataset group.
|
default CompletableFuture<ListSolutionVersionsResponse> |
listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default CompletableFuture<ListSolutionVersionsResponse> |
listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default ListSolutionVersionsPublisher |
listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default ListSolutionVersionsPublisher |
listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)
Returns a list of solution versions for the given solution.
|
default CompletableFuture<UpdateCampaignResponse> |
updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter. |
default CompletableFuture<UpdateCampaignResponse> |
updateCampaign(UpdateCampaignRequest updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static PersonalizeAsyncClient create()
PersonalizeAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PersonalizeAsyncClientBuilder builder()
PersonalizeAsyncClient.default CompletableFuture<CreateBatchInferenceJobResponse> createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)
Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
createBatchInferenceJobRequest - default CompletableFuture<CreateBatchInferenceJobResponse> createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)
Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
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.default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A transaction is a single GetRecommendations or GetPersonalizedRanking call.
Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon
Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned
capacity up and down, but never below minProvisionedTPS. There's a short time delay while the
capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the
minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for
recommendations.
Related APIs
createCampaignRequest - default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)
Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A transaction is a single GetRecommendations or GetPersonalizedRanking call.
Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon
Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned
capacity up and down, but never below minProvisionedTPS. There's a short time delay while the
capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the
minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for
recommendations.
Related APIs
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.default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest)
Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
There are three types of datasets:
Interactions
Items
Users
Each dataset type has an associated schema with required field types. Only the Interactions dataset
is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
createDatasetRequest - default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
There are three types of datasets:
Interactions
Items
Users
Each dataset type has an associated schema with required field types. Only the Interactions dataset
is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
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.default CompletableFuture<CreateDatasetGroupResponse> createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)
Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
To train a model (create a solution), a dataset group that contains an Interactions dataset is
required. Call CreateDataset to add a dataset to the group.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED,
the response includes a failureReason key, which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset
to the group.
You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS 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 - default CompletableFuture<CreateDatasetGroupResponse> createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)
Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
To train a model (create a solution), a dataset group that contains an Interactions dataset is
required. Call CreateDataset to add a dataset to the group.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED,
the response includes a failureReason key, which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset
to the group.
You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS 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.default CompletableFuture<CreateDatasetImportJobResponse> createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.
The dataset import job replaces any existing data in the dataset that you imported in bulk.
Status
A dataset import job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name
(ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status
shows as CREATE FAILED, the response includes a failureReason key, which describes why the job
failed.
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
createDatasetImportJobRequest - default CompletableFuture<CreateDatasetImportJobResponse> createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest)
Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.
The dataset import job replaces any existing data in the dataset that you imported in bulk.
Status
A dataset import job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name
(ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status
shows as CREATE FAILED, the response includes a failureReason key, which describes why the job
failed.
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
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.default CompletableFuture<CreateEventTrackerResponse> createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
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 - default CompletableFuture<CreateEventTrackerResponse> createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest)
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
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.default CompletableFuture<CreateFilterResponse> createFilter(CreateFilterRequest createFilterRequest)
Creates a recommendation filter. For more information, see filter.
createFilterRequest - default CompletableFuture<CreateFilterResponse> createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest)
Creates a recommendation filter. For more information, see filter.
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.default CompletableFuture<CreateSchemaResponse> createSchema(CreateSchemaRequest createSchemaRequest)
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. You specify a schema when you call CreateDataset.
Related APIs
createSchemaRequest - default CompletableFuture<CreateSchemaResponse> createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)
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. 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.default CompletableFuture<CreateSolutionResponse> createSolution(CreateSolutionRequest createSolutionRequest)
Creates the configuration for training a model. A trained model is known as a solution. After the configuration
is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every
time you call CreateSolutionVersion, a new version of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the
dataset group that you provide in the request. A recipe specifies the training algorithm and a feature
transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you
can specify performAutoML and Amazon Personalize will analyze your data and select the optimum
USER_PERSONALIZATION recipe for you.
Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter
optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before
calling CreateSolutionVersion.
Related APIs
createSolutionRequest - default CompletableFuture<CreateSolutionResponse> createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest)
Creates the configuration for training a model. A trained model is known as a solution. After the configuration
is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every
time you call CreateSolutionVersion, a new version of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the
dataset group that you provide in the request. A recipe specifies the training algorithm and a feature
transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you
can specify performAutoML and Amazon Personalize will analyze your data and select the optimum
USER_PERSONALIZATION recipe for you.
Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter
optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before
calling CreateSolutionVersion.
Related APIs
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.default CompletableFuture<CreateSolutionVersionResponse> createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)
Trains or retrains an active solution. A solution is created using the CreateSolution operation and must
be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is
created every time you call this operation.
Status
A solution version can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
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 - default CompletableFuture<CreateSolutionVersionResponse> createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest)
Trains or retrains an active solution. A solution is created using the CreateSolution operation and must
be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is
created every time you call this operation.
Status
A solution version can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
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.default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
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 more information on campaigns, see CreateCampaign.
deleteCampaignRequest - default CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)
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 more information on 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.default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
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 - default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
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.default CompletableFuture<DeleteDatasetGroupResponse> deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)
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 - default CompletableFuture<DeleteDatasetGroupResponse> deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)
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.default CompletableFuture<DeleteEventTrackerResponse> deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)
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 - default CompletableFuture<DeleteEventTrackerResponse> deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest)
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.default CompletableFuture<DeleteFilterResponse> deleteFilter(DeleteFilterRequest deleteFilterRequest)
Deletes a filter.
deleteFilterRequest - default CompletableFuture<DeleteFilterResponse> deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest)
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.default CompletableFuture<DeleteSchemaResponse> deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
deleteSchemaRequest - default CompletableFuture<DeleteSchemaResponse> deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)
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.default CompletableFuture<DeleteSolutionResponse> deleteSolution(DeleteSolutionRequest deleteSolutionRequest)
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 - default CompletableFuture<DeleteSolutionResponse> deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest)
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.default CompletableFuture<DescribeAlgorithmResponse> describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
Describes the given algorithm.
describeAlgorithmRequest - default CompletableFuture<DescribeAlgorithmResponse> describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)
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.default CompletableFuture<DescribeBatchInferenceJobResponse> describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
describeBatchInferenceJobRequest - default CompletableFuture<DescribeBatchInferenceJobResponse> describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest)
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
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.default CompletableFuture<DescribeCampaignResponse> describeCampaign(DescribeCampaignRequest describeCampaignRequest)
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 - default CompletableFuture<DescribeCampaignResponse> describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)
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.default CompletableFuture<DescribeDatasetResponse> describeDataset(DescribeDatasetRequest describeDatasetRequest)
Describes the given dataset. For more information on datasets, see CreateDataset.
describeDatasetRequest - default CompletableFuture<DescribeDatasetResponse> describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
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.default CompletableFuture<DescribeDatasetGroupResponse> describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
describeDatasetGroupRequest - default CompletableFuture<DescribeDatasetGroupResponse> describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)
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.default CompletableFuture<DescribeDatasetImportJobResponse> describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
describeDatasetImportJobRequest - default CompletableFuture<DescribeDatasetImportJobResponse> describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)
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.default CompletableFuture<DescribeEventTrackerResponse> describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)
Describes an event tracker. The response includes the trackingId and status of the
event tracker. For more information on event trackers, see CreateEventTracker.
describeEventTrackerRequest - default CompletableFuture<DescribeEventTrackerResponse> describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)
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.default CompletableFuture<DescribeFeatureTransformationResponse> describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)
Describes the given feature transformation.
describeFeatureTransformationRequest - default CompletableFuture<DescribeFeatureTransformationResponse> describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)
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.default CompletableFuture<DescribeFilterResponse> describeFilter(DescribeFilterRequest describeFilterRequest)
Describes a filter's properties.
describeFilterRequest - default CompletableFuture<DescribeFilterResponse> describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)
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.default CompletableFuture<DescribeRecipeResponse> describeRecipe(DescribeRecipeRequest describeRecipeRequest)
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 - default CompletableFuture<DescribeRecipeResponse> describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)
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.default CompletableFuture<DescribeSchemaResponse> describeSchema(DescribeSchemaRequest describeSchemaRequest)
Describes a schema. For more information on schemas, see CreateSchema.
describeSchemaRequest - default CompletableFuture<DescribeSchemaResponse> describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)
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.default CompletableFuture<DescribeSolutionResponse> describeSolution(DescribeSolutionRequest describeSolutionRequest)
Describes a solution. For more information on solutions, see CreateSolution.
describeSolutionRequest - default CompletableFuture<DescribeSolutionResponse> describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)
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.default CompletableFuture<DescribeSolutionVersionResponse> describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)
Describes a specific version of a solution. For more information on solutions, see CreateSolution.
describeSolutionVersionRequest - default CompletableFuture<DescribeSolutionVersionResponse> describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)
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.default CompletableFuture<GetSolutionMetricsResponse> getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)
Gets the metrics for the specified solution version.
getSolutionMetricsRequest - default CompletableFuture<GetSolutionMetricsResponse> getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)
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.default CompletableFuture<ListBatchInferenceJobsResponse> listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
listBatchInferenceJobsRequest - default CompletableFuture<ListBatchInferenceJobsResponse> listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
Gets a list of the batch inference jobs that have been performed off of a solution version.
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.default ListBatchInferenceJobsPublisher listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListBatchInferenceJobsPublisher listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest)
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 - default CompletableFuture<ListCampaignsResponse> listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
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.default ListCampaignsPublisher listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListCampaignsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListCampaignsPublisher listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListCampaignsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListDatasetGroupsResponse> listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)
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 - default CompletableFuture<ListDatasetGroupsResponse> listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
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.default ListDatasetGroupsPublisher listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListDatasetGroupsPublisher listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListDatasetImportJobsResponse> listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
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 - default CompletableFuture<ListDatasetImportJobsResponse> listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
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.default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest)
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 - default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
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.default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListDatasetsPublisher listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListEventTrackersResponse> listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)
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 - default CompletableFuture<ListEventTrackersResponse> listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)
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.default ListEventTrackersPublisher listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListEventTrackersPublisher listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListFiltersResponse> listFilters(ListFiltersRequest listFiltersRequest)
Lists all filters that belong to a given dataset group.
listFiltersRequest - default CompletableFuture<ListFiltersResponse> listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest)
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.default CompletableFuture<ListRecipesResponse> listRecipes(ListRecipesRequest listRecipesRequest)
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
listRecipesRequest - default CompletableFuture<ListRecipesResponse> listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest)
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.default ListRecipesPublisher listRecipesPaginator(ListRecipesRequest listRecipesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListRecipesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListRecipesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListRecipesPublisher listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListRecipesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListRecipesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListSchemasResponse> listSchemas(ListSchemasRequest listSchemasRequest)
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 - default CompletableFuture<ListSchemasResponse> listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest)
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.default ListSchemasPublisher listSchemasPaginator(ListSchemasRequest listSchemasRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSchemasResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListSchemasResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListSchemasPublisher listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSchemasResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListSchemasResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListSolutionVersionsResponse> listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)
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). For more information on solutions, see CreateSolution.
listSolutionVersionsRequest - default CompletableFuture<ListSolutionVersionsResponse> listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)
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). For more information on solutions, see CreateSolution.
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.default ListSolutionVersionsPublisher listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)
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). For more information on solutions, see CreateSolution.
This is a variant of
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListSolutionVersionsPublisher listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)
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). For more information on solutions, see CreateSolution.
This is a variant of
listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListSolutionsResponse> listSolutions(ListSolutionsRequest listSolutionsRequest)
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 - default CompletableFuture<ListSolutionsResponse> listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)
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.default ListSolutionsPublisher listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListSolutionsPublisher listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<UpdateCampaignResponse> updateCampaign(UpdateCampaignRequest updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.
You must wait until the status of the updated campaign is ACTIVE before asking the
campaign for recommendations.
For more information on campaigns, see CreateCampaign.
updateCampaignRequest - default CompletableFuture<UpdateCampaignResponse> updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)
Updates a campaign by either deploying a new solution or changing the value of the campaign's
minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.
You must wait until the status of the updated campaign is ACTIVE before asking the
campaign for recommendations.
For more information on campaigns, see CreateCampaign.
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.