aws-sdk-personalize 1.16.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669524793bd1b6a04445ab1cde1a76c5c258131593f7fb9363c315d86cc494a8
-  data.tar.gz: f195623424a4baf1cc0238725dfb39485671dad471a6f7919e25361c860f604b
+  metadata.gz: 49b4b511cf2f4253b8bba808b4cefb56bcfa33cc5e0291e125749d8c5a129e6b
+  data.tar.gz: 849188f744079e86f732866dac04b99f8ac1b7b8839a9cda4da2bc1c2dfa01e0
 SHA512:
-  metadata.gz: c8ececc45489015b8ef2b4f51ae8445449b49c0edd8f0d4993047934009a0be5790a3a0bcbb5f2ead4d29627fd01eb2cb31cd39cc818278f937721324431e711
-  data.tar.gz: d5280a68a2625a4d9aebce4de648f2a303afe9909dd1d4bd4aaab21d67e2cf680d6625a25fba25c8659f6a40e0b3cc2facf4a90af96a4dd7552e87f488ea793e
+  metadata.gz: e9307b65504c54c54466aff32c2423730ac7b7f51c22908a8fe8f902b2d26a23771d67d118c6745ab98aee261bbc8e35d56ab48531310a1e8abcffec0279cc96
+  data.tar.gz: b241d1eb81b5da38f708662ab8afd1a4055768f6fe947b082cf18b3303d6f769ee55d38d64b43019229fb49ca0214179db46fece4807e7c0c2b84b66b0e9d3d4

data/lib/aws-sdk-personalize.rb

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

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

@@ -85,13 +85,28 @@ module Aws::Personalize
     #     * `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::Personalize
     #     * 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
@@ -412,11 +427,16 @@ module Aws::Personalize
     # throughput and unit of billing for Amazon Personalize. The minimum
     # provisioned TPS (`minProvisionedTPS`) specifies the baseline
     # throughput provisioned by Amazon Personalize, and thus, the minimum
-    # billing charge. If your TPS increases beyond `minProvisionedTPS`,
-    # Amazon Personalize auto-scales the provisioned capacity up and down,
-    # but never below `minProvisionedTPS`, to maintain a 70% utilization.
-    # There's a short time delay while the capacity is increased that might
-    # cause loss of transactions. It's recommended to start with a low
+    # billing charge.
+    #
+    # If your TPS increases beyond `minProvisionedTPS`, Amazon Personalize
+    # auto-scales the provisioned capacity up and down, but never below
+    # `minProvisionedTPS`. There's a short time delay while the capacity is
+    # increased that might cause loss of transactions.
+    #
+    # The actual TPS used is calculated as the average requests/second
+    # within a 5-minute window. You pay for maximum of either the minimum
+    # provisioned TPS or the actual TPS. We recommend starting with a low
     # `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
     # and then increase the `minProvisionedTPS` as necessary.
     #
@@ -671,7 +691,8 @@ module Aws::Personalize
     # from the data source, as Amazon Personalize makes a copy of your data
     # and processes it in an internal AWS system.
     #
-    # The dataset import job replaces any previous data in the dataset.
+    # The dataset import job replaces any existing data in the dataset that
+    # you imported in bulk.
     #
     # **Status**
     #
@@ -740,23 +761,20 @@ module Aws::Personalize
       req.send_request(options)
     end
 
-    # Creates an event tracker that you use when sending event data to the
+    # Creates an event tracker that you use when adding event data to a
     # specified dataset group using the [PutEvents][1] API.
     #
-    # When Amazon Personalize creates an event tracker, it also creates an
-    # *event-interactions* dataset in the dataset group associated with the
-    # event tracker. The event-interactions dataset stores the event data
-    # from the `PutEvents` call. The contents of this dataset are not
-    # available to the user.
-    #
     # <note markdown="1"> Only one event tracker can be associated with a dataset group. You
     # will get an error if you call `CreateEventTracker` using the same
     # dataset group as an existing event tracker.
     #
     #  </note>
     #
-    # When you send event data you include your tracking ID. The tracking ID
-    # identifies the customer and authorizes the customer to send the data.
+    # When you create an event tracker, the response includes a tracking ID,
+    # which you pass as a parameter when you use the [PutEvents][1]
+    # operation. Amazon Personalize then appends the event data to the
+    # Interactions dataset of the dataset group you specify in your event
+    # tracker.
     #
     # The event tracker can be in one of the following states:
     #
