« blib/lib/Paws/Comprehend/PiiEntitiesDetectionJobFilter.pm
↑ Summary
blib/lib/Paws/Comprehend/PiiEntity.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Comprehend::PiiEntitiesDetectionJobProperties; | ||
| 3 | use Moose; | ||
| 4 | has DataAccessRoleArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has InputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::InputDataConfig'); | ||
| 7 | has JobId => (is => 'ro', isa => 'Str'); | ||
| 8 | has JobName => (is => 'ro', isa => 'Str'); | ||
| 9 | has JobStatus => (is => 'ro', isa => 'Str'); | ||
| 10 | has LanguageCode => (is => 'ro', isa => 'Str'); | ||
| 11 | has Message => (is => 'ro', isa => 'Str'); | ||
| 12 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 13 | has OutputDataConfig => (is => 'ro', isa => 'Paws::Comprehend::PiiOutputDataConfig'); | ||
| 14 | has RedactionConfig => (is => 'ro', isa => 'Paws::Comprehend::RedactionConfig'); | ||
| 15 | has SubmitTime => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Comprehend::PiiEntitiesDetectionJobProperties | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Comprehend::PiiEntitiesDetectionJobProperties object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { DataAccessRoleArn => $value, ..., SubmitTime => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::PiiEntitiesDetectionJobProperties object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->DataAccessRoleArn | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Provides information about a PII entities detection job. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DataAccessRoleArn => Str | ||
| 53 | |||
| 54 | The Amazon Resource Name (ARN) that gives Amazon Comprehend read access | ||
| 55 | to your input data. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 EndTime => Str | ||
| 59 | |||
| 60 | The time that the PII entities detection job completed. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 InputDataConfig => L<Paws::Comprehend::InputDataConfig> | ||
| 64 | |||
| 65 | The input properties for a PII entities detection job. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 JobId => Str | ||
| 69 | |||
| 70 | The identifier assigned to the PII entities detection job. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 JobName => Str | ||
| 74 | |||
| 75 | The name that you assigned the PII entities detection job. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 JobStatus => Str | ||
| 79 | |||
| 80 | The current status of the PII entities detection job. If the status is | ||
| 81 | C<FAILED>, the C<Message> field shows the reason for the failure. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 LanguageCode => Str | ||
| 85 | |||
| 86 | The language code of the input documents | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Message => Str | ||
| 90 | |||
| 91 | A description of the status of a job. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Mode => Str | ||
| 95 | |||
| 96 | Specifies whether the output provides the locations (offsets) of PII | ||
| 97 | entities or a file in which PII entities are redacted. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 OutputDataConfig => L<Paws::Comprehend::PiiOutputDataConfig> | ||
| 101 | |||
| 102 | The output data configuration that you supplied when you created the | ||
| 103 | PII entities detection job. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 RedactionConfig => L<Paws::Comprehend::RedactionConfig> | ||
| 107 | |||
| 108 | Provides configuration parameters for PII entity redaction. | ||
| 109 | |||
| 110 | This parameter is required if you set the C<Mode> parameter to | ||
| 111 | C<ONLY_REDACTION>. In that case, you must provide a C<RedactionConfig> | ||
| 112 | definition that includes the C<PiiEntityTypes> parameter. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 SubmitTime => Str | ||
| 116 | |||
| 117 | The time that the PII entities detection job was submitted for | ||
| 118 | processing. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |