aws-sdk-comprehend 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97c1518c041119d0fa4e310d9fb4e97f43776674
-  data.tar.gz: 308a1ccedf8b2889f19b95a0eef04be11b48fd7d
+  metadata.gz: '0698d44ad3f2f5f6f875932cd27c90ad0f616ee3'
+  data.tar.gz: 3f1b4152e819201b97dab7f9b74ba1cb4b2b0779
 SHA512:
-  metadata.gz: 8a047da29d9b060adf2a559a673f66f5a51aa16f631bf92d2c86a25098b37469d9dac3ae471b0fc9cc7cd198a6f9dd9932595486b2c45706f7357911c8a68b3f
-  data.tar.gz: d79ef69df60ce0820817397e6c4a407ea6862f79b57eb1fb50a4220567b41757208aa3cdfd5746e11f5e2a02a22087edfbe7c9d1e9a3d70c16557c515310acf5
+  metadata.gz: 713cef1fe57743bd49e221902c04cb1f55a5358e4aa9c259e9280feb811b8f16537d1cfa1bc2be8f27cc58572f98b1d6251dc74315a6df150d88b36a7e61676d
+  data.tar.gz: '0955f834bab8148b5140050b2167bceb03ba96cbb0909468018a1a0bf94853c8907f9a9bf616469224c35517e42ff98b090e943a585ad9c12369ac6eafc8e433'

data/lib/aws-sdk-comprehend.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-comprehend/customizations'
 # @service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.11.0'
+  GEM_VERSION = '1.12.0'
 
 end

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

@@ -458,7 +458,8 @@ module Aws::Comprehend
     # documents. To create a classifier you provide a set of training
     # documents that labeled with the categories that you want to use. After
     # the classifier is trained you can use it to categorize a set of
-    # labeled documents into the categories.
+    # labeled documents into the categories. For more information, see
+    # how-document-classification.
     #
     # @option params [required, String] :document_classifier_name
     #   The name of the document classifier.
@@ -707,7 +708,7 @@ module Aws::Comprehend
     #
     #   resp.document_classifier_properties.document_classifier_arn #=> String
     #   resp.document_classifier_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
-    #   resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
+    #   resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
     #   resp.document_classifier_properties.message #=> String
     #   resp.document_classifier_properties.submit_time #=> Time
     #   resp.document_classifier_properties.end_time #=> Time
@@ -833,7 +834,7 @@ module Aws::Comprehend
     #
     #   resp.entity_recognizer_properties.entity_recognizer_arn #=> String
     #   resp.entity_recognizer_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
-    #   resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
+    #   resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
     #   resp.entity_recognizer_properties.message #=> String
     #   resp.entity_recognizer_properties.submit_time #=> Time
     #   resp.entity_recognizer_properties.end_time #=> Time
@@ -1257,7 +1258,7 @@ module Aws::Comprehend
     #
     #   resp = client.list_document_classifiers({
     #     filter: {
-    #       status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
+    #       status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
     #       submit_time_before: Time.now,
     #       submit_time_after: Time.now,
     #     },
@@ -1270,7 +1271,7 @@ module Aws::Comprehend
     #   resp.document_classifier_properties_list #=> Array
     #   resp.document_classifier_properties_list[0].document_classifier_arn #=> String
     #   resp.document_classifier_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
-    #   resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
+    #   resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
     #   resp.document_classifier_properties_list[0].message #=> String
     #   resp.document_classifier_properties_list[0].submit_time #=> Time
     #   resp.document_classifier_properties_list[0].end_time #=> Time
@@ -1441,7 +1442,7 @@ module Aws::Comprehend
     #
     #   resp = client.list_entity_recognizers({
     #     filter: {
-    #       status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
+    #       status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
     #       submit_time_before: Time.now,
     #       submit_time_after: Time.now,
     #     },
@@ -1454,7 +1455,7 @@ module Aws::Comprehend
     #   resp.entity_recognizer_properties_list #=> Array
     #   resp.entity_recognizer_properties_list[0].entity_recognizer_arn #=> String
     #   resp.entity_recognizer_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt"
-    #   resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "IN_ERROR", "TRAINED"
+    #   resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
     #   resp.entity_recognizer_properties_list[0].message #=> String
     #   resp.entity_recognizer_properties_list[0].submit_time #=> Time
     #   resp.entity_recognizer_properties_list[0].end_time #=> Time
@@ -2238,6 +2239,66 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Stops a document classifier training job while in progress.
+    #
+    # If the training job state is `TRAINING`, the job is marked for
+    # termination and put into the `STOP_REQUESTED` state. If the training
+    # job completes before it can be stopped, it is put into the `TRAINED`;
+    # otherwise the training job is stopped and put into the `STOPPED` state
+    # and the service sends back an HTTP 200 response with an empty HTTP
+    # body.
+    #
+    # @option params [required, String] :document_classifier_arn
+    #   The Amazon Resource Name (ARN) that identifies the document classifier
+    #   currently being trained.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_training_document_classifier({
+    #     document_classifier_arn: "DocumentClassifierArn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier AWS API Documentation
+    #
+    # @overload stop_training_document_classifier(params = {})
+    # @param [Hash] params ({})
+    def stop_training_document_classifier(params = {}, options = {})
+      req = build_request(:stop_training_document_classifier, params)
+      req.send_request(options)
+    end
+
+    # Stops an entity recognizer training job while in progress.
+    #
+    # If the training job state is `TRAINING`, the job is marked for
+    # termination and put into the `STOP_REQUESTED` state. If the training
+    # job completes before it can be stopped, it is put into the `TRAINED`;
+    # otherwise the training job is stopped and putted into the `STOPPED`
+    # state and the service sends back an HTTP 200 response with an empty
+    # HTTP body.
+    #
+    # @option params [required, String] :entity_recognizer_arn
+    #   The Amazon Resource Name (ARN) that identifies the entity recognizer
+    #   currently being trained.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_training_entity_recognizer({
+    #     entity_recognizer_arn: "EntityRecognizerArn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer AWS API Documentation
+    #
+    # @overload stop_training_entity_recognizer(params = {})
+    # @param [Hash] params ({})
+    def stop_training_entity_recognizer(params = {}, options = {})
+      req = build_request(:stop_training_entity_recognizer, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -2251,7 +2312,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -179,6 +179,10 @@ module Aws::Comprehend
     StopKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobResponse')
     StopSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobRequest')
     StopSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobResponse')
+    StopTrainingDocumentClassifierRequest = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierRequest')
+    StopTrainingDocumentClassifierResponse = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierResponse')
+    StopTrainingEntityRecognizerRequest = Shapes::StructureShape.new(name: 'StopTrainingEntityRecognizerRequest')
+    StopTrainingEntityRecognizerResponse = Shapes::StructureShape.new(name: 'StopTrainingEntityRecognizerResponse')
     String = Shapes::StringShape.new(name: 'String')
     StringList = Shapes::ListShape.new(name: 'StringList')
     SyntaxLanguageCode = Shapes::StringShape.new(name: 'SyntaxLanguageCode')
@@ -786,6 +790,16 @@ module Aws::Comprehend
     StopSentimentDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
     StopSentimentDetectionJobResponse.struct_class = Types::StopSentimentDetectionJobResponse
 
+    StopTrainingDocumentClassifierRequest.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, required: true, location_name: "DocumentClassifierArn"))
+    StopTrainingDocumentClassifierRequest.struct_class = Types::StopTrainingDocumentClassifierRequest
+
+    StopTrainingDocumentClassifierResponse.struct_class = Types::StopTrainingDocumentClassifierResponse
+
+    StopTrainingEntityRecognizerRequest.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, required: true, location_name: "EntityRecognizerArn"))
+    StopTrainingEntityRecognizerRequest.struct_class = Types::StopTrainingEntityRecognizerRequest
+
+    StopTrainingEntityRecognizerResponse.struct_class = Types::StopTrainingEntityRecognizerResponse
+
     StringList.member = Shapes::ShapeRef.new(shape: String)
 
     SyntaxToken.add_member(:token_id, Shapes::ShapeRef.new(shape: Integer, location_name: "TokenId"))
@@ -1347,6 +1361,30 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
+
+      api.add_operation(:stop_training_document_classifier, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StopTrainingDocumentClassifier"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StopTrainingDocumentClassifierRequest)
+        o.output = Shapes::ShapeRef.new(shape: StopTrainingDocumentClassifierResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
+      api.add_operation(:stop_training_entity_recognizer, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StopTrainingEntityRecognizer"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StopTrainingEntityRecognizerRequest)
+        o.output = Shapes::ShapeRef.new(shape: StopTrainingEntityRecognizerResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
     end
 
   end

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

@@ -1218,7 +1218,7 @@ module Aws::Comprehend
     #   data as a hash:
     #
     #       {
-    #         status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
+    #         status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
     #         submit_time_before: Time.now,
     #         submit_time_after: Time.now,
     #       }
@@ -1294,7 +1294,7 @@ module Aws::Comprehend
     #   @return [String]
     #
     # @!attribute [rw] status
-    #   The status of the document classifier. The the status is `TRAINED`
+    #   The status of the document classifier. If the status is `TRAINED`
     #   the classifier is ready to use. If the status is `FAILED` you can
     #   see additional information about why the classifier wasn't trained
     #   in the `Message` field.
@@ -1753,7 +1753,7 @@ module Aws::Comprehend
     #   data as a hash:
     #
     #       {
-    #         status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
+    #         status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
     #         submit_time_before: Time.now,
     #         submit_time_after: Time.now,
     #       }
@@ -2215,7 +2215,7 @@ module Aws::Comprehend
     #
     #       {
     #         filter: {
-    #           status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
+    #           status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
     #           submit_time_before: Time.now,
     #           submit_time_after: Time.now,
     #         },
@@ -2376,7 +2376,7 @@ module Aws::Comprehend
     #
     #       {
     #         filter: {
-    #           status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, IN_ERROR, TRAINED
+    #           status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
     #           submit_time_before: Time.now,
     #           submit_time_after: Time.now,
     #         },
@@ -3494,6 +3494,52 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StopTrainingDocumentClassifierRequest
+    #   data as a hash:
+    #
+    #       {
+    #         document_classifier_arn: "DocumentClassifierArn", # required
+    #       }
+    #
+    # @!attribute [rw] document_classifier_arn
+    #   The Amazon Resource Name (ARN) that identifies the document
+    #   classifier currently being trained.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifierRequest AWS API Documentation
+    #
+    class StopTrainingDocumentClassifierRequest < Struct.new(
+      :document_classifier_arn)
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifierResponse AWS API Documentation
+    #
+    class StopTrainingDocumentClassifierResponse < Aws::EmptyStructure; end
+
+    # @note When making an API call, you may pass StopTrainingEntityRecognizerRequest
+    #   data as a hash:
+    #
+    #       {
+    #         entity_recognizer_arn: "EntityRecognizerArn", # required
+    #       }
+    #
+    # @!attribute [rw] entity_recognizer_arn
+    #   The Amazon Resource Name (ARN) that identifies the entity recognizer
+    #   currently being trained.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizerRequest AWS API Documentation
+    #
+    class StopTrainingEntityRecognizerRequest < Struct.new(
+      :entity_recognizer_arn)
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizerResponse AWS API Documentation
+    #
+    class StopTrainingEntityRecognizerResponse < Aws::EmptyStructure; end
+
     # Represents a work in the input text that was recognized and assigned a
     # part of speech. There is one syntax token record for each word in the
     # source text.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core