« blib/lib/Paws/API/Caller/Retry.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/AccessPreviewFinding.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AccessAnalyzer::AccessPreview; | ||
| 3 | use Moose; | ||
| 4 | has AnalyzerArn => (is => 'ro', isa => 'Str', request_name => 'analyzerArn', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Configurations => (is => 'ro', isa => 'Paws::AccessAnalyzer::ConfigurationsMap', request_name => 'configurations', traits => ['NameInRequest'], required => 1); | ||
| 6 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest'], required => 1); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest'], required => 1); | ||
| 9 | has StatusReason => (is => 'ro', isa => 'Paws::AccessAnalyzer::AccessPreviewStatusReason', request_name => 'statusReason', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::AccessAnalyzer::AccessPreview | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::AccessAnalyzer::AccessPreview object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { AnalyzerArn => $value, ..., StatusReason => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::AccessAnalyzer::AccessPreview object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->AnalyzerArn | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Contains information about an access preview. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> AnalyzerArn => Str | ||
| 47 | |||
| 48 | The ARN of the analyzer used to generate the access preview. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Configurations => L<Paws::AccessAnalyzer::ConfigurationsMap> | ||
| 52 | |||
| 53 | A map of resource ARNs for the proposed resource configuration. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> CreatedAt => Str | ||
| 57 | |||
| 58 | The time at which the access preview was created. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Id => Str | ||
| 62 | |||
| 63 | The unique ID for the access preview. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Status => Str | ||
| 67 | |||
| 68 | The status of the access preview. | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<Creating> - The access preview creation is in progress. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<Completed> - The access preview is complete. You can preview findings | ||
| 79 | for external access to the resource. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<Failed> - The access preview creation has failed. | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 StatusReason => L<Paws::AccessAnalyzer::AccessPreviewStatusReason> | ||
| 90 | |||
| 91 | Provides more details about the current status of the access preview. | ||
| 92 | |||
| 93 | For example, if the creation of the access preview fails, a C<Failed> | ||
| 94 | status is returned. This failure can be due to an internal issue with | ||
| 95 | the analysis or due to an invalid resource configuration. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, describing an object used in L<Paws::AccessAnalyzer> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |