aws-sdk-comprehend 1.38.0 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c7e76f78bdf9a28bcf93302716c251f7bf7c4b61a7c76e312fa98126ec95cbf
-  data.tar.gz: 1164f64a744b9398a0af4af721c0470b7a93c74ea6df3ad89dcef0f26c64ca07
+  metadata.gz: fb841e7f98bf2b40de5e3f385e3585ec64e29b61e921778971208d527886a5c9
+  data.tar.gz: 4e8687f7495e31d6c9a844ba6a29b1867cf91ecfba0b3bdd64be8e3fda8dfa88
 SHA512:
-  metadata.gz: 05023a037ac3827312ad84e5b8dd401b6ca643fe39d84496ca60b99ba837a21ea0f89d6b17bc4b8b3a0f5d9eb1742ec89299aff64c0f19029a811d6a2692f541
-  data.tar.gz: 69bc82b91d2720f3148756d14dc4089da98e08fc3d6555b4779344be9a4a15d0ad58f1570dd6193193c741c60f54d6789fb2d6323be96f1341f78f00aeb03f3b
+  metadata.gz: 24ee5c1f0fa7e826845c22538e65a110fc59a26b171a2fb47ca05ac5ddc050c09adae81ace2c086dca498f1a47cd6910cfd2630d221e8a8bd61ccaf57812060b
+  data.tar.gz: 0eccd1f090108d68ff3f208b0499112eea405e401966f6dff53174e29c71e1892cd530ce3bf9b0bcac977101a626e1f8dca1de1d0f04d909f67cc89640b50e19

data/lib/aws-sdk-comprehend.rb

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

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