@@ -817,12 +835,7 @@ module Aws::Personalize
       req.send_request(options)
     end
 
-    # Creates a recommendation filter. For more information, see [Using
-    # Filters with Amazon Personalize][1].
-    #
-    #
-    #
-    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    # Creates a recommendation filter. For more information, see filter.
     #
     # @option params [required, String] :name
     #   The name of the filter to create.
@@ -831,20 +844,10 @@ module Aws::Personalize
     #   The ARN of the dataset group that the filter will belong to.
     #
     # @option params [required, String] :filter_expression
-    #   The filter expression that designates the interaction types that the
-    #   filter will filter out. A filter expression must follow the following
-    #   format:
-    #
-    #   `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
-    #
-    #   Where "EVENT\_TYPE" is the type of event to filter out. To filter
-    #   out all items with any interactions history, set `"*"` as the
-    #   EVENT\_TYPE. For more information, see [Using Filters with Amazon
-    #   Personalize][1].
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   The filter expression defines which items are included or excluded
+    #   from recommendations. Filter expression must follow specific format
+    #   rules. For information about filter expression structure and syntax,
+    #   see filter-expressions.
     #
     # @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -935,6 +938,11 @@ module Aws::Personalize
     # `performAutoML` and Amazon Personalize will analyze your data and
     # select the optimum USER\_PERSONALIZATION recipe for you.
     #
+    # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` for
+    # solution hyperparameter optimization at this time.
+    #
+    #  </note>
+    #
     # **Status**
     #
     # A solution can be in one of the following states:
@@ -1000,11 +1008,19 @@ module Aws::Personalize
     #   field), this parameter specifies which event type (for example,
     #   'click' or 'like') is used for training the model.
     #
+    #   If you do not provide an `eventType`, Amazon Personalize will use all
+    #   interactions for training with equal weight regardless of type.
+    #
     # @option params [Types::SolutionConfig] :solution_config
     #   The configuration to use with the solution. When `performAutoML` is
     #   set to true, Amazon Personalize only evaluates the `autoMLConfig`
     #   section of the solution configuration.
     #
+    #   <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
+    #   this time.
+    #
+    #    </note>
+    #
     # @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
@@ -1129,7 +1145,12 @@ module Aws::Personalize
     #   The `UPDATE` option can only be used when you already have an active
     #   solution version created from the input solution using the `FULL`
     #   option and the input solution was trained with the
-    #   native-recipe-hrnn-coldstart recipe.
+    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #
     # @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2572,7 +2593,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.16.0'
+      context[:gem_version] = '1.21.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -240,9 +240,11 @@ module Aws::Personalize
     #       }
     #
     # @!attribute [rw] item_exploration_config
-    #   A string to string map specifying the inference hyperparameters you
-    #   wish to use for hyperparameter optimization. See
-    #   customizing-solution-config-hpo.
+    #   A string to string map specifying the exploration configuration
+    #   hyperparameters, including `explorationWeight` and
+    #   `explorationItemAgeCutOff`, you want to use to configure the amount
+    #   of item exploration Amazon Personalize uses when recommending items.
+    #   See native-recipe-new-item-USER\_PERSONALIZATION.
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobConfig AWS API Documentation
@@ -442,9 +444,16 @@ module Aws::Personalize
     #       }
     #
     # @!attribute [rw] item_exploration_config
-    #   A string to string map specifying the inference hyperparameters you
-    #   wish to use for hyperparameter optimization. See
-    #   customizing-solution-config-hpo.
+    #   A string to string map specifying the exploration configuration
+    #   hyperparameters, including `explorationWeight` and
+    #   `explorationItemAgeCutOff`, you want to use to configure the amount
+    #   of item exploration Amazon Personalize uses when recommending items.
+    #   Provide `itemExplorationConfig` data only if your solution uses the
+    #   [User-Personalization][1] recipe.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
     #   @return [Hash<String,String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
@@ -988,20 +997,10 @@ module Aws::Personalize
     #   @return [String]
     #
     # @!attribute [rw] filter_expression
-    #   The filter expression that designates the interaction types that the
-    #   filter will filter out. A filter expression must follow the
-    #   following format:
-    #
-    #   `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
-    #
-    #   Where "EVENT\_TYPE" is the type of event to filter out. To filter
-    #   out all items with any interactions history, set `"*"` as the
-    #   EVENT\_TYPE. For more information, see [Using Filters with Amazon
-    #   Personalize][1].
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   The filter expression defines which items are included or excluded
+    #   from recommendations. Filter expression must follow specific format
+    #   rules. For information about filter expression structure and syntax,
+    #   see filter-expressions.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
@@ -1159,12 +1158,20 @@ module Aws::Personalize
     #   When your have multiple event types (using an `EVENT_TYPE` schema
     #   field), this parameter specifies which event type (for example,
     #   'click' or 'like') is used for training the model.
