package Paws::Comprehend::StartPiiEntitiesDetectionJob; use Moose; has ClientRequestToken => (is => 'ro', isa => 'Str'); has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig', required => 1); has JobName => (is => 'ro', isa => 'Str'); has LanguageCode => (is => 'ro', isa => 'Str', required => 1); has Mode => (is => 'ro', isa => 'Str', required => 1); has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::OutputDataConfig', required => 1); has RedactionConfig => (is => 'ro', isa => 'Paws::Comprehend::RedactionConfig'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartPiiEntitiesDetectionJob'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::StartPiiEntitiesDetectionJobResponse'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::Comprehend::StartPiiEntitiesDetectionJob - Arguments for method StartPiiEntitiesDetectionJob on L =head1 DESCRIPTION This class represents the parameters used for calling the method StartPiiEntitiesDetectionJob on the L 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. =head1 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 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 L =head1 ATTRIBUTES =head2 ClientRequestToken => Str A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. =head2 B 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. =head2 B InputDataConfig => L The input properties for a PII entities detection job. =head2 JobName => Str The identifier of the job. =head2 B LanguageCode => Str The language of the input documents. Valid values are: C<"en">, C<"es">, C<"fr">, C<"de">, C<"it">, C<"pt">, C<"ar">, C<"hi">, C<"ja">, C<"ko">, C<"zh">, C<"zh-TW"> =head2 B 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: C<"ONLY_REDACTION">, C<"ONLY_OFFSETS"> =head2 B OutputDataConfig => L Provides conguration parameters for the output of PII entity detection jobs. =head2 RedactionConfig => L Provides configuration parameters for PII entity redaction. This parameter is required if you set the C parameter to C. In that case, you must provide a C definition that includes the C parameter. =head1 SEE ALSO This class forms part of L, documenting arguments for method StartPiiEntitiesDetectionJob in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut