aws-sdk-comprehend 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0a504f290d6c4c29ced8ec008f678519428e8f8
-  data.tar.gz: ea463f1abbac0ada1859320ea1f240fe000c7916
+  metadata.gz: 4c2a113acf1524fdf822c877dd60f13de2f157f5
+  data.tar.gz: 014354d5c2eb746a70dac19c9c25a4015a56fc87
 SHA512:
-  metadata.gz: ba637ef3d47091ff0bf447323bbd902bc6ff94b728a3d0b299d44630c1d8753d34622c7ab84ff7f66939705540d4d09c19a3fdedd0dacf897a375b74f0b4a642
-  data.tar.gz: 380f6d0bfb6ce89893ceb7d0b73469f86b49bc567d5c73f58911851b080910973a68ed902580e9710552a43d8dd4e3b62b69df47ca73786fe0ea8ae09ac4c873
+  metadata.gz: b846b985a32d22347ba1ab9fc0970e8b540360e37b67718668e8accc22c0c7e4f1bb3fcbb835b20fd705841c940259da7f23285be526a88b78d611b7547e7eb2
+  data.tar.gz: 0003e1523bde687b8f9564dbd89036acf70d71e4bf0d48d07636684a0d97c5a5bb2c41b18068012c86079b41670faa8fc4ad94c14770ca17515da114b785cc1b

data/lib/aws-sdk-comprehend.rb

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

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

@@ -515,13 +515,16 @@ module Aws::Comprehend
     # @option params [Array<Types::Tag>] :tags
     #   Tags to be associated with the document classifier being created. A
     #   tag is a key-value pair that adds as a metadata to a resource used by
-    #   Amazon Comprehend. For example, a tag with the key-value pair
-    #   ‘Department’:’Sales’ might be added to a resource to indicate its use
-    #   by a particular department.
+    #   Amazon Comprehend. For example, a tag with "Sales" as the key might
+    #   be added to a resource to indicate its use by the sales department.
     #
     # @option params [required, Types::DocumentClassifierInputDataConfig] :input_data_config
     #   Specifies the format and location of the input data for the job.
     #
+    # @option params [Types::DocumentClassifierOutputDataConfig] :output_data_config
+    #   Enables the addition of output results configuration parameters for
+    #   custom classifier jobs.
+    #
     # @option params [String] :client_request_token
     #   A unique identifier for the request. If you don't set the client
     #   request token, Amazon Comprehend generates one.
@@ -562,6 +565,10 @@ module Aws::Comprehend
     #     input_data_config: { # required
     #       s3_uri: "S3Uri", # required
     #     },
+    #     output_data_config: {
+    #       s3_uri: "S3Uri",
+    #       kms_key_id: "KmsKeyId",
+    #     },
     #     client_request_token: "ClientRequestTokenString",
     #     language_code: "en", # required, accepts en, es, fr, de, it, pt
     #     volume_kms_key_id: "KmsKeyId",
@@ -598,9 +605,8 @@ module Aws::Comprehend
     # @option params [Array<Types::Tag>] :tags
     #   Tags to be associated with the entity recognizer being created. A tag
     #   is a key-value pair that adds as a metadata to a resource used by
-    #   Amazon Comprehend. For example, a tag with the key-value pair
-    #   ‘Department’:’Sales’ might be added to a resource to indicate its use
-    #   by a particular department.
+    #   Amazon Comprehend. For example, a tag with "Sales" as the key might
+    #   be added to a resource to indicate its use by the sales department.
     #
     # @option params [required, Types::EntityRecognizerInputDataConfig] :input_data_config
     #   Specifies the format and location of the input data. The S3 bucket
@@ -810,6 +816,8 @@ module Aws::Comprehend
     #   resp.document_classifier_properties.training_start_time #=> Time
     #   resp.document_classifier_properties.training_end_time #=> Time
     #   resp.document_classifier_properties.input_data_config.s3_uri #=> String
+    #   resp.document_classifier_properties.output_data_config.s3_uri #=> String
+    #   resp.document_classifier_properties.output_data_config.kms_key_id #=> String
     #   resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
     #   resp.document_classifier_properties.classifier_metadata.number_of_trained_documents #=> Integer
     #   resp.document_classifier_properties.classifier_metadata.number_of_test_documents #=> Integer
@@ -1388,6 +1396,8 @@ module Aws::Comprehend
     #   resp.document_classifier_properties_list[0].training_start_time #=> Time
     #   resp.document_classifier_properties_list[0].training_end_time #=> Time
     #   resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
+    #   resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
+    #   resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
     #   resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
     #   resp.document_classifier_properties_list[0].classifier_metadata.number_of_trained_documents #=> Integer
     #   resp.document_classifier_properties_list[0].classifier_metadata.number_of_test_documents #=> Integer
@@ -1719,8 +1729,7 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
-    # Lists all tags associated with a given Amazon Comprehend resource. Up
-    # to the maximum number of tags allowed per resource will be displayed.
+    # Lists all tags associated with a given Amazon Comprehend resource.
     #
     # @option params [required, String] :resource_arn
     #   The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
@@ -2536,9 +2545,8 @@ module Aws::Comprehend
 
     # Associates a specific tag with an Amazon Comprehend resource. A tag is
     # a key-value pair that adds as a metadata to a resource used by Amazon
-    # Comprehend. For example, a tag with the key-value pair
-    # ‘Department’:’Sales’ might be added to a resource to indicate its use
-    # by a particular department.
+    # Comprehend. For example, a tag with "Sales" as the key might be
+    # added to a resource to indicate its use by the sales department.
     #
     # @option params [required, String] :resource_arn
     #   The Amazon Resource Name (ARN) of the given Amazon Comprehend resource
@@ -2546,6 +2554,8 @@ module Aws::Comprehend
     #
     # @option params [required, Array<Types::Tag>] :tags
     #   Tags being associated with a specific Amazon Comprehend resource.
+    #   There can be a maximum of 50 tags (both existing and pending)
+    #   associated with a specific resource.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -2578,9 +2588,10 @@ module Aws::Comprehend
     #
     # @option params [required, Array<String>] :tag_keys
     #   The initial part of a key-value pair that forms a tag being removed
-    #   from a given resource. For instance, “Department” might be used as the
-    #   key portion of the pair, with multiple values such as “sales,”
-    #   “legal,” and “administration.”
+    #   from a given resource. For example, a tag with "Sales" as the key
+    #   might be added to a resource to indicate its use by the sales
+    #   department. Keys must be unique and cannot be duplicated for a
+    #   particular resource.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -2613,7 +2624,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -76,6 +76,7 @@ module Aws::Comprehend
     DocumentClassifierArn = Shapes::StringShape.new(name: 'DocumentClassifierArn')
     DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
     DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
+    DocumentClassifierOutputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierOutputDataConfig')
     DocumentClassifierProperties = Shapes::StructureShape.new(name: 'DocumentClassifierProperties')
     DocumentClassifierPropertiesList = Shapes::ListShape.new(name: 'DocumentClassifierPropertiesList')
     DominantLanguage = Shapes::StructureShape.new(name: 'DominantLanguage')
@@ -295,6 +296,7 @@ module Aws::Comprehend
     CreateDocumentClassifierRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
     CreateDocumentClassifierRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
     CreateDocumentClassifierRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, required: true, location_name: "InputDataConfig"))
+    CreateDocumentClassifierRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierOutputDataConfig, location_name: "OutputDataConfig"))
     CreateDocumentClassifierRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
     CreateDocumentClassifierRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
     CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
@@ -437,6 +439,10 @@ module Aws::Comprehend
     DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
     DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
 
+    DocumentClassifierOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
+    DocumentClassifierOutputDataConfig.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
+    DocumentClassifierOutputDataConfig.struct_class = Types::DocumentClassifierOutputDataConfig
+
     DocumentClassifierProperties.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
     DocumentClassifierProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
     DocumentClassifierProperties.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
@@ -446,6 +452,7 @@ module Aws::Comprehend
     DocumentClassifierProperties.add_member(:training_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingStartTime"))
     DocumentClassifierProperties.add_member(:training_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "TrainingEndTime"))
     DocumentClassifierProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, location_name: "InputDataConfig"))
+    DocumentClassifierProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierOutputDataConfig, location_name: "OutputDataConfig"))
     DocumentClassifierProperties.add_member(:classifier_metadata, Shapes::ShapeRef.new(shape: ClassifierMetadata, location_name: "ClassifierMetadata"))
     DocumentClassifierProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
     DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))

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

@@ -468,6 +468,10 @@ module Aws::Comprehend
     #         input_data_config: { # required
     #           s3_uri: "S3Uri", # required
     #         },
+    #         output_data_config: {
+    #           s3_uri: "S3Uri",
+    #           kms_key_id: "KmsKeyId",
+    #         },
     #         client_request_token: "ClientRequestTokenString",
     #         language_code: "en", # required, accepts en, es, fr, de, it, pt
     #         volume_kms_key_id: "KmsKeyId",
@@ -486,15 +490,20 @@ module Aws::Comprehend
     # @!attribute [rw] tags
     #   Tags to be associated with the document classifier being created. A
     #   tag is a key-value pair that adds as a metadata to a resource used
-    #   by Amazon Comprehend. For example, a tag with the key-value pair
-    #   ‘Department’:’Sales’ might be added to a resource to indicate its
-    #   use by a particular department.
+    #   by Amazon Comprehend. For example, a tag with "Sales" as the key
+    #   might be added to a resource to indicate its use by the sales
+    #   department.
     #   @return [Array<Types::Tag>]
     #
     # @!attribute [rw] input_data_config
     #   Specifies the format and location of the input data for the job.
     #   @return [Types::DocumentClassifierInputDataConfig]
     #
+    # @!attribute [rw] output_data_config
+    #   Enables the addition of output results configuration parameters for
+    #   custom classifier jobs.
+    #   @return [Types::DocumentClassifierOutputDataConfig]
+    #
     # @!attribute [rw] client_request_token
     #   A unique identifier for the request. If you don't set the client
     #   request token, Amazon Comprehend generates one.
@@ -528,6 +537,7 @@ module Aws::Comprehend
       :data_access_role_arn,
       :tags,
       :input_data_config,
+      :output_data_config,
       :client_request_token,
       :language_code,
       :volume_kms_key_id)
@@ -595,9 +605,9 @@ module Aws::Comprehend
     # @!attribute [rw] tags
     #   Tags to be associated with the entity recognizer being created. A
     #   tag is a key-value pair that adds as a metadata to a resource used
-    #   by Amazon Comprehend. For example, a tag with the key-value pair
-    #   ‘Department’:’Sales’ might be added to a resource to indicate its
-    #   use by a particular department.
+    #   by Amazon Comprehend. For example, a tag with "Sales" as the key
+    #   might be added to a resource to indicate its use by the sales
+    #   department.
     #   @return [Array<Types::Tag>]
     #
     # @!attribute [rw] input_data_config
@@ -1352,6 +1362,54 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # Provides output results configuration parameters for custom classifier
+    # jobs.
+    #
+    # @note When making an API call, you may pass DocumentClassifierOutputDataConfig
+    #   data as a hash:
+    #
+    #       {
+    #         s3_uri: "S3Uri",
+    #         kms_key_id: "KmsKeyId",
+    #       }
+    #
+    # @!attribute [rw] s3_uri
+    #   When you use the `OutputDataConfig` object while creating a custom
+    #   classifier, you specify the Amazon S3 location where you want to
+    #   write the confusion matrix. The URI must be in the same region as
+    #   the API endpoint that you are calling. The location is used as the
+    #   prefix for the actual location of this output file.
+    #
+    #   When the custom classifier job is finished, the service creates the
+    #   output file in a directory specific to the job. The `S3Uri` field
+    #   contains the location of the output file, called `output.tar.gz`. It
+    #   is a compressed archive that contains the confusion matrix.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon
+    #   Comprehend uses to encrypt the output results from an analysis job.
+    #   The KmsKeyId can be one of the following formats:
+    #
+    #   * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
+    #
+    #   * Amazon Resource Name (ARN) of a KMS Key:
+    #     `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
+    #
+    #   * KMS Key Alias: `"alias/ExampleAlias"`
+    #
+    #   * ARN of a KMS Key Alias:
+    #     `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"`
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierOutputDataConfig AWS API Documentation
+    #
+    class DocumentClassifierOutputDataConfig < Struct.new(
+      :s3_uri,
+      :kms_key_id)
+      include Aws::Structure
+    end
+
     # Provides information about a document classifier.
     #
     # @!attribute [rw] document_classifier_arn
@@ -1401,6 +1459,11 @@ module Aws::Comprehend
     #   document classifier for training.
     #   @return [Types::DocumentClassifierInputDataConfig]
     #
+    # @!attribute [rw] output_data_config
+    #   Provides output results configuration parameters for custom
+    #   classifier jobs.
+    #   @return [Types::DocumentClassifierOutputDataConfig]
+    #
     # @!attribute [rw] classifier_metadata
     #   Information about the document classifier, including the number of
     #   documents used for training the classifier, the number of documents
@@ -1437,6 +1500,7 @@ module Aws::Comprehend
       :training_start_time,
       :training_end_time,
       :input_data_config,
+      :output_data_config,
       :classifier_metadata,
       :data_access_role_arn,
       :volume_kms_key_id)
@@ -2695,9 +2759,9 @@ module Aws::Comprehend
     # @!attribute [rw] tags
     #   Tags associated with the Amazon Comprehend resource being queried. A
     #   tag is a key-value pair that adds as a metadata to a resource used
-    #   by Amazon Comprehend. For example, a tag with the key-value pair
-    #   ‘Department’:’Sales’ might be added to a resource to indicate its
-    #   use by a particular department.
+    #   by Amazon Comprehend. For example, a tag with "Sales" as the key
+    #   might be added to a resource to indicate its use by the sales
+    #   department.
     #   @return [Array<Types::Tag>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResourceResponse AWS API Documentation
@@ -3933,6 +3997,8 @@ module Aws::Comprehend
     #
     # @!attribute [rw] tags
     #   Tags being associated with a specific Amazon Comprehend resource.
+    #   There can be a maximum of 50 tags (both existing and pending)
+    #   associated with a specific resource.
     #   @return [Array<Types::Tag>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResourceRequest AWS API Documentation
@@ -4085,9 +4151,10 @@ module Aws::Comprehend
     #
     # @!attribute [rw] tag_keys
     #   The initial part of a key-value pair that forms a tag being removed
-    #   from a given resource. For instance, “Department” might be used as
-    #   the key portion of the pair, with multiple values such as “sales,”
-    #   “legal,” and “administration.”
+    #   from a given resource. For example, a tag with "Sales" as the key
+    #   might be added to a resource to indicate its use by the sales
+    #   department. Keys must be unique and cannot be duplicated for a
+    #   particular resource.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResourceRequest AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core