+    #
+    #   If you do not provide an `eventType`, Amazon Personalize will use
+    #   all interactions for training with equal weight regardless of type.
     #   @return [String]
     #
     # @!attribute [rw] solution_config
     #   The configuration to use with the solution. When `performAutoML` is
     #   set to true, Amazon Personalize only evaluates the `autoMLConfig`
     #   section of the solution configuration.
+    #
+    #   <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
+    #   at this time.
+    #
+    #    </note>
     #   @return [Types::SolutionConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
@@ -1218,7 +1225,12 @@ module Aws::Personalize
     #   The `UPDATE` option can only be used when you already have an active
     #   solution version created from the input solution using the `FULL`
     #   option and the input solution was trained with the
-    #   native-recipe-hrnn-coldstart recipe.
+    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
@@ -2533,17 +2545,9 @@ module Aws::Personalize
     #
     # @!attribute [rw] filter_expression
     #   Specifies the type of item interactions to filter out of
-    #   recommendation results. The filter expression must follow the
-    #   following format:
-    #
-    #   `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
-    #
-    #   Where "EVENT\_TYPE" is the type of event to filter out. For more
-    #   information, see [Using Filters with Amazon Personalize][1].
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
+    #   recommendation results. The filter expression must follow specific
+    #   format rules. For information about filter expression structure and
+    #   syntax, see filter-expressions.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -2646,9 +2650,7 @@ module Aws::Personalize
       include Aws::Structure
     end
 
-    # Describes the properties for hyperparameter optimization (HPO). For
-    # use with the bring-your-own-recipe feature. Do not use for Amazon
-    # Personalize native recipes.
+    # Describes the properties for hyperparameter optimization (HPO).
     #
     # @note When making an API call, you may pass HPOConfig
     #   data as a hash:
@@ -2689,6 +2691,11 @@ module Aws::Personalize
     #
     # @!attribute [rw] hpo_objective
     #   The metric to optimize during HPO.
+    #
+    #   <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
+    #   at this time.
+    #
+    #    </note>
     #   @return [Types::HPOObjective]
     #
     # @!attribute [rw] hpo_resource_config
@@ -2711,6 +2718,11 @@ module Aws::Personalize
 
     # The metric to optimize during hyperparameter optimization (HPO).
     #
+    # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
+    # this time.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass HPOObjective
     #   data as a hash:
     #
@@ -3633,7 +3645,9 @@ module Aws::Personalize
     #
     # @!attribute [rw] event_type
     #   The event type (for example, 'click' or 'like') that is used for
-    #   training the model.
+    #   training the model. If no `eventType` is provided, Amazon
+    #   Personalize uses all interactions for training with equal weight
+    #   regardless of type.
     #   @return [String]
     #
     # @!attribute [rw] solution_config
@@ -3863,17 +3877,23 @@ module Aws::Personalize
     #   @return [Float]
     #
     # @!attribute [rw] training_mode
-    #   The scope of training used to create the solution version. The
-    #   `FULL` option trains the solution version based on the entirety of
-    #   the input solution's training data, while the `UPDATE` option
-    #   processes only the training data that has changed since the creation
-    #   of the last solution version. Choose `UPDATE` when you want to start
-    #   recommending items added to the dataset without retraining the
-    #   model.
-    #
-    #   The `UPDATE` option can only be used after you've created a
-    #   solution version with the `FULL` option and the training solution
-    #   uses the native-recipe-hrnn-coldstart.
+    #   The scope of training to be performed when creating the solution
+    #   version. The `FULL` option trains the solution version based on the
+    #   entirety of the input solution's training data, while the `UPDATE`
+    #   option processes only the data that has changed in comparison to the
+    #   input solution. Choose `UPDATE` when you want to incrementally
+    #   update your solution version instead of creating an entirely new
+    #   one.
+    #
+    #   The `UPDATE` option can only be used when you already have an active
+    #   solution version created from the input solution using the `FULL`
+    #   option and the input solution was trained with the
+    #   [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
     #   @return [String]
     #
     # @!attribute [rw] tuned_hpo_params

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-02-02 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.112.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.112.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement