« blib/lib/Paws/Comprehend/StartKeyPhrasesDetectionJobResponse.pm
↑ Summary
blib/lib/Paws/Comprehend/StartPiiEntitiesDetectionJobResponse.pm »
| 1 | |||
| 2 | package Paws::Comprehend::StartPiiEntitiesDetectionJob; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataAccessRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig', required => 1); | ||
| 7 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 8 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Mode => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::OutputDataConfig', required => 1); | ||
| 11 | has RedactionConfig => (is => 'ro', isa => 'Paws::Comprehend::RedactionConfig'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartPiiEntitiesDetectionJob'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::StartPiiEntitiesDetectionJobResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Comprehend::StartPiiEntitiesDetectionJob - Arguments for method StartPiiEntitiesDetectionJob on L<Paws::Comprehend> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method StartPiiEntitiesDetectionJob on the | ||
| 29 | L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class | ||
| 30 | as arguments to method StartPiiEntitiesDetectionJob. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartPiiEntitiesDetectionJob. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $comprehend = Paws->service('Comprehend'); | ||
| 37 | my $StartPiiEntitiesDetectionJobResponse = | ||
| 38 | $comprehend->StartPiiEntitiesDetectionJob( | ||
| 39 | DataAccessRoleArn => 'MyIamRoleArn', | ||
| 40 | InputDataConfig => { | ||
| 41 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 42 | InputFormat => 'ONE_DOC_PER_FILE' | ||
| 43 | , # values: ONE_DOC_PER_FILE, ONE_DOC_PER_LINE; OPTIONAL | ||
| 44 | }, | ||
| 45 | LanguageCode => 'en', | ||
| 46 | Mode => 'ONLY_REDACTION', | ||
| 47 | OutputDataConfig => { | ||
| 48 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 49 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 50 | }, | ||
| 51 | ClientRequestToken => 'MyClientRequestTokenString', # OPTIONAL | ||
| 52 | JobName => 'MyJobName', # OPTIONAL | ||
| 53 | RedactionConfig => { | ||
| 54 | MaskCharacter => 'MyMaskCharacter', # min: 1, max: 1; OPTIONAL | ||
| 55 | MaskMode => | ||
| 56 | 'MASK', # values: MASK, REPLACE_WITH_PII_ENTITY_TYPE; OPTIONAL | ||
| 57 | PiiEntityTypes => [ | ||
| 58 | 'BANK_ACCOUNT_NUMBER', | ||
| 59 | ... # 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 | ||
| 60 | ], # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | ); | ||
| 63 | |||
| 64 | # Results: | ||
| 65 | my $JobId = $StartPiiEntitiesDetectionJobResponse->JobId; | ||
| 66 | my $JobStatus = $StartPiiEntitiesDetectionJobResponse->JobStatus; | ||
| 67 | |||
| 68 | # Returns a L<Paws::Comprehend::StartPiiEntitiesDetectionJobResponse> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/StartPiiEntitiesDetectionJob> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ClientRequestToken => Str | ||
| 77 | |||
| 78 | A unique identifier for the request. If you don't set the client | ||
| 79 | request token, Amazon Comprehend generates one. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> DataAccessRoleArn => Str | ||
| 84 | |||
| 85 | The Amazon Resource Name (ARN) of the AWS Identity and Access | ||
| 86 | Management (IAM) role that grants Amazon Comprehend read access to your | ||
| 87 | input data. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> InputDataConfig => L<Paws::Comprehend::InputDataConfig> | ||
| 92 | |||
| 93 | The input properties for a PII entities detection job. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 JobName => Str | ||
| 98 | |||
| 99 | The identifier of the job. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 104 | |||
| 105 | The language of the input documents. | ||
| 106 | |||
| 107 | 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"> | ||
| 108 | |||
| 109 | =head2 B<REQUIRED> Mode => Str | ||
| 110 | |||
| 111 | Specifies whether the output provides the locations (offsets) of PII | ||
| 112 | entities or a file in which PII entities are redacted. | ||
| 113 | |||
| 114 | Valid values are: C<"ONLY_REDACTION">, C<"ONLY_OFFSETS"> | ||
| 115 | |||
| 116 | =head2 B<REQUIRED> OutputDataConfig => L<Paws::Comprehend::OutputDataConfig> | ||
| 117 | |||
| 118 | Provides conguration parameters for the output of PII entity detection | ||
| 119 | jobs. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 RedactionConfig => L<Paws::Comprehend::RedactionConfig> | ||
| 124 | |||
| 125 | Provides configuration parameters for PII entity redaction. | ||
| 126 | |||
| 127 | This parameter is required if you set the C<Mode> parameter to | ||
| 128 | C<ONLY_REDACTION>. In that case, you must provide a C<RedactionConfig> | ||
| 129 | definition that includes the C<PiiEntityTypes> parameter. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method StartPiiEntitiesDetectionJob in L<Paws::Comprehend> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |