aws-sdk-comprehend 1.44.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ad3963c70493fd091a5c3019ba24ae72eec643a44ada58faf9cd9c60639595
-  data.tar.gz: ea890d4c8078e40db1b78fbf7cb19ebce593563925caba288424bbf9523524e1
+  metadata.gz: eaba32a4f57dbbceb28c4971772a0ffe6da0e7e792848ef4765dffea16f68a58
+  data.tar.gz: bdde5db48550908bc508e6ba526470d51b7e56cf0d577df0e794b6c40c86608b
 SHA512:
-  metadata.gz: d22df7d9dd5046979fc0a7136d98810419332d927995e3697ce7a5e1b2aa99570aa57b6b48c390c3fc505c48ab4b042b273a665372449dbc576373173f752514
-  data.tar.gz: e6e6b3dd25e4d5a6282828c4ef18c00fc84c0d370692a463213bcdfd2512f7b33893cfce61dc60bf5319d9296c4aecb65f644c3b7b3b938ff7a3823e6bba06a8
+  metadata.gz: 0fed0eb3f1ff17711c848c1bd89f3a91b703810be3c15d81d55dfbf341481db708b9a212aa8e693da0204b7d5b5591ab8cf14ca7a096c53d277ac0c33ea9a54b
+  data.tar.gz: 53cbb816eed784b16b24e146e0178e35263886823800ff5b63db05d12ddea7f7094f2a9899644a105f5b083f5f4afc19000ce9094224f6eb571c5ba6f8e724bb

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+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.45.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.45.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
@@ -3680,7 +3718,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.44.0'
+      context[:gem_version] = '1.45.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"))
@@ -698,6 +709,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
 
@@ -923,6 +938,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 +1407,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:
     #
@@ -2607,6 +2647,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
@@ -6167,11 +6228,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.45.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core