aws-sdk-personalizeruntime 1.5.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b5f6be600853cc7e7015907b92fb6c84d204e73c
-  data.tar.gz: a0dbb79d67701ee308eeff1369885c36a290b96b
+SHA256:
+  metadata.gz: c686e65ed6d74f28ab36678391fd1f096103fa64fcd6d333418975b231d645d9
+  data.tar.gz: f2b4a2616212475d2ac7fcccf4a888420596934410dce3e011ea7c40bfa039bb
 SHA512:
-  metadata.gz: d46ad1ac79c997b704669ee23eeffd1236f43d24353935eb7a8ca2a8c96e2148e20c5962c739c69e5c428a22a9f5322346ff8cb3f13f3c89de41d61644137823
-  data.tar.gz: f213eaf0a6e5eb6dd17515eca0417c59c41c0dbee76cc1e601b62bbe0eeab494c7c36a63bc5db56b8156ad4dd379877bae3e452a055dac5a1b1e4786d8ee980d
+  metadata.gz: bfa0ed5427e007ea136dd98623a2444711efd90eeceebbfa0d13f8f4946f531662815eda41e4d393b1dc112333d527b501aacca1073a1731a9dd30739549a4e1
+  data.tar.gz: 228e9d782dc8aa08a803c910ba649b7235e3da666970c6bbbcf5955af205b89d20f2ce346c822697888f312a897ea978d60ae84722850c319b90fb1cf10e0c62

data/lib/aws-sdk-personalizeruntime.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     personalize_runtime = Aws::PersonalizeRuntime::Client.new
+#     resp = personalize_runtime.get_personalized_ranking(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Personalize Runtime all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Personalize Runtime are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::PersonalizeRuntime::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Personalize Runtime API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.10.0'
 
 end

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:personalizeruntime)
 
 module Aws::PersonalizeRuntime
+  # An API client for PersonalizeRuntime.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::PersonalizeRuntime::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::PersonalizeRuntime
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::PersonalizeRuntime
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +150,10 @@ module Aws::PersonalizeRuntime
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +161,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 avalid HTTP(S) URI.
+    #     to test 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
@@ -154,7 +176,7 @@ module Aws::PersonalizeRuntime
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +188,29 @@ module Aws::PersonalizeRuntime
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +218,30 @@ module Aws::PersonalizeRuntime
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -209,16 +264,15 @@ module Aws::PersonalizeRuntime
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -227,7 +281,7 @@ module Aws::PersonalizeRuntime
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -270,12 +324,18 @@ module Aws::PersonalizeRuntime
     # @option params [required, Array<String>] :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 reranked
-    #   list.
+    #   list. The maximum is 500.
     #
     # @option params [required, String] :user_id
     #   The user for which you want the campaign to provide a personalized
     #   ranking.
     #
+    # @option params [Hash<String,String>] :context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might be
+    #   relevant when getting a user's recommendations, such as the user's
+    #   current location or device type.
+    #
     # @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;
@@ -286,12 +346,16 @@ module Aws::PersonalizeRuntime
     #     campaign_arn: "Arn", # required
     #     input_list: ["ItemID"], # required
     #     user_id: "UserID", # required
+    #     context: {
+    #       "AttributeName" => "AttributeValue",
+    #     },
     #   })
     #
     # @example Response structure
     #
     #   resp.personalized_ranking #=> Array
     #   resp.personalized_ranking[0].item_id #=> String
+    #   resp.personalized_ranking[0].score #=> Float
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking AWS API Documentation
     #
@@ -331,7 +395,13 @@ module Aws::PersonalizeRuntime
     #
     # @option params [Integer] :num_results
     #   The number of results to return. The default is 25. The maximum is
-    #   100.
+    #   500.
+    #
+    # @option params [Hash<String,String>] :context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might be
+    #   relevant when getting a user's recommendations, such as the user's
+    #   current location or device type.
     #
     # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -344,12 +414,16 @@ module Aws::PersonalizeRuntime
     #     item_id: "ItemID",
     #     user_id: "UserID",
     #     num_results: 1,
+    #     context: {
+    #       "AttributeName" => "AttributeValue",
+    #     },
     #   })
     #
     # @example Response structure
     #
     #   resp.item_list #=> Array
     #   resp.item_list[0].item_id #=> String
+    #   resp.item_list[0].score #=> Float
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations AWS API Documentation
     #
@@ -373,7 +447,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -12,6 +12,9 @@ module Aws::PersonalizeRuntime
     include Seahorse::Model
 
     Arn = Shapes::StringShape.new(name: 'Arn')
+    AttributeName = Shapes::StringShape.new(name: 'AttributeName')
+    AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
+    Context = Shapes::MapShape.new(name: 'Context')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     GetPersonalizedRankingRequest = Shapes::StructureShape.new(name: 'GetPersonalizedRankingRequest')
     GetPersonalizedRankingResponse = Shapes::StructureShape.new(name: 'GetPersonalizedRankingResponse')
@@ -24,11 +27,16 @@ module Aws::PersonalizeRuntime
     NumResults = Shapes::IntegerShape.new(name: 'NumResults')
     PredictedItem = Shapes::StructureShape.new(name: 'PredictedItem')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    Score = Shapes::FloatShape.new(name: 'Score')
     UserID = Shapes::StringShape.new(name: 'UserID')
 
+    Context.key = Shapes::ShapeRef.new(shape: AttributeName)
+    Context.value = Shapes::ShapeRef.new(shape: AttributeValue)
+
     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.struct_class = Types::GetPersonalizedRankingRequest
 
     GetPersonalizedRankingResponse.add_member(:personalized_ranking, Shapes::ShapeRef.new(shape: ItemList, location_name: "personalizedRanking"))
@@ -38,6 +46,7 @@ module Aws::PersonalizeRuntime
     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.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))
@@ -51,6 +60,7 @@ module Aws::PersonalizeRuntime
     ItemList.member = Shapes::ShapeRef.new(shape: PredictedItem)
 
     PredictedItem.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemID, location_name: "itemId"))
+    PredictedItem.add_member(:score, Shapes::ShapeRef.new(shape: Score, location_name: "score"))
     PredictedItem.struct_class = Types::PredictedItem
 
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))

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

@@ -6,6 +6,30 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::PersonalizeRuntime
+
+  # When PersonalizeRuntime returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::PersonalizeRuntime::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all PersonalizeRuntime errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::PersonalizeRuntime::Errors::ServiceError
+  #       # rescues all PersonalizeRuntime API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {InvalidInputException}
+  # * {ResourceNotFoundException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +47,6 @@ module Aws::PersonalizeRuntime
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -39,7 +62,6 @@ module Aws::PersonalizeRuntime
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::PersonalizeRuntime
+
   class Resource
 
     # @param options ({})

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

@@ -15,6 +15,9 @@ module Aws::PersonalizeRuntime
     #         campaign_arn: "Arn", # required
     #         input_list: ["ItemID"], # required
     #         user_id: "UserID", # required
+    #         context: {
+    #           "AttributeName" => "AttributeValue",
+    #         },
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -25,7 +28,7 @@ module Aws::PersonalizeRuntime
     # @!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
-    #   reranked list.
+    #   reranked list. The maximum is 500.
     #   @return [Array<String>]
     #
     # @!attribute [rw] user_id
@@ -33,17 +36,26 @@ module Aws::PersonalizeRuntime
     #   ranking.
     #   @return [String]
     #
+    # @!attribute [rw] context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might
+    #   be relevant when getting a user's recommendations, such as the
+    #   user's current location or device type.
+    #   @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(
       :campaign_arn,
       :input_list,
-      :user_id)
+      :user_id,
+      :context)
       include Aws::Structure
     end
 
     # @!attribute [rw] personalized_ranking
-    #   A list of items in order of most likely interest to the user.
+    #   A list of items in order of most likely interest to the user. The
+    #   maximum is 500.
     #   @return [Array<Types::PredictedItem>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingResponse AWS API Documentation
@@ -61,6 +73,9 @@ module Aws::PersonalizeRuntime
     #         item_id: "ItemID",
     #         user_id: "UserID",
     #         num_results: 1,
+    #         context: {
+    #           "AttributeName" => "AttributeValue",
+    #         },
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -82,21 +97,30 @@ module Aws::PersonalizeRuntime
     #
     # @!attribute [rw] num_results
     #   The number of results to return. The default is 25. The maximum is
-    #   100.
+    #   500.
     #   @return [Integer]
     #
+    # @!attribute [rw] context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might
+    #   be relevant when getting a user's recommendations, such as the
+    #   user's current location or device type.
+    #   @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(
       :campaign_arn,
       :item_id,
       :user_id,
-      :num_results)
+      :num_results,
+      :context)
       include Aws::Structure
     end
 
     # @!attribute [rw] item_list
-    #   A list of recommendations.
+    #   A list of recommendations sorted in ascending order by prediction
+    #   score. There can be a maximum of 500 items in the list.
     #   @return [Array<Types::PredictedItem>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsResponse AWS API Documentation
@@ -126,10 +150,17 @@ module Aws::PersonalizeRuntime
     #   The recommended item ID.
     #   @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.
+    #   @return [Float]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/PredictedItem AWS API Documentation
     #
     class PredictedItem < Struct.new(
-      :item_id)
+      :item_id,
+      :score)
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Personalize Runtime