You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::StartPiiEntitiesDetectionJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartPiiEntitiesDetectionJobRequest as input to an Aws::Client method, you can use a vanilla 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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

A unique identifier for the request. If you don\'t set the client request token, Amazon Comprehend generates one.

Returns:

  • (String) —

    A unique identifier for the request.

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

#input_data_config ⇒ Types::InputDataConfig

The input properties for a PII entities detection job.

Returns:

#job_name ⇒ String

The identifier of the job.

Returns:

  • (String) —

    The identifier of the job.

#language_code ⇒ String

The language of the input documents.

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

Returns:

  • (String) —

    The language of the input documents.

#mode ⇒ String

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

Possible values:

  • ONLY_REDACTION
  • ONLY_OFFSETS

Returns:

  • (String) —

    Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

#output_data_config ⇒ Types::OutputDataConfig

Provides configuration parameters for the output of PII entity detection jobs.

Returns:

#redaction_config ⇒ Types::RedactionConfig

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.

Returns: