aws-sdk-personalize 1.54.0 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd14d8e66b02fd14e030e52361d24584538dfa1cc20d6814802e6b497de4752c
-  data.tar.gz: '080a3ff20c4b6d95735aaa84412df43891c8bb6c4569a91eca62b9a52357a8a4'
+  metadata.gz: c7daeac7194e519e51c19b3c071131c0b6fe08345bc89c14598ff66c59133311
+  data.tar.gz: 3b5d14a30c53697c62bd7fcf5225b3618a16e0177f4fa956bd4e51824815fdd6
 SHA512:
-  metadata.gz: dfb17ef08475162941d7ce4764612c45d8315d07be32f2548c6ad18ee72911395c60efdb48c482753eb23b5162dd12c3e47992d6b72d65887923c812c13f051b
-  data.tar.gz: 87955eacb81de2d276145fffe928b7438fc7cfecfa3bd59ea8a7aa262433160c6f8907a7b149773706de65037e9c0a576582513e6eabfe21ae3ac24931eebccc
+  metadata.gz: 8249caaeae22b0da592a66919f33953809851d6109bb16579caf462d0ffac907c0399740b4676e477ae022ba8c2ee60382c471947a53941799dc0776f4d8d74f
+  data.tar.gz: f29fcdaea018ee05cceb6ce38147a78802af59bbbf22387fc97b9c449cd4697f28bdef7a0f720d39c05b0e16210604c39396a6010e3e04223f05dc31a2160bd4

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.56.0 (2023-11-27)
+------------------
+
+* Feature - Enables metadata in recommendations, recommendations with themes, and next best action recommendations
+
+1.55.0 (2023-11-22)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.54.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.54.0
+1.56.0

data/lib/aws-sdk-personalize/client.rb

@@ -398,13 +398,35 @@ module Aws::Personalize
 
     # @!group API Operations
 
-    # Creates a batch inference job. The operation can handle up to 50
-    # million records and the input file must be in JSON format. For more
-    # information, see [Creating a batch inference job][1].
+    # 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 ][1].
     #
-    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html
+    # 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 ][2].
+    #
+    # You can't get batch recommendations with the Trending-Now or
+    # Next-Best-Action recipes.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html
+    # [2]: https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html
     #
     # @option params [required, String] :job_name
     #   The name of the batch inference job to create.
@@ -448,6 +470,24 @@ module Aws::Personalize
     #
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
     #
+    # @option params [String] :batch_inference_job_mode
+    #   The mode of the batch inference job. To generate descriptive themes
+    #   for groups of similar items, set the job mode to `THEME_GENERATION`.
+    #   If you don't want to generate themes, use the default
+    #   `BATCH_INFERENCE`.
+    #
+    #   When you get batch recommendations with themes, you will incur
+    #   additional costs. For more information, see [Amazon Personalize
+    #   pricing][1].
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/personalize/pricing/
+    #
+    # @option params [Types::ThemeGenerationConfig] :theme_generation_config
+    #   For theme generation jobs, specify the name of the column in your
+    #   Items dataset that contains each item's name.
+    #
     # @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
@@ -483,6 +523,12 @@ module Aws::Personalize
     #         tag_value: "TagValue", # required
     #       },
     #     ],
+    #     batch_inference_job_mode: "BATCH_INFERENCE", # accepts BATCH_INFERENCE, THEME_GENERATION
+    #     theme_generation_config: {
+    #       fields_for_theme_generation: { # required
+    #         item_name: "ColumnName", # required
+    #       },
+    #     },
     #   })
     #
     # @example Response structure
@@ -695,6 +741,7 @@ module Aws::Personalize
     #       item_exploration_config: {
     #         "ParameterName" => "ParameterValue",
     #       },
+    #       enable_metadata_with_recommendations: false,
     #     },
     #     tags: [
     #       {
@@ -721,17 +768,21 @@ module Aws::Personalize
     # Use [CreateDatasetImportJob][1] to import your training data to a
     # dataset.
     #
-    # There are three types of datasets:
+    # There are 5 types of datasets:
     #
-    # * Interactions
+    # * Item interactions
     #
     # * Items
     #
     # * Users
     #
+    # * Action interactions
+    #
+    # * Actions
+    #
     # Each dataset type has an associated schema with required field types.
-    # Only the `Interactions` dataset is required in order to train a model
-    # (also referred to as creating a solution).
+    # 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:
     #
@@ -782,6 +833,10 @@ module Aws::Personalize
     #
     #   * Users
     #
+    #   * Actions
+    #
+    #   * Action\_Interactions
+    #
     # @option params [Array<Types::Tag>] :tags
     #   A list of [tags][1] to apply to the dataset.
     #
@@ -919,12 +974,16 @@ module Aws::Personalize
     # Amazon Personalize resources. A dataset group can contain at most
     # three datasets, one for each type of dataset:
     #
-    # * Interactions
+    # * 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
@@ -1049,6 +1108,12 @@ module Aws::Personalize
     # bucket, see [Giving Amazon Personalize Access to Amazon S3
     # Resources][1].
     #
+    # 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][2].
+    #
     # 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
@@ -1064,7 +1129,7 @@ module Aws::Personalize
     # ^
     #
     # To get the status of the import job, call
-    # [DescribeDatasetImportJob][2], providing the Amazon Resource Name
+    # [DescribeDatasetImportJob][3], 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
@@ -1077,15 +1142,16 @@ module Aws::Personalize
     #
     # **Related APIs**
     #
-    # * [ListDatasetImportJobs][3]
+    # * [ListDatasetImportJobs][4]
     #
-    # * [DescribeDatasetImportJob][2]
+    # * [DescribeDatasetImportJob][3]
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
-    # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html
-    # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html
+    # [2]: https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html
+    # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html
+    # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html
     #
     # @option params [required, String] :job_name
     #   The name for the dataset import job.
@@ -1170,8 +1236,8 @@ module Aws::Personalize
     #
     # When you create an event tracker, the response includes a tracking ID,
     # which you pass as a parameter when you use the [PutEvents][1]
-    # operation. Amazon Personalize then appends the event data to the
-    # Interactions dataset of the dataset group you specify in your event
+    # 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:
@@ -1497,6 +1563,7 @@ module Aws::Personalize
     #           "DatasetType" => ["ColumnName"],
     #         },
     #       },
+    #       enable_metadata_with_recommendations: false,
     #     },
     #     tags: [
     #       {
@@ -1851,21 +1918,30 @@ module Aws::Personalize
     #
     # @option params [String] :training_mode
     #   The scope of training to be performed when creating the solution
-    #   version. The `FULL` option trains the solution version based on the
-    #   entirety of the input solution's training data, while the `UPDATE`
-    #   option processes only the data that has changed in comparison to the
-    #   input solution. Choose `UPDATE` when you want to incrementally update
-    #   your solution version instead of creating an entirely new one.
+    #   version. The default is `FULL`. This creates a completely new model
+    #   based on the entirety of the training data from the datasets in your
+    #   dataset group.
+    #
+    #   If you use [User-Personalization][1], you can specify a training mode
+    #   of `UPDATE`. This updates the model to consider new items for
+    #   recommendations. It is not a full retraining. You should still
+    #   complete a full retraining weekly. If you specify `UPDATE`, Amazon
+    #   Personalize will stop automatic updates for the solution version. To
+    #   resume updates, create a new solution with training mode set to `FULL`
+    #   and deploy it in a campaign. For more information about automatic
+    #   updates, see [Automatic updates][2].
     #
     #   The `UPDATE` option can only be used when you already have an active
     #   solution version created from the input solution using the `FULL`
     #   option and the input solution was trained with the
-    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #   [User-Personalization][1] recipe or the legacy [HRNN-Coldstart][3]
+    #   recipe.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
-    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates
+    #   [3]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #
     # @option params [Array<Types::Tag>] :tags
     #   A list of [tags][1] to apply to the solution version.
@@ -1994,9 +2070,9 @@ module Aws::Personalize
       req.send_request(options)
     end
 
-    # Deletes the event tracker. Does not delete the event-interactions
-    # dataset from the associated dataset group. For more information on
-    # event trackers, see [CreateEventTracker][1].
+    # Deletes the event tracker. Does not delete the dataset from the
+    # dataset group. For more information on event trackers, see
+    # [CreateEventTracker][1].
     #
     #
     #
@@ -2240,6 +2316,8 @@ module Aws::Personalize
     #   resp.batch_inference_job.batch_inference_job_config.item_exploration_config #=> Hash
     #   resp.batch_inference_job.batch_inference_job_config.item_exploration_config["ParameterName"] #=> String
     #   resp.batch_inference_job.role_arn #=> String
+    #   resp.batch_inference_job.batch_inference_job_mode #=> String, one of "BATCH_INFERENCE", "THEME_GENERATION"
+    #   resp.batch_inference_job.theme_generation_config.fields_for_theme_generation.item_name #=> String
     #   resp.batch_inference_job.status #=> String
     #   resp.batch_inference_job.creation_date_time #=> Time
     #   resp.batch_inference_job.last_updated_date_time #=> Time
@@ -2335,6 +2413,7 @@ module Aws::Personalize
     #   resp.campaign.min_provisioned_tps #=> Integer
     #   resp.campaign.campaign_config.item_exploration_config #=> Hash
     #   resp.campaign.campaign_config.item_exploration_config["ParameterName"] #=> String
+    #   resp.campaign.campaign_config.enable_metadata_with_recommendations #=> Boolean
     #   resp.campaign.status #=> String
     #   resp.campaign.failure_reason #=> String
     #   resp.campaign.creation_date_time #=> Time
@@ -2343,6 +2422,7 @@ module Aws::Personalize
     #   resp.campaign.latest_campaign_update.min_provisioned_tps #=> Integer
     #   resp.campaign.latest_campaign_update.campaign_config.item_exploration_config #=> Hash
     #   resp.campaign.latest_campaign_update.campaign_config.item_exploration_config["ParameterName"] #=> String
+    #   resp.campaign.latest_campaign_update.campaign_config.enable_metadata_with_recommendations #=> Boolean
     #   resp.campaign.latest_campaign_update.status #=> String
     #   resp.campaign.latest_campaign_update.failure_reason #=> String
     #   resp.campaign.latest_campaign_update.creation_date_time #=> Time
@@ -2392,6 +2472,7 @@ module Aws::Personalize
     #   resp.dataset.latest_dataset_update.failure_reason #=> String
     #   resp.dataset.latest_dataset_update.creation_date_time #=> Time
     #   resp.dataset.latest_dataset_update.last_updated_date_time #=> Time
+    #   resp.dataset.tracking_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset AWS API Documentation
     #
@@ -2783,6 +2864,7 @@ module Aws::Personalize
     #   resp.recommender.recommender_config.training_data_config.excluded_dataset_columns #=> Hash
     #   resp.recommender.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
     #   resp.recommender.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
+    #   resp.recommender.recommender_config.enable_metadata_with_recommendations #=> Boolean
     #   resp.recommender.creation_date_time #=> Time
     #   resp.recommender.last_updated_date_time #=> Time
     #   resp.recommender.status #=> String
@@ -2793,6 +2875,7 @@ module Aws::Personalize
     #   resp.recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns #=> Hash
     #   resp.recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
     #   resp.recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
+    #   resp.recommender.latest_recommender_update.recommender_config.enable_metadata_with_recommendations #=> Boolean
     #   resp.recommender.latest_recommender_update.creation_date_time #=> Time
     #   resp.recommender.latest_recommender_update.last_updated_date_time #=> Time
     #   resp.recommender.latest_recommender_update.status #=> String
@@ -3074,6 +3157,7 @@ module Aws::Personalize
     #   resp.batch_inference_jobs[0].last_updated_date_time #=> Time
     #   resp.batch_inference_jobs[0].failure_reason #=> String
     #   resp.batch_inference_jobs[0].solution_version_arn #=> String
+    #   resp.batch_inference_jobs[0].batch_inference_job_mode #=> String, one of "BATCH_INFERENCE", "THEME_GENERATION"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs AWS API Documentation
@@ -3379,8 +3463,8 @@ module Aws::Personalize
     #   datasets to list.
     #
     # @option params [String] :next_token
-    #   A token returned from the previous call to `ListDatasetImportJobs` for
-    #   getting the next set of dataset import jobs (if they exist).
+    #   A token returned from the previous call to `ListDatasets` for getting
+    #   the next set of dataset import jobs (if they exist).
     #
     # @option params [Integer] :max_results
     #   The maximum number of datasets to return.
@@ -3720,6 +3804,7 @@ module Aws::Personalize
     #   resp.recommenders[0].recommender_config.training_data_config.excluded_dataset_columns #=> Hash
     #   resp.recommenders[0].recommender_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
     #   resp.recommenders[0].recommender_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
+    #   resp.recommenders[0].recommender_config.enable_metadata_with_recommendations #=> Boolean
     #   resp.recommenders[0].status #=> String
     #   resp.recommenders[0].creation_date_time #=> Time
     #   resp.recommenders[0].last_updated_date_time #=> Time
@@ -4082,8 +4167,10 @@ module Aws::Personalize
       req.send_request(options)
     end
 
-    # Updates a campaign by either deploying a new solution or changing the
-    # value of the campaign's `minProvisionedTPS` parameter.
+    # Updates a campaign to deploy a retrained solution version with an
+    # existing campaign, change your campaign's `minProvisionedTPS`, or
+    # modify your campaign's configuration, such as the exploration
+    # configuration.
     #
     # To update a campaign, the campaign status must be ACTIVE or CREATE
     # FAILED. Check the campaign status using the [DescribeCampaign][1]
@@ -4096,12 +4183,15 @@ module Aws::Personalize
     #
     #  </note>
     #
-    # For more information on campaigns, see [CreateCampaign][2].
+    # For more information about updating a campaign, including code
+    # samples, see [Updating a campaign][2]. For more information about
+    # campaigns, see [Creating a campaign][3].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
-    # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
+    # [2]: https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html
+    # [3]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html
     #
     # @option params [required, String] :campaign_arn
     #   The Amazon Resource Name (ARN) of the campaign.
@@ -4134,6 +4224,7 @@ module Aws::Personalize
     #       item_exploration_config: {
     #         "ParameterName" => "ParameterValue",
     #       },
+    #       enable_metadata_with_recommendations: false,
     #     },
     #   })
     #
@@ -4276,6 +4367,7 @@ module Aws::Personalize
     #           "DatasetType" => ["ColumnName"],
     #         },
     #       },
+    #       enable_metadata_with_recommendations: false,
     #     },
     #   })
     #
@@ -4305,7 +4397,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.54.0'
+      context[:gem_version] = '1.56.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-personalize/client_api.rb

@@ -24,6 +24,7 @@ module Aws::Personalize
     BatchInferenceJob = Shapes::StructureShape.new(name: 'BatchInferenceJob')
     BatchInferenceJobConfig = Shapes::StructureShape.new(name: 'BatchInferenceJobConfig')
     BatchInferenceJobInput = Shapes::StructureShape.new(name: 'BatchInferenceJobInput')
+    BatchInferenceJobMode = Shapes::StringShape.new(name: 'BatchInferenceJobMode')
     BatchInferenceJobOutput = Shapes::StructureShape.new(name: 'BatchInferenceJobOutput')
     BatchInferenceJobSummary = Shapes::StructureShape.new(name: 'BatchInferenceJobSummary')
     BatchInferenceJobs = Shapes::ListShape.new(name: 'BatchInferenceJobs')
@@ -159,6 +160,7 @@ module Aws::Personalize
     FeatureTransformation = Shapes::StructureShape.new(name: 'FeatureTransformation')
     FeatureTransformationParameters = Shapes::MapShape.new(name: 'FeatureTransformationParameters')
     FeaturizationParameters = Shapes::MapShape.new(name: 'FeaturizationParameters')
+    FieldsForThemeGeneration = Shapes::StructureShape.new(name: 'FieldsForThemeGeneration')
     Filter = Shapes::StructureShape.new(name: 'Filter')
     FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
     FilterSummary = Shapes::StructureShape.new(name: 'FilterSummary')
@@ -277,6 +279,7 @@ module Aws::Personalize
     TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
     TagValue = Shapes::StringShape.new(name: 'TagValue')
     Tags = Shapes::ListShape.new(name: 'Tags')
+    ThemeGenerationConfig = Shapes::StructureShape.new(name: 'ThemeGenerationConfig')
     TooManyTagKeysException = Shapes::StructureShape.new(name: 'TooManyTagKeysException')
     TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
     TrackingId = Shapes::StringShape.new(name: 'TrackingId')
@@ -333,6 +336,8 @@ module Aws::Personalize
     BatchInferenceJob.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, location_name: "jobOutput"))
     BatchInferenceJob.add_member(:batch_inference_job_config, Shapes::ShapeRef.new(shape: BatchInferenceJobConfig, location_name: "batchInferenceJobConfig"))
     BatchInferenceJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
+    BatchInferenceJob.add_member(:batch_inference_job_mode, Shapes::ShapeRef.new(shape: BatchInferenceJobMode, location_name: "batchInferenceJobMode"))
+    BatchInferenceJob.add_member(:theme_generation_config, Shapes::ShapeRef.new(shape: ThemeGenerationConfig, location_name: "themeGenerationConfig"))
     BatchInferenceJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
     BatchInferenceJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
     BatchInferenceJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
@@ -354,6 +359,7 @@ module Aws::Personalize
     BatchInferenceJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
     BatchInferenceJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
     BatchInferenceJobSummary.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
+    BatchInferenceJobSummary.add_member(:batch_inference_job_mode, Shapes::ShapeRef.new(shape: BatchInferenceJobMode, location_name: "batchInferenceJobMode"))
     BatchInferenceJobSummary.struct_class = Types::BatchInferenceJobSummary
 
     BatchInferenceJobs.member = Shapes::ShapeRef.new(shape: BatchInferenceJobSummary)
@@ -402,6 +408,7 @@ module Aws::Personalize
     Campaign.struct_class = Types::Campaign
 
     CampaignConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
+    CampaignConfig.add_member(:enable_metadata_with_recommendations, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableMetadataWithRecommendations"))
     CampaignConfig.struct_class = Types::CampaignConfig
 
     CampaignSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -449,6 +456,8 @@ module Aws::Personalize
     CreateBatchInferenceJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
     CreateBatchInferenceJobRequest.add_member(:batch_inference_job_config, Shapes::ShapeRef.new(shape: BatchInferenceJobConfig, location_name: "batchInferenceJobConfig"))
     CreateBatchInferenceJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
+    CreateBatchInferenceJobRequest.add_member(:batch_inference_job_mode, Shapes::ShapeRef.new(shape: BatchInferenceJobMode, location_name: "batchInferenceJobMode"))
+    CreateBatchInferenceJobRequest.add_member(:theme_generation_config, Shapes::ShapeRef.new(shape: ThemeGenerationConfig, location_name: "themeGenerationConfig"))
     CreateBatchInferenceJobRequest.struct_class = Types::CreateBatchInferenceJobRequest
 
     CreateBatchInferenceJobResponse.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
@@ -600,6 +609,7 @@ module Aws::Personalize
     Dataset.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
     Dataset.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
     Dataset.add_member(:latest_dataset_update, Shapes::ShapeRef.new(shape: DatasetUpdateSummary, location_name: "latestDatasetUpdate"))
+    Dataset.add_member(:tracking_id, Shapes::ShapeRef.new(shape: TrackingId, location_name: "trackingId"))
     Dataset.struct_class = Types::Dataset
 
     DatasetExportJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
@@ -898,6 +908,9 @@ module Aws::Personalize
     FeaturizationParameters.key = Shapes::ShapeRef.new(shape: ParameterName)
     FeaturizationParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
 
+    FieldsForThemeGeneration.add_member(:item_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "itemName"))
+    FieldsForThemeGeneration.struct_class = Types::FieldsForThemeGeneration
+
     Filter.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
     Filter.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     Filter.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
@@ -1190,6 +1203,7 @@ module Aws::Personalize
     RecommenderConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
     RecommenderConfig.add_member(:min_recommendation_requests_per_second, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minRecommendationRequestsPerSecond"))
     RecommenderConfig.add_member(:training_data_config, Shapes::ShapeRef.new(shape: TrainingDataConfig, location_name: "trainingDataConfig"))
+    RecommenderConfig.add_member(:enable_metadata_with_recommendations, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableMetadataWithRecommendations"))
     RecommenderConfig.struct_class = Types::RecommenderConfig
 
     RecommenderSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -1319,6 +1333,9 @@ module Aws::Personalize
 
     Tags.member = Shapes::ShapeRef.new(shape: Tag)
 
+    ThemeGenerationConfig.add_member(:fields_for_theme_generation, Shapes::ShapeRef.new(shape: FieldsForThemeGeneration, required: true, location_name: "fieldsForThemeGeneration"))
+    ThemeGenerationConfig.struct_class = Types::ThemeGenerationConfig
+
     TooManyTagKeysException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     TooManyTagKeysException.struct_class = Types::TooManyTagKeysException
 

data/lib/aws-sdk-personalize/endpoint_provider.rb

@@ -32,7 +32,7 @@ module Aws::Personalize
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://personalize-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

data/lib/aws-sdk-personalize/types.rb

@@ -187,6 +187,14 @@ module Aws::Personalize
     #   requested the batch inference job.
     #   @return [String]
     #
+    # @!attribute [rw] batch_inference_job_mode
+    #   The job's mode.
+    #   @return [String]
+    #
+    # @!attribute [rw] theme_generation_config
+    #   The job's theme generation settings.
+    #   @return [Types::ThemeGenerationConfig]
+    #
     # @!attribute [rw] status
     #   The status of the batch inference job. The status is one of the
     #   following values:
@@ -221,6 +229,8 @@ module Aws::Personalize
       :job_output,
       :batch_inference_job_config,
       :role_arn,
+      :batch_inference_job_mode,
+      :theme_generation_config,
       :status,
       :creation_date_time,
       :last_updated_date_time)
@@ -327,6 +337,10 @@ module Aws::Personalize
     #   The ARN of the solution version used by the batch inference job.
     #   @return [String]
     #
+    # @!attribute [rw] batch_inference_job_mode
+    #   The job's mode.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobSummary AWS API Documentation
     #
     class BatchInferenceJobSummary < Struct.new(
@@ -336,7 +350,8 @@ module Aws::Personalize
       :creation_date_time,
       :last_updated_date_time,
       :failure_reason,
-      :solution_version_arn)
+      :solution_version_arn,
+      :batch_inference_job_mode)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -611,10 +626,25 @@ module Aws::Personalize
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] enable_metadata_with_recommendations
+    #   Whether metadata with recommendations is enabled for the campaign.
+    #   If enabled, you can specify the columns from your Items dataset in
+    #   your request for recommendations. Amazon Personalize returns this
+    #   data for each item in the recommendation response.
+    #
+    #   If you enable metadata in recommendations, you will incur additional
+    #   costs. For more information, see [Amazon Personalize pricing][1].
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/personalize/pricing/
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
     #
     class CampaignConfig < Struct.new(
-      :item_exploration_config)
+      :item_exploration_config,
+      :enable_metadata_with_recommendations)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -823,6 +853,26 @@ module Aws::Personalize
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] batch_inference_job_mode
+    #   The mode of the batch inference job. To generate descriptive themes
+    #   for groups of similar items, set the job mode to `THEME_GENERATION`.
+    #   If you don't want to generate themes, use the default
+    #   `BATCH_INFERENCE`.
+    #
+    #   When you get batch recommendations with themes, you will incur
+    #   additional costs. For more information, see [Amazon Personalize
+    #   pricing][1].
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/personalize/pricing/
+    #   @return [String]
+    #
+    # @!attribute [rw] theme_generation_config
+    #   For theme generation jobs, specify the name of the column in your
+    #   Items dataset that contains each item's name.
+    #   @return [Types::ThemeGenerationConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
     #
     class CreateBatchInferenceJobRequest < Struct.new(
@@ -834,7 +884,9 @@ module Aws::Personalize
       :job_output,
       :role_arn,
       :batch_inference_job_config,
-      :tags)
+      :tags,
+      :batch_inference_job_mode,
+      :theme_generation_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1193,6 +1245,10 @@ module Aws::Personalize
     #   * Items
     #
     #   * Users
+    #
+    #   * Actions
+    #
+    #   * Action\_Interactions
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -1571,22 +1627,30 @@ module Aws::Personalize
     #
     # @!attribute [rw] training_mode
     #   The scope of training to be performed when creating the solution
-    #   version. The `FULL` option trains the solution version based on the
-    #   entirety of the input solution's training data, while the `UPDATE`
-    #   option processes only the data that has changed in comparison to the
-    #   input solution. Choose `UPDATE` when you want to incrementally
-    #   update your solution version instead of creating an entirely new
-    #   one.
+    #   version. The default is `FULL`. This creates a completely new model
+    #   based on the entirety of the training data from the datasets in your
+    #   dataset group.
+    #
+    #   If you use [User-Personalization][1], you can specify a training
+    #   mode of `UPDATE`. This updates the model to consider new items for
+    #   recommendations. It is not a full retraining. You should still
+    #   complete a full retraining weekly. If you specify `UPDATE`, Amazon
+    #   Personalize will stop automatic updates for the solution version. To
+    #   resume updates, create a new solution with training mode set to
+    #   `FULL` and deploy it in a campaign. For more information about
+    #   automatic updates, see [Automatic updates][2].
     #
     #   The `UPDATE` option can only be used when you already have an active
     #   solution version created from the input solution using the `FULL`
     #   option and the input solution was trained with the
-    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #   [User-Personalization][1] recipe or the legacy [HRNN-Coldstart][3]
+    #   recipe.
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
-    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates
+    #   [3]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -1661,6 +1725,10 @@ module Aws::Personalize
     #   * Items
     #
     #   * Users
+    #
+    #   * Actions
+    #
+    #   * Action\_Interactions
     #   @return [String]
     #
     # @!attribute [rw] schema_arn
@@ -1690,6 +1758,13 @@ module Aws::Personalize
     #   Describes the latest update to the dataset.
     #   @return [Types::DatasetUpdateSummary]
     #
+    # @!attribute [rw] tracking_id
+    #   The ID of the event tracker for an Action interactions dataset. You
+    #   specify the tracker's ID in the `PutActionInteractions` API
+    #   operation. Amazon Personalize uses it to direct new data to the
+    #   Action interactions dataset in your dataset group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Dataset AWS API Documentation
     #
     class Dataset < Struct.new(
@@ -1701,7 +1776,8 @@ module Aws::Personalize
       :status,
       :creation_date_time,
       :last_updated_date_time,
-      :latest_dataset_update)
+      :latest_dataset_update,
+      :tracking_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1860,12 +1936,13 @@ module Aws::Personalize
       include Aws::Structure
     end
 
-    # A dataset group is a collection of related datasets (Interactions,
-    # User, and Item). You create a dataset group by calling
-    # [CreateDatasetGroup][1]. You then create a dataset and add it to a
-    # dataset group by calling [CreateDataset][2]. The dataset group is used
-    # to create and train a solution by calling [CreateSolution][3]. A
-    # dataset group can contain only one of each type of dataset.
+    # A dataset group is a collection of related datasets (Item
+    # interactions, Users, Items, Actions, Action interactions). You create
+    # a dataset group by calling [CreateDatasetGroup][1]. You then create a
+    # dataset and add it to a dataset group by calling [CreateDataset][2].
+    # The dataset group is used to create and train a solution by calling
+    # [CreateSolution][3]. A dataset group can contain only one of each type
+    # of dataset.
     #
     # You can specify an Key Management Service (KMS) key to encrypt the
     # datasets in the group.
@@ -1896,8 +1973,9 @@ module Aws::Personalize
     #   @return [String]
     #
     # @!attribute [rw] role_arn
-    #   The ARN of the IAM role that has permissions to create the dataset
-    #   group.
+    #   The ARN of the Identity and Access Management (IAM) role that has
+    #   permissions to access the Key Management Service (KMS) key.
+    #   Supplying an IAM role is only valid when also specifying a KMS key.
     #   @return [String]
     #
     # @!attribute [rw] kms_key_arn
@@ -3140,6 +3218,22 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # A string to string map of the configuration details for theme
+    # generation.
+    #
+    # @!attribute [rw] item_name
+    #   The name of the Items dataset column that stores the name of each
+    #   item in the dataset.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/FieldsForThemeGeneration AWS API Documentation
+    #
+    class FieldsForThemeGeneration < Struct.new(
+      :item_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information on a recommendation filter, including its ARN,
     # status, and filter expression.
     #
@@ -3701,8 +3795,8 @@ module Aws::Personalize
     #   @return [String]
     #
     # @!attribute [rw] next_token
-    #   A token returned from the previous call to `ListDatasetImportJobs`
-    #   for getting the next set of dataset import jobs (if they exist).
+    #   A token returned from the previous call to `ListDatasets` for
+    #   getting the next set of dataset import jobs (if they exist).
     #   @return [String]
     #
     # @!attribute [rw] max_results
@@ -4547,12 +4641,27 @@ module Aws::Personalize
     #   domain recommender.
     #   @return [Types::TrainingDataConfig]
     #
+    # @!attribute [rw] enable_metadata_with_recommendations
+    #   Whether metadata with recommendations is enabled for the
+    #   recommender. If enabled, you can specify the columns from your Items
+    #   dataset in your request for recommendations. Amazon Personalize
+    #   returns this data for each item in the recommendation response.
+    #
+    #   If you enable metadata in recommendations, you will incur additional
+    #   costs. For more information, see [Amazon Personalize pricing][1].
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/personalize/pricing/
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
     #
     class RecommenderConfig < Struct.new(
       :item_exploration_config,
       :min_recommendation_requests_per_second,
-      :training_data_config)
+      :training_data_config,
+      :enable_metadata_with_recommendations)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4841,7 +4950,7 @@ module Aws::Personalize
     #   @return [Types::HPOConfig]
     #
     # @!attribute [rw] algorithm_hyper_parameters
-    #   Lists the hyperparameter names and ranges.
+    #   Lists the algorithm hyperparameters and their values.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] feature_transformation_parameters
@@ -5233,6 +5342,22 @@ module Aws::Personalize
     #
     class TagResourceResponse < Aws::EmptyStructure; end
 
+    # The configuration details for generating themes with a batch inference
+    # job.
+    #
+    # @!attribute [rw] fields_for_theme_generation
+    #   Fields used to generate descriptive themes for a batch inference
+    #   job.
+    #   @return [Types::FieldsForThemeGeneration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ThemeGenerationConfig AWS API Documentation
+    #
+    class ThemeGenerationConfig < Struct.new(
+      :fields_for_theme_generation)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The request contains more tag keys than can be associated with a
     # resource (50 tag keys per resource).
     #

data/lib/aws-sdk-personalize.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalize/customizations'
 # @!group service
 module Aws::Personalize
 
-  GEM_VERSION = '1.54.0'
+  GEM_VERSION = '1.56.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.54.0
+  version: 1.56.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.184.0
+        version: 3.188.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.184.0
+        version: 3.188.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="