Interface PersonalizeAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PersonalizeAsyncClient extends AwsClient
Service client for accessing Amazon Personalize asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

  • Field Details

  • Method Details

    • createBatchInferenceJob

      default CompletableFuture<CreateBatchInferenceJobResponse> createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)

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

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

      For more information, see Creating a batch inference job .

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

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

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

      Parameters:
      createBatchInferenceJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createBatchInferenceJob

      default CompletableFuture<CreateBatchInferenceJobResponse> createBatchInferenceJob(Consumer<CreateBatchInferenceJobRequest.Builder> createBatchInferenceJobRequest)

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

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

      For more information, see Creating a batch inference job .

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

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

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


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

      Parameters:
      createBatchInferenceJobRequest - A Consumer that will call methods on CreateBatchInferenceJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createBatchSegmentJob

      default CompletableFuture<CreateBatchSegmentJobResponse> createBatchSegmentJob(CreateBatchSegmentJobRequest createBatchSegmentJobRequest)

      Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.

      Parameters:
      createBatchSegmentJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createBatchSegmentJob

      default CompletableFuture<CreateBatchSegmentJobResponse> createBatchSegmentJob(Consumer<CreateBatchSegmentJobRequest.Builder> createBatchSegmentJobRequest)

      Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments.


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

      Parameters:
      createBatchSegmentJobRequest - A Consumer that will call methods on CreateBatchSegmentJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCampaign

      default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest)

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

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

      Minimum Provisioned TPS and Auto-Scaling

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

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

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

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

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

      Status

      A campaign can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the campaign status, call DescribeCampaign.

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

      Related APIs

      Parameters:
      createCampaignRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createCampaign

      default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest)

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

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

      Minimum Provisioned TPS and Auto-Scaling

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

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

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

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

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

      Status

      A campaign can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the campaign status, call DescribeCampaign.

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

      Related APIs


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

      Parameters:
      createCampaignRequest - A Consumer that will call methods on CreateCampaignRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDataDeletionJob

      default CompletableFuture<CreateDataDeletionJobResponse> createDataDeletionJob(CreateDataDeletionJobRequest createDataDeletionJobRequest)

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

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

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

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

      Status

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

      • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

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

      Related APIs

      Parameters:
      createDataDeletionJobRequest -
      Returns:
      A Java Future containing the result of the CreateDataDeletionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDataDeletionJob

      default CompletableFuture<CreateDataDeletionJobResponse> createDataDeletionJob(Consumer<CreateDataDeletionJobRequest.Builder> createDataDeletionJobRequest)

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

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

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

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

      Status

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

      • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

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

      Related APIs


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

      Parameters:
      createDataDeletionJobRequest - A Consumer that will call methods on CreateDataDeletionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataDeletionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDataset

      default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest)

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

      There are 5 types of datasets:

      • Item interactions

      • Items

      • Users

      • Action interactions

      • Actions

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

      A dataset can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the status of the dataset, call DescribeDataset.

      Related APIs

      Parameters:
      createDatasetRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDataset

      default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)

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

      There are 5 types of datasets:

      • Item interactions

      • Items

      • Users

      • Action interactions

      • Actions

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

      A dataset can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the status of the dataset, call DescribeDataset.

      Related APIs


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

      Parameters:
      createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDatasetExportJob

      default CompletableFuture<CreateDatasetExportJobResponse> createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)

      Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

      Status

      A dataset export job can be in one of the following states:

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

      To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

      Parameters:
      createDatasetExportJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDatasetExportJob

      default CompletableFuture<CreateDatasetExportJobResponse> createDatasetExportJob(Consumer<CreateDatasetExportJobRequest.Builder> createDatasetExportJobRequest)

      Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.

      Status

      A dataset export job can be in one of the following states:

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

      To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.


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

      Parameters:
      createDatasetExportJobRequest - A Consumer that will call methods on CreateDatasetExportJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDatasetGroup

      default CompletableFuture<CreateDatasetGroupResponse> createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)

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

      • Item interactions

      • Items

      • Users

      • Actions

      • Action interactions

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

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

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

      • DELETE PENDING

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

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

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

      APIs that require a dataset group ARN in the request

      Related APIs

      Parameters:
      createDatasetGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDatasetGroup

      default CompletableFuture<CreateDatasetGroupResponse> createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)

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

      • Item interactions

      • Items

      • Users

      • Actions

      • Action interactions

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

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

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

      • DELETE PENDING

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

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

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

      APIs that require a dataset group ARN in the request

      Related APIs


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

      Parameters:
      createDatasetGroupRequest - A Consumer that will call methods on CreateDatasetGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDatasetImportJob

      default CompletableFuture<CreateDatasetImportJobResponse> createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)

      Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

      If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.

      By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.

      Status

      A dataset import job can be in one of the following states:

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

      To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

      Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

      Related APIs

      Parameters:
      createDatasetImportJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createDatasetImportJob

      default CompletableFuture<CreateDatasetImportJobResponse> createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest)

      Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.

      If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see How new data influences real-time recommendations.

      By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.

      Status

      A dataset import job can be in one of the following states:

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

      To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

      Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

      Related APIs


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

      Parameters:
      createDatasetImportJobRequest - A Consumer that will call methods on CreateDatasetImportJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createEventTracker

      default CompletableFuture<CreateEventTrackerResponse> createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)

      Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

      Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

      When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.

      The event tracker can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the status of the event tracker, call DescribeEventTracker.

      The event tracker must be in the ACTIVE state before using the tracking ID.

      Related APIs

      Parameters:
      createEventTrackerRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createEventTracker

      default CompletableFuture<CreateEventTrackerResponse> createEventTracker(Consumer<CreateEventTrackerRequest.Builder> createEventTrackerRequest)

      Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

      Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

      When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.

      The event tracker can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the status of the event tracker, call DescribeEventTracker.

      The event tracker must be in the ACTIVE state before using the tracking ID.

      Related APIs


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

      Parameters:
      createEventTrackerRequest - A Consumer that will call methods on CreateEventTrackerRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createFilter

      default CompletableFuture<CreateFilterResponse> createFilter(CreateFilterRequest createFilterRequest)

      Creates a recommendation filter. For more information, see Filtering recommendations and user segments.

      Parameters:
      createFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createFilter

      default CompletableFuture<CreateFilterResponse> createFilter(Consumer<CreateFilterRequest.Builder> createFilterRequest)

      Creates a recommendation filter. For more information, see Filtering recommendations and user segments.


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

      Parameters:
      createFilterRequest - A Consumer that will call methods on CreateFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createMetricAttribution

      default CompletableFuture<CreateMetricAttributionResponse> createMetricAttribution(CreateMetricAttributionRequest createMetricAttributionRequest)

      Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

      Parameters:
      createMetricAttributionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createMetricAttribution

      default CompletableFuture<CreateMetricAttributionResponse> createMetricAttribution(Consumer<CreateMetricAttributionRequest.Builder> createMetricAttributionRequest)

      Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.


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

      Parameters:
      createMetricAttributionRequest - A Consumer that will call methods on CreateMetricAttributionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createRecommender

      default CompletableFuture<CreateRecommenderResponse> createRecommender(CreateRecommenderRequest createRecommenderRequest)

      Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.

      Minimum recommendation requests per second

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

      When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.

      If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond . There's a short time delay while the capacity is increased that might cause loss of requests.

      Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.

      Status

      A recommender can be in one of the following states:

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

      • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the recommender status, call DescribeRecommender.

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

      Related APIs

      Parameters:
      createRecommenderRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createRecommender

      default CompletableFuture<CreateRecommenderResponse> createRecommender(Consumer<CreateRecommenderRequest.Builder> createRecommenderRequest)

      Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.

      Minimum recommendation requests per second

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

      When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.

      If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond . There's a short time delay while the capacity is increased that might cause loss of requests.

      Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary.

      Status

      A recommender can be in one of the following states:

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

      • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

      • DELETE PENDING > DELETE IN_PROGRESS

      To get the recommender status, call DescribeRecommender.

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

      Related APIs


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

      Parameters:
      createRecommenderRequest - A Consumer that will call methods on CreateRecommenderRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createSchema

      default CompletableFuture<CreateSchemaResponse> createSchema(CreateSchemaRequest createSchemaRequest)

      Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

      Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.

      Related APIs

      Parameters:
      createSchemaRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createSchema

      default CompletableFuture<CreateSchemaResponse> createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest)

      Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

      Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.

      Related APIs


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

      Parameters:
      createSchemaRequest - A Consumer that will call methods on CreateSchemaRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createSolution

      default CompletableFuture<CreateSolutionResponse> createSolution(CreateSolutionRequest createSolutionRequest)

      By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

      Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

      By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

      To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

      After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

      After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

      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. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

      Related APIs

      Parameters:
      createSolutionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createSolution

      default CompletableFuture<CreateSolutionResponse> createSolution(Consumer<CreateSolutionRequest.Builder> createSolutionRequest)

      By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing.

      Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see Creating and configuring a solution.

      By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see Configuring automatic training.

      To turn off automatic training, set performAutoTraining to false. If you turn off automatic training, you must manually create a solution version by calling the CreateSolutionVersion operation.

      After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

      After training completes you can evaluate model accuracy by calling GetSolutionMetrics. When you are satisfied with the solution version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

      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. If you use manual training, the status must be ACTIVE before you call CreateSolutionVersion.

      Related APIs


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

      Parameters:
      createSolutionRequest - A Consumer that will call methods on CreateSolutionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createSolutionVersion

      default CompletableFuture<CreateSolutionVersionResponse> createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)

      Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

      Status

      A solution version can be in one of the following states:

      • CREATE PENDING

      • CREATE IN_PROGRESS

      • ACTIVE

      • CREATE FAILED

      • CREATE STOPPING

      • CREATE STOPPED

      To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

      If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

      Related APIs

      Parameters:
      createSolutionVersionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createSolutionVersion

      default CompletableFuture<CreateSolutionVersionResponse> createSolutionVersion(Consumer<CreateSolutionVersionRequest.Builder> createSolutionVersionRequest)

      Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

      Status

      A solution version can be in one of the following states:

      • CREATE PENDING

      • CREATE IN_PROGRESS

      • ACTIVE

      • CREATE FAILED

      • CREATE STOPPING

      • CREATE STOPPED

      To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

      If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

      Related APIs


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

      Parameters:
      createSolutionVersionRequest - A Consumer that will call methods on CreateSolutionVersionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCampaign

      default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)

      Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.

      Parameters:
      deleteCampaignRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteCampaign

      default CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest)

      Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.


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

      Parameters:
      deleteCampaignRequest - A Consumer that will call methods on DeleteCampaignRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDataset

      default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest)

      Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information about deleting datasets, see Deleting a dataset.

      Parameters:
      deleteDatasetRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDataset

      default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)

      Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information about deleting datasets, see Deleting a dataset.


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

      Parameters:
      deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDatasetGroup

      default CompletableFuture<DeleteDatasetGroupResponse> deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)

      Deletes a dataset group. Before you delete a dataset group, you must delete the following:

      • All associated event trackers.

      • All associated solutions.

      • All datasets in the dataset group.

      Parameters:
      deleteDatasetGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteDatasetGroup

      default CompletableFuture<DeleteDatasetGroupResponse> deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)

      Deletes a dataset group. Before you delete a dataset group, you must delete the following:

      • All associated event trackers.

      • All associated solutions.

      • All datasets in the dataset group.


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

      Parameters:
      deleteDatasetGroupRequest - A Consumer that will call methods on DeleteDatasetGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEventTracker

      default CompletableFuture<DeleteEventTrackerResponse> deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)

      Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.

      Parameters:
      deleteEventTrackerRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEventTracker

      default CompletableFuture<DeleteEventTrackerResponse> deleteEventTracker(Consumer<DeleteEventTrackerRequest.Builder> deleteEventTrackerRequest)

      Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.


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

      Parameters:
      deleteEventTrackerRequest - A Consumer that will call methods on DeleteEventTrackerRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteFilter

      default CompletableFuture<DeleteFilterResponse> deleteFilter(DeleteFilterRequest deleteFilterRequest)

      Deletes a filter.

      Parameters:
      deleteFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteFilter

      default CompletableFuture<DeleteFilterResponse> deleteFilter(Consumer<DeleteFilterRequest.Builder> deleteFilterRequest)

      Deletes a filter.


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

      Parameters:
      deleteFilterRequest - A Consumer that will call methods on DeleteFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteMetricAttribution

      default CompletableFuture<DeleteMetricAttributionResponse> deleteMetricAttribution(DeleteMetricAttributionRequest deleteMetricAttributionRequest)

      Deletes a metric attribution.

      Parameters:
      deleteMetricAttributionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteMetricAttribution

      default CompletableFuture<DeleteMetricAttributionResponse> deleteMetricAttribution(Consumer<DeleteMetricAttributionRequest.Builder> deleteMetricAttributionRequest)

      Deletes a metric attribution.


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

      Parameters:
      deleteMetricAttributionRequest - A Consumer that will call methods on DeleteMetricAttributionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRecommender

      default CompletableFuture<DeleteRecommenderResponse> deleteRecommender(DeleteRecommenderRequest deleteRecommenderRequest)

      Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.

      Parameters:
      deleteRecommenderRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRecommender

      default CompletableFuture<DeleteRecommenderResponse> deleteRecommender(Consumer<DeleteRecommenderRequest.Builder> deleteRecommenderRequest)

      Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.


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

      Parameters:
      deleteRecommenderRequest - A Consumer that will call methods on DeleteRecommenderRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSchema

      default CompletableFuture<DeleteSchemaResponse> deleteSchema(DeleteSchemaRequest deleteSchemaRequest)

      Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

      Parameters:
      deleteSchemaRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSchema

      default CompletableFuture<DeleteSchemaResponse> deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest)

      Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.


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

      Parameters:
      deleteSchemaRequest - A Consumer that will call methods on DeleteSchemaRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSolution

      default CompletableFuture<DeleteSolutionResponse> deleteSolution(DeleteSolutionRequest deleteSolutionRequest)

      Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

      Parameters:
      deleteSolutionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteSolution

      default CompletableFuture<DeleteSolutionResponse> deleteSolution(Consumer<DeleteSolutionRequest.Builder> deleteSolutionRequest)

      Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.


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

      Parameters:
      deleteSolutionRequest - A Consumer that will call methods on DeleteSolutionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeAlgorithm

      default CompletableFuture<DescribeAlgorithmResponse> describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)

      Describes the given algorithm.

      Parameters:
      describeAlgorithmRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeAlgorithm

      default CompletableFuture<DescribeAlgorithmResponse> describeAlgorithm(Consumer<DescribeAlgorithmRequest.Builder> describeAlgorithmRequest)

      Describes the given algorithm.


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

      Parameters:
      describeAlgorithmRequest - A Consumer that will call methods on DescribeAlgorithmRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeBatchInferenceJob

      default CompletableFuture<DescribeBatchInferenceJobResponse> describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)

      Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

      Parameters:
      describeBatchInferenceJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeBatchInferenceJob

      default CompletableFuture<DescribeBatchInferenceJobResponse> describeBatchInferenceJob(Consumer<DescribeBatchInferenceJobRequest.Builder> describeBatchInferenceJobRequest)

      Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.


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

      Parameters:
      describeBatchInferenceJobRequest - A Consumer that will call methods on DescribeBatchInferenceJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeBatchSegmentJob

      default CompletableFuture<DescribeBatchSegmentJobResponse> describeBatchSegmentJob(DescribeBatchSegmentJobRequest describeBatchSegmentJobRequest)

      Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

      Parameters:
      describeBatchSegmentJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeBatchSegmentJob

      default CompletableFuture<DescribeBatchSegmentJobResponse> describeBatchSegmentJob(Consumer<DescribeBatchSegmentJobRequest.Builder> describeBatchSegmentJobRequest)

      Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.


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

      Parameters:
      describeBatchSegmentJobRequest - A Consumer that will call methods on DescribeBatchSegmentJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCampaign

      default CompletableFuture<DescribeCampaignResponse> describeCampaign(DescribeCampaignRequest describeCampaignRequest)

      Describes the given campaign, including its status.

      A campaign can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

      For more information on campaigns, see CreateCampaign.

      Parameters:
      describeCampaignRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeCampaign

      default CompletableFuture<DescribeCampaignResponse> describeCampaign(Consumer<DescribeCampaignRequest.Builder> describeCampaignRequest)

      Describes the given campaign, including its status.

      A campaign can be in one of the following states:

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

      • DELETE PENDING > DELETE IN_PROGRESS

      When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

      For more information on campaigns, see CreateCampaign.


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

      Parameters:
      describeCampaignRequest - A Consumer that will call methods on DescribeCampaignRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDataDeletionJob

      default CompletableFuture<DescribeDataDeletionJobResponse> describeDataDeletionJob(DescribeDataDeletionJobRequest describeDataDeletionJobRequest)

      Describes the data deletion job created by CreateDataDeletionJob, including the job status.

      Parameters:
      describeDataDeletionJobRequest -
      Returns:
      A Java Future containing the result of the DescribeDataDeletionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDataDeletionJob

      default CompletableFuture<DescribeDataDeletionJobResponse> describeDataDeletionJob(Consumer<DescribeDataDeletionJobRequest.Builder> describeDataDeletionJobRequest)

      Describes the data deletion job created by CreateDataDeletionJob, including the job status.


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

      Parameters:
      describeDataDeletionJobRequest - A Consumer that will call methods on DescribeDataDeletionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDataDeletionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDataset

      default CompletableFuture<DescribeDatasetResponse> describeDataset(DescribeDatasetRequest describeDatasetRequest)

      Describes the given dataset. For more information on datasets, see CreateDataset.

      Parameters:
      describeDatasetRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDataset

      default CompletableFuture<DescribeDatasetResponse> describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)

      Describes the given dataset. For more information on datasets, see CreateDataset.


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

      Parameters:
      describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDatasetExportJob

      default CompletableFuture<DescribeDatasetExportJobResponse> describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)

      Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

      Parameters:
      describeDatasetExportJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDatasetExportJob

      default CompletableFuture<DescribeDatasetExportJobResponse> describeDatasetExportJob(Consumer<DescribeDatasetExportJobRequest.Builder> describeDatasetExportJobRequest)

      Describes the dataset export job created by CreateDatasetExportJob, including the export job status.


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

      Parameters:
      describeDatasetExportJobRequest - A Consumer that will call methods on DescribeDatasetExportJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDatasetGroup

      default CompletableFuture<DescribeDatasetGroupResponse> describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)

      Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

      Parameters:
      describeDatasetGroupRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDatasetGroup

      default CompletableFuture<DescribeDatasetGroupResponse> describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)

      Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.


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

      Parameters:
      describeDatasetGroupRequest - A Consumer that will call methods on DescribeDatasetGroupRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDatasetImportJob

      default CompletableFuture<DescribeDatasetImportJobResponse> describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)

      Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

      Parameters:
      describeDatasetImportJobRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeDatasetImportJob

      default CompletableFuture<DescribeDatasetImportJobResponse> describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)

      Describes the dataset import job created by CreateDatasetImportJob, including the import job status.


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

      Parameters:
      describeDatasetImportJobRequest - A Consumer that will call methods on DescribeDatasetImportJobRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventTracker

      default CompletableFuture<DescribeEventTrackerResponse> describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)

      Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

      Parameters:
      describeEventTrackerRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventTracker

      default CompletableFuture<DescribeEventTrackerResponse> describeEventTracker(Consumer<DescribeEventTrackerRequest.Builder> describeEventTrackerRequest)

      Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.


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

      Parameters:
      describeEventTrackerRequest - A Consumer that will call methods on DescribeEventTrackerRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeFeatureTransformation

      default CompletableFuture<DescribeFeatureTransformationResponse> describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)

      Describes the given feature transformation.

      Parameters:
      describeFeatureTransformationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeFeatureTransformation

      default CompletableFuture<DescribeFeatureTransformationResponse> describeFeatureTransformation(Consumer<DescribeFeatureTransformationRequest.Builder> describeFeatureTransformationRequest)

      Describes the given feature transformation.


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

      Parameters:
      describeFeatureTransformationRequest - A Consumer that will call methods on DescribeFeatureTransformationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeFilter

      default CompletableFuture<DescribeFilterResponse> describeFilter(DescribeFilterRequest describeFilterRequest)

      Describes a filter's properties.

      Parameters:
      describeFilterRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeFilter

      default CompletableFuture<DescribeFilterResponse> describeFilter(Consumer<DescribeFilterRequest.Builder> describeFilterRequest)

      Describes a filter's properties.


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

      Parameters:
      describeFilterRequest - A Consumer that will call methods on DescribeFilterRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricAttribution

      default CompletableFuture<DescribeMetricAttributionResponse> describeMetricAttribution(DescribeMetricAttributionRequest describeMetricAttributionRequest)

      Describes a metric attribution.

      Parameters:
      describeMetricAttributionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeMetricAttribution

      default CompletableFuture<DescribeMetricAttributionResponse> describeMetricAttribution(Consumer<DescribeMetricAttributionRequest.Builder> describeMetricAttributionRequest)

      Describes a metric attribution.


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

      Parameters:
      describeMetricAttributionRequest - A Consumer that will call methods on DescribeMetricAttributionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeRecipe

      default CompletableFuture<DescribeRecipeResponse> describeRecipe(DescribeRecipeRequest describeRecipeRequest)

      Describes a recipe.

      A recipe contains three items:

      • An algorithm that trains a model.

      • Hyperparameters that govern the training.

      • Feature transformation information for modifying the input data before training.

      Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

      Parameters:
      describeRecipeRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeRecipe

      default CompletableFuture<DescribeRecipeResponse> describeRecipe(Consumer<DescribeRecipeRequest.Builder> describeRecipeRequest)

      Describes a recipe.

      A recipe contains three items:

      • An algorithm that trains a model.

      • Hyperparameters that govern the training.

      • Feature transformation information for modifying the input data before training.

      Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.


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

      Parameters:
      describeRecipeRequest - A Consumer that will call methods on DescribeRecipeRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeRecommender

      default CompletableFuture<DescribeRecommenderResponse> describeRecommender(DescribeRecommenderRequest describeRecommenderRequest)

      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.

      Parameters:
      describeRecommenderRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeRecommender

      default CompletableFuture<DescribeRecommenderResponse> describeRecommender(Consumer<DescribeRecommenderRequest.Builder> describeRecommenderRequest)

      Describes the given recommender, including its status.

      A recommender can be in one of the following states:

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

      • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

      • DELETE PENDING > DELETE IN_PROGRESS

      When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

      The modelMetrics key is null when the recommender is being created or deleted.

      For more information on recommenders, see CreateRecommender.


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

      Parameters:
      describeRecommenderRequest - A Consumer that will call methods on DescribeRecommenderRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSchema

      default CompletableFuture<DescribeSchemaResponse> describeSchema(DescribeSchemaRequest describeSchemaRequest)

      Describes a schema. For more information on schemas, see CreateSchema.

      Parameters:
      describeSchemaRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSchema

      default CompletableFuture<DescribeSchemaResponse> describeSchema(Consumer<DescribeSchemaRequest.Builder> describeSchemaRequest)

      Describes a schema. For more information on schemas, see CreateSchema.


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

      Parameters:
      describeSchemaRequest - A Consumer that will call methods on DescribeSchemaRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSolution

      default CompletableFuture<DescribeSolutionResponse> describeSolution(DescribeSolutionRequest describeSolutionRequest)

      Describes a solution. For more information on solutions, see CreateSolution.

      Parameters:
      describeSolutionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSolution

      default CompletableFuture<DescribeSolutionResponse> describeSolution(Consumer<DescribeSolutionRequest.Builder> describeSolutionRequest)

      Describes a solution. For more information on solutions, see CreateSolution.


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

      Parameters:
      describeSolutionRequest - A Consumer that will call methods on DescribeSolutionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSolutionVersion

      default CompletableFuture<DescribeSolutionVersionResponse> describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)

      Describes a specific version of a solution. For more information on solutions, see CreateSolution

      Parameters:
      describeSolutionVersionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeSolutionVersion

      default CompletableFuture<DescribeSolutionVersionResponse> describeSolutionVersion(Consumer<DescribeSolutionVersionRequest.Builder> describeSolutionVersionRequest)

      Describes a specific version of a solution. For more information on solutions, see CreateSolution


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

      Parameters:
      describeSolutionVersionRequest - A Consumer that will call methods on DescribeSolutionVersionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getSolutionMetrics

      default CompletableFuture<GetSolutionMetricsResponse> getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)

      Gets the metrics for the specified solution version.

      Parameters:
      getSolutionMetricsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getSolutionMetrics

      default CompletableFuture<GetSolutionMetricsResponse> getSolutionMetrics(Consumer<GetSolutionMetricsRequest.Builder> getSolutionMetricsRequest)

      Gets the metrics for the specified solution version.


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

      Parameters:
      getSolutionMetricsRequest - A Consumer that will call methods on GetSolutionMetricsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchInferenceJobs

      default CompletableFuture<ListBatchInferenceJobsResponse> listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)

      Gets a list of the batch inference jobs that have been performed off of a solution version.

      Parameters:
      listBatchInferenceJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchInferenceJobs

      default CompletableFuture<ListBatchInferenceJobsResponse> listBatchInferenceJobs(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)

      Gets a list of the batch inference jobs that have been performed off of a solution version.


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

      Parameters:
      listBatchInferenceJobsRequest - A Consumer that will call methods on ListBatchInferenceJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchInferenceJobsPaginator

      default ListBatchInferenceJobsPublisher listBatchInferenceJobsPaginator(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)

      This is a variant of listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest) operation.

      Parameters:
      listBatchInferenceJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchInferenceJobsPaginator

      default ListBatchInferenceJobsPublisher listBatchInferenceJobsPaginator(Consumer<ListBatchInferenceJobsRequest.Builder> listBatchInferenceJobsRequest)

      This is a variant of listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchInferenceJobsPublisher publisher = client.listBatchInferenceJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listBatchInferenceJobs(software.amazon.awssdk.services.personalize.model.ListBatchInferenceJobsRequest) operation.


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

      Parameters:
      listBatchInferenceJobsRequest - A Consumer that will call methods on ListBatchInferenceJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchSegmentJobs

      default CompletableFuture<ListBatchSegmentJobsResponse> listBatchSegmentJobs(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest)

      Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

      Parameters:
      listBatchSegmentJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchSegmentJobs

      default CompletableFuture<ListBatchSegmentJobsResponse> listBatchSegmentJobs(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest)

      Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.


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

      Parameters:
      listBatchSegmentJobsRequest - A Consumer that will call methods on ListBatchSegmentJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchSegmentJobsPaginator

      default ListBatchSegmentJobsPublisher listBatchSegmentJobsPaginator(ListBatchSegmentJobsRequest listBatchSegmentJobsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse>() {
 
 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 listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest) operation.

      Parameters:
      listBatchSegmentJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchSegmentJobsPaginator

      default ListBatchSegmentJobsPublisher listBatchSegmentJobsPaginator(Consumer<ListBatchSegmentJobsRequest.Builder> listBatchSegmentJobsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListBatchSegmentJobsPublisher publisher = client.listBatchSegmentJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsResponse>() {
 
 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 listBatchSegmentJobs(software.amazon.awssdk.services.personalize.model.ListBatchSegmentJobsRequest) operation.


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

      Parameters:
      listBatchSegmentJobsRequest - A Consumer that will call methods on ListBatchSegmentJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCampaigns

      default CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest)

      Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

      Parameters:
      listCampaignsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCampaigns

      default CompletableFuture<ListCampaignsResponse> listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)

      Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.


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

      Parameters:
      listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCampaignsPaginator

      default ListCampaignsPublisher listCampaignsPaginator(ListCampaignsRequest listCampaignsRequest)

      This is a variant of listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListCampaignsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation.

      Parameters:
      listCampaignsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCampaignsPaginator

      default ListCampaignsPublisher listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest)

      This is a variant of listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListCampaignsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListCampaignsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCampaigns(software.amazon.awssdk.services.personalize.model.ListCampaignsRequest) operation.


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

      Parameters:
      listCampaignsRequest - A Consumer that will call methods on ListCampaignsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDataDeletionJobs

      default CompletableFuture<ListDataDeletionJobsResponse> listDataDeletionJobs(ListDataDeletionJobsRequest listDataDeletionJobsRequest)

      Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.

      Parameters:
      listDataDeletionJobsRequest -
      Returns:
      A Java Future containing the result of the ListDataDeletionJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDataDeletionJobs

      default CompletableFuture<ListDataDeletionJobsResponse> listDataDeletionJobs(Consumer<ListDataDeletionJobsRequest.Builder> listDataDeletionJobsRequest)

      Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see Deleting users.


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

      Parameters:
      listDataDeletionJobsRequest - A Consumer that will call methods on ListDataDeletionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataDeletionJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetExportJobs

      default CompletableFuture<ListDatasetExportJobsResponse> listDatasetExportJobs(ListDatasetExportJobsRequest listDatasetExportJobsRequest)

      Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

      Parameters:
      listDatasetExportJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetExportJobs

      default CompletableFuture<ListDatasetExportJobsResponse> listDatasetExportJobs(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)

      Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.


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

      Parameters:
      listDatasetExportJobsRequest - A Consumer that will call methods on ListDatasetExportJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetExportJobsPaginator

      default ListDatasetExportJobsPublisher listDatasetExportJobsPaginator(ListDatasetExportJobsRequest listDatasetExportJobsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse>() {
 
 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 listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest) operation.

      Parameters:
      listDatasetExportJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetExportJobsPaginator

      default ListDatasetExportJobsPublisher listDatasetExportJobsPaginator(Consumer<ListDatasetExportJobsRequest.Builder> listDatasetExportJobsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetExportJobsPublisher publisher = client.listDatasetExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsResponse>() {
 
 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 listDatasetExportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetExportJobsRequest) operation.


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

      Parameters:
      listDatasetExportJobsRequest - A Consumer that will call methods on ListDatasetExportJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetGroups

      default CompletableFuture<ListDatasetGroupsResponse> listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)

      Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

      Parameters:
      listDatasetGroupsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetGroups

      default CompletableFuture<ListDatasetGroupsResponse> listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)

      Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.


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

      Parameters:
      listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetGroupsPaginator

      default ListDatasetGroupsPublisher listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)

      This is a variant of listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation.

      Parameters:
      listDatasetGroupsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetGroupsPaginator

      default ListDatasetGroupsPublisher listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)

      This is a variant of listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatasetGroups(software.amazon.awssdk.services.personalize.model.ListDatasetGroupsRequest) operation.


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

      Parameters:
      listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetImportJobs

      default CompletableFuture<ListDatasetImportJobsResponse> listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)

      Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

      Parameters:
      listDatasetImportJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetImportJobs

      default CompletableFuture<ListDatasetImportJobsResponse> listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)

      Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.


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

      Parameters:
      listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetImportJobsPaginator

      default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)

      This is a variant of listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest) operation.

      Parameters:
      listDatasetImportJobsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetImportJobsPaginator

      default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)

      This is a variant of listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatasetImportJobs(software.amazon.awssdk.services.personalize.model.ListDatasetImportJobsRequest) operation.


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

      Parameters:
      listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasets

      default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest)

      Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

      Parameters:
      listDatasetsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasets

      default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)

      Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.


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

      Parameters:
      listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetsPaginator

      default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)

      This is a variant of listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation.

      Parameters:
      listDatasetsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listDatasetsPaginator

      default ListDatasetsPublisher listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)

      This is a variant of listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListDatasetsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListDatasetsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatasets(software.amazon.awssdk.services.personalize.model.ListDatasetsRequest) operation.


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

      Parameters:
      listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventTrackers

      default CompletableFuture<ListEventTrackersResponse> listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)

      Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

      Parameters:
      listEventTrackersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventTrackers

      default CompletableFuture<ListEventTrackersResponse> listEventTrackers(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)

      Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.


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

      Parameters:
      listEventTrackersRequest - A Consumer that will call methods on ListEventTrackersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventTrackersPaginator

      default ListEventTrackersPublisher listEventTrackersPaginator(ListEventTrackersRequest listEventTrackersRequest)

      This is a variant of listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation.

      Parameters:
      listEventTrackersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventTrackersPaginator

      default ListEventTrackersPublisher listEventTrackersPaginator(Consumer<ListEventTrackersRequest.Builder> listEventTrackersRequest)

      This is a variant of listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListEventTrackersPublisher publisher = client.listEventTrackersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListEventTrackersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEventTrackers(software.amazon.awssdk.services.personalize.model.ListEventTrackersRequest) operation.


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

      Parameters:
      listEventTrackersRequest - A Consumer that will call methods on ListEventTrackersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFilters

      default CompletableFuture<ListFiltersResponse> listFilters(ListFiltersRequest listFiltersRequest)

      Lists all filters that belong to a given dataset group.

      Parameters:
      listFiltersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFilters

      default CompletableFuture<ListFiltersResponse> listFilters(Consumer<ListFiltersRequest.Builder> listFiltersRequest)

      Lists all filters that belong to a given dataset group.


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

      Parameters:
      listFiltersRequest - A Consumer that will call methods on ListFiltersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFiltersPaginator

      default ListFiltersPublisher listFiltersPaginator(ListFiltersRequest listFiltersRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListFiltersResponse>() {
 
 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 listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest) operation.

      Parameters:
      listFiltersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listFiltersPaginator

      default ListFiltersPublisher listFiltersPaginator(Consumer<ListFiltersRequest.Builder> listFiltersRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListFiltersPublisher publisher = client.listFiltersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListFiltersResponse>() {
 
 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 listFilters(software.amazon.awssdk.services.personalize.model.ListFiltersRequest) operation.


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

      Parameters:
      listFiltersRequest - A Consumer that will call methods on ListFiltersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributionMetrics

      default CompletableFuture<ListMetricAttributionMetricsResponse> listMetricAttributionMetrics(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)

      Lists the metrics for the metric attribution.

      Parameters:
      listMetricAttributionMetricsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributionMetrics

      default CompletableFuture<ListMetricAttributionMetricsResponse> listMetricAttributionMetrics(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)

      Lists the metrics for the metric attribution.


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

      Parameters:
      listMetricAttributionMetricsRequest - A Consumer that will call methods on ListMetricAttributionMetricsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributionMetricsPaginator

      default ListMetricAttributionMetricsPublisher listMetricAttributionMetricsPaginator(ListMetricAttributionMetricsRequest listMetricAttributionMetricsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse>() {
 
 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 listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest) operation.

      Parameters:
      listMetricAttributionMetricsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributionMetricsPaginator

      default ListMetricAttributionMetricsPublisher listMetricAttributionMetricsPaginator(Consumer<ListMetricAttributionMetricsRequest.Builder> listMetricAttributionMetricsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionMetricsPublisher publisher = client.listMetricAttributionMetricsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsResponse>() {
 
 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 listMetricAttributionMetrics(software.amazon.awssdk.services.personalize.model.ListMetricAttributionMetricsRequest) operation.


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

      Parameters:
      listMetricAttributionMetricsRequest - A Consumer that will call methods on ListMetricAttributionMetricsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributions

      default CompletableFuture<ListMetricAttributionsResponse> listMetricAttributions(ListMetricAttributionsRequest listMetricAttributionsRequest)

      Lists metric attributions.

      Parameters:
      listMetricAttributionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributions

      default CompletableFuture<ListMetricAttributionsResponse> listMetricAttributions(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest)

      Lists metric attributions.


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

      Parameters:
      listMetricAttributionsRequest - A Consumer that will call methods on ListMetricAttributionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributionsPaginator

      default ListMetricAttributionsPublisher listMetricAttributionsPaginator(ListMetricAttributionsRequest listMetricAttributionsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse>() {
 
 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 listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest) operation.

      Parameters:
      listMetricAttributionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMetricAttributionsPaginator

      default ListMetricAttributionsPublisher listMetricAttributionsPaginator(Consumer<ListMetricAttributionsRequest.Builder> listMetricAttributionsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListMetricAttributionsPublisher publisher = client.listMetricAttributionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListMetricAttributionsResponse>() {
 
 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 listMetricAttributions(software.amazon.awssdk.services.personalize.model.ListMetricAttributionsRequest) operation.


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

      Parameters:
      listMetricAttributionsRequest - A Consumer that will call methods on ListMetricAttributionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecipes

      default CompletableFuture<ListRecipesResponse> listRecipes(ListRecipesRequest listRecipesRequest)

      Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

      Parameters:
      listRecipesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecipes

      default CompletableFuture<ListRecipesResponse> listRecipes(Consumer<ListRecipesRequest.Builder> listRecipesRequest)

      Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).


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

      Parameters:
      listRecipesRequest - A Consumer that will call methods on ListRecipesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecipesPaginator

      default ListRecipesPublisher listRecipesPaginator(ListRecipesRequest listRecipesRequest)

      This is a variant of listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListRecipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListRecipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation.

      Parameters:
      listRecipesRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecipesPaginator

      default ListRecipesPublisher listRecipesPaginator(Consumer<ListRecipesRequest.Builder> listRecipesRequest)

      This is a variant of listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecipesPublisher publisher = client.listRecipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListRecipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListRecipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listRecipes(software.amazon.awssdk.services.personalize.model.ListRecipesRequest) operation.


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

      Parameters:
      listRecipesRequest - A Consumer that will call methods on ListRecipesRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommenders

      default CompletableFuture<ListRecommendersResponse> listRecommenders(ListRecommendersRequest listRecommendersRequest)

      Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.

      Parameters:
      listRecommendersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommenders

      default CompletableFuture<ListRecommendersResponse> listRecommenders(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)

      Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.


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

      Parameters:
      listRecommendersRequest - A Consumer that will call methods on ListRecommendersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommendersPaginator

      default ListRecommendersPublisher listRecommendersPaginator(ListRecommendersRequest listRecommendersRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListRecommendersResponse>() {
 
 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 listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest) operation.

      Parameters:
      listRecommendersRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommendersPaginator

      default ListRecommendersPublisher listRecommendersPaginator(Consumer<ListRecommendersRequest.Builder> listRecommendersRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListRecommendersPublisher publisher = client.listRecommendersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListRecommendersResponse>() {
 
 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 listRecommenders(software.amazon.awssdk.services.personalize.model.ListRecommendersRequest) operation.


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

      Parameters:
      listRecommendersRequest - A Consumer that will call methods on ListRecommendersRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSchemas

      default CompletableFuture<ListSchemasResponse> listSchemas(ListSchemasRequest listSchemasRequest)

      Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

      Parameters:
      listSchemasRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSchemas

      default CompletableFuture<ListSchemasResponse> listSchemas(Consumer<ListSchemasRequest.Builder> listSchemasRequest)

      Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.


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

      Parameters:
      listSchemasRequest - A Consumer that will call methods on ListSchemasRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSchemasPaginator

      default ListSchemasPublisher listSchemasPaginator(ListSchemasRequest listSchemasRequest)

      This is a variant of listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSchemasResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListSchemasResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation.

      Parameters:
      listSchemasRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSchemasPaginator

      default ListSchemasPublisher listSchemasPaginator(Consumer<ListSchemasRequest.Builder> listSchemasRequest)

      This is a variant of listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListSchemasPublisher publisher = client.listSchemasPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSchemasResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListSchemasResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSchemas(software.amazon.awssdk.services.personalize.model.ListSchemasRequest) operation.


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

      Parameters:
      listSchemasRequest - A Consumer that will call methods on ListSchemasRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutionVersions

      default CompletableFuture<ListSolutionVersionsResponse> listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)

      Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).

      Parameters:
      listSolutionVersionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutionVersions

      default CompletableFuture<ListSolutionVersionsResponse> listSolutionVersions(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)

      Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN).


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

      Parameters:
      listSolutionVersionsRequest - A Consumer that will call methods on ListSolutionVersionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutionVersionsPaginator

      default ListSolutionVersionsPublisher listSolutionVersionsPaginator(ListSolutionVersionsRequest listSolutionVersionsRequest)

      This is a variant of listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest) operation.

      Parameters:
      listSolutionVersionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutionVersionsPaginator

      default ListSolutionVersionsPublisher listSolutionVersionsPaginator(Consumer<ListSolutionVersionsRequest.Builder> listSolutionVersionsRequest)

      This is a variant of listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionVersionsPublisher publisher = client.listSolutionVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSolutionVersions(software.amazon.awssdk.services.personalize.model.ListSolutionVersionsRequest) operation.


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

      Parameters:
      listSolutionVersionsRequest - A Consumer that will call methods on ListSolutionVersionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutions

      default CompletableFuture<ListSolutionsResponse> listSolutions(ListSolutionsRequest listSolutionsRequest)

      Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

      Parameters:
      listSolutionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutions

      default CompletableFuture<ListSolutionsResponse> listSolutions(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)

      Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.


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

      Parameters:
      listSolutionsRequest - A Consumer that will call methods on ListSolutionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutionsPaginator

      default ListSolutionsPublisher listSolutionsPaginator(ListSolutionsRequest listSolutionsRequest)

      This is a variant of listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation.

      Parameters:
      listSolutionsRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSolutionsPaginator

      default ListSolutionsPublisher listSolutionsPaginator(Consumer<ListSolutionsRequest.Builder> listSolutionsRequest)

      This is a variant of listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.personalize.paginators.ListSolutionsPublisher publisher = client.listSolutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.personalize.model.ListSolutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.personalize.model.ListSolutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSolutions(software.amazon.awssdk.services.personalize.model.ListSolutionsRequest) operation.


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

      Parameters:
      listSolutionsRequest - A Consumer that will call methods on ListSolutionsRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Get a list of tags attached to a resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Get a list of tags attached to a resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startRecommender

      default CompletableFuture<StartRecommenderResponse> startRecommender(StartRecommenderRequest startRecommenderRequest)

      Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.

      Parameters:
      startRecommenderRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startRecommender

      default CompletableFuture<StartRecommenderResponse> startRecommender(Consumer<StartRecommenderRequest.Builder> startRecommenderRequest)

      Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.


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

      Parameters:
      startRecommenderRequest - A Consumer that will call methods on StartRecommenderRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopRecommender

      default CompletableFuture<StopRecommenderResponse> stopRecommender(StopRecommenderRequest stopRecommenderRequest)

      Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

      Parameters:
      stopRecommenderRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopRecommender

      default CompletableFuture<StopRecommenderResponse> stopRecommender(Consumer<StopRecommenderRequest.Builder> stopRecommenderRequest)

      Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.


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

      Parameters:
      stopRecommenderRequest - A Consumer that will call methods on StopRecommenderRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopSolutionVersionCreation

      default CompletableFuture<StopSolutionVersionCreationResponse> stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest)

      Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

      Depending on the current state of the solution version, the solution version state changes as follows:

      • CREATE_PENDING > CREATE_STOPPED

        or

      • CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

      You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

      Parameters:
      stopSolutionVersionCreationRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopSolutionVersionCreation

      default CompletableFuture<StopSolutionVersionCreationResponse> stopSolutionVersionCreation(Consumer<StopSolutionVersionCreationRequest.Builder> stopSolutionVersionCreationRequest)

      Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

      Depending on the current state of the solution version, the solution version state changes as follows:

      • CREATE_PENDING > CREATE_STOPPED

        or

      • CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

      You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.


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

      Parameters:
      stopSolutionVersionCreationRequest - A Consumer that will call methods on StopSolutionVersionCreationRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Add a list of tags to a resource.

      Parameters:
      tagResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Add a list of tags to a resource.


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.

      Parameters:
      untagResourceRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateCampaign

      default CompletableFuture<UpdateCampaignResponse> updateCampaign(UpdateCampaignRequest updateCampaignRequest)

      Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

      To update a campaign to start automatically using the latest solution version, specify the following:

      • For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/invalid input: '&#36'LATEST format.

      • In the campaignConfig, set syncWithLatestSolutionVersion to true.

      To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

      You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

      For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

      Parameters:
      updateCampaignRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateCampaign

      default CompletableFuture<UpdateCampaignResponse> updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest)

      Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

      To update a campaign to start automatically using the latest solution version, specify the following:

      • For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/invalid input: '&#36'LATEST format.

      • In the campaignConfig, set syncWithLatestSolutionVersion to true.

      To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

      You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

      For more information about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.


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

      Parameters:
      updateCampaignRequest - A Consumer that will call methods on UpdateCampaignRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateDataset

      default CompletableFuture<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest updateDatasetRequest)

      Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.

      Parameters:
      updateDatasetRequest -
      Returns:
      A Java Future containing the result of the UpdateDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateDataset

      default CompletableFuture<UpdateDatasetResponse> updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)

      Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.


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

      Parameters:
      updateDatasetRequest - A Consumer that will call methods on UpdateDatasetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateMetricAttribution

      default CompletableFuture<UpdateMetricAttributionResponse> updateMetricAttribution(UpdateMetricAttributionRequest updateMetricAttributionRequest)

      Updates a metric attribution.

      Parameters:
      updateMetricAttributionRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateMetricAttribution

      default CompletableFuture<UpdateMetricAttributionResponse> updateMetricAttribution(Consumer<UpdateMetricAttributionRequest.Builder> updateMetricAttributionRequest)

      Updates a metric attribution.


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

      Parameters:
      updateMetricAttributionRequest - A Consumer that will call methods on UpdateMetricAttributionRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateRecommender

      default CompletableFuture<UpdateRecommenderResponse> updateRecommender(UpdateRecommenderRequest updateRecommenderRequest)

      Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.

      Parameters:
      updateRecommenderRequest -
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateRecommender

      default CompletableFuture<UpdateRecommenderResponse> updateRecommender(Consumer<UpdateRecommenderRequest.Builder> updateRecommenderRequest)

      Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operation.


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

      Parameters:
      updateRecommenderRequest - A Consumer that will call methods on UpdateRecommenderRequest.Builder to create a request.
      Returns:
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateSolution

      default CompletableFuture<UpdateSolutionResponse> updateSolution(UpdateSolutionRequest updateSolutionRequest)

      Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution.

      A solution update can be in one of the following states:

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

      To get the status of a solution update, call the DescribeSolution API operation and find the status in the latestSolutionUpdate.

      Parameters:
      updateSolutionRequest -
      Returns:
      A Java Future containing the result of the UpdateSolution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException Provide a valid value for the field or parameter.
      • ResourceNotFoundException Could not find the specified resource.
      • ResourceInUseException The specified resource is in use.
      • LimitExceededException The limit on the number of requests per second has been exceeded.
      • 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.
      See Also:

    • updateSolution

      default CompletableFuture<UpdateSolutionResponse> updateSolution(Consumer<UpdateSolutionRequest.Builder> updateSolutionRequest)

      Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution.

      A solution update can be in one of the following states:

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

      To get the status of a solution update, call the DescribeSolution API operation and find the status in the latestSolutionUpdate.


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

      Parameters:
      updateSolutionRequest - A Consumer that will call methods on UpdateSolutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSolution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidInputException Provide a valid value for the field or parameter.
      • ResourceNotFoundException Could not find the specified resource.
      • ResourceInUseException The specified resource is in use.
      • LimitExceededException The limit on the number of requests per second has been exceeded.
      • 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.
      See Also:

    • serviceClientConfiguration

      default PersonalizeServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static PersonalizeAsyncClient create()
      Create a PersonalizeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static PersonalizeAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PersonalizeAsyncClient.