NAME

Paws::Comprehend::StartPiiEntitiesDetectionJob - Arguments for method StartPiiEntitiesDetectionJob on Paws::Comprehend

DESCRIPTION

This class represents the parameters used for calling the method StartPiiEntitiesDetectionJob on the Amazon Comprehend service. Use the attributes of this class as arguments to method StartPiiEntitiesDetectionJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartPiiEntitiesDetectionJob.

SYNOPSIS

    my $comprehend = Paws->service('Comprehend');
    my $StartPiiEntitiesDetectionJobResponse =
      $comprehend->StartPiiEntitiesDetectionJob(
      DataAccessRoleArn => 'MyIamRoleArn',
      InputDataConfig   => {
        S3Uri       => 'MyS3Uri',           # max: 1024
        InputFormat => 'ONE_DOC_PER_FILE'
        ,    # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL
      },
      LanguageCode     => 'en',
      Mode             => 'ONLY_REDACTION',
      OutputDataConfig => {
        S3Uri    => 'MyS3Uri',       # max: 1024
        KmsKeyId => 'MyKmsKeyId',    # max: 2048; OPTIONAL
      },
      ClientRequestToken => 'MyClientRequestTokenString',    # OPTIONAL
      JobName            => 'MyJobName',                     # OPTIONAL
      RedactionConfig    => {
        MaskCharacter => 'MyMaskCharacter',    # min: 1, max: 1; OPTIONAL
        MaskMode      =>
          'MASK',    # values: MASK, REPLACE_WITH_PII_ENTITY_TYPE; OPTIONAL
        PiiEntityTypes => [
          'BANK_ACCOUNT_NUMBER',
          ... # values: 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
        ],    # OPTIONAL
      },    # OPTIONAL
      );
    # Results:
    my $JobId     = $StartPiiEntitiesDetectionJobResponse->JobId;
    my $JobStatus = $StartPiiEntitiesDetectionJobResponse->JobStatus;
   # Returns a L<Paws::Comprehend::StartPiiEntitiesDetectionJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/comprehend/StartPiiEntitiesDetectionJob>

ATTRIBUTES

ClientRequestToken => Str

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

REQUIRED DataAccessRoleArn => Str

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

REQUIRED InputDataConfig => Paws::Comprehend::InputDataConfig

The input properties for a PII entities detection job.

JobName => Str

The identifier of the job.

REQUIRED LanguageCode => Str

The language of the input documents.

Valid values are: "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"

REQUIRED Mode => Str

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

Valid values are: "ONLY_REDACTION", "ONLY_OFFSETS"

REQUIRED OutputDataConfig => Paws::Comprehend::OutputDataConfig

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

RedactionConfig => Paws::Comprehend::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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>