@@ -1334,6 +1334,52 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Gets the properties associated with a PII entities detection job. For
+    # example, you can use this operation to get the job status.
+    #
+    # @option params [required, String] :job_id
+    #   The identifier that Amazon Comprehend generated for the job. The
+    #   operation returns this identifier in its response.
+    #
+    # @return [Types::DescribePiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribePiiEntitiesDetectionJobResponse#pii_entities_detection_job_properties #pii_entities_detection_job_properties} => Types::PiiEntitiesDetectionJobProperties
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_pii_entities_detection_job({
+    #     job_id: "JobId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.pii_entities_detection_job_properties.job_id #=> String
+    #   resp.pii_entities_detection_job_properties.job_name #=> String
+    #   resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
+    #   resp.pii_entities_detection_job_properties.message #=> String
+    #   resp.pii_entities_detection_job_properties.submit_time #=> Time
+    #   resp.pii_entities_detection_job_properties.end_time #=> Time
+    #   resp.pii_entities_detection_job_properties.input_data_config.s3_uri #=> String
+    #   resp.pii_entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
+    #   resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
+    #   resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
+    #   resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
+    #   resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> 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.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
+    #   resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
+    #   resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
+    #   resp.pii_entities_detection_job_properties.data_access_role_arn #=> String
+    #   resp.pii_entities_detection_job_properties.mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob AWS API Documentation
+    #
+    # @overload describe_pii_entities_detection_job(params = {})
+    # @param [Hash] params ({})
+    def describe_pii_entities_detection_job(params = {}, options = {})
+      req = build_request(:describe_pii_entities_detection_job, params)
+      req.send_request(options)
+    end
+
     # Gets the properties associated with a sentiment detection job. Use
     # this operation to get the status of a detection job.
     #
@@ -1557,6 +1603,44 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Inspects the input text for entities that contain personally
+    # identifiable information (PII) and returns information about them.
+    #
+    # @option params [required, String] :text
+    #   A UTF-8 text string. Each string must contain fewer that 5,000 bytes
+    #   of UTF-8 encoded characters.
+    #
+    # @option params [required, String] :language_code
+    #   The language of the input documents.
+    #
+    # @return [Types::DetectPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DetectPiiEntitiesResponse#entities #entities} => Array<Types::PiiEntity>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.detect_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.entities #=> Array
+    #   resp.entities[0].score #=> Float
+    #   resp.entities[0].type #=> 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.entities[0].begin_offset #=> Integer
+    #   resp.entities[0].end_offset #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities AWS API Documentation
+    #
+    # @overload detect_pii_entities(params = {})
+    # @param [Hash] params ({})
+    def detect_pii_entities(params = {}, options = {})
+      req = build_request(:detect_pii_entities, params)
+      req.send_request(options)
+    end
+
     # Inspects text and returns an inference of the prevailing sentiment
     # (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
     #
@@ -2118,6 +2202,68 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Gets a list of the PII entity detection jobs that you have submitted.
+    #
+    # @option params [Types::PiiEntitiesDetectionJobFilter] :filter
+    #   Filters the jobs that are returned. You can filter jobs on their name,
+    #   status, or the date and time that they were submitted. You can only
+    #   set one filter at a time.
+    #
+    # @option params [String] :next_token
+    #   Identifies the next page of results to return.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return in each page.
+    #
+    # @return [Types::ListPiiEntitiesDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListPiiEntitiesDetectionJobsResponse#pii_entities_detection_job_properties_list #pii_entities_detection_job_properties_list} => Array<Types::PiiEntitiesDetectionJobProperties>
+    #   * {Types::ListPiiEntitiesDetectionJobsResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_pii_entities_detection_jobs({
+    #     filter: {
+    #       job_name: "JobName",
+    #       job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
+    #       submit_time_before: Time.now,
+    #       submit_time_after: Time.now,
+    #     },
+    #     next_token: "String",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.pii_entities_detection_job_properties_list #=> Array
+    #   resp.pii_entities_detection_job_properties_list[0].job_id #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].job_name #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
+    #   resp.pii_entities_detection_job_properties_list[0].message #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].submit_time #=> Time
+    #   resp.pii_entities_detection_job_properties_list[0].end_time #=> Time
+    #   resp.pii_entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
+    #   resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
+    #   resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> 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.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
+    #   resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
+    #   resp.pii_entities_detection_job_properties_list[0].data_access_role_arn #=> String
+    #   resp.pii_entities_detection_job_properties_list[0].mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs AWS API Documentation
+    #
+    # @overload list_pii_entities_detection_jobs(params = {})
+    # @param [Hash] params ({})
+    def list_pii_entities_detection_jobs(params = {}, options = {})
+      req = build_request(:list_pii_entities_detection_jobs, params)
+      req.send_request(options)
+    end
+
     # Gets a list of sentiment detection jobs that you have submitted.
     #
     # @option params [Types::SentimentDetectionJobFilter] :filter
@@ -2662,6 +2808,87 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Starts an asynchronous PII entity detection job for a collection of
+    # documents.
+    #
+    # @option params [required, Types::InputDataConfig] :input_data_config
+    #   The input properties for a PII entities detection job.
+    #
+    # @option params [required, Types::OutputDataConfig] :output_data_config
+    #   Provides configuration parameters for the output of PII entity
+    #   detection jobs.
+    #
+    # @option params [required, String] :mode
+    #   Specifies whether the output provides the locations (offsets) of PII
+    #   entities or a file in which PII entities are redacted.
+    #
+    # @option params [Types::RedactionConfig] :redaction_config
+    #   Provides configuration parameters for PII entity redaction.
+    #
+    #   This parameter is required if you set the `Mode` parameter to
+    #   `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
+    #   definition that includes the `PiiEntityTypes` parameter.
+    #
+    # @option params [required, 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
+    #   your input data.
+    #
+    # @option params [String] :job_name
+    #   The identifier of the job.
+    #
+    # @option params [required, String] :language_code
+    #   The language of the input documents.
+    #
+    # @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.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::StartPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartPiiEntitiesDetectionJobResponse#job_id #job_id} => String
+    #   * {Types::StartPiiEntitiesDetectionJobResponse#job_status #job_status} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_pii_entities_detection_job({
+    #     input_data_config: { # required
+    #       s3_uri: "S3Uri", # required
+    #       input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
+    #     },
+    #     output_data_config: { # required
+    #       s3_uri: "S3Uri", # required
+    #       kms_key_id: "KmsKeyId",
+    #     },
+    #     mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
+    #     redaction_config: {
+    #       pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts 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
+    #       mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
+    #       mask_character: "MaskCharacter",
+    #     },
+    #     data_access_role_arn: "IamRoleArn", # required
+    #     job_name: "JobName",
+    #     language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
+    #     client_request_token: "ClientRequestTokenString",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_id #=> String
+    #   resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob AWS API Documentation
+    #
+    # @overload start_pii_entities_detection_job(params = {})
+    # @param [Hash] params ({})
+    def start_pii_entities_detection_job(params = {}, options = {})
+      req = build_request(:start_pii_entities_detection_job, params)
+      req.send_request(options)
+    end
+
     # Starts an asynchronous sentiment detection job for a collection of
     # documents. use the operation to track the status of a job.
     #
@@ -2979,6 +3206,36 @@ module Aws::Comprehend
       req.send_request(options)
     end
 
+    # Stops a PII entities detection job in progress.
+    #
+    # @option params [required, String] :job_id
+    #   The identifier of the PII entities detection job to stop.
+    #
+    # @return [Types::StopPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StopPiiEntitiesDetectionJobResponse#job_id #job_id} => String
+    #   * {Types::StopPiiEntitiesDetectionJobResponse#job_status #job_status} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_pii_entities_detection_job({
+    #     job_id: "JobId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_id #=> String
+    #   resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob AWS API Documentation
+    #
+    # @overload stop_pii_entities_detection_job(params = {})
+    # @param [Hash] params ({})
+    def stop_pii_entities_detection_job(params = {}, options = {})
+      req = build_request(:stop_pii_entities_detection_job, params)
+      req.send_request(options)
+    end
+
     # Stops a sentiment detection job in progress.
     #
     # If the job state is `IN_PROGRESS` the job is marked for termination
@@ -3190,7 +3447,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.38.0'
+      context[:gem_version] = '1.39.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -71,6 +71,8 @@ module Aws::Comprehend
     DescribeEntityRecognizerResponse = Shapes::StructureShape.new(name: 'DescribeEntityRecognizerResponse')
     DescribeKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobRequest')
     DescribeKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeKeyPhrasesDetectionJobResponse')
+    DescribePiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobRequest')
+    DescribePiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribePiiEntitiesDetectionJobResponse')
     DescribeSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobRequest')
     DescribeSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'DescribeSentimentDetectionJobResponse')
     DescribeTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'DescribeTopicsDetectionJobRequest')
@@ -81,6 +83,8 @@ module Aws::Comprehend
     DetectEntitiesResponse = Shapes::StructureShape.new(name: 'DetectEntitiesResponse')
     DetectKeyPhrasesRequest = Shapes::StructureShape.new(name: 'DetectKeyPhrasesRequest')
     DetectKeyPhrasesResponse = Shapes::StructureShape.new(name: 'DetectKeyPhrasesResponse')
+    DetectPiiEntitiesRequest = Shapes::StructureShape.new(name: 'DetectPiiEntitiesRequest')
+    DetectPiiEntitiesResponse = Shapes::StructureShape.new(name: 'DetectPiiEntitiesResponse')
     DetectSentimentRequest = Shapes::StructureShape.new(name: 'DetectSentimentRequest')
     DetectSentimentResponse = Shapes::StructureShape.new(name: 'DetectSentimentResponse')
     DetectSyntaxRequest = Shapes::StructureShape.new(name: 'DetectSyntaxRequest')
@@ -174,19 +178,33 @@ module Aws::Comprehend
     ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
     ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
     ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
+    ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
+    ListOfPiiEntityTypes = Shapes::ListShape.new(name: 'ListOfPiiEntityTypes')
     ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
+    ListPiiEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsRequest')
+    ListPiiEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsResponse')
     ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
     ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
     ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
     ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
     ListTopicsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsRequest')
     ListTopicsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsResponse')
+    MaskCharacter = Shapes::StringShape.new(name: 'MaskCharacter')
     MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
     ModelStatus = Shapes::StringShape.new(name: 'ModelStatus')
     NumberOfTopicsInteger = Shapes::IntegerShape.new(name: 'NumberOfTopicsInteger')
     OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
     PartOfSpeechTag = Shapes::StructureShape.new(name: 'PartOfSpeechTag')
     PartOfSpeechTagType = Shapes::StringShape.new(name: 'PartOfSpeechTagType')
+    PiiEntitiesDetectionJobFilter = Shapes::StructureShape.new(name: 'PiiEntitiesDetectionJobFilter')
+    PiiEntitiesDetectionJobProperties = Shapes::StructureShape.new(name: 'PiiEntitiesDetectionJobProperties')
+    PiiEntitiesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'PiiEntitiesDetectionJobPropertiesList')
+    PiiEntitiesDetectionMaskMode = Shapes::StringShape.new(name: 'PiiEntitiesDetectionMaskMode')
+    PiiEntitiesDetectionMode = Shapes::StringShape.new(name: 'PiiEntitiesDetectionMode')
+    PiiEntity = Shapes::StructureShape.new(name: 'PiiEntity')
+    PiiEntityType = Shapes::StringShape.new(name: 'PiiEntityType')
+    PiiOutputDataConfig = Shapes::StructureShape.new(name: 'PiiOutputDataConfig')
+    RedactionConfig = Shapes::StructureShape.new(name: 'RedactionConfig')
     ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
     ResourceLimitExceededException = Shapes::StructureShape.new(name: 'ResourceLimitExceededException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
@@ -207,6 +225,8 @@ module Aws::Comprehend
     StartEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartEntitiesDetectionJobResponse')
     StartKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobRequest')
     StartKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartKeyPhrasesDetectionJobResponse')
+    StartPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobRequest')
+    StartPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StartPiiEntitiesDetectionJobResponse')
     StartSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobRequest')
     StartSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StartSentimentDetectionJobResponse')
     StartTopicsDetectionJobRequest = Shapes::StructureShape.new(name: 'StartTopicsDetectionJobRequest')
@@ -217,6 +237,8 @@ module Aws::Comprehend
     StopEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopEntitiesDetectionJobResponse')
     StopKeyPhrasesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobRequest')
     StopKeyPhrasesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopKeyPhrasesDetectionJobResponse')
+    StopPiiEntitiesDetectionJobRequest = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobRequest')
+    StopPiiEntitiesDetectionJobResponse = Shapes::StructureShape.new(name: 'StopPiiEntitiesDetectionJobResponse')
     StopSentimentDetectionJobRequest = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobRequest')
     StopSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobResponse')
     StopTrainingDocumentClassifierRequest = Shapes::StructureShape.new(name: 'StopTrainingDocumentClassifierRequest')
@@ -444,6 +466,12 @@ module Aws::Comprehend
     DescribeKeyPhrasesDetectionJobResponse.add_member(:key_phrases_detection_job_properties, Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobProperties, location_name: "KeyPhrasesDetectionJobProperties"))
     DescribeKeyPhrasesDetectionJobResponse.struct_class = Types::DescribeKeyPhrasesDetectionJobResponse
 
+    DescribePiiEntitiesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
+    DescribePiiEntitiesDetectionJobRequest.struct_class = Types::DescribePiiEntitiesDetectionJobRequest
+
+    DescribePiiEntitiesDetectionJobResponse.add_member(:pii_entities_detection_job_properties, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobProperties, location_name: "PiiEntitiesDetectionJobProperties"))
+    DescribePiiEntitiesDetectionJobResponse.struct_class = Types::DescribePiiEntitiesDetectionJobResponse
+
     DescribeSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
     DescribeSentimentDetectionJobRequest.struct_class = Types::DescribeSentimentDetectionJobRequest
 
@@ -477,6 +505,13 @@ module Aws::Comprehend
     DetectKeyPhrasesResponse.add_member(:key_phrases, Shapes::ShapeRef.new(shape: ListOfKeyPhrases, location_name: "KeyPhrases"))
     DetectKeyPhrasesResponse.struct_class = Types::DetectKeyPhrasesResponse
 
+    DetectPiiEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
+    DetectPiiEntitiesRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
+    DetectPiiEntitiesRequest.struct_class = Types::DetectPiiEntitiesRequest
+
+    DetectPiiEntitiesResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfPiiEntities, location_name: "Entities"))
+    DetectPiiEntitiesResponse.struct_class = Types::DetectPiiEntitiesResponse
+
     DetectSentimentRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
     DetectSentimentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
     DetectSentimentRequest.struct_class = Types::DetectSentimentRequest
@@ -822,8 +857,21 @@ module Aws::Comprehend
 
     ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
 
+    ListOfPiiEntities.member = Shapes::ShapeRef.new(shape: PiiEntity)
+
+    ListOfPiiEntityTypes.member = Shapes::ShapeRef.new(shape: PiiEntityType)
+
     ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
 
+    ListPiiEntitiesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobFilter, location_name: "Filter"))
+    ListPiiEntitiesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
+    ListPiiEntitiesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
+    ListPiiEntitiesDetectionJobsRequest.struct_class = Types::ListPiiEntitiesDetectionJobsRequest
+
+    ListPiiEntitiesDetectionJobsResponse.add_member(:pii_entities_detection_job_properties_list, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobPropertiesList, location_name: "PiiEntitiesDetectionJobPropertiesList"))
+    ListPiiEntitiesDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
+    ListPiiEntitiesDetectionJobsResponse.struct_class = Types::ListPiiEntitiesDetectionJobsResponse
+
     ListSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: SentimentDetectionJobFilter, location_name: "Filter"))
     ListSentimentDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
     ListSentimentDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
@@ -857,6 +905,43 @@ module Aws::Comprehend
     PartOfSpeechTag.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
     PartOfSpeechTag.struct_class = Types::PartOfSpeechTag
 
+    PiiEntitiesDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
+    PiiEntitiesDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
+    PiiEntitiesDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
+    PiiEntitiesDetectionJobFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
+    PiiEntitiesDetectionJobFilter.struct_class = Types::PiiEntitiesDetectionJobFilter
+
+    PiiEntitiesDetectionJobProperties.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
+    PiiEntitiesDetectionJobProperties.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
+    PiiEntitiesDetectionJobProperties.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
+    PiiEntitiesDetectionJobProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
+    PiiEntitiesDetectionJobProperties.add_member(:submit_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTime"))
+    PiiEntitiesDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
+    PiiEntitiesDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
+    PiiEntitiesDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: PiiOutputDataConfig, location_name: "OutputDataConfig"))
+    PiiEntitiesDetectionJobProperties.add_member(:redaction_config, Shapes::ShapeRef.new(shape: RedactionConfig, location_name: "RedactionConfig"))
+    PiiEntitiesDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
+    PiiEntitiesDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
+    PiiEntitiesDetectionJobProperties.add_member(:mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMode, location_name: "Mode"))
+    PiiEntitiesDetectionJobProperties.struct_class = Types::PiiEntitiesDetectionJobProperties
+
+    PiiEntitiesDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobProperties)
+
+    PiiEntity.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    PiiEntity.add_member(:type, Shapes::ShapeRef.new(shape: PiiEntityType, location_name: "Type"))
+    PiiEntity.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
+    PiiEntity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
+    PiiEntity.struct_class = Types::PiiEntity
+
+    PiiOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
+    PiiOutputDataConfig.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
+    PiiOutputDataConfig.struct_class = Types::PiiOutputDataConfig
+
+    RedactionConfig.add_member(:pii_entity_types, Shapes::ShapeRef.new(shape: ListOfPiiEntityTypes, location_name: "PiiEntityTypes"))
+    RedactionConfig.add_member(:mask_mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMaskMode, location_name: "MaskMode"))
+    RedactionConfig.add_member(:mask_character, Shapes::ShapeRef.new(shape: MaskCharacter, location_name: "MaskCharacter"))
+    RedactionConfig.struct_class = Types::RedactionConfig
+
     ResourceInUseException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     ResourceInUseException.struct_class = Types::ResourceInUseException
 
@@ -955,6 +1040,20 @@ module Aws::Comprehend
     StartKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
     StartKeyPhrasesDetectionJobResponse.struct_class = Types::StartKeyPhrasesDetectionJobResponse
 
+    StartPiiEntitiesDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:mode, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionMode, required: true, location_name: "Mode"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:redaction_config, Shapes::ShapeRef.new(shape: RedactionConfig, location_name: "RedactionConfig"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
+    StartPiiEntitiesDetectionJobRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestTokenString, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
+    StartPiiEntitiesDetectionJobRequest.struct_class = Types::StartPiiEntitiesDetectionJobRequest
+
+    StartPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
+    StartPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
+    StartPiiEntitiesDetectionJobResponse.struct_class = Types::StartPiiEntitiesDetectionJobResponse
+
     StartSentimentDetectionJobRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
     StartSentimentDetectionJobRequest.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, required: true, location_name: "OutputDataConfig"))
     StartSentimentDetectionJobRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
@@ -1004,6 +1103,13 @@ module Aws::Comprehend
     StopKeyPhrasesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
     StopKeyPhrasesDetectionJobResponse.struct_class = Types::StopKeyPhrasesDetectionJobResponse
 
+    StopPiiEntitiesDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
+    StopPiiEntitiesDetectionJobRequest.struct_class = Types::StopPiiEntitiesDetectionJobRequest
+
+    StopPiiEntitiesDetectionJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
+    StopPiiEntitiesDetectionJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
+    StopPiiEntitiesDetectionJobResponse.struct_class = Types::StopPiiEntitiesDetectionJobResponse
+
     StopSentimentDetectionJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
     StopSentimentDetectionJobRequest.struct_class = Types::StopSentimentDetectionJobRequest
 
@@ -1365,6 +1471,18 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:describe_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribePiiEntitiesDetectionJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DescribePiiEntitiesDetectionJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribePiiEntitiesDetectionJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:describe_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeSentimentDetectionJob"
         o.http_method = "POST"
@@ -1425,6 +1543,18 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:detect_pii_entities, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DetectPiiEntities"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DetectPiiEntitiesRequest)
+        o.output = Shapes::ShapeRef.new(shape: DetectPiiEntitiesResponse)
+        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(:detect_sentiment, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DetectSentiment"
         o.http_method = "POST"
@@ -1568,6 +1698,18 @@ module Aws::Comprehend
         )
       end)
 
+      api.add_operation(:list_pii_entities_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListPiiEntitiesDetectionJobs"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListPiiEntitiesDetectionJobsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListPiiEntitiesDetectionJobsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidFilterException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:list_sentiment_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListSentimentDetectionJobs"
         o.http_method = "POST"
@@ -1667,6 +1809,18 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:start_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartPiiEntitiesDetectionJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StartPiiEntitiesDetectionJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartPiiEntitiesDetectionJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: KmsKeyValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:start_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StartSentimentDetectionJob"
         o.http_method = "POST"
@@ -1724,6 +1878,17 @@ module Aws::Comprehend
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:stop_pii_entities_detection_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StopPiiEntitiesDetectionJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StopPiiEntitiesDetectionJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: StopPiiEntitiesDetectionJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: JobNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:stop_sentiment_detection_job, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StopSentimentDetectionJob"
         o.http_method = "POST"

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

@@ -1225,6 +1225,38 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DescribePiiEntitiesDetectionJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The identifier that Amazon Comprehend generated for the job. The
+    #   operation returns this identifier in its response.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobRequest AWS API Documentation
+    #
+    class DescribePiiEntitiesDetectionJobRequest < Struct.new(
+      :job_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] pii_entities_detection_job_properties
+    #   Provides information about a PII entities detection job.
+    #   @return [Types::PiiEntitiesDetectionJobProperties]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobResponse AWS API Documentation
+    #
+    class DescribePiiEntitiesDetectionJobResponse < Struct.new(
+      :pii_entities_detection_job_properties)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DescribeSentimentDetectionJobRequest
     #   data as a hash:
     #
@@ -1440,6 +1472,47 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DetectPiiEntitiesRequest
+    #   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
+    #   A UTF-8 text string. Each string must contain fewer that 5,000 bytes
+    #   of UTF-8 encoded characters.
+    #   @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/DetectPiiEntitiesRequest AWS API Documentation
+    #
+    class DetectPiiEntitiesRequest < Struct.new(
+      :text,
+      :language_code)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] entities
+    #   A collection of PII entities identified in the input text. For each
+    #   entity, the response provides the entity type, where the entity text
+    #   begins and ends, and the level of confidence that Amazon Comprehend
+    #   has in the detection.
+    #   @return [Array<Types::PiiEntity>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesResponse AWS API Documentation
+    #
+    class DetectPiiEntitiesResponse < Struct.new(
+      :entities)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DetectSentimentRequest
     #   data as a hash:
     #
@@ -3481,6 +3554,61 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListPiiEntitiesDetectionJobsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         filter: {
+    #           job_name: "JobName",
+    #           job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
+    #           submit_time_before: Time.now,
+    #           submit_time_after: Time.now,
+    #         },
+    #         next_token: "String",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] filter
+    #   Filters the jobs that are returned. You can filter jobs on their
+    #   name, status, or the date and time that they were submitted. You can
+    #   only set one filter at a time.
+    #   @return [Types::PiiEntitiesDetectionJobFilter]
+    #
+    # @!attribute [rw] next_token
+    #   Identifies the next page of results to return.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in each page.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsRequest AWS API Documentation
+    #
+    class ListPiiEntitiesDetectionJobsRequest < Struct.new(
+      :filter,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] pii_entities_detection_job_properties_list
+    #   A list containing the properties of each job that is returned.
+    #   @return [Array<Types::PiiEntitiesDetectionJobProperties>]
+    #
+    # @!attribute [rw] next_token
+    #   Identifies the next page of results to return.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsResponse AWS API Documentation
+    #
+    class ListPiiEntitiesDetectionJobsResponse < Struct.new(
+      :pii_entities_detection_job_properties_list,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListSentimentDetectionJobsRequest
     #   data as a hash:
     #
@@ -3707,6 +3835,228 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # Provides information for filtering a list of PII entity detection
+    # jobs.
+    #
+    # @note When making an API call, you may pass PiiEntitiesDetectionJobFilter
+    #   data as a hash:
+    #
+    #       {
+    #         job_name: "JobName",
+    #         job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
+    #         submit_time_before: Time.now,
+    #         submit_time_after: Time.now,
+    #       }
+    #
+    # @!attribute [rw] job_name
+    #   Filters on the name of the job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   Filters the list of jobs based on job status. Returns only jobs with
+    #   the specified status.
+    #   @return [String]
+    #
+    # @!attribute [rw] submit_time_before
+    #   Filters the list of jobs based on the time that the job was
+    #   submitted for processing. Returns only jobs submitted before the
+    #   specified time. Jobs are returned in ascending order, oldest to
+    #   newest.
+    #   @return [Time]
+    #
+    # @!attribute [rw] submit_time_after
+    #   Filters the list of jobs based on the time that the job was
+    #   submitted for processing. Returns only jobs submitted after the
+    #   specified time. Jobs are returned in descending order, newest to
+    #   oldest.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobFilter AWS API Documentation
+    #
+    class PiiEntitiesDetectionJobFilter < Struct.new(
+      :job_name,
+      :job_status,
+      :submit_time_before,
+      :submit_time_after)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides information about a PII entities detection job.
+    #
+    # @!attribute [rw] job_id
+    #   The identifier assigned to the PII entities detection job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The name that you assigned the PII entities detection job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   The current status of the PII entities detection job. If the status
+    #   is `FAILED`, the `Message` field shows the reason for the failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   A description of the status of a job.
+    #   @return [String]
+    #
+    # @!attribute [rw] submit_time
+    #   The time that the PII entities detection job was submitted for
+    #   processing.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_time
+    #   The time that the PII entities detection job completed.
+    #   @return [Time]
+    #
+    # @!attribute [rw] input_data_config
+    #   The input properties for a PII entities detection job.
+    #   @return [Types::InputDataConfig]
+    #
+    # @!attribute [rw] output_data_config
+    #   The output data configuration that you supplied when you created the
+    #   PII entities detection job.
+    #   @return [Types::PiiOutputDataConfig]
+    #
+    # @!attribute [rw] redaction_config
+    #   Provides configuration parameters for PII entity redaction.
+    #
+    #   This parameter is required if you set the `Mode` parameter to
+    #   `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
+    #   definition that includes the `PiiEntityTypes` parameter.
+    #   @return [Types::RedactionConfig]
+    #
+    # @!attribute [rw] language_code
+    #   The language code of the input documents
+    #   @return [String]
+    #
+    # @!attribute [rw] data_access_role_arn
+    #   The Amazon Resource Name (ARN) that gives Amazon Comprehend read
+    #   access to your input data.
+    #   @return [String]
+    #
+    # @!attribute [rw] mode
+    #   Specifies whether the output provides the locations (offsets) of PII
+    #   entities or a file in which PII entities are redacted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobProperties AWS API Documentation
+    #
+    class PiiEntitiesDetectionJobProperties < Struct.new(
+      :job_id,
+      :job_name,
+      :job_status,
+      :message,
+      :submit_time,
+      :end_time,
+      :input_data_config,
+      :output_data_config,
+      :redaction_config,
+      :language_code,
+      :data_access_role_arn,
+      :mode)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides information about a PII entity.
+    #
+    # @!attribute [rw] score
+    #   The level of confidence that Amazon Comprehend has in the accuracy
+    #   of the detection.
+    #   @return [Float]
+    #
+    # @!attribute [rw] type
+    #   The entity's type.
+    #   @return [String]
+    #
+    # @!attribute [rw] begin_offset
+    #   A character offset in the input text that shows where the PII entity
+    #   begins (the first character is at position 0). The offset returns
+    #   the position of each UTF-8 code point in the string. A *code point*
+    #   is the abstract character from a particular graphical
+    #   representation. For example, a multi-byte UTF-8 character maps to a
+    #   single code point.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_offset
+    #   A character offset in the input text that shows where the PII entity
+    #   ends. The offset returns the position of each UTF-8 code point in
+    #   the string. A *code point* is the abstract character from a
+    #   particular graphical representation. For example, a multi-byte UTF-8
+    #   character maps to a single code point.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntity AWS API Documentation
+    #
+    class PiiEntity < Struct.new(
+      :score,
+      :type,
+      :begin_offset,
+      :end_offset)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides configuration parameters for the output of PII entity
+    # detection jobs.
+    #
+    # @!attribute [rw] s3_uri
+    #   When you use the `PiiOutputDataConfig` object with asynchronous
+    #   operations, you specify the Amazon S3 location where you want to
+    #   write the output data.
+    #   @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.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
+    #
+    class PiiOutputDataConfig < Struct.new(
+      :s3_uri,
+      :kms_key_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides configuration parameters for PII entity redaction.
+    #
+    # @note When making an API call, you may pass RedactionConfig
+    #   data as a hash:
+    #
+    #       {
+    #         pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts 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
+    #         mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
+    #         mask_character: "MaskCharacter",
+    #       }
+    #
+    # @!attribute [rw] pii_entity_types
+    #   An array of the types of PII entities that Amazon Comprehend detects
+    #   in the input text for your request.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] mask_mode
+    #   Specifies whether the PII entity is redacted with the mask character
+    #   or the entity type.
+    #   @return [String]
+    #
+    # @!attribute [rw] mask_character
+    #   A character that replaces each character in the redacted PII entity.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/RedactionConfig AWS API Documentation
+    #
+    class RedactionConfig < Struct.new(
+      :pii_entity_types,
+      :mask_mode,
+      :mask_character)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The specified resource name is already in use. Use a different name
     # and try your request again.
     #
@@ -4440,6 +4790,106 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StartPiiEntitiesDetectionJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         input_data_config: { # required
+    #           s3_uri: "S3Uri", # required
+    #           input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
+    #         },
+    #         output_data_config: { # required
+    #           s3_uri: "S3Uri", # required
+    #           kms_key_id: "KmsKeyId",
+    #         },
+    #         mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
+    #         redaction_config: {
+    #           pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts 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
+    #           mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
+    #           mask_character: "MaskCharacter",
+    #         },
+    #         data_access_role_arn: "IamRoleArn", # required
+    #         job_name: "JobName",
+    #         language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
+    #         client_request_token: "ClientRequestTokenString",
+    #       }
+    #
+    # @!attribute [rw] input_data_config
+    #   The input properties for a PII entities detection job.
+    #   @return [Types::InputDataConfig]
+    #
+    # @!attribute [rw] output_data_config
+    #   Provides configuration parameters for the output of PII entity
+    #   detection jobs.
+    #   @return [Types::OutputDataConfig]
+    #
+    # @!attribute [rw] mode
+    #   Specifies whether the output provides the locations (offsets) of PII
+    #   entities or a file in which PII entities are redacted.
+    #   @return [String]
+    #
+    # @!attribute [rw] redaction_config
+    #   Provides configuration parameters for PII entity redaction.
+    #
+    #   This parameter is required if you set the `Mode` parameter to
+    #   `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
+    #   definition that includes the `PiiEntityTypes` parameter.
+    #   @return [Types::RedactionConfig]
+    #
+    # @!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
+    #   your input data.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_name
+    #   The identifier of the job.
+    #   @return [String]
+    #
+    # @!attribute [rw] language_code
+    #   The language of the input documents.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_request_token
+    #   A unique identifier for the request. If you don't set the client
+    #   request token, Amazon Comprehend generates one.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
+    #
+    class StartPiiEntitiesDetectionJobRequest < Struct.new(
+      :input_data_config,
+      :output_data_config,
+      :mode,
+      :redaction_config,
+      :data_access_role_arn,
+      :job_name,
+      :language_code,
+      :client_request_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_id
+    #   The identifier generated for the job.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   The status of the job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobResponse AWS API Documentation
+    #
+    class StartPiiEntitiesDetectionJobResponse < Struct.new(
+      :job_id,
+      :job_status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StartSentimentDetectionJobRequest
     #   data as a hash:
     #
@@ -4807,6 +5257,42 @@ module Aws::Comprehend
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass StopPiiEntitiesDetectionJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The identifier of the PII entities detection job to stop.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobRequest AWS API Documentation
+    #
+    class StopPiiEntitiesDetectionJobRequest < Struct.new(
+      :job_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_id
+    #   The identifier of the PII entities detection job to stop.
+    #   @return [String]
+    #
+    # @!attribute [rw] job_status
+    #   The status of the PII entities detection job.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobResponse AWS API Documentation
+    #
+    class StopPiiEntitiesDetectionJobResponse < Struct.new(
+      :job_id,
+      :job_status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StopSentimentDetectionJobRequest
     #   data as a hash:
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-comprehend
 version: !ruby/object:Gem::Version
-  version: 1.38.0
+  version: 1.39.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core