aws-sdk-personalizeruntime 1.13.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6739d6c8361e473f756be445337403d97debb255dbef3b5270810c38145efb44
-  data.tar.gz: 39fc794ef6da4a0f8b6a5b72580447fd6496879263956f4ac57e0d379481a5e9
+  metadata.gz: 2d963bcea7b9fe9a9f033ad6259a34715040fc5b4ceab0b4d5ddfd7f97ea7a23
+  data.tar.gz: d29ab7f20f520f291ed3db9c25c4c0a6687d8534f036db65ded13c2fd7dee310
 SHA512:
-  metadata.gz: 2f8a98cd3d4084808f00f5a8aac562f3eaf4c986e09f85d4cdea49dee06dd9b0700cc283c3be9f0feb7b6f88baa8c4fef622508e0b3e77c5f56795d77508ca9a
-  data.tar.gz: ace7426ad454413180788b97e8c8368e5b562e2d80414705a18704e18b3983bdb0a77837a1d2270fce7294e1c367243ad19c56cce6f94445538b1ab3a06b002d
+  metadata.gz: b185fd9345a9f71fa285044f895f0e9814192806d7c84356e9349047741ca55166d9335c403061647a3018632a94f45d841582bcd3febebcd2902d8435841bd6
+  data.tar.gz: 403fecb8e0db68fdba979a6b7f00ec7528956579af20b88e00ba0377203bf9cdea2d102da133e77346ea924af7d5a915e0f3d2a253e7f3f003cdab56cf4674c2

data/lib/aws-sdk-personalizeruntime.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.13.0'
+  GEM_VERSION = '1.18.0'
 
 end

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

@@ -85,13 +85,28 @@ module Aws::PersonalizeRuntime
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::PersonalizeRuntime
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * 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.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -326,7 +341,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.
     #
@@ -340,9 +355,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
     #
@@ -353,6 +373,7 @@ module Aws::PersonalizeRuntime
     #     context: {
     #       "AttributeName" => "AttributeValue",
     #     },
+    #     filter_arn: "Arn",
     #   })
     #
     # @example Response structure
@@ -360,6 +381,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
     #
@@ -409,11 +431,18 @@ module Aws::PersonalizeRuntime
     #
     # @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.
+    #   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
     #
@@ -433,6 +462,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
     #
@@ -456,7 +486,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.13.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -28,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')
@@ -39,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"))
@@ -53,6 +56,7 @@ module Aws::PersonalizeRuntime
     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/types.rb

@@ -20,6 +20,7 @@ module Aws::PersonalizeRuntime
     #         context: {
     #           "AttributeName" => "AttributeValue",
     #         },
+    #         filter_arn: "Arn",
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -28,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>]
     #
@@ -45,13 +46,19 @@ 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
@@ -61,10 +68,15 @@ 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
@@ -114,7 +126,13 @@ module Aws::PersonalizeRuntime
     #
     # @!attribute [rw] filter_arn
     #   The ARN of the filter to apply to the returned recommendations. For
-    #   more information, see Using Filters with Amazon Personalize.
+    #   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
@@ -135,10 +153,15 @@ 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

metadata

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