« blib/lib/Paws/FSX/ActiveDirectoryBackupAttributes.pm
↑ Summary
blib/lib/Paws/FSX/AdministrativeActionFailureDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::AdministrativeAction; | ||
| 3 | use Moose; | ||
| 4 | has AdministrativeActionType => (is => 'ro', isa => 'Str'); | ||
| 5 | has FailureDetails => (is => 'ro', isa => 'Paws::FSX::AdministrativeActionFailureDetails'); | ||
| 6 | has ProgressPercent => (is => 'ro', isa => 'Int'); | ||
| 7 | has RequestTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has Status => (is => 'ro', isa => 'Str'); | ||
| 9 | has TargetFileSystemValues => (is => 'ro', isa => 'Paws::FSX::FileSystem'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::FSX::AdministrativeAction | ||
| 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::FSX::AdministrativeAction object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { AdministrativeActionType => $value, ..., TargetFileSystemValues => $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::FSX::AdministrativeAction object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->AdministrativeActionType | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Describes a specific Amazon FSx administrative action for the current | ||
| 42 | Windows or Lustre file system. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 AdministrativeActionType => Str | ||
| 48 | |||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | =head2 FailureDetails => L<Paws::FSX::AdministrativeActionFailureDetails> | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 ProgressPercent => Int | ||
| 58 | |||
| 59 | Provides the percent complete of a C<STORAGE_OPTIMIZATION> | ||
| 60 | administrative action. Does not apply to any other administrative | ||
| 61 | action type. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 RequestTime => Str | ||
| 65 | |||
| 66 | Time that the administrative action request was received. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Status => Str | ||
| 70 | |||
| 71 | Describes the status of the administrative action, as follows: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<FAILED> - Amazon FSx failed to process the administrative action | ||
| 78 | successfully. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<IN_PROGRESS> - Amazon FSx is processing the administrative action. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<PENDING> - Amazon FSx is waiting to process the administrative | ||
| 87 | action. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<COMPLETED> - Amazon FSx has finished processing the administrative | ||
| 92 | task. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<UPDATED_OPTIMIZING> - For a storage capacity increase update, Amazon | ||
| 97 | FSx has updated the file system with the new storage capacity, and is | ||
| 98 | now performing the storage optimization process. For more information, | ||
| 99 | see Managing storage capacity | ||
| 100 | (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) | ||
| 101 | in the I<Amazon FSx for Windows File Server User Guide> and Managing | ||
| 102 | storage and throughput capacity | ||
| 103 | (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) | ||
| 104 | in the I<Amazon FSx for Lustre User Guide>. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 TargetFileSystemValues => L<Paws::FSX::FileSystem> | ||
| 111 | |||
| 112 | Describes the target value for the administration action, provided in | ||
| 113 | the C<UpdateFileSystem> operation. Returned for C<FILE_SYSTEM_UPDATE> | ||
| 114 | administrative actions. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |