« blib/lib/Paws/Macie2/ClassificationResult.pm
↑ Summary
blib/lib/Paws/Macie2/CreateClassificationJob.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Macie2::ClassificationResultStatus; | ||
| 3 | use Moose; | ||
| 4 | has Code => (is => 'ro', isa => 'Str', request_name => 'code', traits => ['NameInRequest']); | ||
| 5 | has Reason => (is => 'ro', isa => 'Str', request_name => 'reason', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Macie2::ClassificationResultStatus | ||
| 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::ClassificationResultStatus object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Code => $value, ..., Reason => $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::ClassificationResultStatus object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Code | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Provides information about the status of a sensitive data finding. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 Code => Str | ||
| 43 | |||
| 44 | The status of the finding. Possible values are: | ||
| 45 | |||
| 46 | =over | ||
| 47 | |||
| 48 | =item * | ||
| 49 | |||
| 50 | COMPLETE - Amazon Macie successfully completed its analysis of the S3 | ||
| 51 | object that the finding applies to. | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | PARTIAL - Macie analyzed only a subset of the data in the S3 object | ||
| 56 | that the finding applies to. For example, the object is an archive file | ||
| 57 | that contains files in an unsupported format. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | SKIPPED - Macie wasn't able to analyze the S3 object that the finding | ||
| 62 | applies to. For example, the object is a file in an unsupported format. | ||
| 63 | |||
| 64 | =back | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Reason => Str | ||
| 69 | |||
| 70 | A brief description of the status of the finding. Amazon Macie uses | ||
| 71 | this value to notify you of any errors, warnings, or considerations | ||
| 72 | that might impact your analysis of the finding. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, describing an object used in L<Paws::Macie2> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |