aws-sdk-personalize 1.57.0 → 1.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 497ec8ab9d141f4d66a35ea8f66994b1ec0db37e5ff480febc5a4d8ffb75ffaf
-  data.tar.gz: d0d7c01a94947ac6a74f0205a6e4fe96e9b9e4405c27a56abc404ab9689a49d5
+  metadata.gz: 82a28ded422b26b351ac757bcc13b35a07fca90729383fdee834fc3661cdb255
+  data.tar.gz: 9c8df332bb533e8ff4dd4b7238bef450d39d62f713de52c3b5cb5b90cf98ce74
 SHA512:
-  metadata.gz: 196eafeab48df267c053ec31ef8dc88f730a677b6f74ed9c765f22fc9bee81b525574ad283c794ee93b336a0a18fa89d2e7abc0b076e69c69c2dc52b16ea6265
-  data.tar.gz: 8d6d7b8423c0de6f5365ff03898db20795f7c23bf8e0d332a9da908e4ed3cfeb8ba3a920078dc459cff708f3ae0d8fc7c3637ff9f3d594bb02cb83fad96ca01a
+  metadata.gz: 6456b657658f8526d5e6fea81dd61eb36fdb0d72c158dbd2a8a207210c208ea065b1c8ab1bdc0df9991cfbe5c1aca6daba8bd7b0c96ae955364f791653aa9a56
+  data.tar.gz: fbe1676b4a6375b64eeaa0eac6cc2b2aedda5d4b250c6514da18fb8109db9e0948570194b5d39975c91e2d5ce5293e4dbe056b44e60dfd8c1b70ee5efb193296

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.58.0 (2024-01-16)
+------------------
+
+* Feature - Documentation updates for Amazon Personalize.
+
 1.57.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.57.0
+1.58.0

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

@@ -644,28 +644,34 @@ module Aws::Personalize
     #
     # **Minimum Provisioned TPS and Auto-Scaling**
     #
-    # A high `minProvisionedTPS` will increase your bill. We recommend
+    # 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.
     #
-    # A transaction is a single `GetRecommendations` or
-    # `GetPersonalizedRanking` call. Transactions per second (TPS) is the
-    # throughput and unit of billing for Amazon Personalize. The minimum
-    # provisioned TPS (`minProvisionedTPS`) specifies the baseline
-    # throughput provisioned by Amazon Personalize, and thus, the minimum
-    # billing charge.
-    #
-    # If your TPS increases beyond `minProvisionedTPS`, Amazon Personalize
-    # auto-scales the provisioned capacity up and down, but never below
-    # `minProvisionedTPS`. There's a short time delay while the capacity is
-    # increased that might cause loss of transactions.
+    # 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.
     #
-    # The actual TPS used is calculated as the average requests/second
-    # within a 5-minute window. You pay for maximum of either the minimum
-    # provisioned TPS or the actual TPS. We recommend starting with a low
-    # `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
-    # and then increase the `minProvisionedTPS` as necessary.
+    # For more information about campaign costs, see [Amazon Personalize
+    # pricing][3].
     #
     # **Status**
     #
@@ -676,7 +682,7 @@ module Aws::Personalize
     #
     # * DELETE PENDING > DELETE IN\_PROGRESS
     #
-    # To get the campaign status, call [DescribeCampaign][3].
+    # To get the campaign status, call [DescribeCampaign][4].
     #
     # <note markdown="1"> Wait until the `status` of the campaign is `ACTIVE` before asking the
     # campaign for recommendations.
@@ -685,22 +691,23 @@ module Aws::Personalize
     #
     # **Related APIs**
     #
-    # * [ListCampaigns][4]
+    # * [ListCampaigns][5]
     #
-    # * [DescribeCampaign][3]
+    # * [DescribeCampaign][4]
     #
-    # * [UpdateCampaign][5]
+    # * [UpdateCampaign][6]
     #
-    # * [DeleteCampaign][6]
+    # * [DeleteCampaign][7]
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
     # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
