aws-sdk-personalizeruntime 1.10.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c686e65ed6d74f28ab36678391fd1f096103fa64fcd6d333418975b231d645d9
-  data.tar.gz: f2b4a2616212475d2ac7fcccf4a888420596934410dce3e011ea7c40bfa039bb
+  metadata.gz: bca3cda9086671e924fcdcbef06ed8512c5bcb3b739252136e0d611a53e6183b
+  data.tar.gz: '08239b4123a122038843509022232693644606fb86903c74e82240256276ea51'
 SHA512:
-  metadata.gz: bfa0ed5427e007ea136dd98623a2444711efd90eeceebbfa0d13f8f4946f531662815eda41e4d393b1dc112333d527b501aacca1073a1731a9dd30739549a4e1
-  data.tar.gz: 228e9d782dc8aa08a803c910ba649b7235e3da666970c6bbbcf5955af205b89d20f2ce346c822697888f312a897ea978d60ae84722850c319b90fb1cf10e0c62
+  metadata.gz: ec053f1a913ed5dc228ebb9a9387a98285260824305afb0f359ff7d01745aca5cf19ccb7a12ccfe226448fff36378847e44518ea36f1bb0b71840247accaf221
+  data.tar.gz: 69bef1f5d19579f612de9dbcb5525c282bf2d9ceb1361d81a085a034a474249ab47794eb6606818369da6e45750396aa2d447a51e3e32ac378a83d17340cb826

data/lib/aws-sdk-personalizeruntime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.10.0'
+  GEM_VERSION = '1.15.0'
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
@@ -69,6 +72,7 @@ module Aws::PersonalizeRuntime
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -161,7 +165,7 @@ module Aws::PersonalizeRuntime
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be a valid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -322,7 +326,7 @@ module Aws::PersonalizeRuntime
     #   the personalized ranking.
     #
     # @option params [required, Array<String>] :input_list
-    #   A list of items (itemId's) to rank. If an item was not included in
+    #   A list of items (by `itemId`) to rank. If an item was not included in
     #   the training dataset, the item is appended to the end of the reranked
     #   list. The maximum is 500.
     #
@@ -336,9 +340,14 @@ module Aws::PersonalizeRuntime
     #   relevant when getting a user's recommendations, such as the user's
     #   current location or device type.
     #
+    # @option params [String] :filter_arn
+    #   The Amazon Resource Name (ARN) of a filter you created to include or
+    #   exclude items from recommendations for a given user.
+    #
     # @return [Types::GetPersonalizedRankingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetPersonalizedRankingResponse#personalized_ranking #personalized_ranking} => Array&lt;Types::PredictedItem&gt;
+    #   * {Types::GetPersonalizedRankingResponse#recommendation_id #recommendation_id} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -349,6 +358,7 @@ module Aws::PersonalizeRuntime
     #     context: {
     #       "AttributeName" => "AttributeValue",
     #     },
+    #     filter_arn: "Arn",
     #   })
     #
     # @example Response structure
@@ -356,6 +366,7 @@ module Aws::PersonalizeRuntime
     #   resp.personalized_ranking #=> Array
     #   resp.personalized_ranking[0].item_id #=> String
     #   resp.personalized_ranking[0].score #=> Float
+    #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking AWS API Documentation
     #
@@ -403,9 +414,20 @@ module Aws::PersonalizeRuntime
     #   relevant when getting a user's recommendations, such as the user's
     #   current location or device type.
     #
+    # @option params [String] :filter_arn
+    #   The ARN of the filter to apply to the returned recommendations. For
+    #   more information, see [Using Filters with Amazon Personalize][1].
+    #
+    #   When using this parameter, be sure the filter resource is `ACTIVE`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #
     # @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;
+    #   * {Types::GetRecommendationsResponse#recommendation_id #recommendation_id} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -417,6 +439,7 @@ module Aws::PersonalizeRuntime
     #     context: {
     #       "AttributeName" => "AttributeValue",
     #     },
+    #     filter_arn: "Arn",
     #   })
     #
     # @example Response structure
@@ -424,6 +447,7 @@ module Aws::PersonalizeRuntime
     #   resp.item_list #=> Array
     #   resp.item_list[0].item_id #=> String
     #   resp.item_list[0].score #=> Float
+    #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations AWS API Documentation
     #
@@ -447,7 +471,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.10.0'
+      context[:gem_version] = '1.15.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -26,6 +28,7 @@ module Aws::PersonalizeRuntime
     ItemList = Shapes::ListShape.new(name: 'ItemList')
     NumResults = Shapes::IntegerShape.new(name: 'NumResults')
     PredictedItem = Shapes::StructureShape.new(name: 'PredictedItem')
+    RecommendationID = Shapes::StringShape.new(name: 'RecommendationID')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Score = Shapes::FloatShape.new(name: 'Score')
     UserID = Shapes::StringShape.new(name: 'UserID')
@@ -37,9 +40,11 @@ module Aws::PersonalizeRuntime
     GetPersonalizedRankingRequest.add_member(:input_list, Shapes::ShapeRef.new(shape: InputList, required: true, location_name: "inputList"))
     GetPersonalizedRankingRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, required: true, location_name: "userId"))
     GetPersonalizedRankingRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
+    GetPersonalizedRankingRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     GetPersonalizedRankingRequest.struct_class = Types::GetPersonalizedRankingRequest
 
     GetPersonalizedRankingResponse.add_member(:personalized_ranking, Shapes::ShapeRef.new(shape: ItemList, location_name: "personalizedRanking"))
+    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"))
@@ -47,9 +52,11 @@ module Aws::PersonalizeRuntime
     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.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))
+    GetRecommendationsResponse.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationID, location_name: "recommendationId"))
     GetRecommendationsResponse.struct_class = Types::GetRecommendationsResponse
 
     InputList.member = Shapes::ShapeRef.new(shape: ItemID)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -18,6 +20,7 @@ module Aws::PersonalizeRuntime
     #         context: {
     #           "AttributeName" => "AttributeValue",
     #         },
+    #         filter_arn: "Arn",
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -26,8 +29,8 @@ module Aws::PersonalizeRuntime
     #   @return [String]
     #
     # @!attribute [rw] input_list
-    #   A list of items (itemId's) to rank. If an item was not included in
-    #   the training dataset, the item is appended to the end of the
+    #   A list of items (by `itemId`) to rank. If an item was not included
+    #   in the training dataset, the item is appended to the end of the
     #   reranked list. The maximum is 500.
     #   @return [Array<String>]
     #
@@ -43,13 +46,20 @@ module Aws::PersonalizeRuntime
     #   user's current location or device type.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] filter_arn
+    #   The Amazon Resource Name (ARN) of a filter you created to include or
+    #   exclude items from recommendations for a given user.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingRequest AWS API Documentation
     #
     class GetPersonalizedRankingRequest < Struct.new(
       :campaign_arn,
       :input_list,
       :user_id,
-      :context)
+      :context,
+      :filter_arn)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -58,10 +68,16 @@ module Aws::PersonalizeRuntime
     #   maximum is 500.
     #   @return [Array<Types::PredictedItem>]
     #
+    # @!attribute [rw] recommendation_id
+    #   The ID of the recommendation.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingResponse AWS API Documentation
     #
     class GetPersonalizedRankingResponse < Struct.new(
-      :personalized_ranking)
+      :personalized_ranking,
+      :recommendation_id)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -76,6 +92,7 @@ module Aws::PersonalizeRuntime
     #         context: {
     #           "AttributeName" => "AttributeValue",
     #         },
+    #         filter_arn: "Arn",
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -107,6 +124,17 @@ module Aws::PersonalizeRuntime
     #   user's current location or device type.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter to apply to the returned recommendations. For
+    #   more information, see [Using Filters with Amazon Personalize][1].
+    #
+    #   When using this parameter, be sure the filter resource is `ACTIVE`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
@@ -114,7 +142,9 @@ module Aws::PersonalizeRuntime
       :item_id,
       :user_id,
       :num_results,
-      :context)
+      :context,
+      :filter_arn)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -123,10 +153,16 @@ module Aws::PersonalizeRuntime
     #   score. There can be a maximum of 500 items in the list.
     #   @return [Array<Types::PredictedItem>]
     #
+    # @!attribute [rw] recommendation_id
+    #   The ID of the recommendation.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsResponse AWS API Documentation
     #
     class GetRecommendationsResponse < Struct.new(
-      :item_list)
+      :item_list,
+      :recommendation_id)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -139,6 +175,7 @@ module Aws::PersonalizeRuntime
     #
     class InvalidInputException < Struct.new(
       :message)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -151,9 +188,9 @@ module Aws::PersonalizeRuntime
     #   @return [String]
     #
     # @!attribute [rw] score
-    #   A numeric representation of the model's certainty in the item's
-    #   suitability. For more information on scoring logic, see
-    #   how-scores-work.
+    #   A numeric representation of the model's certainty that the item
+    #   will be the next user selection. For more information on scoring
+    #   logic, see how-scores-work.
     #   @return [Float]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/PredictedItem AWS API Documentation
@@ -161,6 +198,7 @@ module Aws::PersonalizeRuntime
     class PredictedItem < Struct.new(
       :item_id,
       :score)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -173,6 +211,7 @@ module Aws::PersonalizeRuntime
     #
     class ResourceNotFoundException < Struct.new(
       :message)
+      SENSITIVE = []
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-08-06 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.71.0
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement