aws-sdk-comprehend 1.44.0 → 1.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ad3963c70493fd091a5c3019ba24ae72eec643a44ada58faf9cd9c60639595
-  data.tar.gz: ea890d4c8078e40db1b78fbf7cb19ebce593563925caba288424bbf9523524e1
+  metadata.gz: cfbda392422e7cfed95b782c72ce15b3f982b566eb5a193539875327e9adee8b
+  data.tar.gz: c45342a8abe385cdc7cc9b32674b981f32acf4b39fd4a29333b0890f6201dc24
 SHA512:
-  metadata.gz: d22df7d9dd5046979fc0a7136d98810419332d927995e3697ce7a5e1b2aa99570aa57b6b48c390c3fc505c48ab4b042b273a665372449dbc576373173f752514
-  data.tar.gz: e6e6b3dd25e4d5a6282828c4ef18c00fc84c0d370692a463213bcdfd2512f7b33893cfce61dc60bf5319d9296c4aecb65f644c3b7b3b938ff7a3823e6bba06a8
+  metadata.gz: f48a8cd17bbc874d4fb039294a48208f34b5d995d739c2fda21fc6e4797baa69766df506b2d401c2e1fb58b8e0b916d470edd90f26caa3584e6c012c0e8c2c8c
+  data.tar.gz: b8dfc5a55b13921f2b2bef2b58fcde1702e6e98b9c7b7246e627823b0f637284acbb8b7cde152a017be134aefa3c6814a712f24f7b03286c1c3ed8ad7646a4d0

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.48.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.47.0 (2021-07-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.46.0 (2021-03-31)
+------------------
+
+* Feature - Support for customer managed KMS encryption of Comprehend custom models
+
+1.45.0 (2021-03-11)
+------------------
+
+* Feature - ContainsPiiEntities API analyzes the input text for the presence of personally identifiable information(PII) and returns the labels of identified PII entity types such as name, address etc.
+
 1.44.0 (2021-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.44.0
+1.48.0

data/lib/aws-sdk-comprehend.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-comprehend/customizations'
 # @!group service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.44.0'
+  GEM_VERSION = '1.48.0'
 
 end

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

@@ -621,6 +621,44 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Analyzes input text for the presence of personally identifiable
+    # information (PII) and returns the labels of identified PII entity
+    # types such as name, address, bank account number, or phone number.
+    #
+    # @option params [required, String] :text
+    #   Creates a new document classification request to analyze a single
+    #   document in real-time, returning personally identifiable information
+    #   (PII) entity labels.
+    #
+    # @option params [required, String] :language_code
+    #   The language of the input documents.
+    #
+    # @return [Types::ContainsPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ContainsPiiEntitiesResponse#labels #labels} => Array<Types::EntityLabel>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.contains_pii_entities({
+    #     text: "String", # required
+    #     language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.labels #=> Array
+    #   resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
+    #   resp.labels[0].score #=> Float
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities AWS API Documentation
+    #
+    # @overload contains_pii_entities(params = {})
+    # @param [Hash] params ({})
+    def contains_pii_entities(params = {}, options = {})
+      req = build_request(:contains_pii_entities, params)
+      req.send_request(options)
+    end
+
     # Creates a new document classifier that you can use to categorize
     # documents. To create a classifier, you provide a set of training
     # documents that labeled with the categories that you want to use. After
@@ -690,6 +728,16 @@ module Aws::Comprehend
     #   multiple labels for an individual document are separated by a
     #   delimiter. The default delimiter between labels is a pipe (\|).
     #
+    # @option params [String] :model_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
+    #   uses to encrypt trained custom models. The ModelKmsKeyId can be either
+    #   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"`
+    #
     # @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
@@ -728,6 +776,7 @@ module Aws::Comprehend
     #       subnets: ["SubnetId"], # required
     #     },
     #     mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
+    #     model_kms_key_id: "KmsKeyId",
     #   })
     #
     # @example Response structure
@@ -773,6 +822,12 @@ module Aws::Comprehend
     #   "Sales" as the key might be added to an endpoint to indicate its use
     #   by the sales department.
     #
+    # @option params [String] :data_access_role_arn
+    #   The Amazon Resource Name (ARN) of the AWS identity and Access
+    #   Management (IAM) role that grants Amazon Comprehend read access to
+    #   trained custom models encrypted with a customer managed key
+    #   (ModelKmsKeyId).
+    #
     # @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
@@ -790,6 +845,7 @@ module Aws::Comprehend
     #         value: "TagValue",
     #       },
     #     ],
+    #     data_access_role_arn: "IamRoleArn",
     #   })
     #
     # @example Response structure
@@ -864,6 +920,16 @@ module Aws::Comprehend
     #
     #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #
+    # @option params [String] :model_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
+    #   uses to encrypt trained custom models. The ModelKmsKeyId can be either
+    #   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"`
+    #
     # @return [Types::CreateEntityRecognizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateEntityRecognizerResponse#entity_recognizer_arn #entity_recognizer_arn} => String
@@ -909,6 +975,7 @@ module Aws::Comprehend
     #       security_group_ids: ["SecurityGroupId"], # required
     #       subnets: ["SubnetId"], # required
     #     },
+    #     model_kms_key_id: "KmsKeyId",
     #   })
     #
     # @example Response structure
@@ -1110,6 +1177,7 @@ module Aws::Comprehend
     #   resp.document_classifier_properties.vpc_config.subnets #=> Array
     #   resp.document_classifier_properties.vpc_config.subnets[0] #=> String
     #   resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
+    #   resp.document_classifier_properties.model_kms_key_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
     #
@@ -1191,6 +1259,7 @@ module Aws::Comprehend
     #   resp.endpoint_properties.current_inference_units #=> Integer
     #   resp.endpoint_properties.creation_time #=> Time
     #   resp.endpoint_properties.last_modified_time #=> Time
+    #   resp.endpoint_properties.data_access_role_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
     #
@@ -1302,6 +1371,7 @@ module Aws::Comprehend
     #   resp.entity_recognizer_properties.vpc_config.security_group_ids[0] #=> String
     #   resp.entity_recognizer_properties.vpc_config.subnets #=> Array
     #   resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
+    #   resp.entity_recognizer_properties.model_kms_key_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
     #
@@ -1927,6 +1997,7 @@ module Aws::Comprehend
     #   resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
     #   resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
     #   resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
+    #   resp.document_classifier_properties_list[0].model_kms_key_id #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
@@ -2046,6 +2117,7 @@ module Aws::Comprehend
     #   resp.endpoint_properties_list[0].current_inference_units #=> Integer
     #   resp.endpoint_properties_list[0].creation_time #=> Time
     #   resp.endpoint_properties_list[0].last_modified_time #=> Time
+    #   resp.endpoint_properties_list[0].data_access_role_arn #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
@@ -2201,6 +2273,7 @@ module Aws::Comprehend
     #   resp.entity_recognizer_properties_list[0].vpc_config.security_group_ids[0] #=> String
     #   resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
     #   resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
+    #   resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
@@ -3680,7 +3753,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.44.0'
+      context[:gem_version] = '1.48.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -46,6 +46,8 @@ module Aws::Comprehend
     ComprehendEndpointName = Shapes::StringShape.new(name: 'ComprehendEndpointName')
     ComprehendModelArn = Shapes::StringShape.new(name: 'ComprehendModelArn')
     ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException')
+    ContainsPiiEntitiesRequest = Shapes::StructureShape.new(name: 'ContainsPiiEntitiesRequest')
+    ContainsPiiEntitiesResponse = Shapes::StructureShape.new(name: 'ContainsPiiEntitiesResponse')
     CreateDocumentClassifierRequest = Shapes::StructureShape.new(name: 'CreateDocumentClassifierRequest')
     CreateDocumentClassifierResponse = Shapes::StructureShape.new(name: 'CreateDocumentClassifierResponse')
     CreateEndpointRequest = Shapes::StructureShape.new(name: 'CreateEndpointRequest')
@@ -122,6 +124,7 @@ module Aws::Comprehend
     EntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'EntitiesDetectionJobProperties')
     EntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'EntitiesDetectionJobPropertiesList')
     Entity = Shapes::StructureShape.new(name: 'Entity')
