software.amazon.awssdk.services.personalize.PersonalizeAsyncClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.personalize;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.personalize.model.CreateBatchInferenceJobRequest;
import software.amazon.awssdk.services.personalize.model.CreateBatchInferenceJobResponse;
import software.amazon.awssdk.services.personalize.model.CreateBatchSegmentJobRequest;
import software.amazon.awssdk.services.personalize.model.CreateBatchSegmentJobResponse;
import software.amazon.awssdk.services.personalize.model.CreateCampaignRequest;
import software.amazon.awssdk.services.personalize.model.CreateCampaignResponse;
import software.amazon.awssdk.services.personalize.model.CreateDatasetExportJobRequest;
import software.amazon.awssdk.services.personalize.model.CreateDatasetExportJobResponse;
import software.amazon.awssdk.services.personalize.model.CreateDatasetGroupRequest;
import software.amazon.awssdk.services.personalize.model.CreateDatasetGroupResponse;
import software.amazon.awssdk.services.personalize.model.CreateDatasetImportJobRequest;
import software.amazon.awssdk.services.personalize.model.CreateDatasetImportJobResponse;
import software.amazon.awssdk.services.personalize.model.CreateDatasetRequest;
import software.amazon.awssdk.services.personalize.model.CreateDatasetResponse;
import software.amazon.awssdk.services.personalize.model.CreateEventTrackerRequest;
import software.amazon.awssdk.services.personalize.model.CreateEventTrackerResponse;
import software.amazon.awssdk.services.personalize.model.CreateFilterRequest;
import software.amazon.awssdk.services.personalize.model.CreateFilterResponse;
import software.amazon.awssdk.services.personalize.model.CreateMetricAttributionRequest;
import software.amazon.awssdk.services.personalize.model.CreateMetricAttributionResponse;
import software.amazon.awssdk.services.personalize.model.CreateRecommenderRequest;
import software.amazon.awssdk.services.personalize.model.CreateRecommenderResponse;
import software.amazon.awssdk.services.personalize.model.CreateSchemaRequest;
import software.amazon.awssdk.services.personalize.model.CreateSchemaResponse;
import software.amazon.awssdk.services.personalize.model.CreateSolutionRequest;
import software.amazon.awssdk.services.personalize.model.CreateSolutionResponse;
import software.amazon.awssdk.services.personalize.model.CreateSolutionVersionRequest;
import software.amazon.awssdk.services.personalize.model.CreateSolutionVersionResponse;
import software.amazon.awssdk.services.personalize.model.DeleteCampaignRequest;
import software.amazon.awssdk.services.personalize.model.DeleteCampaignResponse;
import software.amazon.awssdk.services.personalize.model.DeleteDatasetGroupRequest;
import software.amazon.awssdk.services.personalize.model.DeleteDatasetGroupResponse;
import software.amazon.awssdk.services.personalize.model.DeleteDatasetRequest;
import software.amazon.awssdk.services.personalize.model.DeleteDatasetResponse;
import software.amazon.awssdk.services.personalize.model.DeleteEventTrackerRequest;
import software.amazon.awssdk.services.personalize.model.DeleteEventTrackerResponse;
import software.amazon.awssdk.services.personalize.model.DeleteFilterRequest;
import software.amazon.awssdk.services.personalize.model.DeleteFilterResponse;
import software.amazon.awssdk.services.personalize.model.DeleteMetricAttributionRequest;
import software.amazon.awssdk.services.personalize.model.DeleteMetricAttributionResponse;
import software.amazon.awssdk.services.personalize.model.DeleteRecommenderRequest;
import software.amazon.awssdk.services.personalize.model.DeleteRecommenderResponse;
import software.amazon.awssdk.services.personalize.model.DeleteSchemaRequest;
import software.amazon.awssdk.services.personalize.model.DeleteSchemaResponse;
import software.amazon.awssdk.services.personalize.model.DeleteSolutionRequest;
import software.amazon.awssdk.services.personalize.model.DeleteSolutionResponse;
import software.amazon.awssdk.services.personalize.model.DescribeAlgorithmRequest;
import software.amazon.awssdk.services.personalize.model.DescribeAlgorithmResponse;
import software.amazon.awssdk.services.personalize.model.DescribeBatchInferenceJobRequest;
import software.amazon.awssdk.services.personalize.model.DescribeBatchInferenceJobResponse;
import software.amazon.awssdk.services.personalize.model.DescribeBatchSegmentJobRequest;
import software.amazon.awssdk.services.personalize.model.DescribeBatchSegmentJobResponse;
import software.amazon.awssdk.services.personalize.model.DescribeCampaignRequest;
import software.amazon.awssdk.services.personalize.model.DescribeCampaignResponse;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetExportJobRequest;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetExportJobResponse;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetGroupRequest;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetGroupResponse;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetImportJobRequest;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetImportJobResponse;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetRequest;
import software.amazon.awssdk.services.personalize.model.DescribeDatasetResponse;
import software.amazon.awssdk.services.personalize.model.DescribeEventTrackerRequest;
import software.amazon.awssdk.services.personalize.model.DescribeEventTrackerResponse;
import software.amazon.awssdk.services.personalize.model.DescribeFeatureTransformationRequest;
import software.amazon.awssdk.services.personalize.model.DescribeFeatureTransformationResponse;
import software.amazon.awssdk.services.personalize.model.DescribeFilterRequest;
import software.amazon.awssdk.services.personalize.model.DescribeFilterResponse;
import software.amazon.awssdk.services.personalize.model.DescribeMetricAttributionRequest;
import software.amazon.awssdk.services.personalize.model.DescribeMetricAttributionResponse;
import software.amazon.awssdk.services.personalize.model.DescribeRecipeRequest;
import software.amazon.awssdk.services.personalize.model.DescribeRecipeResponse;
import software.amazon.awssdk.services.personalize.model.DescribeRecommenderRequest;
import software.amazon.awssdk.services.personalize.model.DescribeRecommenderResponse;
import software.amazon.awssdk.services.personalize.model.DescribeSchemaRequest;
import software.amazon.awssdk.services.personalize.model.DescribeSchemaResponse;
import software.amazon.awssdk.services.personalize.model.DescribeSolutionRequest;
import software.amazon.awssdk.services.personalize.model.DescribeSolutionResponse;
import software.amazon.awssdk.services.personalize.model.DescribeSolutionVersionRequest;
import software.amazon.awssdk.services.personalize.model.DescribeSolutionVersionResponse;
import software.amazon.awssdk.services.personalize.model.GetSolutionMetricsRequest;
import software.amazon.awssdk.services.personalize.model.GetSolutionMetricsResponse;
import software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest;
import software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse;
import software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest;
import software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse;
import software.amazon.awssdk.services.personalize.model.ListCampaignsRequest;
import software.amazon.awssdk.services.personalize.model.ListCampaignsResponse;
import software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest;
import software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse;
import software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest;
import software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse;
import software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest;
import software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse;
import software.amazon.awssdk.services.personalize.model.ListDatasetsRequest;
import software.amazon.awssdk.services.personalize.model.ListDatasetsResponse;
import software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest;
import software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse;
import software.amazon.awssdk.services.personalize.model.ListFiltersRequest;
import software.amazon.awssdk.services.personalize.model.ListFiltersResponse;
import software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest;
import software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse;
import software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest;
import software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse;
import software.amazon.awssdk.services.personalize.model.ListRecipesRequest;
import software.amazon.awssdk.services.personalize.model.ListRecipesResponse;
import software.amazon.awssdk.services.personalize.model.ListRecommendersRequest;
import software.amazon.awssdk.services.personalize.model.ListRecommendersResponse;
import software.amazon.awssdk.services.personalize.model.ListSchemasRequest;
import software.amazon.awssdk.services.personalize.model.ListSchemasResponse;
import software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest;
import software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse;
import software.amazon.awssdk.services.personalize.model.ListSolutionsRequest;
import software.amazon.awssdk.services.personalize.model.ListSolutionsResponse;
import software.amazon.awssdk.services.personalize.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.personalize.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.personalize.model.StartRecommenderRequest;
import software.amazon.awssdk.services.personalize.model.StartRecommenderResponse;
import software.amazon.awssdk.services.personalize.model.StopRecommenderRequest;
import software.amazon.awssdk.services.personalize.model.StopRecommenderResponse;
import software.amazon.awssdk.services.personalize.model.StopSolutionVersionCreationRequest;
import software.amazon.awssdk.services.personalize.model.StopSolutionVersionCreationResponse;
import software.amazon.awssdk.services.personalize.model.TagResourceRequest;
import software.amazon.awssdk.services.personalize.model.TagResourceResponse;
import software.amazon.awssdk.services.personalize.model.UntagResourceRequest;
import software.amazon.awssdk.services.personalize.model.UntagResourceResponse;
import software.amazon.awssdk.services.personalize.model.UpdateCampaignRequest;
import software.amazon.awssdk.services.personalize.model.UpdateCampaignResponse;
import software.amazon.awssdk.services.personalize.model.UpdateMetricAttributionRequest;
import software.amazon.awssdk.services.personalize.model.UpdateMetricAttributionResponse;
import software.amazon.awssdk.services.personalize.model.UpdateRecommenderRequest;
import software.amazon.awssdk.services.personalize.model.UpdateRecommenderResponse;
import software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher;
import software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher;
/**
* Service client for accessing Amazon Personalize asynchronously. This can be created using the static
* {@link #builder()} method.
*
*
* Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to
* customers.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface PersonalizeAsyncClient extends AwsClient {
String SERVICE_NAME = "personalize";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "personalize";
/**
*
* Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in
* JSON format. For more information, see Creating a batch
* inference job.
*
*
* @param createBatchInferenceJobRequest
* @return A Java Future containing the result of the CreateBatchInferenceJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateBatchInferenceJob
* @see AWS API Documentation
*/
default CompletableFuture createBatchInferenceJob(
CreateBatchInferenceJobRequest createBatchInferenceJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in
* JSON format. For more information, see Creating a batch
* inference job.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBatchInferenceJobRequest.Builder} avoiding
* the need to create one manually via {@link CreateBatchInferenceJobRequest#builder()}
*
*
* @param createBatchInferenceJobRequest
* A {@link Consumer} that will call methods on {@link CreateBatchInferenceJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateBatchInferenceJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateBatchInferenceJob
* @see AWS API Documentation
*/
default CompletableFuture createBatchInferenceJob(
Consumer createBatchInferenceJobRequest) {
return createBatchInferenceJob(CreateBatchInferenceJobRequest.builder().applyMutation(createBatchInferenceJobRequest)
.build());
}
/**
*
* Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON
* format. For more information, see Getting batch recommendations
* and user segments.
*
*
* @param createBatchSegmentJobRequest
* @return A Java Future containing the result of the CreateBatchSegmentJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateBatchSegmentJob
* @see AWS API Documentation
*/
default CompletableFuture createBatchSegmentJob(
CreateBatchSegmentJobRequest createBatchSegmentJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON
* format. For more information, see Getting batch recommendations
* and user segments.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBatchSegmentJobRequest.Builder} avoiding the
* need to create one manually via {@link CreateBatchSegmentJobRequest#builder()}
*
*
* @param createBatchSegmentJobRequest
* A {@link Consumer} that will call methods on {@link CreateBatchSegmentJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateBatchSegmentJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateBatchSegmentJob
* @see AWS API Documentation
*/
default CompletableFuture createBatchSegmentJob(
Consumer createBatchSegmentJobRequest) {
return createBatchSegmentJob(CreateBatchSegmentJobRequest.builder().applyMutation(createBatchSegmentJobRequest).build());
}
/**
*
* Creates a campaign that deploys a solution version. When a client calls the GetRecommendations
* and
* GetPersonalizedRanking APIs, a campaign is specified in the request.
*
*
* Minimum Provisioned TPS and Auto-Scaling
*
*
* A transaction is a single GetRecommendations or GetPersonalizedRanking call.
* Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
* provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon
* Personalize, and thus, the minimum billing charge.
*
*
* If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned
* capacity up and down, but never below minProvisionedTPS. There's a short time delay while the
* capacity is increased that might cause loss of transactions.
*
*
* The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
* either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
* minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the
* minProvisionedTPS as necessary.
*
*
* Status
*
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* To get the campaign status, call DescribeCampaign.
*
*
*
* Wait until the status of the campaign is ACTIVE before asking the campaign for
* recommendations.
*
*
*
* Related APIs
*
*
* -
*
* ListCampaigns
*
*
* -
*
* DescribeCampaign
*
*
* -
*
* UpdateCampaign
*
*
* -
*
* DeleteCampaign
*
*
*
*
* @param createCampaignRequest
* @return A Java Future containing the result of the CreateCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture createCampaign(CreateCampaignRequest createCampaignRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a campaign that deploys a solution version. When a client calls the GetRecommendations
* and
* GetPersonalizedRanking APIs, a campaign is specified in the request.
*
*
* Minimum Provisioned TPS and Auto-Scaling
*
*
* A transaction is a single GetRecommendations or GetPersonalizedRanking call.
* Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum
* provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon
* Personalize, and thus, the minimum billing charge.
*
*
* If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned
* capacity up and down, but never below minProvisionedTPS. There's a short time delay while the
* capacity is increased that might cause loss of transactions.
*
*
* The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of
* either the minimum provisioned TPS or the actual TPS. We recommend starting with a low
* minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the
* minProvisionedTPS as necessary.
*
*
* Status
*
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* To get the campaign status, call DescribeCampaign.
*
*
*
* Wait until the status of the campaign is ACTIVE before asking the campaign for
* recommendations.
*
*
*
* Related APIs
*
*
* -
*
* ListCampaigns
*
*
* -
*
* DescribeCampaign
*
*
* -
*
* UpdateCampaign
*
*
* -
*
* DeleteCampaign
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateCampaignRequest.Builder} avoiding the need to
* create one manually via {@link CreateCampaignRequest#builder()}
*
*
* @param createCampaignRequest
* A {@link Consumer} that will call methods on {@link CreateCampaignRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture createCampaign(Consumer createCampaignRequest) {
return createCampaign(CreateCampaignRequest.builder().applyMutation(createCampaignRequest).build());
}
/**
*
* 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
*
*
* -
*
*
* -
*
* ListDatasets
*
*
* -
*
* DescribeDataset
*
*
* -
*
* DeleteDataset
*
*
*
*
* @param createDatasetRequest
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture createDataset(CreateDatasetRequest createDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
*
*
* -
*
*
* -
*
* ListDatasets
*
*
* -
*
* DescribeDataset
*
*
* -
*
* DeleteDataset
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetRequest.Builder} avoiding the need to
* create one manually via {@link CreateDatasetRequest#builder()}
*
*
* @param createDatasetRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture createDataset(Consumer createDatasetRequest) {
return createDataset(CreateDatasetRequest.builder().applyMutation(createDatasetRequest).build());
}
/**
*
* Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export
* the training data, you must specify an service-linked IAM role that gives Amazon Personalize
* PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon
* Personalize developer guide.
*
*
* Status
*
*
* A dataset export job can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*
* To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset
* export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a
* failureReason key, which describes why the job failed.
*
*
* @param createDatasetExportJobRequest
* @return A Java Future containing the result of the CreateDatasetExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDatasetExportJob
* @see AWS API Documentation
*/
default CompletableFuture createDatasetExportJob(
CreateDatasetExportJobRequest createDatasetExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export
* the training data, you must specify an service-linked IAM role that gives Amazon Personalize
* PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon
* Personalize developer guide.
*
*
* Status
*
*
* A dataset export job can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*
* To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset
* export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a
* failureReason key, which describes why the job failed.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetExportJobRequest.Builder} avoiding the
* need to create one manually via {@link CreateDatasetExportJobRequest#builder()}
*
*
* @param createDatasetExportJobRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDatasetExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDatasetExportJob
* @see AWS API Documentation
*/
default CompletableFuture createDatasetExportJob(
Consumer createDatasetExportJobRequest) {
return createDatasetExportJob(CreateDatasetExportJobRequest.builder().applyMutation(createDatasetExportJobRequest)
.build());
}
/**
*
* Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group
* can contain at most three datasets, one for each type of dataset:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
*
*
* A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like
* recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution
* version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom
* resources such as solutions and solution versions trained with recipes for custom use cases and deployed with
* campaigns.
*
*
* A dataset group can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING
*
*
*
*
* To get the status of the dataset group, call DescribeDatasetGroup.
* If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why
* the creation failed.
*
*
*
* You must wait until the status of the dataset group is ACTIVE before adding a dataset
* to the group.
*
*
*
* You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS
* key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
*
*
* APIs that require a dataset group ARN in the request
*
*
* -
*
* CreateDataset
*
*
* -
*
*
* -
*
* CreateSolution
*
*
*
*
* Related APIs
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param createDatasetGroupRequest
* @return A Java Future containing the result of the CreateDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDatasetGroup
* @see AWS API Documentation
*/
default CompletableFuture createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group
* can contain at most three datasets, one for each type of dataset:
*
*
* -
*
* Interactions
*
*
* -
*
* Items
*
*
* -
*
* Users
*
*
*
*
* A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like
* recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution
* version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom
* resources such as solutions and solution versions trained with recipes for custom use cases and deployed with
* campaigns.
*
*
* A dataset group can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING
*
*
*
*
* To get the status of the dataset group, call DescribeDatasetGroup.
* If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why
* the creation failed.
*
*
*
* You must wait until the status of the dataset group is ACTIVE before adding a dataset
* to the group.
*
*
*
* You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS
* key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
*
*
* APIs that require a dataset group ARN in the request
*
*
* -
*
* CreateDataset
*
*
* -
*
*
* -
*
* CreateSolution
*
*
*
*
* Related APIs
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateDatasetGroupRequest#builder()}
*
*
* @param createDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDatasetGroup
* @see AWS API Documentation
*/
default CompletableFuture createDatasetGroup(
Consumer createDatasetGroupRequest) {
return createDatasetGroup(CreateDatasetGroupRequest.builder().applyMutation(createDatasetGroupRequest).build());
}
/**
*
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize
* dataset. To allow Amazon Personalize to ACTIVE -or- CREATE FAILED
*
*
*
* To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset
* import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a
* failureReason key, which describes why the job failed.
*
*
*
* Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
*
*
*
* Related APIs
*
*
* -
*
*
* -
*
*
*
*
* @param createDatasetImportJobRequest
* @return A Java Future containing the result of the CreateDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture createDatasetImportJob(
CreateDatasetImportJobRequest createDatasetImportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize
* dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has
* permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it
* internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon
* Personalize Access to Amazon S3 Resources.
*
*
*
* By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new
* records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob
* operation.
*
*
*
* Status
*
*
* A dataset import job can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*
* To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset
* import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a
* failureReason key, which describes why the job failed.
*
*
*
* Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
*
*
*
* Related APIs
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetImportJobRequest.Builder} avoiding the
* need to create one manually via {@link CreateDatasetImportJobRequest#builder()}
*
*
* @param createDatasetImportJobRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetImportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture createDatasetImportJob(
Consumer createDatasetImportJobRequest) {
return createDatasetImportJob(CreateDatasetImportJobRequest.builder().applyMutation(createDatasetImportJobRequest)
.build());
}
/**
*
* 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
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param createEventTrackerRequest
* @return A Java Future containing the result of the CreateEventTracker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateEventTracker
* @see AWS API Documentation
*/
default CompletableFuture createEventTracker(CreateEventTrackerRequest createEventTrackerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateEventTrackerRequest.Builder} avoiding the
* need to create one manually via {@link CreateEventTrackerRequest#builder()}
*
*
* @param createEventTrackerRequest
* A {@link Consumer} that will call methods on {@link CreateEventTrackerRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateEventTracker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateEventTracker
* @see AWS API Documentation
*/
default CompletableFuture createEventTracker(
Consumer createEventTrackerRequest) {
return createEventTracker(CreateEventTrackerRequest.builder().applyMutation(createEventTrackerRequest).build());
}
/**
*
* Creates a recommendation filter. For more information, see Filtering recommendations and user
* segments.
*
*
* @param createFilterRequest
* @return A Java Future containing the result of the CreateFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateFilter
* @see AWS API
* Documentation
*/
default CompletableFuture createFilter(CreateFilterRequest createFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a recommendation filter. For more information, see Filtering recommendations and user
* segments.
*
*
*
* This is a convenience which creates an instance of the {@link CreateFilterRequest.Builder} avoiding the need to
* create one manually via {@link CreateFilterRequest#builder()}
*
*
* @param createFilterRequest
* A {@link Consumer} that will call methods on {@link CreateFilterRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateFilter
* @see AWS API
* Documentation
*/
default CompletableFuture createFilter(Consumer createFilterRequest) {
return createFilter(CreateFilterRequest.builder().applyMutation(createFilterRequest).build());
}
/**
*
* Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon
* Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For
* more information, see Measuring impact of
* recommendations.
*
*
* @param createMetricAttributionRequest
* @return A Java Future containing the result of the CreateMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceInUseException The specified resource is in use.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture createMetricAttribution(
CreateMetricAttributionRequest createMetricAttributionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon
* Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For
* more information, see Measuring impact of
* recommendations.
*
*
*
* This is a convenience which creates an instance of the {@link CreateMetricAttributionRequest.Builder} avoiding
* the need to create one manually via {@link CreateMetricAttributionRequest#builder()}
*
*
* @param createMetricAttributionRequest
* A {@link Consumer} that will call methods on {@link CreateMetricAttributionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceInUseException The specified resource is in use.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture createMetricAttribution(
Consumer createMetricAttributionRequest) {
return createMetricAttribution(CreateMetricAttributionRequest.builder().applyMutation(createMetricAttributionRequest)
.build());
}
/**
*
* Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for
* a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations
* request.
*
*
* Minimum recommendation requests per second
*
*
* When you create a recommender, you can configure the recommender's minimum recommendation requests per second.
* The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the
* baseline recommendation request throughput provisioned by Amazon Personalize. The default
* minRecommendationRequestsPerSecond is 1. A recommendation request is a single
* GetRecommendations operation. Request throughput is measured in requests per second and Amazon
* Personalize uses your requests per second to derive your requests per hour and the price of your recommender
* usage.
*
*
* If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize
* auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond
* . There's a short time delay while the capacity is increased that might cause loss of requests.
*
*
* Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or
* the actual number of requests. The actual request throughput used is calculated as the average requests/second
* within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond,
* track your usage using Amazon CloudWatch metrics, and then increase the
* minRecommendationRequestsPerSecond as necessary.
*
*
* Status
*
*
* A recommender can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* To get the recommender status, call DescribeRecommender.
*
*
*
* Wait until the status of the recommender is ACTIVE before asking the recommender for
* recommendations.
*
*
*
* Related APIs
*
*
* -
*
* ListRecommenders
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @param createRecommenderRequest
* @return A Java Future containing the result of the CreateRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture createRecommender(CreateRecommenderRequest createRecommenderRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for
* a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations
* request.
*
*
* Minimum recommendation requests per second
*
*
* When you create a recommender, you can configure the recommender's minimum recommendation requests per second.
* The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the
* baseline recommendation request throughput provisioned by Amazon Personalize. The default
* minRecommendationRequestsPerSecond is 1. A recommendation request is a single
* GetRecommendations operation. Request throughput is measured in requests per second and Amazon
* Personalize uses your requests per second to derive your requests per hour and the price of your recommender
* usage.
*
*
* If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize
* auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond
* . There's a short time delay while the capacity is increased that might cause loss of requests.
*
*
* Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or
* the actual number of requests. The actual request throughput used is calculated as the average requests/second
* within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond,
* track your usage using Amazon CloudWatch metrics, and then increase the
* minRecommendationRequestsPerSecond as necessary.
*
*
* Status
*
*
* A recommender can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* To get the recommender status, call DescribeRecommender.
*
*
*
* Wait until the status of the recommender is ACTIVE before asking the recommender for
* recommendations.
*
*
*
* Related APIs
*
*
* -
*
* ListRecommenders
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateRecommenderRequest.Builder} avoiding the need
* to create one manually via {@link CreateRecommenderRequest#builder()}
*
*
* @param createRecommenderRequest
* A {@link Consumer} that will call methods on {@link CreateRecommenderRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture createRecommender(
Consumer createRecommenderRequest) {
return createRecommender(CreateRecommenderRequest.builder().applyMutation(createRecommenderRequest).build());
}
/**
*
* Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON
* format.
*
*
* Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set
* of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide
* the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
*
*
* Related APIs
*
*
* -
*
* ListSchemas
*
*
* -
*
* DescribeSchema
*
*
* -
*
* DeleteSchema
*
*
*
*
* @param createSchemaRequest
* @return A Java Future containing the result of the CreateSchema operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateSchema
* @see AWS API
* Documentation
*/
default CompletableFuture createSchema(CreateSchemaRequest createSchemaRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON
* format.
*
*
* Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set
* of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide
* the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
*
*
* Related APIs
*
*
* -
*
* ListSchemas
*
*
* -
*
* DescribeSchema
*
*
* -
*
* DeleteSchema
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateSchemaRequest.Builder} avoiding the need to
* create one manually via {@link CreateSchemaRequest#builder()}
*
*
* @param createSchemaRequest
* A {@link Consumer} that will call methods on {@link CreateSchemaRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateSchema operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateSchema
* @see AWS API
* Documentation
*/
default CompletableFuture createSchema(Consumer createSchemaRequest) {
return createSchema(CreateSchemaRequest.builder().applyMutation(createSchemaRequest).build());
}
/**
*
* 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
*
*
* -
*
* ListSolutions
*
*
* -
*
*
* -
*
* DescribeSolution
*
*
* -
*
* DeleteSolution
*
*
*
*
* -
*
*
* -
*
*
*
*
* @param createSolutionRequest
* @return A Java Future containing the result of the CreateSolution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateSolution
* @see AWS
* API Documentation
*/
default CompletableFuture createSolution(CreateSolutionRequest createSolutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
*
*
* -
*
* ListSolutions
*
*
* -
*
*
* -
*
* DescribeSolution
*
*
* -
*
* DeleteSolution
*
*
*
*
* -
*
*
* -
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateSolutionRequest.Builder} avoiding the need to
* create one manually via {@link CreateSolutionRequest#builder()}
*
*
* @param createSolutionRequest
* A {@link Consumer} that will call methods on {@link CreateSolutionRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateSolution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateSolution
* @see AWS
* API Documentation
*/
default CompletableFuture createSolution(Consumer createSolutionRequest) {
return createSolution(CreateSolutionRequest.builder().applyMutation(createSolutionRequest).build());
}
/**
*
* Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and
* must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is
* created every time you call this operation.
*
*
* Status
*
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING
*
*
* -
*
* CREATE IN_PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
* -
*
* CREATE STOPPING
*
*
* -
*
* CREATE STOPPED
*
*
*
*
* To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.
*
*
* If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why
* the job failed.
*
*
* Related APIs
*
*
* -
*
*
* -
*
*
* -
*
* ListSolutions
*
*
* -
*
* CreateSolution
*
*
* -
*
* DescribeSolution
*
*
* -
*
* DeleteSolution
*
*
*
*
* @param createSolutionVersionRequest
* @return A Java Future containing the result of the CreateSolutionVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateSolutionVersion
* @see AWS API Documentation
*/
default CompletableFuture createSolutionVersion(
CreateSolutionVersionRequest createSolutionVersionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and
* must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is
* created every time you call this operation.
*
*
* Status
*
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING
*
*
* -
*
* CREATE IN_PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
* -
*
* CREATE STOPPING
*
*
* -
*
* CREATE STOPPED
*
*
*
*
* To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.
*
*
* If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why
* the job failed.
*
*
* Related APIs
*
*
* -
*
*
* -
*
*
* -
*
* ListSolutions
*
*
* -
*
* CreateSolution
*
*
* -
*
* DescribeSolution
*
*
* -
*
* DeleteSolution
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateSolutionVersionRequest.Builder} avoiding the
* need to create one manually via {@link CreateSolutionVersionRequest#builder()}
*
*
* @param createSolutionVersionRequest
* A {@link Consumer} that will call methods on {@link CreateSolutionVersionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateSolutionVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - ResourceInUseException The specified resource is in use.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.CreateSolutionVersion
* @see AWS API Documentation
*/
default CompletableFuture createSolutionVersion(
Consumer createSolutionVersionRequest) {
return createSolutionVersion(CreateSolutionVersionRequest.builder().applyMutation(createSolutionVersionRequest).build());
}
/**
*
* Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted
* and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations
* request. For information on creating campaigns, see CreateCampaign.
*
*
* @param deleteCampaignRequest
* @return A Java Future containing the result of the DeleteCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted
* and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations
* request. For information on creating campaigns, see CreateCampaign.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCampaignRequest.Builder} avoiding the need to
* create one manually via {@link DeleteCampaignRequest#builder()}
*
*
* @param deleteCampaignRequest
* A {@link Consumer} that will call methods on {@link DeleteCampaignRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture deleteCampaign(Consumer deleteCampaignRequest) {
return deleteCampaign(DeleteCampaignRequest.builder().applyMutation(deleteCampaignRequest).build());
}
/**
*
* 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.
*
*
* @param deleteDatasetRequest
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteDataset
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDataset(DeleteDatasetRequest deleteDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDatasetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDatasetRequest#builder()}
*
*
* @param deleteDatasetRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteDataset
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDataset(Consumer deleteDatasetRequest) {
return deleteDataset(DeleteDatasetRequest.builder().applyMutation(deleteDatasetRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param deleteDatasetGroupRequest
* @return A Java Future containing the result of the DeleteDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteDatasetGroup
* @see AWS API Documentation
*/
default CompletableFuture deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDatasetGroupRequest#builder()}
*
*
* @param deleteDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteDatasetGroup
* @see AWS API Documentation
*/
default CompletableFuture deleteDatasetGroup(
Consumer deleteDatasetGroupRequest) {
return deleteDatasetGroup(DeleteDatasetGroupRequest.builder().applyMutation(deleteDatasetGroupRequest).build());
}
/**
*
* Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For
* more information on event trackers, see CreateEventTracker.
*
*
* @param deleteEventTrackerRequest
* @return A Java Future containing the result of the DeleteEventTracker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteEventTracker
* @see AWS API Documentation
*/
default CompletableFuture deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteEventTrackerRequest.Builder} avoiding the
* need to create one manually via {@link DeleteEventTrackerRequest#builder()}
*
*
* @param deleteEventTrackerRequest
* A {@link Consumer} that will call methods on {@link DeleteEventTrackerRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteEventTracker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteEventTracker
* @see AWS API Documentation
*/
default CompletableFuture deleteEventTracker(
Consumer deleteEventTrackerRequest) {
return deleteEventTracker(DeleteEventTrackerRequest.builder().applyMutation(deleteEventTrackerRequest).build());
}
/**
*
* Deletes a filter.
*
*
* @param deleteFilterRequest
* @return A Java Future containing the result of the DeleteFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteFilter
* @see AWS API
* Documentation
*/
default CompletableFuture deleteFilter(DeleteFilterRequest deleteFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a filter.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteFilterRequest.Builder} avoiding the need to
* create one manually via {@link DeleteFilterRequest#builder()}
*
*
* @param deleteFilterRequest
* A {@link Consumer} that will call methods on {@link DeleteFilterRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteFilter
* @see AWS API
* Documentation
*/
default CompletableFuture deleteFilter(Consumer deleteFilterRequest) {
return deleteFilter(DeleteFilterRequest.builder().applyMutation(deleteFilterRequest).build());
}
/**
*
* Deletes a metric attribution.
*
*
* @param deleteMetricAttributionRequest
* @return A Java Future containing the result of the DeleteMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture deleteMetricAttribution(
DeleteMetricAttributionRequest deleteMetricAttributionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a metric attribution.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMetricAttributionRequest.Builder} avoiding
* the need to create one manually via {@link DeleteMetricAttributionRequest#builder()}
*
*
* @param deleteMetricAttributionRequest
* A {@link Consumer} that will call methods on {@link DeleteMetricAttributionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture deleteMetricAttribution(
Consumer deleteMetricAttributionRequest) {
return deleteMetricAttribution(DeleteMetricAttributionRequest.builder().applyMutation(deleteMetricAttributionRequest)
.build());
}
/**
*
* Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations
* request.
*
*
* @param deleteRecommenderRequest
* @return A Java Future containing the result of the DeleteRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations
* request.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRecommenderRequest.Builder} avoiding the need
* to create one manually via {@link DeleteRecommenderRequest#builder()}
*
*
* @param deleteRecommenderRequest
* A {@link Consumer} that will call methods on {@link DeleteRecommenderRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRecommender(
Consumer deleteRecommenderRequest) {
return deleteRecommender(DeleteRecommenderRequest.builder().applyMutation(deleteRecommenderRequest).build());
}
/**
*
* Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more
* information on schemas, see CreateSchema.
*
*
* @param deleteSchemaRequest
* @return A Java Future containing the result of the DeleteSchema operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteSchema
* @see AWS API
* Documentation
*/
default CompletableFuture deleteSchema(DeleteSchemaRequest deleteSchemaRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteSchemaRequest.Builder} avoiding the need to
* create one manually via {@link DeleteSchemaRequest#builder()}
*
*
* @param deleteSchemaRequest
* A {@link Consumer} that will call methods on {@link DeleteSchemaRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteSchema operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteSchema
* @see AWS API
* Documentation
*/
default CompletableFuture deleteSchema(Consumer deleteSchemaRequest) {
return deleteSchema(DeleteSchemaRequest.builder().applyMutation(deleteSchemaRequest).build());
}
/**
*
* 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.
*
*
* @param deleteSolutionRequest
* @return A Java Future containing the result of the DeleteSolution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteSolution
* @see AWS
* API Documentation
*/
default CompletableFuture deleteSolution(DeleteSolutionRequest deleteSolutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteSolutionRequest.Builder} avoiding the need to
* create one manually via {@link DeleteSolutionRequest#builder()}
*
*
* @param deleteSolutionRequest
* A {@link Consumer} that will call methods on {@link DeleteSolutionRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteSolution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DeleteSolution
* @see AWS
* API Documentation
*/
default CompletableFuture deleteSolution(Consumer deleteSolutionRequest) {
return deleteSolution(DeleteSolutionRequest.builder().applyMutation(deleteSolutionRequest).build());
}
/**
*
* Describes the given algorithm.
*
*
* @param describeAlgorithmRequest
* @return A Java Future containing the result of the DescribeAlgorithm operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeAlgorithm
* @see AWS
* API Documentation
*/
default CompletableFuture describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the given algorithm.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAlgorithmRequest.Builder} avoiding the need
* to create one manually via {@link DescribeAlgorithmRequest#builder()}
*
*
* @param describeAlgorithmRequest
* A {@link Consumer} that will call methods on {@link DescribeAlgorithmRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeAlgorithm operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeAlgorithm
* @see AWS
* API Documentation
*/
default CompletableFuture describeAlgorithm(
Consumer describeAlgorithmRequest) {
return describeAlgorithm(DescribeAlgorithmRequest.builder().applyMutation(describeAlgorithmRequest).build());
}
/**
*
* 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.
*
*
* @param describeBatchInferenceJobRequest
* @return A Java Future containing the result of the DescribeBatchInferenceJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeBatchInferenceJob
* @see AWS API Documentation
*/
default CompletableFuture describeBatchInferenceJob(
DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeBatchInferenceJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeBatchInferenceJobRequest#builder()}
*
*
* @param describeBatchInferenceJobRequest
* A {@link Consumer} that will call methods on {@link DescribeBatchInferenceJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeBatchInferenceJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeBatchInferenceJob
* @see AWS API Documentation
*/
default CompletableFuture describeBatchInferenceJob(
Consumer describeBatchInferenceJobRequest) {
return describeBatchInferenceJob(DescribeBatchInferenceJobRequest.builder()
.applyMutation(describeBatchInferenceJobRequest).build());
}
/**
*
* Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output
* configurations, and the ARN of the solution version used to generate segments.
*
*
* @param describeBatchSegmentJobRequest
* @return A Java Future containing the result of the DescribeBatchSegmentJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeBatchSegmentJob
* @see AWS API Documentation
*/
default CompletableFuture describeBatchSegmentJob(
DescribeBatchSegmentJobRequest describeBatchSegmentJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output
* configurations, and the ARN of the solution version used to generate segments.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBatchSegmentJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeBatchSegmentJobRequest#builder()}
*
*
* @param describeBatchSegmentJobRequest
* A {@link Consumer} that will call methods on {@link DescribeBatchSegmentJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeBatchSegmentJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeBatchSegmentJob
* @see AWS API Documentation
*/
default CompletableFuture describeBatchSegmentJob(
Consumer describeBatchSegmentJobRequest) {
return describeBatchSegmentJob(DescribeBatchSegmentJobRequest.builder().applyMutation(describeBatchSegmentJobRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeCampaignRequest
* @return A Java Future containing the result of the DescribeCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture describeCampaign(DescribeCampaignRequest describeCampaignRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeCampaignRequest.Builder} avoiding the need
* to create one manually via {@link DescribeCampaignRequest#builder()}
*
*
* @param describeCampaignRequest
* A {@link Consumer} that will call methods on {@link DescribeCampaignRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture describeCampaign(
Consumer describeCampaignRequest) {
return describeCampaign(DescribeCampaignRequest.builder().applyMutation(describeCampaignRequest).build());
}
/**
*
* Describes the given dataset. For more information on datasets, see CreateDataset.
*
*
* @param describeDatasetRequest
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDataset
* @see AWS
* API Documentation
*/
default CompletableFuture describeDataset(DescribeDatasetRequest describeDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the given dataset. For more information on datasets, see CreateDataset.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDatasetRequest.Builder} avoiding the need
* to create one manually via {@link DescribeDatasetRequest#builder()}
*
*
* @param describeDatasetRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDataset
* @see AWS
* API Documentation
*/
default CompletableFuture describeDataset(
Consumer describeDatasetRequest) {
return describeDataset(DescribeDatasetRequest.builder().applyMutation(describeDatasetRequest).build());
}
/**
*
* Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
*
*
* @param describeDatasetExportJobRequest
* @return A Java Future containing the result of the DescribeDatasetExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDatasetExportJob
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetExportJob(
DescribeDatasetExportJobRequest describeDatasetExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDatasetExportJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDatasetExportJobRequest#builder()}
*
*
* @param describeDatasetExportJobRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDatasetExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDatasetExportJob
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetExportJob(
Consumer describeDatasetExportJobRequest) {
return describeDatasetExportJob(DescribeDatasetExportJobRequest.builder().applyMutation(describeDatasetExportJobRequest)
.build());
}
/**
*
* Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
*
*
* @param describeDatasetGroupRequest
* @return A Java Future containing the result of the DescribeDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDatasetGroup
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetGroup(
DescribeDatasetGroupRequest describeDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDatasetGroupRequest#builder()}
*
*
* @param describeDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDatasetGroup
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetGroup(
Consumer describeDatasetGroupRequest) {
return describeDatasetGroup(DescribeDatasetGroupRequest.builder().applyMutation(describeDatasetGroupRequest).build());
}
/**
*
* Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
*
*
* @param describeDatasetImportJobRequest
* @return A Java Future containing the result of the DescribeDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetImportJob(
DescribeDatasetImportJobRequest describeDatasetImportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDatasetImportJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDatasetImportJobRequest#builder()}
*
*
* @param describeDatasetImportJobRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetImportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetImportJob(
Consumer describeDatasetImportJobRequest) {
return describeDatasetImportJob(DescribeDatasetImportJobRequest.builder().applyMutation(describeDatasetImportJobRequest)
.build());
}
/**
*
* Describes an event tracker. The response includes the trackingId and status of the
* event tracker. For more information on event trackers, see CreateEventTracker.
*
*
* @param describeEventTrackerRequest
* @return A Java Future containing the result of the DescribeEventTracker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeEventTracker
* @see AWS API Documentation
*/
default CompletableFuture describeEventTracker(
DescribeEventTrackerRequest describeEventTrackerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventTrackerRequest.Builder} avoiding the
* need to create one manually via {@link DescribeEventTrackerRequest#builder()}
*
*
* @param describeEventTrackerRequest
* A {@link Consumer} that will call methods on {@link DescribeEventTrackerRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeEventTracker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeEventTracker
* @see AWS API Documentation
*/
default CompletableFuture describeEventTracker(
Consumer describeEventTrackerRequest) {
return describeEventTracker(DescribeEventTrackerRequest.builder().applyMutation(describeEventTrackerRequest).build());
}
/**
*
* Describes the given feature transformation.
*
*
* @param describeFeatureTransformationRequest
* @return A Java Future containing the result of the DescribeFeatureTransformation operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeFeatureTransformation
* @see AWS API Documentation
*/
default CompletableFuture describeFeatureTransformation(
DescribeFeatureTransformationRequest describeFeatureTransformationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the given feature transformation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeFeatureTransformationRequest.Builder}
* avoiding the need to create one manually via {@link DescribeFeatureTransformationRequest#builder()}
*
*
* @param describeFeatureTransformationRequest
* A {@link Consumer} that will call methods on {@link DescribeFeatureTransformationRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeFeatureTransformation operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeFeatureTransformation
* @see AWS API Documentation
*/
default CompletableFuture describeFeatureTransformation(
Consumer describeFeatureTransformationRequest) {
return describeFeatureTransformation(DescribeFeatureTransformationRequest.builder()
.applyMutation(describeFeatureTransformationRequest).build());
}
/**
*
* Describes a filter's properties.
*
*
* @param describeFilterRequest
* @return A Java Future containing the result of the DescribeFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeFilter
* @see AWS
* API Documentation
*/
default CompletableFuture describeFilter(DescribeFilterRequest describeFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a filter's properties.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeFilterRequest.Builder} avoiding the need to
* create one manually via {@link DescribeFilterRequest#builder()}
*
*
* @param describeFilterRequest
* A {@link Consumer} that will call methods on {@link DescribeFilterRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeFilter
* @see AWS
* API Documentation
*/
default CompletableFuture describeFilter(Consumer describeFilterRequest) {
return describeFilter(DescribeFilterRequest.builder().applyMutation(describeFilterRequest).build());
}
/**
*
* Describes a metric attribution.
*
*
* @param describeMetricAttributionRequest
* @return A Java Future containing the result of the DescribeMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture describeMetricAttribution(
DescribeMetricAttributionRequest describeMetricAttributionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a metric attribution.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMetricAttributionRequest.Builder} avoiding
* the need to create one manually via {@link DescribeMetricAttributionRequest#builder()}
*
*
* @param describeMetricAttributionRequest
* A {@link Consumer} that will call methods on {@link DescribeMetricAttributionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture describeMetricAttribution(
Consumer describeMetricAttributionRequest) {
return describeMetricAttribution(DescribeMetricAttributionRequest.builder()
.applyMutation(describeMetricAttributionRequest).build());
}
/**
*
* 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.
*
*
* @param describeRecipeRequest
* @return A Java Future containing the result of the DescribeRecipe operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeRecipe
* @see AWS
* API Documentation
*/
default CompletableFuture describeRecipe(DescribeRecipeRequest describeRecipeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeRecipeRequest.Builder} avoiding the need to
* create one manually via {@link DescribeRecipeRequest#builder()}
*
*
* @param describeRecipeRequest
* A {@link Consumer} that will call methods on {@link DescribeRecipeRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeRecipe operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeRecipe
* @see AWS
* API Documentation
*/
default CompletableFuture describeRecipe(Consumer describeRecipeRequest) {
return describeRecipe(DescribeRecipeRequest.builder().applyMutation(describeRecipeRequest).build());
}
/**
*
* Describes the given recommender, including its status.
*
*
* A recommender can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* When the status is CREATE FAILED, the response includes the failureReason
* key, which describes why.
*
*
* The modelMetrics key is null when the recommender is being created or deleted.
*
*
* For more information on recommenders, see CreateRecommender.
*
*
* @param describeRecommenderRequest
* @return A Java Future containing the result of the DescribeRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeRecommender
* @see AWS API Documentation
*/
default CompletableFuture describeRecommender(
DescribeRecommenderRequest describeRecommenderRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the given recommender, including its status.
*
*
* A recommender can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* When the status is CREATE FAILED, the response includes the failureReason
* key, which describes why.
*
*
* The modelMetrics key is null when the recommender is being created or deleted.
*
*
* For more information on recommenders, see CreateRecommender.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeRecommenderRequest.Builder} avoiding the
* need to create one manually via {@link DescribeRecommenderRequest#builder()}
*
*
* @param describeRecommenderRequest
* A {@link Consumer} that will call methods on {@link DescribeRecommenderRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeRecommender
* @see AWS API Documentation
*/
default CompletableFuture describeRecommender(
Consumer describeRecommenderRequest) {
return describeRecommender(DescribeRecommenderRequest.builder().applyMutation(describeRecommenderRequest).build());
}
/**
*
* Describes a schema. For more information on schemas, see CreateSchema.
*
*
* @param describeSchemaRequest
* @return A Java Future containing the result of the DescribeSchema operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeSchema
* @see AWS
* API Documentation
*/
default CompletableFuture describeSchema(DescribeSchemaRequest describeSchemaRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a schema. For more information on schemas, see CreateSchema.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSchemaRequest.Builder} avoiding the need to
* create one manually via {@link DescribeSchemaRequest#builder()}
*
*
* @param describeSchemaRequest
* A {@link Consumer} that will call methods on {@link DescribeSchemaRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeSchema operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeSchema
* @see AWS
* API Documentation
*/
default CompletableFuture describeSchema(Consumer describeSchemaRequest) {
return describeSchema(DescribeSchemaRequest.builder().applyMutation(describeSchemaRequest).build());
}
/**
*
* Describes a solution. For more information on solutions, see CreateSolution.
*
*
* @param describeSolutionRequest
* @return A Java Future containing the result of the DescribeSolution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeSolution
* @see AWS
* API Documentation
*/
default CompletableFuture describeSolution(DescribeSolutionRequest describeSolutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a solution. For more information on solutions, see CreateSolution.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSolutionRequest.Builder} avoiding the need
* to create one manually via {@link DescribeSolutionRequest#builder()}
*
*
* @param describeSolutionRequest
* A {@link Consumer} that will call methods on {@link DescribeSolutionRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeSolution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeSolution
* @see AWS
* API Documentation
*/
default CompletableFuture describeSolution(
Consumer describeSolutionRequest) {
return describeSolution(DescribeSolutionRequest.builder().applyMutation(describeSolutionRequest).build());
}
/**
*
* Describes a specific version of a solution. For more information on solutions, see CreateSolution
*
*
* @param describeSolutionVersionRequest
* @return A Java Future containing the result of the DescribeSolutionVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeSolutionVersion
* @see AWS API Documentation
*/
default CompletableFuture describeSolutionVersion(
DescribeSolutionVersionRequest describeSolutionVersionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a specific version of a solution. For more information on solutions, see CreateSolution
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSolutionVersionRequest.Builder} avoiding
* the need to create one manually via {@link DescribeSolutionVersionRequest#builder()}
*
*
* @param describeSolutionVersionRequest
* A {@link Consumer} that will call methods on {@link DescribeSolutionVersionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeSolutionVersion operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.DescribeSolutionVersion
* @see AWS API Documentation
*/
default CompletableFuture describeSolutionVersion(
Consumer describeSolutionVersionRequest) {
return describeSolutionVersion(DescribeSolutionVersionRequest.builder().applyMutation(describeSolutionVersionRequest)
.build());
}
/**
*
* Gets the metrics for the specified solution version.
*
*
* @param getSolutionMetricsRequest
* @return A Java Future containing the result of the GetSolutionMetrics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.GetSolutionMetrics
* @see AWS API Documentation
*/
default CompletableFuture getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets the metrics for the specified solution version.
*
*
*
* This is a convenience which creates an instance of the {@link GetSolutionMetricsRequest.Builder} avoiding the
* need to create one manually via {@link GetSolutionMetricsRequest#builder()}
*
*
* @param getSolutionMetricsRequest
* A {@link Consumer} that will call methods on {@link GetSolutionMetricsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetSolutionMetrics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.GetSolutionMetrics
* @see AWS API Documentation
*/
default CompletableFuture getSolutionMetrics(
Consumer getSolutionMetricsRequest) {
return getSolutionMetrics(GetSolutionMetricsRequest.builder().applyMutation(getSolutionMetricsRequest).build());
}
/**
*
* Gets a list of the batch inference jobs that have been performed off of a solution version.
*
*
* @param listBatchInferenceJobsRequest
* @return A Java Future containing the result of the ListBatchInferenceJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchInferenceJobs
* @see AWS API Documentation
*/
default CompletableFuture listBatchInferenceJobs(
ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListBatchInferenceJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListBatchInferenceJobsRequest#builder()}
*
*
* @param listBatchInferenceJobsRequest
* A {@link Consumer} that will call methods on {@link ListBatchInferenceJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListBatchInferenceJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchInferenceJobs
* @see AWS API Documentation
*/
default CompletableFuture listBatchInferenceJobs(
Consumer listBatchInferenceJobsRequest) {
return listBatchInferenceJobs(ListBatchInferenceJobsRequest.builder().applyMutation(listBatchInferenceJobsRequest)
.build());
}
/**
*
* Gets a list of the batch inference jobs that have been performed off of a solution version.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)}
* operation.
*
*
* @param listBatchInferenceJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchInferenceJobs
* @see AWS API Documentation
*/
default ListBatchInferenceJobsPublisher listBatchInferenceJobsPaginator(
ListBatchInferenceJobsRequest listBatchInferenceJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of the batch inference jobs that have been performed off of a solution version.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListBatchInferenceJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListBatchInferenceJobsRequest#builder()}
*
*
* @param listBatchInferenceJobsRequest
* A {@link Consumer} that will call methods on {@link ListBatchInferenceJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchInferenceJobs
* @see AWS API Documentation
*/
default ListBatchInferenceJobsPublisher listBatchInferenceJobsPaginator(
Consumer listBatchInferenceJobsRequest) {
return listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest.builder()
.applyMutation(listBatchInferenceJobsRequest).build());
}
/**
*
* Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
*
*
* @param listBatchSegmentJobsRequest
* @return A Java Future containing the result of the ListBatchSegmentJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchSegmentJobs
* @see AWS API Documentation
*/
default CompletableFuture listBatchSegmentJobs(
ListBatchSegmentJobsRequest listBatchSegmentJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
*
*
*
* This is a convenience which creates an instance of the {@link ListBatchSegmentJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListBatchSegmentJobsRequest#builder()}
*
*
* @param listBatchSegmentJobsRequest
* A {@link Consumer} that will call methods on {@link ListBatchSegmentJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListBatchSegmentJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchSegmentJobs
* @see AWS API Documentation
*/
default CompletableFuture listBatchSegmentJobs(
Consumer listBatchSegmentJobsRequest) {
return listBatchSegmentJobs(ListBatchSegmentJobsRequest.builder().applyMutation(listBatchSegmentJobsRequest).build());
}
/**
*
* Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
*
*
*
* This is a variant of
* {@link #listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse 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
* {@link #listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)}
* operation.
*
*
* @param listBatchSegmentJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchSegmentJobs
* @see AWS API Documentation
*/
default ListBatchSegmentJobsPublisher listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
*
*
*
* This is a variant of
* {@link #listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse 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
* {@link #listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListBatchSegmentJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListBatchSegmentJobsRequest#builder()}
*
*
* @param listBatchSegmentJobsRequest
* A {@link Consumer} that will call methods on {@link ListBatchSegmentJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListBatchSegmentJobs
* @see AWS API Documentation
*/
default ListBatchSegmentJobsPublisher listBatchSegmentJobsPaginator(
Consumer listBatchSegmentJobsRequest) {
return listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest.builder().applyMutation(listBatchSegmentJobsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listCampaignsRequest
* @return A Java Future containing the result of the ListCampaigns operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListCampaigns
* @see AWS API
* Documentation
*/
default CompletableFuture listCampaigns(ListCampaignsRequest listCampaignsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListCampaignsRequest.Builder} avoiding the need to
* create one manually via {@link ListCampaignsRequest#builder()}
*
*
* @param listCampaignsRequest
* A {@link Consumer} that will call methods on {@link ListCampaignsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListCampaigns operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListCampaigns
* @see AWS API
* Documentation
*/
default CompletableFuture listCampaigns(Consumer listCampaignsRequest) {
return listCampaigns(ListCampaignsRequest.builder().applyMutation(listCampaignsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)} operation.
*
*
* @param listCampaignsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListCampaigns
* @see AWS API
* Documentation
*/
default ListCampaignsPublisher listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListCampaignsRequest.Builder} avoiding the need to
* create one manually via {@link ListCampaignsRequest#builder()}
*
*
* @param listCampaignsRequest
* A {@link Consumer} that will call methods on {@link ListCampaignsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListCampaigns
* @see AWS API
* Documentation
*/
default ListCampaignsPublisher listCampaignsPaginator(Consumer listCampaignsRequest) {
return listCampaignsPaginator(ListCampaignsRequest.builder().applyMutation(listCampaignsRequest).build());
}
/**
*
* Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the
* dataset export jobs associated with the account are listed. The response provides the properties for each dataset
* export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
*
*
* @param listDatasetExportJobsRequest
* @return A Java Future containing the result of the ListDatasetExportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listDatasetExportJobs(
ListDatasetExportJobsRequest listDatasetExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the
* dataset export jobs associated with the account are listed. The response provides the properties for each dataset
* export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
*
*
*
* This is a convenience which creates an instance of the {@link ListDatasetExportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetExportJobsRequest#builder()}
*
*
* @param listDatasetExportJobsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetExportJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListDatasetExportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listDatasetExportJobs(
Consumer listDatasetExportJobsRequest) {
return listDatasetExportJobs(ListDatasetExportJobsRequest.builder().applyMutation(listDatasetExportJobsRequest).build());
}
/**
*
* Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the
* dataset export jobs associated with the account are listed. The response provides the properties for each dataset
* export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
*
*
*
* This is a variant of
* {@link #listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse 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
* {@link #listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)}
* operation.
*
*
* @param listDatasetExportJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetExportJobs
* @see AWS API Documentation
*/
default ListDatasetExportJobsPublisher listDatasetExportJobsPaginator(
ListDatasetExportJobsRequest listDatasetExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the
* dataset export jobs associated with the account are listed. The response provides the properties for each dataset
* export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
*
*
*
* This is a variant of
* {@link #listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse 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
* {@link #listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetExportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetExportJobsRequest#builder()}
*
*
* @param listDatasetExportJobsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetExportJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetExportJobs
* @see AWS API Documentation
*/
default ListDatasetExportJobsPublisher listDatasetExportJobsPaginator(
Consumer listDatasetExportJobsRequest) {
return listDatasetExportJobsPaginator(ListDatasetExportJobsRequest.builder().applyMutation(listDatasetExportJobsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listDatasetGroupsRequest
* @return A Java Future containing the result of the ListDatasetGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default CompletableFuture listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetGroupsRequest.Builder} avoiding the need
* to create one manually via {@link ListDatasetGroupsRequest#builder()}
*
*
* @param listDatasetGroupsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetGroupsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDatasetGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default CompletableFuture listDatasetGroups(
Consumer listDatasetGroupsRequest) {
return listDatasetGroups(ListDatasetGroupsRequest.builder().applyMutation(listDatasetGroupsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)}
* operation.
*
*
* @param listDatasetGroupsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default ListDatasetGroupsPublisher listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetGroupsRequest.Builder} avoiding the need
* to create one manually via {@link ListDatasetGroupsRequest#builder()}
*
*
* @param listDatasetGroupsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetGroupsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default ListDatasetGroupsPublisher listDatasetGroupsPaginator(
Consumer listDatasetGroupsRequest) {
return listDatasetGroupsPaginator(ListDatasetGroupsRequest.builder().applyMutation(listDatasetGroupsRequest).build());
}
/**
*
* 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.
*
*
* @param listDatasetImportJobsRequest
* @return A Java Future containing the result of the ListDatasetImportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default CompletableFuture listDatasetImportJobs(
ListDatasetImportJobsRequest listDatasetImportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetImportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetImportJobsRequest#builder()}
*
*
* @param listDatasetImportJobsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetImportJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListDatasetImportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default CompletableFuture listDatasetImportJobs(
Consumer listDatasetImportJobsRequest) {
return listDatasetImportJobs(ListDatasetImportJobsRequest.builder().applyMutation(listDatasetImportJobsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)}
* operation.
*
*
* @param listDatasetImportJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(
ListDatasetImportJobsRequest listDatasetImportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetImportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetImportJobsRequest#builder()}
*
*
* @param listDatasetImportJobsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetImportJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(
Consumer listDatasetImportJobsRequest) {
return listDatasetImportJobsPaginator(ListDatasetImportJobsRequest.builder().applyMutation(listDatasetImportJobsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listDatasetsRequest
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets(ListDatasetsRequest listDatasetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetsRequest.Builder} avoiding the need to
* create one manually via {@link ListDatasetsRequest#builder()}
*
*
* @param listDatasetsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets(Consumer listDatasetsRequest) {
return listDatasets(ListDatasetsRequest.builder().applyMutation(listDatasetsRequest).build());
}
/**
*
* 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 {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)} operation.
*
*
* @param listDatasetsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetsRequest.Builder} avoiding the need to
* create one manually via {@link ListDatasetsRequest#builder()}
*
*
* @param listDatasetsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator(Consumer listDatasetsRequest) {
return listDatasetsPaginator(ListDatasetsRequest.builder().applyMutation(listDatasetsRequest).build());
}
/**
*
* 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.
*
*
* @param listEventTrackersRequest
* @return A Java Future containing the result of the ListEventTrackers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListEventTrackers
* @see AWS
* API Documentation
*/
default CompletableFuture listEventTrackers(ListEventTrackersRequest listEventTrackersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListEventTrackersRequest.Builder} avoiding the need
* to create one manually via {@link ListEventTrackersRequest#builder()}
*
*
* @param listEventTrackersRequest
* A {@link Consumer} that will call methods on {@link ListEventTrackersRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListEventTrackers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListEventTrackers
* @see AWS
* API Documentation
*/
default CompletableFuture listEventTrackers(
Consumer listEventTrackersRequest) {
return listEventTrackers(ListEventTrackersRequest.builder().applyMutation(listEventTrackersRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)}
* operation.
*
*
* @param listEventTrackersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListEventTrackers
* @see AWS
* API Documentation
*/
default ListEventTrackersPublisher listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListEventTrackersRequest.Builder} avoiding the need
* to create one manually via {@link ListEventTrackersRequest#builder()}
*
*
* @param listEventTrackersRequest
* A {@link Consumer} that will call methods on {@link ListEventTrackersRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListEventTrackers
* @see AWS
* API Documentation
*/
default ListEventTrackersPublisher listEventTrackersPaginator(
Consumer listEventTrackersRequest) {
return listEventTrackersPaginator(ListEventTrackersRequest.builder().applyMutation(listEventTrackersRequest).build());
}
/**
*
* Lists all filters that belong to a given dataset group.
*
*
* @param listFiltersRequest
* @return A Java Future containing the result of the ListFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListFilters
* @see AWS API
* Documentation
*/
default CompletableFuture listFilters(ListFiltersRequest listFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all filters that belong to a given dataset group.
*
*
*
* This is a convenience which creates an instance of the {@link ListFiltersRequest.Builder} avoiding the need to
* create one manually via {@link ListFiltersRequest#builder()}
*
*
* @param listFiltersRequest
* A {@link Consumer} that will call methods on {@link ListFiltersRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListFilters
* @see AWS API
* Documentation
*/
default CompletableFuture listFilters(Consumer listFiltersRequest) {
return listFilters(ListFiltersRequest.builder().applyMutation(listFiltersRequest).build());
}
/**
*
* Lists all filters that belong to a given dataset group.
*
*
*
* This is a variant of {@link #listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListFiltersResponse 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
* {@link #listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)} operation.
*
*
* @param listFiltersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListFilters
* @see AWS API
* Documentation
*/
default ListFiltersPublisher listFiltersPaginator(ListFiltersRequest listFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all filters that belong to a given dataset group.
*
*
*
* This is a variant of {@link #listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListFiltersResponse 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
* {@link #listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListFiltersRequest.Builder} avoiding the need to
* create one manually via {@link ListFiltersRequest#builder()}
*
*
* @param listFiltersRequest
* A {@link Consumer} that will call methods on {@link ListFiltersRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListFilters
* @see AWS API
* Documentation
*/
default ListFiltersPublisher listFiltersPaginator(Consumer listFiltersRequest) {
return listFiltersPaginator(ListFiltersRequest.builder().applyMutation(listFiltersRequest).build());
}
/**
*
* Lists the metrics for the metric attribution.
*
*
* @param listMetricAttributionMetricsRequest
* @return A Java Future containing the result of the ListMetricAttributionMetrics operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributionMetrics
* @see AWS API Documentation
*/
default CompletableFuture listMetricAttributionMetrics(
ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the metrics for the metric attribution.
*
*
*
* This is a convenience which creates an instance of the {@link ListMetricAttributionMetricsRequest.Builder}
* avoiding the need to create one manually via {@link ListMetricAttributionMetricsRequest#builder()}
*
*
* @param listMetricAttributionMetricsRequest
* A {@link Consumer} that will call methods on {@link ListMetricAttributionMetricsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ListMetricAttributionMetrics operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributionMetrics
* @see AWS API Documentation
*/
default CompletableFuture listMetricAttributionMetrics(
Consumer listMetricAttributionMetricsRequest) {
return listMetricAttributionMetrics(ListMetricAttributionMetricsRequest.builder()
.applyMutation(listMetricAttributionMetricsRequest).build());
}
/**
*
* Lists the metrics for the metric attribution.
*
*
*
* This is a variant of
* {@link #listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse 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
* {@link #listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)}
* operation.
*
*
* @param listMetricAttributionMetricsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributionMetrics
* @see AWS API Documentation
*/
default ListMetricAttributionMetricsPublisher listMetricAttributionMetricsPaginator(
ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the metrics for the metric attribution.
*
*
*
* This is a variant of
* {@link #listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse 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
* {@link #listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListMetricAttributionMetricsRequest.Builder}
* avoiding the need to create one manually via {@link ListMetricAttributionMetricsRequest#builder()}
*
*
* @param listMetricAttributionMetricsRequest
* A {@link Consumer} that will call methods on {@link ListMetricAttributionMetricsRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributionMetrics
* @see AWS API Documentation
*/
default ListMetricAttributionMetricsPublisher listMetricAttributionMetricsPaginator(
Consumer listMetricAttributionMetricsRequest) {
return listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest.builder()
.applyMutation(listMetricAttributionMetricsRequest).build());
}
/**
*
* Lists metric attributions.
*
*
* @param listMetricAttributionsRequest
* @return A Java Future containing the result of the ListMetricAttributions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributions
* @see AWS API Documentation
*/
default CompletableFuture listMetricAttributions(
ListMetricAttributionsRequest listMetricAttributionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists metric attributions.
*
*
*
* This is a convenience which creates an instance of the {@link ListMetricAttributionsRequest.Builder} avoiding the
* need to create one manually via {@link ListMetricAttributionsRequest#builder()}
*
*
* @param listMetricAttributionsRequest
* A {@link Consumer} that will call methods on {@link ListMetricAttributionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListMetricAttributions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributions
* @see AWS API Documentation
*/
default CompletableFuture listMetricAttributions(
Consumer listMetricAttributionsRequest) {
return listMetricAttributions(ListMetricAttributionsRequest.builder().applyMutation(listMetricAttributionsRequest)
.build());
}
/**
*
* Lists metric attributions.
*
*
*
* This is a variant of
* {@link #listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse 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
* {@link #listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)}
* operation.
*
*
* @param listMetricAttributionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributions
* @see AWS API Documentation
*/
default ListMetricAttributionsPublisher listMetricAttributionsPaginator(
ListMetricAttributionsRequest listMetricAttributionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists metric attributions.
*
*
*
* This is a variant of
* {@link #listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)}
* 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse 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
* {@link #listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListMetricAttributionsRequest.Builder} avoiding the
* need to create one manually via {@link ListMetricAttributionsRequest#builder()}
*
*
* @param listMetricAttributionsRequest
* A {@link Consumer} that will call methods on {@link ListMetricAttributionsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListMetricAttributions
* @see AWS API Documentation
*/
default ListMetricAttributionsPublisher listMetricAttributionsPaginator(
Consumer listMetricAttributionsRequest) {
return listMetricAttributionsPaginator(ListMetricAttributionsRequest.builder()
.applyMutation(listMetricAttributionsRequest).build());
}
/**
*
* Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's
* Amazon Resource Name (ARN).
*
*
* @param listRecipesRequest
* @return A Java Future containing the result of the ListRecipes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - InvalidInputException Provide a valid value for the field or parameter.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecipes
* @see AWS API
* Documentation
*/
default CompletableFuture listRecipes(ListRecipesRequest listRecipesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListRecipesRequest.Builder} avoiding the need to
* create one manually via {@link ListRecipesRequest#builder()}
*
*
* @param listRecipesRequest
* A {@link Consumer} that will call methods on {@link ListRecipesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListRecipes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - InvalidInputException Provide a valid value for the field or parameter.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecipes
* @see AWS API
* Documentation
*/
default CompletableFuture listRecipes(Consumer listRecipesRequest) {
return listRecipes(ListRecipesRequest.builder().applyMutation(listRecipesRequest).build());
}
/**
*
* 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 {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)} operation.
*
*
* @param listRecipesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - InvalidInputException Provide a valid value for the field or parameter.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecipes
* @see AWS API
* Documentation
*/
default ListRecipesPublisher listRecipesPaginator(ListRecipesRequest listRecipesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListRecipesRequest.Builder} avoiding the need to
* create one manually via {@link ListRecipesRequest#builder()}
*
*
* @param listRecipesRequest
* A {@link Consumer} that will call methods on {@link ListRecipesRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - InvalidInputException Provide a valid value for the field or parameter.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecipes
* @see AWS API
* Documentation
*/
default ListRecipesPublisher listRecipesPaginator(Consumer listRecipesRequest) {
return listRecipesPaginator(ListRecipesRequest.builder().applyMutation(listRecipesRequest).build());
}
/**
*
* Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all
* the recommenders associated with the account are listed. The response provides the properties for each
* recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
*
*
* @param listRecommendersRequest
* @return A Java Future containing the result of the ListRecommenders operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecommenders
* @see AWS
* API Documentation
*/
default CompletableFuture listRecommenders(ListRecommendersRequest listRecommendersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all
* the recommenders associated with the account are listed. The response provides the properties for each
* recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecommendersRequest.Builder} avoiding the need
* to create one manually via {@link ListRecommendersRequest#builder()}
*
*
* @param listRecommendersRequest
* A {@link Consumer} that will call methods on {@link ListRecommendersRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListRecommenders operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecommenders
* @see AWS
* API Documentation
*/
default CompletableFuture listRecommenders(
Consumer listRecommendersRequest) {
return listRecommenders(ListRecommendersRequest.builder().applyMutation(listRecommendersRequest).build());
}
/**
*
* Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all
* the recommenders associated with the account are listed. The response provides the properties for each
* recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
*
*
*
* This is a variant of
* {@link #listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListRecommendersResponse 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
* {@link #listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)}
* operation.
*
*
* @param listRecommendersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecommenders
* @see AWS
* API Documentation
*/
default ListRecommendersPublisher listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all
* the recommenders associated with the account are listed. The response provides the properties for each
* recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
*
*
*
* This is a variant of
* {@link #listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)} 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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.personalize.model.ListRecommendersResponse 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
* {@link #listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListRecommendersRequest.Builder} avoiding the need
* to create one manually via {@link ListRecommendersRequest#builder()}
*
*
* @param listRecommendersRequest
* A {@link Consumer} that will call methods on {@link ListRecommendersRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListRecommenders
* @see AWS
* API Documentation
*/
default ListRecommendersPublisher listRecommendersPaginator(Consumer listRecommendersRequest) {
return listRecommendersPaginator(ListRecommendersRequest.builder().applyMutation(listRecommendersRequest).build());
}
/**
*
* 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.
*
*
* @param listSchemasRequest
* @return A Java Future containing the result of the ListSchemas operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSchemas
* @see AWS API
* Documentation
*/
default CompletableFuture listSchemas(ListSchemasRequest listSchemasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListSchemasRequest.Builder} avoiding the need to
* create one manually via {@link ListSchemasRequest#builder()}
*
*
* @param listSchemasRequest
* A {@link Consumer} that will call methods on {@link ListSchemasRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListSchemas operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSchemas
* @see AWS API
* Documentation
*/
default CompletableFuture listSchemas(Consumer listSchemasRequest) {
return listSchemas(ListSchemasRequest.builder().applyMutation(listSchemasRequest).build());
}
/**
*
* 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 {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)} operation.
*
*
* @param listSchemasRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSchemas
* @see AWS API
* Documentation
*/
default ListSchemasPublisher listSchemasPaginator(ListSchemasRequest listSchemasRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListSchemasRequest.Builder} avoiding the need to
* create one manually via {@link ListSchemasRequest#builder()}
*
*
* @param listSchemasRequest
* A {@link Consumer} that will call methods on {@link ListSchemasRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSchemas
* @see AWS API
* Documentation
*/
default ListSchemasPublisher listSchemasPaginator(Consumer listSchemasRequest) {
return listSchemasPaginator(ListSchemasRequest.builder().applyMutation(listSchemasRequest).build());
}
/**
*
* 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).
*
*
* @param listSolutionVersionsRequest
* @return A Java Future containing the result of the ListSolutionVersions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutionVersions
* @see AWS API Documentation
*/
default CompletableFuture listSolutionVersions(
ListSolutionVersionsRequest listSolutionVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of solution versions for the given solution. When a solution is not specified, all the solution
* versions associated with the account are listed. The response provides the properties for each solution version,
* including the Amazon Resource Name (ARN).
*
*
*
* This is a convenience which creates an instance of the {@link ListSolutionVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListSolutionVersionsRequest#builder()}
*
*
* @param listSolutionVersionsRequest
* A {@link Consumer} that will call methods on {@link ListSolutionVersionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListSolutionVersions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutionVersions
* @see AWS API Documentation
*/
default CompletableFuture listSolutionVersions(
Consumer listSolutionVersionsRequest) {
return listSolutionVersions(ListSolutionVersionsRequest.builder().applyMutation(listSolutionVersionsRequest).build());
}
/**
*
* Returns a list of solution versions for the given solution. When a solution is not specified, all the solution
* versions associated with the account are listed. The response provides the properties for each solution version,
* including the Amazon Resource Name (ARN).
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)}
* operation.
*
*
* @param listSolutionVersionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutionVersions
* @see AWS API Documentation
*/
default ListSolutionVersionsPublisher listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of solution versions for the given solution. When a solution is not specified, all the solution
* versions associated with the account are listed. The response provides the properties for each solution version,
* including the Amazon Resource Name (ARN).
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSolutionVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListSolutionVersionsRequest#builder()}
*
*
* @param listSolutionVersionsRequest
* A {@link Consumer} that will call methods on {@link ListSolutionVersionsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutionVersions
* @see AWS API Documentation
*/
default ListSolutionVersionsPublisher listSolutionVersionsPaginator(
Consumer listSolutionVersionsRequest) {
return listSolutionVersionsPaginator(ListSolutionVersionsRequest.builder().applyMutation(listSolutionVersionsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listSolutionsRequest
* @return A Java Future containing the result of the ListSolutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutions
* @see AWS API
* Documentation
*/
default CompletableFuture listSolutions(ListSolutionsRequest listSolutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListSolutionsRequest.Builder} avoiding the need to
* create one manually via {@link ListSolutionsRequest#builder()}
*
*
* @param listSolutionsRequest
* A {@link Consumer} that will call methods on {@link ListSolutionsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListSolutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutions
* @see AWS API
* Documentation
*/
default CompletableFuture listSolutions(Consumer listSolutionsRequest) {
return listSolutions(ListSolutionsRequest.builder().applyMutation(listSolutionsRequest).build());
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)} operation.
*
*
* @param listSolutionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutions
* @see AWS API
* Documentation
*/
default ListSolutionsPublisher listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListSolutionsRequest.Builder} avoiding the need to
* create one manually via {@link ListSolutionsRequest#builder()}
*
*
* @param listSolutionsRequest
* A {@link Consumer} that will call methods on {@link ListSolutionsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - InvalidNextTokenException The token is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListSolutions
* @see AWS API
* Documentation
*/
default ListSolutionsPublisher listSolutionsPaginator(Consumer listSolutionsRequest) {
return listSolutionsPaginator(ListSolutionsRequest.builder().applyMutation(listSolutionsRequest).build());
}
/**
*
* Get a list of tags
* attached to a resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Get a list of tags
* attached to a resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing
* and automatic retraining for the recommender.
*
*
* @param startRecommenderRequest
* @return A Java Future containing the result of the StartRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.StartRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture startRecommender(StartRecommenderRequest startRecommenderRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing
* and automatic retraining for the recommender.
*
*
*
* This is a convenience which creates an instance of the {@link StartRecommenderRequest.Builder} avoiding the need
* to create one manually via {@link StartRecommenderRequest#builder()}
*
*
* @param startRecommenderRequest
* A {@link Consumer} that will call methods on {@link StartRecommenderRequest.Builder} to create a request.
* @return A Java Future containing the result of the StartRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.StartRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture startRecommender(
Consumer startRecommenderRequest) {
return startRecommender(StartRecommenderRequest.builder().applyMutation(startRecommenderRequest).build());
}
/**
*
* Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the
* recommender.
*
*
* @param stopRecommenderRequest
* @return A Java Future containing the result of the StopRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.StopRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture stopRecommender(StopRecommenderRequest stopRecommenderRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the
* recommender.
*
*
*
* This is a convenience which creates an instance of the {@link StopRecommenderRequest.Builder} avoiding the need
* to create one manually via {@link StopRecommenderRequest#builder()}
*
*
* @param stopRecommenderRequest
* A {@link Consumer} that will call methods on {@link StopRecommenderRequest.Builder} to create a request.
* @return A Java Future containing the result of the StopRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.StopRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture stopRecommender(
Consumer stopRecommenderRequest) {
return stopRecommender(StopRecommenderRequest.builder().applyMutation(stopRecommenderRequest).build());
}
/**
*
* Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
*
*
* Depending on the current state of the solution version, the solution version state changes as follows:
*
*
* -
*
* CREATE_PENDING > CREATE_STOPPED
*
*
* or
*
*
* -
*
* CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
*
*
*
*
* You are billed for all of the training completed up until you stop the solution version creation. You cannot
* resume creating a solution version once it has been stopped.
*
*
* @param stopSolutionVersionCreationRequest
* @return A Java Future containing the result of the StopSolutionVersionCreation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.StopSolutionVersionCreation
* @see AWS API Documentation
*/
default CompletableFuture stopSolutionVersionCreation(
StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
*
*
* Depending on the current state of the solution version, the solution version state changes as follows:
*
*
* -
*
* CREATE_PENDING > CREATE_STOPPED
*
*
* or
*
*
* -
*
* CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
*
*
*
*
* You are billed for all of the training completed up until you stop the solution version creation. You cannot
* resume creating a solution version once it has been stopped.
*
*
*
* This is a convenience which creates an instance of the {@link StopSolutionVersionCreationRequest.Builder}
* avoiding the need to create one manually via {@link StopSolutionVersionCreationRequest#builder()}
*
*
* @param stopSolutionVersionCreationRequest
* A {@link Consumer} that will call methods on {@link StopSolutionVersionCreationRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the StopSolutionVersionCreation operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.StopSolutionVersionCreation
* @see AWS API Documentation
*/
default CompletableFuture stopSolutionVersionCreation(
Consumer stopSolutionVersionCreationRequest) {
return stopSolutionVersionCreation(StopSolutionVersionCreationRequest.builder()
.applyMutation(stopSolutionVersionCreationRequest).build());
}
/**
*
* Add a list of tags to a resource.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - ResourceInUseException The specified resource is in use.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Add a list of tags to a resource.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
* - ResourceInUseException The specified resource is in use.
* - LimitExceededException The limit on the number of requests per second has been exceeded.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Remove tags that are
* attached to a resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - TooManyTagKeysException The request contains more tag keys than can be associated with a resource (50
* tag keys per resource).
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Remove tags that are
* attached to a resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - TooManyTagKeysException The request contains more tag keys than can be associated with a resource (50
* tag keys per resource).
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates a campaign by either deploying a new solution or changing the value of the campaign's
* minProvisionedTPS parameter.
*
*
* To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign
* operation.
*
*
*
* You can still get recommendations from a campaign while an update is in progress. The campaign will use the
* previous solution version and campaign configuration to generate recommendations until the latest campaign update
* status is Active.
*
*
*
* For more information on campaigns, see CreateCampaign.
*
*
* @param updateCampaignRequest
* @return A Java Future containing the result of the UpdateCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UpdateCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture updateCampaign(UpdateCampaignRequest updateCampaignRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a campaign by either deploying a new solution or changing the value of the campaign's
* minProvisionedTPS parameter.
*
*
* To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign
* operation.
*
*
*
* You can still get recommendations from a campaign while an update is in progress. The campaign will use the
* previous solution version and campaign configuration to generate recommendations until the latest campaign update
* status is Active.
*
*
*
* For more information on campaigns, see CreateCampaign.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateCampaignRequest.Builder} avoiding the need to
* create one manually via {@link UpdateCampaignRequest#builder()}
*
*
* @param updateCampaignRequest
* A {@link Consumer} that will call methods on {@link UpdateCampaignRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateCampaign operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UpdateCampaign
* @see AWS
* API Documentation
*/
default CompletableFuture updateCampaign(Consumer updateCampaignRequest) {
return updateCampaign(UpdateCampaignRequest.builder().applyMutation(updateCampaignRequest).build());
}
/**
*
* Updates a metric attribution.
*
*
* @param updateMetricAttributionRequest
* @return A Java Future containing the result of the UpdateMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UpdateMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture updateMetricAttribution(
UpdateMetricAttributionRequest updateMetricAttributionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a metric attribution.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateMetricAttributionRequest.Builder} avoiding
* the need to create one manually via {@link UpdateMetricAttributionRequest#builder()}
*
*
* @param updateMetricAttributionRequest
* A {@link Consumer} that will call methods on {@link UpdateMetricAttributionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateMetricAttribution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UpdateMetricAttribution
* @see AWS API Documentation
*/
default CompletableFuture updateMetricAttribution(
Consumer updateMetricAttributionRequest) {
return updateMetricAttribution(UpdateMetricAttributionRequest.builder().applyMutation(updateMetricAttributionRequest)
.build());
}
/**
*
* Updates the recommender to modify the recommender configuration.
*
*
* @param updateRecommenderRequest
* @return A Java Future containing the result of the UpdateRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UpdateRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture updateRecommender(UpdateRecommenderRequest updateRecommenderRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the recommender to modify the recommender configuration.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRecommenderRequest.Builder} avoiding the need
* to create one manually via {@link UpdateRecommenderRequest#builder()}
*
*
* @param updateRecommenderRequest
* A {@link Consumer} that will call methods on {@link UpdateRecommenderRequest.Builder} to create a request.
* @return A Java Future containing the result of the UpdateRecommender operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException Provide a valid value for the field or parameter.
* - ResourceNotFoundException Could not find the specified resource.
* - ResourceInUseException The specified resource is in use.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - PersonalizeException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample PersonalizeAsyncClient.UpdateRecommender
* @see AWS
* API Documentation
*/
default CompletableFuture updateRecommender(
Consumer updateRecommenderRequest) {
return updateRecommender(UpdateRecommenderRequest.builder().applyMutation(updateRecommenderRequest).build());
}
@Override
default PersonalizeServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link PersonalizeAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static PersonalizeAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link PersonalizeAsyncClient}.
*/
static PersonalizeAsyncClientBuilder builder() {
return new DefaultPersonalizeAsyncClientBuilder();
}
}