-    # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
-    # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
-    # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html
-    # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html
+    # [3]: https://aws.amazon.com/personalize/pricing/
+    # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
+    # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
+    # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html
+    # [7]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html
     #
     # @option params [required, String] :name
     #   A name for the new campaign. The campaign name must be unique within
@@ -1721,7 +1728,7 @@ module Aws::Personalize
     # @option params [Boolean] :perform_auto_ml
     #   We don't recommend enabling automated machine learning. Instead,
     #   match your use case to the available Amazon Personalize recipes. For
-    #   more information, see [Determining your use case.][1]
+    #   more information, see [Choosing a recipe][1].
     #
     #   Whether to perform automated machine learning (AutoML). The default is
     #   `false`. For this case, you must specify `recipeArn`.
@@ -1735,11 +1742,17 @@ module Aws::Personalize
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
     #
     # @option params [String] :recipe_arn
-    #   The ARN of the recipe to use for model training. This is required when
-    #   `performAutoML` is false.
+    #   The Amazon Resource Name (ARN) of the recipe to use for model
+    #   training. This is required when `performAutoML` is false. For
+    #   information about different Amazon Personalize recipes and their ARNs,
+    #   see [Choosing a recipe][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
     #
     # @option params [required, String] :dataset_group_arn
     #   The Amazon Resource Name (ARN) of the dataset group that provides the
@@ -4397,7 +4410,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.57.0'
+      context[:gem_version] = '1.58.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -630,14 +630,17 @@ module Aws::Personalize
     #   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.
+    #   data for each item in the recommendation response. For information
+    #   about enabling metadata for a campaign, see [Enabling metadata in
+    #   recommendations for a campaign][1].
     #
     #   If you enable metadata in recommendations, you will incur additional
-    #   costs. For more information, see [Amazon Personalize pricing][1].
+    #   costs. For more information, see [Amazon Personalize pricing][2].
     #
     #
     #
-    #   [1]: https://aws.amazon.com/personalize/pricing/
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata
+    #   [2]: https://aws.amazon.com/personalize/pricing/
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
@@ -1534,7 +1537,7 @@ module Aws::Personalize
     # @!attribute [rw] perform_auto_ml
     #   We don't recommend enabling automated machine learning. Instead,
     #   match your use case to the available Amazon Personalize recipes. For
-    #   more information, see [Determining your use case.][1]
+    #   more information, see [Choosing a recipe][1].
     #
     #   Whether to perform automated machine learning (AutoML). The default
     #   is `false`. For this case, you must specify `recipeArn`.
@@ -1548,12 +1551,18 @@ module Aws::Personalize
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
     #   @return [Boolean]
     #
     # @!attribute [rw] recipe_arn
-    #   The ARN of the recipe to use for model training. This is required
-    #   when `performAutoML` is false.
+    #   The Amazon Resource Name (ARN) of the recipe to use for model
+    #   training. This is required when `performAutoML` is false. For
+    #   information about different Amazon Personalize recipes and their
+    #   ARNs, see [Choosing a recipe][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
     #   @return [String]
     #
     # @!attribute [rw] dataset_group_arn
@@ -4645,14 +4654,17 @@ module Aws::Personalize
     #   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.
+    #   returns this data for each item in the recommendation response. For
+    #   information about enabling metadata for a recommender, see [Enabling
+    #   metadata in recommendations for a recommender][1].
     #
     #   If you enable metadata in recommendations, you will incur additional
-    #   costs. For more information, see [Amazon Personalize pricing][1].
+    #   costs. For more information, see [Amazon Personalize pricing][2].
     #
     #
     #
-    #   [1]: https://aws.amazon.com/personalize/pricing/
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata
+    #   [2]: https://aws.amazon.com/personalize/pricing/
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation

data/lib/aws-sdk-personalize.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.57.0
+  version: 1.58.0
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -72,7 +72,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-personalize
   changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-personalize/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Personalize
 test_files: []