+    EntityLabel = Shapes::StructureShape.new(name: 'EntityLabel')
     EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
     EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
     EntityRecognizerAugmentedManifestsList = Shapes::ListShape.new(name: 'EntityRecognizerAugmentedManifestsList')
@@ -191,6 +194,7 @@ module Aws::Comprehend
     ListOfDetectSyntaxResult = Shapes::ListShape.new(name: 'ListOfDetectSyntaxResult')
     ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
     ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
+    ListOfEntityLabels = Shapes::ListShape.new(name: 'ListOfEntityLabels')
     ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
     ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
     ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
@@ -395,6 +399,13 @@ module Aws::Comprehend
     ConcurrentModificationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     ConcurrentModificationException.struct_class = Types::ConcurrentModificationException
 
+    ContainsPiiEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
+    ContainsPiiEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
+    ContainsPiiEntitiesRequest.struct_class = Types::ContainsPiiEntitiesRequest
+
+    ContainsPiiEntitiesResponse.add_member(:labels, Shapes::ShapeRef.new(shape: ListOfEntityLabels, location_name: "Labels"))
+    ContainsPiiEntitiesResponse.struct_class = Types::ContainsPiiEntitiesResponse
+
     CreateDocumentClassifierRequest.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "DocumentClassifierName"))
     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"))
@@ -405,6 +416,7 @@ module Aws::Comprehend
     CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
     CreateDocumentClassifierRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
     CreateDocumentClassifierRequest.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
