start_pii_entities_detection_job ¶

def start_pii_entities_detection_job(
    self,
    input_data_config: "capo_comprehend.types.input_data_config.InputDataConfig",
    output_data_config: "capo_comprehend.types.output_data_config.OutputDataConfig",
    mode: "capo_comprehend.types.pii_entities_detection_mode.PiiEntitiesDetectionMode",
    data_access_role_arn: "capo_comprehend.types.iam_role_arn.IamRoleArn",
    language_code: "capo_comprehend.types.language_code.LanguageCode",
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
    redaction_config: Optional[
        "capo_comprehend.types.redaction_config.RedactionConfig"
    ] = None,
    job_name: Optional["capo_comprehend.types.job_name.JobName"] = None,
    client_request_token: Optional[
        "capo_comprehend.types.client_request_token_string.ClientRequestTokenString"
    ] = None,
    tags: Optional["capo_comprehend.types.tag_list.TagList"] = None,
) -> "capo_comprehend.types.start_pii_entities_detection_job_response.StartPiiEntitiesDetectionJobResponse":
    """<p>Starts an asynchronous PII entity detection job for a collection of documents.</p>

    Args:
        input_data_config: <p>The input properties for a PII entities detection job.</p>
        output_data_config: <p>Provides configuration parameters for the output of PII entity detection jobs.</p>
        mode: <p>Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.</p>
        redaction_config: <p>Provides configuration parameters for PII entity redaction.</p> <p>This parameter is required if you set the <code>Mode</code> parameter to <code>ONLY_REDACTION</code>. In that case, you must provide a <code>RedactionConfig</code> definition that includes the <code>PiiEntityTypes</code> parameter.</p>
        data_access_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.</p>
        job_name: <p>The identifier of the job.</p>
        language_code: <p>The language of the input documents. Enter the language code for English (en) or Spanish (es).</p>
        client_request_token: <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>
        tags: <p>Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.</p>

    Raises:
        capo_comprehend.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_comprehend.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</p>
        capo_comprehend.errors.kms_key_validation_exception.KmsKeyValidationException: <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.</p>
        capo_comprehend.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource name is already in use. Use a different name and try your request again.</p>
        capo_comprehend.errors.too_many_requests_exception.TooManyRequestsException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_comprehend.errors.too_many_tags_exception.TooManyTagsException: <p>The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. </p>
        capo_comprehend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_comprehend.types.start_pii_entities_detection_job_request.StartPiiEntitiesDetectionJobRequest]",
    ) -> OperationResponse[
        "capo_comprehend.types.start_pii_entities_detection_job_response.StartPiiEntitiesDetectionJobResponse"
    ]:
        import capo_comprehend._operations.comprehend_20171127.start_pii_entities_detection_job

        output, http_response = (
            capo_comprehend._operations.comprehend_20171127.start_pii_entities_detection_job.start_pii_entities_detection_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartPiiEntitiesDetectionJob")
    )
    input_: capo_comprehend.types.start_pii_entities_detection_job_request.StartPiiEntitiesDetectionJobRequest = {
        "input_data_config": input_data_config,
        "output_data_config": output_data_config,
        "mode": mode,
        "data_access_role_arn": data_access_role_arn,
        "language_code": language_code,
    }
    if redaction_config is not None:
        input_["redaction_config"] = redaction_config
    if job_name is not None:
        input_["job_name"] = job_name
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output