aws-sdk-personalizeruntime 1.14.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98020ec76be383f236d64d6a51fcd5d1340ef041b86ae43682bfe56eda132d47
-  data.tar.gz: 7acee0c9b4f7d53b3b0905c2c8e45b139aee139dc97397de42618ad8eb7d1649
+  metadata.gz: a1a068ec7abbd010896e6d36e06631303e5d65d645e02a06c55c36fb987ce351
+  data.tar.gz: 70c9c93a8308b39d7b62f0925f5d2278000a6d5950fc3bfa034069c8296ae4d1
 SHA512:
-  metadata.gz: f663d58af663a73438ac2f18a24966e5db06116916ac7c3dfd2a2babbb37b4e883c721c4e183e938647c80d14b53bd06fb460032f8b52b0e2f6e319be7c1fce0
-  data.tar.gz: 99498da5d96cbbdc1569e5e7f52d337a5237aee486f3e834abe3bd338083e2c026910bd496ef97ca0b9c902b1f7db92e596af29a4bacfb77a87de3adfe0570c5
+  metadata.gz: 7cf26df6d82bd0326a4990156fb3c32c80ff7cb28bd735aaa271aafbf3a7ab6b6af50c35ccb9f8959c10009fbf26c52c39d55dc6239358006a6e93757d061390
+  data.tar.gz: c452c32ce173b6c7489d21212e6e5356aea5025a4818a814b216c994b80877ae9c9a5fa388752261455b0e034aeb5437b911f141580d2ccfe9a21ddcd45ecee9

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.14.0'
+  GEM_VERSION = '1.19.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
@@ -341,12 +356,37 @@ module Aws::PersonalizeRuntime
     #   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.
+    #   The Amazon Resource Name (ARN) of a filter you created to include
+    #   items or exclude items from recommendations for a given user. For more
+    #   information, see [Filtering Recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #
+    # @option params [Hash<String,String>] :filter_values
+    #   The values to use when filtering recommendations. For each placeholder
+    #   parameter in your filter expression, provide the parameter name (in
+    #   matching case) as a key and the filter value(s) as the corresponding
+    #   value. Separate multiple values for one parameter with a comma.
+    #
+    #   For filter expressions that use an `INCLUDE` element to include items,
+    #   you must provide values for all parameters that are defined in the
+    #   expression. For filters with expressions that use an `EXCLUDE` element
+    #   to exclude items, you can omit the `filter-values`.In this case,
+    #   Amazon Personalize doesn't use that portion of the expression to
+    #   filter recommendations.
+    #
+    #   For more information, see [Filtering Recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #
     # @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
     #
@@ -358,6 +398,9 @@ module Aws::PersonalizeRuntime
     #       "AttributeName" => "AttributeValue",
     #     },
     #     filter_arn: "Arn",
+    #     filter_values: {
+    #       "FilterAttributeName" => "FilterAttributeValue",
+    #     },
     #   })
     #
     # @example Response structure
@@ -365,6 +408,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
     #
@@ -414,17 +458,37 @@ 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][1].
+    #   more information, see [Filtering Recommendations][1].
     #
     #   When using this parameter, be sure the filter resource is `ACTIVE`.
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #
+    # @option params [Hash<String,String>] :filter_values
+    #   The values to use when filtering recommendations. For each placeholder
+    #   parameter in your filter expression, provide the parameter name (in
+    #   matching case) as a key and the filter value(s) as the corresponding
+    #   value. Separate multiple values for one parameter with a comma.
+    #
+    #   For filter expressions that use an `INCLUDE` element to include items,
+    #   you must provide values for all parameters that are defined in the
+    #   expression. For filters with expressions that use an `EXCLUDE` element
+    #   to exclude items, you can omit the `filter-values`.In this case,
+    #   Amazon Personalize doesn't use that portion of the expression to
+    #   filter recommendations.
+    #
+    #   For more information, see [Filtering Recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.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
     #
@@ -437,6 +501,9 @@ module Aws::PersonalizeRuntime
     #       "AttributeName" => "AttributeValue",
     #     },
     #     filter_arn: "Arn",
+    #     filter_values: {
+    #       "FilterAttributeName" => "FilterAttributeValue",
+    #     },
     #   })
     #
     # @example Response structure
@@ -444,6 +511,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
     #
@@ -467,7 +535,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.14.0'
+      context[:gem_version] = '1.19.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -18,6 +18,9 @@ module Aws::PersonalizeRuntime
     AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
     Context = Shapes::MapShape.new(name: 'Context')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
+    FilterAttributeName = Shapes::StringShape.new(name: 'FilterAttributeName')
+    FilterAttributeValue = Shapes::StringShape.new(name: 'FilterAttributeValue')
+    FilterValues = Shapes::MapShape.new(name: 'FilterValues')
     GetPersonalizedRankingRequest = Shapes::StructureShape.new(name: 'GetPersonalizedRankingRequest')
     GetPersonalizedRankingResponse = Shapes::StructureShape.new(name: 'GetPersonalizedRankingResponse')
     GetRecommendationsRequest = Shapes::StructureShape.new(name: 'GetRecommendationsRequest')
@@ -28,6 +31,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')
@@ -35,14 +39,19 @@ module Aws::PersonalizeRuntime
     Context.key = Shapes::ShapeRef.new(shape: AttributeName)
     Context.value = Shapes::ShapeRef.new(shape: AttributeValue)
 
+    FilterValues.key = Shapes::ShapeRef.new(shape: FilterAttributeName)
+    FilterValues.value = Shapes::ShapeRef.new(shape: FilterAttributeValue)
+
     GetPersonalizedRankingRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
     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.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
     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"))
@@ -51,9 +60,11 @@ module Aws::PersonalizeRuntime
     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.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

@@ -21,6 +21,9 @@ module Aws::PersonalizeRuntime
     #           "AttributeName" => "AttributeValue",
     #         },
     #         filter_arn: "Arn",
+    #         filter_values: {
+    #           "FilterAttributeName" => "FilterAttributeValue",
+    #         },
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -47,10 +50,36 @@ module Aws::PersonalizeRuntime
     #   @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.
+    #   The Amazon Resource Name (ARN) of a filter you created to include
+    #   items or exclude items from recommendations for a given user. For
+    #   more information, see [Filtering Recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #   @return [String]
     #
+    # @!attribute [rw] filter_values
+    #   The values to use when filtering recommendations. For each
+    #   placeholder parameter in your filter expression, provide the
+    #   parameter name (in matching case) as a key and the filter value(s)
+    #   as the corresponding value. Separate multiple values for one
+    #   parameter with a comma.
+    #
+    #   For filter expressions that use an `INCLUDE` element to include
+    #   items, you must provide values for all parameters that are defined
+    #   in the expression. For filters with expressions that use an
+    #   `EXCLUDE` element to exclude items, you can omit the
+    #   `filter-values`.In this case, Amazon Personalize doesn't use that
+    #   portion of the expression to filter recommendations.
+    #
+    #   For more information, see [Filtering Recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #   @return [Hash<String,String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingRequest AWS API Documentation
     #
     class GetPersonalizedRankingRequest < Struct.new(
@@ -58,7 +87,8 @@ module Aws::PersonalizeRuntime
       :input_list,
       :user_id,
       :context,
-      :filter_arn)
+      :filter_arn,
+      :filter_values)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -68,10 +98,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
@@ -88,6 +123,9 @@ module Aws::PersonalizeRuntime
     #           "AttributeName" => "AttributeValue",
     #         },
     #         filter_arn: "Arn",
+    #         filter_values: {
+    #           "FilterAttributeName" => "FilterAttributeValue",
+    #         },
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -121,15 +159,36 @@ 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][1].
+    #   more information, see [Filtering Recommendations][1].
     #
     #   When using this parameter, be sure the filter resource is `ACTIVE`.
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #   @return [String]
     #
+    # @!attribute [rw] filter_values
+    #   The values to use when filtering recommendations. For each
+    #   placeholder parameter in your filter expression, provide the
+    #   parameter name (in matching case) as a key and the filter value(s)
+    #   as the corresponding value. Separate multiple values for one
+    #   parameter with a comma.
+    #
+    #   For filter expressions that use an `INCLUDE` element to include
+    #   items, you must provide values for all parameters that are defined
+    #   in the expression. For filters with expressions that use an
+    #   `EXCLUDE` element to exclude items, you can omit the
+    #   `filter-values`.In this case, Amazon Personalize doesn't use that
+    #   portion of the expression to filter recommendations.
+    #
+    #   For more information, see [Filtering Recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #   @return [Hash<String,String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
@@ -138,7 +197,8 @@ module Aws::PersonalizeRuntime
       :user_id,
       :num_results,
       :context,
-      :filter_arn)
+      :filter_arn,
+      :filter_values)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -148,10 +208,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.14.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-11-12 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