Package software.amazon.awssdk.services.personalize

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 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