aws-sdk-personalizeruntime 1.25.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e007c39401713abedb073793e043adf3bb22a3bb9dec0871a7f9f1fb7539a0
-  data.tar.gz: 6652cbc7d79a0e168f95efdefe8ecc5b98317923123310870a79dd0058d27266
+  metadata.gz: c6b8915fe05b0aed1b385a30faa2543173db011f49c24ae4b61042692c243f5f
+  data.tar.gz: 935dc699a7cdb7fde7721dcf1110cfafe37011e3d97dcd22edc04ad9602fb8cb
 SHA512:
-  metadata.gz: 738fd433dc2a540d7d8afbfb8dc4658baf31b2949c34d7b2890a473527f61116990c48fb0f53271f5f506bc0fc184e1e94170924305351f38d8f0bc7832c4b06
-  data.tar.gz: 4adae78090f27c91f61410c1fdfae9e896af99ca70fc1f2c2c1a2e3a6e602455e12a49a268d160c0cb2c29452200b5ae66c21c0865950b44b33224951ba99654
+  metadata.gz: 7f8ad4b13cd8aefbc9f148ba311ab402ae1f1d395e7645fab066d1a5e160df4d648401c1b44011d844465d86c8e355f9b16ba22732f67099f45ba4cec55fa33a
+  data.tar.gz: 164576f6c719556751a0825516398921619ddfd075f362d25f7ed354fea0566e80c9667c98d38ddf0b42e51fe837380b80c26b80b7339b117f7c61cc2f08aeef

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.29.0 (2021-11-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.28.0 (2021-11-29)
+------------------
+
+* Feature - This release adds inference support for Recommenders.
+
+1.27.0 (2021-11-04)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.26.0 (2021-10-18)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.25.0 (2021-09-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.25.0
+1.29.0

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

@@ -119,7 +119,9 @@ module Aws::PersonalizeRuntime
     #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
     #       are very aggressive. Construct and pass an instance of
     #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts.
+    #       enable retries and extended timeouts. Instance profile credential
+    #       fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
+    #       to true.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -275,6 +277,15 @@ module Aws::PersonalizeRuntime
     #     ** Please note ** When response stubbing is enabled, no HTTP
     #     requests are made, and retries are disabled.
     #
+    #   @option options [Boolean] :use_dualstack_endpoint
+    #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
+    #     will be used if available.
+    #
+    #   @option options [Boolean] :use_fips_endpoint
+    #     When set to `true`, fips compatible endpoints will be used if available.
+    #     When a `fips` region is used, the region is normalized and this config
+    #     is set to `true`.
+    #
     #   @option options [Boolean] :validate_params (true)
     #     When `true`, request parameters are validated before
     #     sending the request.
@@ -419,20 +430,30 @@ module Aws::PersonalizeRuntime
       req.send_request(options)
     end
 
-    # Returns a list of recommended items. The required input depends on the
-    # recipe type used to create the solution backing the campaign, as
-    # follows:
+    # Returns a list of recommended items. For campaigns, the campaign's
+    # Amazon Resource Name (ARN) is required and the required user and item
+    # input depends on the recipe type used to create the solution backing
+    # the campaign as follows:
     #
-    # * RELATED\_ITEMS - `itemId` required, `userId` not used
+    # * USER\_PERSONALIZATION - `userId` required, `itemId` not used
     #
-    # * USER\_PERSONALIZATION - `itemId` optional, `userId` required
+    # * RELATED\_ITEMS - `itemId` required, `userId` not used
     #
     # <note markdown="1"> Campaigns that are backed by a solution created using a recipe of type
     # PERSONALIZED\_RANKING use the API.
     #
     #  </note>
     #
-    # @option params [required, String] :campaign_arn
+    # For recommenders, the recommender's ARN is required and the required
+    # item and user input depends on the use case (domain-based recipe)
+    # backing the recommender. For information on use case requirements see
+    # [Choosing recommender use cases][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
+    #
+    # @option params [String] :campaign_arn
     #   The Amazon Resource Name (ARN) of the campaign to use for getting
     #   recommendations.
     #
@@ -485,6 +506,11 @@ module Aws::PersonalizeRuntime
     #
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #
+    # @option params [String] :recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to use to get
+    #   recommendations. Provide a recommender ARN if you created a Domain
+    #   dataset group with a recommender for a domain use case.
+    #
     # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetRecommendationsResponse#item_list #item_list} => Array&lt;Types::PredictedItem&gt;
@@ -493,7 +519,7 @@ module Aws::PersonalizeRuntime
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_recommendations({
-    #     campaign_arn: "Arn", # required
+    #     campaign_arn: "Arn",
     #     item_id: "ItemID",
     #     user_id: "UserID",
     #     num_results: 1,
@@ -504,6 +530,7 @@ module Aws::PersonalizeRuntime
     #     filter_values: {
     #       "FilterAttributeName" => "FilterAttributeValue",
     #     },
+    #     recommender_arn: "Arn",
     #   })
     #
     # @example Response structure
@@ -535,7 +562,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.25.0'
+      context[:gem_version] = '1.29.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -54,13 +54,14 @@ module Aws::PersonalizeRuntime
     GetPersonalizedRankingResponse.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationID, location_name: "recommendationId"))
     GetPersonalizedRankingResponse.struct_class = Types::GetPersonalizedRankingResponse
 
-    GetRecommendationsRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
+    GetRecommendationsRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
     GetRecommendationsRequest.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemID, location_name: "itemId"))
     GetRecommendationsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, location_name: "userId"))
     GetRecommendationsRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumResults, location_name: "numResults"))
     GetRecommendationsRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
     GetRecommendationsRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     GetRecommendationsRequest.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
+    GetRecommendationsRequest.add_member(:recommender_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recommenderArn"))
     GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))

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

@@ -115,7 +115,7 @@ module Aws::PersonalizeRuntime
     #   data as a hash:
     #
     #       {
-    #         campaign_arn: "Arn", # required
+    #         campaign_arn: "Arn",
     #         item_id: "ItemID",
     #         user_id: "UserID",
     #         num_results: 1,
@@ -126,6 +126,7 @@ module Aws::PersonalizeRuntime
     #         filter_values: {
     #           "FilterAttributeName" => "FilterAttributeValue",
     #         },
+    #         recommender_arn: "Arn",
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -189,6 +190,12 @@ module Aws::PersonalizeRuntime
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to use to get
+    #   recommendations. Provide a recommender ARN if you created a Domain
+    #   dataset group with a recommender for a domain use case.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
@@ -198,13 +205,14 @@ module Aws::PersonalizeRuntime
       :num_results,
       :context,
       :filter_arn,
-      :filter_values)
+      :filter_values,
+      :recommender_arn)
       SENSITIVE = []
       include Aws::Structure
     end
 
     # @!attribute [rw] item_list
-    #   A list of recommendations sorted in ascending order by prediction
+    #   A list of recommendations sorted in descending order by prediction
     #   score. There can be a maximum of 500 items in the list.
     #   @return [Array<Types::PredictedItem>]
     #

data/lib/aws-sdk-personalizeruntime.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @!group service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.25.0'
+  GEM_VERSION = '1.29.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-11-30 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.120.0
+        version: 3.122.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.120.0
+        version: 3.122.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement