aws-sdk-comprehend 1.35.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb730a09dbf7ca9369c83d4f70c0f3bae288115edcb23a231a4f63421d1ad86c
-  data.tar.gz: 8c0cab20548f4d18381be952684dba777b04df374fe7f710720bb69686d88ff7
+  metadata.gz: c616569ac151be94478678e8f509d8cc0a148201704f390a297716813aacdbb4
+  data.tar.gz: 04544c64f14ae2c12f441c69ddb498c328f6eb5d7bc9753daecc92870a8ef26c
 SHA512:
-  metadata.gz: 2d12d452da9db09af118395bc123ffe9c95f09b96c26b5ed8223a08d027ae9d1af0e2b385cd0b801b70e75f227eebcda3e03db5f415cb976ab509804e5945628
-  data.tar.gz: 4cb90bfa95e1d742892681f9516b17dd719740c1e9bd87e0d117b993ead936ee58b0f44a94d35b69d5a903332809681002fe81f04089e1def4c12e124588fc5d
+  metadata.gz: 1739c21b0c89d9ab9e466bd9a10beb11ed6cfb01f300361a02c00c0af927745c5e431443ec1c402a3db4308f97ac40ae303f8ad2fbd59cf1cd74f6a0d1d34c62
+  data.tar.gz: ac326f22ea88035afdb8345306e01d5bb828d095463a4761958b6b0bca8d697bf4faebee237eff8f0aa8a0036f62c15b335d1024bd21af2727e5f54b4b8ead56

data/lib/aws-sdk-comprehend.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-comprehend/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.35.0'
+  GEM_VERSION = '1.40.0'
 
 end

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

@@ -85,13 +85,28 @@ module Aws::Comprehend
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Comprehend
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -691,8 +706,15 @@ module Aws::Comprehend
     #       },
     #     ],
     #     input_data_config: { # required
-    #       s3_uri: "S3Uri", # required
+    #       data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
+    #       s3_uri: "S3Uri",
     #       label_delimiter: "LabelDelimiter",
+    #       augmented_manifests: [
+    #         {
+    #           s3_uri: "S3Uri", # required
+    #           attribute_names: ["AttributeNamesListItem"], # required
+    #         },
+    #       ],
     #     },
     #     output_data_config: {
     #       s3_uri: "S3Uri",
@@ -817,8 +839,10 @@ module Aws::Comprehend
     #   not need to pass this option.**
     #
     # @option params [required, String] :language_code
-    #   The language of the input documents. All documents must be in the same
-    #   language. Only English ("en") is currently supported.
+    #   You can specify any of the following languages supported by Amazon
+    #   Comprehend: English ("en"), Spanish ("es"), French ("fr"),
+    #   Italian ("it"), German ("de"), or Portuguese ("pt"). All
+    #   documents must be in the same language.
     #
     # @option params [String] :volume_kms_key_id
     #   ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
@@ -856,12 +880,13 @@ module Aws::Comprehend
     #       },
     #     ],
     #     input_data_config: { # required
+    #       data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
     #       entity_types: [ # required
     #         {
     #           type: "EntityTypeName", # required
     #         },
     #       ],
-    #       documents: { # required
+    #       documents: {
     #         s3_uri: "S3Uri", # required
     #       },
     #       annotations: {
@@ -870,6 +895,12 @@ module Aws::Comprehend
     #       entity_list: {
     #         s3_uri: "S3Uri", # required
     #       },
+    #       augmented_manifests: [
+    #         {
+    #           s3_uri: "S3Uri", # required
+    #           attribute_names: ["AttributeNamesListItem"], # required
+    #         },
+    #       ],
     #     },
     #     client_request_token: "ClientRequestTokenString",
     #     language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
@@ -1052,8 +1083,13 @@ module Aws::Comprehend
     #   resp.document_classifier_properties.end_time #=> Time
     #   resp.document_classifier_properties.training_start_time #=> Time
     #   resp.document_classifier_properties.training_end_time #=> Time
+    #   resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
     #   resp.document_classifier_properties.input_data_config.s3_uri #=> String
     #   resp.document_classifier_properties.input_data_config.label_delimiter #=> String
+    #   resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
+    #   resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
+    #   resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
+    #   resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
     #   resp.document_classifier_properties.output_data_config.s3_uri #=> String
     #   resp.document_classifier_properties.output_data_config.kms_key_id #=> String
     #   resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
@@ -1239,11 +1275,16 @@ module Aws::Comprehend
     #   resp.entity_recognizer_properties.end_time #=> Time
     #   resp.entity_recognizer_properties.training_start_time #=> Time
     #   resp.entity_recognizer_properties.training_end_time #=> Time
+    #   resp.entity_recognizer_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
     #   resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
     #   resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
     #   resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
     #   resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
     #   resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
+    #   resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
+    #   resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
+    #   resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
+    #   resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
     #   resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
     #   resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
     #   resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
@@ -1317,6 +1358,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.
     #
@@ -1540,6 +1627,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`).
     #
@@ -1734,8 +1859,13 @@ module Aws::Comprehend
     #   resp.document_classifier_properties_list[0].end_time #=> Time
     #   resp.document_classifier_properties_list[0].training_start_time #=> Time
     #   resp.document_classifier_properties_list[0].training_end_time #=> Time
+    #   resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
     #   resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
     #   resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
+    #   resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
+    #   resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
+    #   resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
+    #   resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
     #   resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
     #   resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
     #   resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
@@ -2003,11 +2133,16 @@ module Aws::Comprehend
     #   resp.entity_recognizer_properties_list[0].end_time #=> Time
     #   resp.entity_recognizer_properties_list[0].training_start_time #=> Time
     #   resp.entity_recognizer_properties_list[0].training_end_time #=> Time
+    #   resp.entity_recognizer_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
     #   resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
     #   resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
     #   resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
     #   resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
     #   resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
+    #   resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
+    #   resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
+    #   resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
+    #   resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
     #   resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
     #   resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
     #   resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
@@ -2101,6 +2236,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
@@ -2645,6 +2842,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.
     #
@@ -2962,6 +3240,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
@@ -3173,7 +3481,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.35.0'
+      context[:gem_version] = '1.40.0'
       Seahorse::Client::Request.new(handlers, context)
     end