+    CreateDocumentClassifierRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
     CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
 
     CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
@@ -415,6 +427,7 @@ module Aws::Comprehend
     CreateEndpointRequest.add_member(:desired_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, required: true, location_name: "DesiredInferenceUnits"))
     CreateEndpointRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
     CreateEndpointRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+    CreateEndpointRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
     CreateEndpointRequest.struct_class = Types::CreateEndpointRequest
 
     CreateEndpointResponse.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: ComprehendEndpointArn, location_name: "EndpointArn"))
@@ -428,6 +441,7 @@ module Aws::Comprehend
     CreateEntityRecognizerRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
     CreateEntityRecognizerRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
     CreateEntityRecognizerRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
+    CreateEntityRecognizerRequest.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
     CreateEntityRecognizerRequest.struct_class = Types::CreateEntityRecognizerRequest
 
     CreateEntityRecognizerResponse.add_member(:entity_recognizer_arn, Shapes::ShapeRef.new(shape: EntityRecognizerArn, location_name: "EntityRecognizerArn"))
@@ -617,6 +631,7 @@ module Aws::Comprehend
     DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
     DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
     DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
+    DocumentClassifierProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
     DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
 
     DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
@@ -664,6 +679,7 @@ module Aws::Comprehend
     EndpointProperties.add_member(:current_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "CurrentInferenceUnits"))
     EndpointProperties.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
     EndpointProperties.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
+    EndpointProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
     EndpointProperties.struct_class = Types::EndpointProperties
 
     EndpointPropertiesList.member = Shapes::ShapeRef.new(shape: EndpointProperties)
@@ -698,6 +714,10 @@ module Aws::Comprehend
     Entity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
     Entity.struct_class = Types::Entity
 
+    EntityLabel.add_member(:name, Shapes::ShapeRef.new(shape: PiiEntityType, location_name: "Name"))
+    EntityLabel.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    EntityLabel.struct_class = Types::EntityLabel
+
     EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
     EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
 
@@ -753,6 +773,7 @@ module Aws::Comprehend
     EntityRecognizerProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
     EntityRecognizerProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
     EntityRecognizerProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
+    EntityRecognizerProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
     EntityRecognizerProperties.struct_class = Types::EntityRecognizerProperties
 
     EntityRecognizerPropertiesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerProperties)
@@ -923,6 +944,8 @@ module Aws::Comprehend
 
     ListOfEntities.member = Shapes::ShapeRef.new(shape: Entity)
 
+    ListOfEntityLabels.member = Shapes::ShapeRef.new(shape: EntityLabel)
+
     ListOfKeyPhrases.member = Shapes::ShapeRef.new(shape: KeyPhrase)
 
     ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
@@ -1390,6 +1413,18 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:contains_pii_entities, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ContainsPiiEntities"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ContainsPiiEntitiesRequest)
+        o.output = Shapes::ShapeRef.new(shape: ContainsPiiEntitiesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:create_document_classifier, Seahorse::Model::Operation.new.tap do |o|
         o.name = "CreateDocumentClassifier"
         o.http_method = "POST"

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

@@ -632,6 +632,46 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ContainsPiiEntitiesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         text: "String", # required
+    #         language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
+    #       }
+    #
+    # @!attribute [rw] text
+    #   Creates a new document classification request to analyze a single
+    #   document in real-time, returning personally identifiable information
+    #   (PII) entity labels.
+    #   @return [String]
+    #
+    # @!attribute [rw] language_code
+    #   The language of the input documents.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesRequest AWS API Documentation
+    #
+    class ContainsPiiEntitiesRequest < Struct.new(
+      :text,
+      :language_code)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] labels
+    #   The labels used in the document being analyzed. Individual labels
+    #   represent personally identifiable information (PII) entity types.
+    #   @return [Array<Types::EntityLabel>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesResponse AWS API Documentation
+    #
+    class ContainsPiiEntitiesResponse < Struct.new(
+      :labels)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateDocumentClassifierRequest
     #   data as a hash:
     #
@@ -667,6 +707,7 @@ module Aws::Comprehend
     #           subnets: ["SubnetId"], # required
     #         },
     #         mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
+    #         model_kms_key_id: "KmsKeyId",
     #       }
     #
     # @!attribute [rw] document_classifier_name
@@ -743,6 +784,17 @@ module Aws::Comprehend
     #   delimiter. The default delimiter between labels is a pipe (\|).
     #   @return [String]
     #
+    # @!attribute [rw] model_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon
+    #   Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
+    #   can be either 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"`
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
     #
     class CreateDocumentClassifierRequest < Struct.new(
@@ -755,7 +807,8 @@ module Aws::Comprehend
       :language_code,
       :volume_kms_key_id,
       :vpc_config,
-      :mode)
+      :mode,
+      :model_kms_key_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -787,6 +840,7 @@ module Aws::Comprehend
     #             value: "TagValue",
     #           },
     #         ],
+    #         data_access_role_arn: "IamRoleArn",
     #       }
     #
     # @!attribute [rw] endpoint_name
@@ -821,6 +875,13 @@ module Aws::Comprehend
     #   indicate its use by the sales department.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] data_access_role_arn
+    #   The Amazon Resource Name (ARN) of the AWS identity and Access
+    #   Management (IAM) role that grants Amazon Comprehend read access to
+    #   trained custom models encrypted with a customer managed key
+    #   (ModelKmsKeyId).
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
     #
     class CreateEndpointRequest < Struct.new(
@@ -828,7 +889,8 @@ module Aws::Comprehend
       :model_arn,
       :desired_inference_units,
       :client_request_token,
-      :tags)
+      :tags,
+      :data_access_role_arn)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -887,6 +949,7 @@ module Aws::Comprehend
     #           security_group_ids: ["SecurityGroupId"], # required
     #           subnets: ["SubnetId"], # required
     #         },
+    #         model_kms_key_id: "KmsKeyId",
     #       }
     #
     # @!attribute [rw] recognizer_name
@@ -953,6 +1016,17 @@ module Aws::Comprehend
     #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
+    # @!attribute [rw] model_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon
+    #   Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
+    #   can be either 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"`
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizerRequest AWS API Documentation
     #
     class CreateEntityRecognizerRequest < Struct.new(
@@ -963,7 +1037,8 @@ module Aws::Comprehend
       :client_request_token,
       :language_code,
       :volume_kms_key_id,
-      :vpc_config)
+      :vpc_config,
+      :model_kms_key_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2120,6 +2195,17 @@ module Aws::Comprehend
     #   mode and this cannot be changed once the classifier is trained.
     #   @return [String]
     #
+    # @!attribute [rw] model_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon
+    #   Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
+    #   can be either 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"`
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
     #
     class DocumentClassifierProperties < Struct.new(
@@ -2137,7 +2223,8 @@ module Aws::Comprehend
       :data_access_role_arn,
       :volume_kms_key_id,
       :vpc_config,
-      :mode)
+      :mode,
+      :model_kms_key_id)
       SENSITIVE = [:classifier_metadata]
       include Aws::Structure
     end
@@ -2407,6 +2494,13 @@ module Aws::Comprehend
     #   The date and time that the endpoint was last modified.
     #   @return [Time]
     #
+    # @!attribute [rw] data_access_role_arn
+    #   The Amazon Resource Name (ARN) of the AWS identity and Access
+    #   Management (IAM) role that grants Amazon Comprehend read access to
+    #   trained custom models encrypted with a customer managed key
+    #   (ModelKmsKeyId).
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
     #
     class EndpointProperties < Struct.new(
@@ -2417,7 +2511,8 @@ module Aws::Comprehend
       :desired_inference_units,
       :current_inference_units,
       :creation_time,
-      :last_modified_time)
+      :last_modified_time,
+      :data_access_role_arn)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2607,6 +2702,27 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # Specifies one of the label or labels that categorize the personally
+    # identifiable information (PII) entity being analyzed.
+    #
+    # @!attribute [rw] name
+    #   The name of the label.
+    #   @return [String]
+    #
+    # @!attribute [rw] score
+    #   The level of confidence that Amazon Comprehend has in the accuracy
+    #   of the detection.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityLabel AWS API Documentation
+    #
+    class EntityLabel < Struct.new(
+      :name,
+      :score)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Describes the annotations associated with a entity recognizer.
     #
     # @note When making an API call, you may pass EntityRecognizerAnnotations
@@ -2989,6 +3105,17 @@ module Aws::Comprehend
     #   [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
     #   @return [Types::VpcConfig]
     #
+    # @!attribute [rw] model_kms_key_id
+    #   ID for the AWS Key Management Service (KMS) key that Amazon
+    #   Comprehend uses to encrypt trained custom models. The ModelKmsKeyId
+    #   can be either 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"`
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
     #
     class EntityRecognizerProperties < Struct.new(
@@ -3004,7 +3131,8 @@ module Aws::Comprehend
       :recognizer_metadata,
       :data_access_role_arn,
       :volume_kms_key_id,
-      :vpc_config)
+      :vpc_config,
+      :model_kms_key_id)
       SENSITIVE = [:recognizer_metadata]
       include Aws::Structure
     end
@@ -6167,11 +6295,9 @@ module Aws::Comprehend
     end
 
     # Amazon Comprehend can't process the language of the input text. For
-    # all custom entity recognition APIs (such as `CreateEntityRecognizer`),
-    # only English, Spanish, French, Italian, German, or Portuguese are
-    # accepted. For most other APIs, such as those for Custom
-    # Classification, Amazon Comprehend accepts text in all supported
-    # languages. For a list of supported languages, see supported-languages.
+    # custom entity recognition APIs, only English, Spanish, French,
+    # Italian, German, or Portuguese are accepted. For a list of supported
+    # languages, see supported-languages.
     #
     # @!attribute [rw] message
     #   @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.44.0
+  version: 1.48.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-07-30 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.112.0
+        version: 3.119.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.112.0
+        version: 3.119.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-comprehend
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-comprehend/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-comprehend
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-comprehend/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Comprehend