aws-sdk-personalize 1.40.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2137f455dff05dcf6f85d52adef29761b2f95d37b65332d0fbd2dcdef767c30b
-  data.tar.gz: 44f7465a1a172df66f8fef62bcc0228c1d6ba4fc5fc243db3824c53217e1760a
+  metadata.gz: 3dc407b97dfd715c2a50bb1ba07c79332cc359940e83ddf7f6dabfb786c579fa
+  data.tar.gz: ed92e673a1bed28e1721875e1efe8f0ae11d6d656b5aec306e7d9b1fbdd66714
 SHA512:
-  metadata.gz: 61372af08f199a3d33e73cf09b4b784ddcf3ca385e7be2eae416bad5bbcec5f10d6def7ad9ebb58872fe913f0609a4935e28ba64f80e03d47ea6f441f94055d4
-  data.tar.gz: 1436a4955cbe6ae913b297d488065f8ebbe6a7fd73cd5b6205c24faa701167f8296cd56f7efbd3acbd1b0c98d34c4f0712ccf59fba9a2ec77f7999974677c7c1
+  metadata.gz: fe27bfcb1c7e081e3aa3c242d089218a372ac2d730570641a0ebb3728dcce22fda82c0143981fccb14c5fd86d72c5f4397e825c372f8586fa66a688fb415be77
+  data.tar.gz: 4d281bb6c08bcc87eadbb8f463c3e4edab7f5b25892cbfbdfdc8bfc05c5e92c43257dee03b9414c9dcaded5be1685d47167c32734b1c30543670d8ce267b0529

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.41.0 (2022-04-19)
+------------------
+
+* Feature - Adding StartRecommender and StopRecommender APIs for Personalize.
+
 1.40.0 (2022-04-07)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.40.0
+1.41.0

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

@@ -3575,6 +3575,65 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Starts a recommender that is INACTIVE. Starting a recommender does not
+    # create any new models, but resumes billing and automatic retraining
+    # for the recommender.
+    #
+    # @option params [required, String] :recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to start.
+    #
+    # @return [Types::StartRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartRecommenderResponse#recommender_arn #recommender_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_recommender({
+    #     recommender_arn: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.recommender_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StartRecommender AWS API Documentation
+    #
+    # @overload start_recommender(params = {})
+    # @param [Hash] params ({})
+    def start_recommender(params = {}, options = {})
+      req = build_request(:start_recommender, params)
+      req.send_request(options)
+    end
+
+    # Stops a recommender that is ACTIVE. Stopping a recommender halts
+    # billing and automatic retraining for the recommender.
+    #
+    # @option params [required, String] :recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to stop.
+    #
+    # @return [Types::StopRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StopRecommenderResponse#recommender_arn #recommender_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_recommender({
+    #     recommender_arn: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.recommender_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StopRecommender AWS API Documentation
+    #
+    # @overload stop_recommender(params = {})
+    # @param [Hash] params ({})
+    def stop_recommender(params = {}, options = {})
+      req = build_request(:stop_recommender, params)
+      req.send_request(options)
+    end
+
     # Stops creating a solution version that is in a state of
     # CREATE\_PENDING or CREATE IN\_PROGRESS.
     #
@@ -3685,8 +3744,10 @@ module Aws::Personalize
     # FAILED. Check the campaign status using the [DescribeCampaign][1]
     # operation.
     #
-    # <note markdown="1"> You must wait until the `status` of the updated campaign is `ACTIVE`
-    # before asking the campaign for recommendations.
+    # <note markdown="1"> You can still get recommendations from a campaign while an update is
+    # in progress. The campaign will use the previous solution version and
+    # campaign configuration to generate recommendations until the latest
+    # campaign update status is `Active`.
     #
     #  </note>
     #
@@ -3790,7 +3851,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.40.0'
+      context[:gem_version] = '1.41.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -242,7 +242,11 @@ module Aws::Personalize
     SolutionVersionSummary = Shapes::StructureShape.new(name: 'SolutionVersionSummary')
     SolutionVersions = Shapes::ListShape.new(name: 'SolutionVersions')
     Solutions = Shapes::ListShape.new(name: 'Solutions')
+    StartRecommenderRequest = Shapes::StructureShape.new(name: 'StartRecommenderRequest')
+    StartRecommenderResponse = Shapes::StructureShape.new(name: 'StartRecommenderResponse')
     Status = Shapes::StringShape.new(name: 'Status')
+    StopRecommenderRequest = Shapes::StructureShape.new(name: 'StopRecommenderRequest')
+    StopRecommenderResponse = Shapes::StructureShape.new(name: 'StopRecommenderResponse')
     StopSolutionVersionCreationRequest = Shapes::StructureShape.new(name: 'StopSolutionVersionCreationRequest')
     Tag = Shapes::StructureShape.new(name: 'Tag')
     TagKey = Shapes::StringShape.new(name: 'TagKey')
@@ -1166,6 +1170,18 @@ module Aws::Personalize
 
     Solutions.member = Shapes::ShapeRef.new(shape: SolutionSummary)
 
+    StartRecommenderRequest.add_member(:recommender_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "recommenderArn"))
+    StartRecommenderRequest.struct_class = Types::StartRecommenderRequest
+
+    StartRecommenderResponse.add_member(:recommender_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recommenderArn"))
+    StartRecommenderResponse.struct_class = Types::StartRecommenderResponse
+
+    StopRecommenderRequest.add_member(:recommender_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "recommenderArn"))
+    StopRecommenderRequest.struct_class = Types::StopRecommenderRequest
+
+    StopRecommenderResponse.add_member(:recommender_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recommenderArn"))
+    StopRecommenderResponse.struct_class = Types::StopRecommenderResponse
+
     StopSolutionVersionCreationRequest.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "solutionVersionArn"))
     StopSolutionVersionCreationRequest.struct_class = Types::StopSolutionVersionCreationRequest
 
@@ -1900,6 +1916,28 @@ module Aws::Personalize
         o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
       end)
 
+      api.add_operation(:start_recommender, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartRecommender"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StartRecommenderRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartRecommenderResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
+      end)
+
+      api.add_operation(:stop_recommender, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StopRecommender"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StopRecommenderRequest)
+        o.output = Shapes::ShapeRef.new(shape: StopRecommenderResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
+      end)
+
       api.add_operation(:stop_solution_version_creation, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StopSolutionVersionCreation"
         o.http_method = "POST"

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

@@ -5499,6 +5499,68 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StartRecommenderRequest
+    #   data as a hash:
+    #
+    #       {
+    #         recommender_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to start.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StartRecommenderRequest AWS API Documentation
+    #
+    class StartRecommenderRequest < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender you started.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StartRecommenderResponse AWS API Documentation
+    #
+    class StartRecommenderResponse < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass StopRecommenderRequest
+    #   data as a hash:
+    #
+    #       {
+    #         recommender_arn: "Arn", # required
+    #       }
+    #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to stop.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StopRecommenderRequest AWS API Documentation
+    #
+    class StopRecommenderRequest < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender you stopped.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/StopRecommenderResponse AWS API Documentation
+    #
+    class StopRecommenderResponse < Struct.new(
+      :recommender_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StopSolutionVersionCreationRequest
     #   data as a hash:
     #

data/lib/aws-sdk-personalize.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-personalize/customizations'
 # @!group service
 module Aws::Personalize
 
-  GEM_VERSION = '1.40.0'
+  GEM_VERSION = '1.41.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core