« blib/lib/Paws/FSX/DataRepositoryFailureDetails.pm
↑ Summary
blib/lib/Paws/FSX/DataRepositoryTaskFailureDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::DataRepositoryTask; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has FailureDetails => (is => 'ro', isa => 'Paws::FSX::DataRepositoryTaskFailureDetails'); | ||
| 7 | has FileSystemId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Lifecycle => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Paths => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has Report => (is => 'ro', isa => 'Paws::FSX::CompletionReport'); | ||
| 11 | has ResourceARN => (is => 'ro', isa => 'Str'); | ||
| 12 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 13 | has Status => (is => 'ro', isa => 'Paws::FSX::DataRepositoryTaskStatus'); | ||
| 14 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Tag]'); | ||
| 15 | has TaskId => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::FSX::DataRepositoryTask | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::FSX::DataRepositoryTask object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { CreationTime => $value, ..., Type => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::FSX::DataRepositoryTask object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->CreationTime | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | A description of the data repository task. You use data repository | ||
| 49 | tasks to perform bulk transfer operations between your Amazon FSx file | ||
| 50 | system and its linked data repository. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> CreationTime => Str | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 EndTime => Str | ||
| 61 | |||
| 62 | The time that Amazon FSx completed processing the task, populated after | ||
| 63 | the task is complete. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 FailureDetails => L<Paws::FSX::DataRepositoryTaskFailureDetails> | ||
| 67 | |||
| 68 | Failure message describing why the task failed, it is populated only | ||
| 69 | when C<Lifecycle> is set to C<FAILED>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Lifecycle => Str | ||
| 78 | |||
| 79 | The lifecycle status of the data repository task, as follows: | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<PENDING> - Amazon FSx has not started the task. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<EXECUTING> - Amazon FSx is processing the task. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<FAILED> - Amazon FSx was not able to complete the task. For example, | ||
| 94 | there may be files the task failed to process. The | ||
| 95 | DataRepositoryTaskFailureDetails property provides more information | ||
| 96 | about task failures. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<SUCCEEDED> - FSx completed the task successfully. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<CANCELED> - Amazon FSx canceled the task and it did not complete. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<CANCELING> - FSx is in process of canceling the task. | ||
| 109 | |||
| 110 | =back | ||
| 111 | |||
| 112 | You cannot delete an FSx for Lustre file system if there are data | ||
| 113 | repository tasks for the file system in the C<PENDING> or C<EXECUTING> | ||
| 114 | states. Please retry when the data repository task is finished (with a | ||
| 115 | status of C<CANCELED>, C<SUCCEEDED>, or C<FAILED>). You can use the | ||
| 116 | DescribeDataRepositoryTask action to monitor the task status. Contact | ||
| 117 | the FSx team if you need to delete your file system immediately. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 Paths => ArrayRef[Str|Undef] | ||
| 121 | |||
| 122 | An array of paths on the Amazon FSx for Lustre file system that specify | ||
| 123 | the data for the data repository task to process. For example, in an | ||
| 124 | EXPORT_TO_REPOSITORY task, the paths specify which data to export to | ||
| 125 | the linked data repository. | ||
| 126 | |||
| 127 | (Default) If C<Paths> is not specified, Amazon FSx uses the file system | ||
| 128 | root directory. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 Report => L<Paws::FSX::CompletionReport> | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 ResourceARN => Str | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 StartTime => Str | ||
| 142 | |||
| 143 | The time that Amazon FSx began processing the task. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 Status => L<Paws::FSX::DataRepositoryTaskStatus> | ||
| 147 | |||
| 148 | Provides the status of the number of files that the task has processed | ||
| 149 | successfully and failed to process. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 Tags => ArrayRef[L<Paws::FSX::Tag>] | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 B<REQUIRED> TaskId => Str | ||
| 158 | |||
| 159 | The system-generated, unique 17-digit ID of the data repository task. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 B<REQUIRED> Type => Str | ||
| 163 | |||
| 164 | The type of data repository task; EXPORT_TO_REPOSITORY is the only type | ||
| 165 | currently supported. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |