| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Macie2::Record; | ||
| 3 | use Moose; | ||
| 4 | has JsonPath => (is => 'ro', isa => 'Str', request_name => 'jsonPath', traits => ['NameInRequest']); | ||
| 5 | has RecordIndex => (is => 'ro', isa => 'Int', request_name => 'recordIndex', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Macie2::Record | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Macie2::Record object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { JsonPath => $value, ..., RecordIndex => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Macie2::Record object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->JsonPath | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies the location of an occurrence of sensitive data in an Apache | ||
| 38 | Avro object container, Apache Parquet file, JSON file, or JSON Lines | ||
| 39 | file. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 JsonPath => Str | ||
| 45 | |||
| 46 | The path, as a JSONPath expression, to the sensitive data. For an Avro | ||
| 47 | object container or Parquet file, this is the path to the field in the | ||
| 48 | record (recordIndex) that contains the data. For a JSON or JSON Lines | ||
| 49 | file, this is the path to the field or array that contains the data. If | ||
| 50 | the data is a value in an array, the path also indicates which value | ||
| 51 | contains the data. | ||
| 52 | |||
| 53 | If Amazon Macie detects sensitive data in the name of any element in | ||
| 54 | the path, Macie omits this field. If the name of an element exceeds 20 | ||
| 55 | characters, Macie truncates the name by removing characters from the | ||
| 56 | beginning of the name. If the resulting full path exceeds 250 | ||
| 57 | characters, Macie also truncates the path, starting with the first | ||
| 58 | element in the path, until the path contains 250 or fewer characters. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 RecordIndex => Int | ||
| 62 | |||
| 63 | For an Avro object container or Parquet file, the record index, | ||
| 64 | starting from 0, for the record that contains the sensitive data. For a | ||
| 65 | JSON Lines file, the line index, starting from 0, for the line that | ||
| 66 | contains the sensitive data. This value is always 0 for JSON files. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, describing an object used in L<Paws::Macie2> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |