| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::StorageGateway::TapeArchive; | ||
| 3 | use Moose; | ||
| 4 | has CompletionTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has KMSKey => (is => 'ro', isa => 'Str'); | ||
| 6 | has PoolEntryDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has PoolId => (is => 'ro', isa => 'Str'); | ||
| 8 | has RetentionStartDate => (is => 'ro', isa => 'Str'); | ||
| 9 | has RetrievedTo => (is => 'ro', isa => 'Str'); | ||
| 10 | has TapeARN => (is => 'ro', isa => 'Str'); | ||
| 11 | has TapeBarcode => (is => 'ro', isa => 'Str'); | ||
| 12 | has TapeCreatedDate => (is => 'ro', isa => 'Str'); | ||
| 13 | has TapeSizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 14 | has TapeStatus => (is => 'ro', isa => 'Str'); | ||
| 15 | has TapeUsedInBytes => (is => 'ro', isa => 'Int'); | ||
| 16 | has Worm => (is => 'ro', isa => 'Bool'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::StorageGateway::TapeArchive | ||
| 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::StorageGateway::TapeArchive object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { CompletionTime => $value, ..., Worm => $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::StorageGateway::TapeArchive object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->CompletionTime | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Represents a virtual tape that is archived in the virtual tape shelf | ||
| 49 | (VTS). | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CompletionTime => Str | ||
| 55 | |||
| 56 | The time that the archiving of the virtual tape was completed. | ||
| 57 | |||
| 58 | The default timestamp format is in the ISO8601 extended | ||
| 59 | YYYY-MM-DD'T'HH:MM:SS'Z' format. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 KMSKey => Str | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 PoolEntryDate => Str | ||
| 68 | |||
| 69 | The time that the tape entered the custom tape pool. | ||
| 70 | |||
| 71 | The default timestamp format is in the ISO8601 extended | ||
| 72 | YYYY-MM-DD'T'HH:MM:SS'Z' format. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 PoolId => Str | ||
| 76 | |||
| 77 | The ID of the pool that was used to archive the tape. The tapes in this | ||
| 78 | pool are archived in the S3 storage class that is associated with the | ||
| 79 | pool. | ||
| 80 | |||
| 81 | Valid Values: C<GLACIER> | C<DEEP_ARCHIVE> | ||
| 82 | |||
| 83 | |||
| 84 | =head2 RetentionStartDate => Str | ||
| 85 | |||
| 86 | If the archived tape is subject to tape retention lock, the date that | ||
| 87 | the archived tape started being retained. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 RetrievedTo => Str | ||
| 91 | |||
| 92 | The Amazon Resource Name (ARN) of the tape gateway that the virtual | ||
| 93 | tape is being retrieved to. | ||
| 94 | |||
| 95 | The virtual tape is retrieved from the virtual tape shelf (VTS). | ||
| 96 | |||
| 97 | |||
| 98 | =head2 TapeARN => Str | ||
| 99 | |||
| 100 | The Amazon Resource Name (ARN) of an archived virtual tape. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 TapeBarcode => Str | ||
| 104 | |||
| 105 | The barcode that identifies the archived virtual tape. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 TapeCreatedDate => Str | ||
| 109 | |||
| 110 | The date the virtual tape was created. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 TapeSizeInBytes => Int | ||
| 114 | |||
| 115 | The size, in bytes, of the archived virtual tape. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 TapeStatus => Str | ||
| 119 | |||
| 120 | The current state of the archived virtual tape. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 TapeUsedInBytes => Int | ||
| 124 | |||
| 125 | The size, in bytes, of data stored on the virtual tape. | ||
| 126 | |||
| 127 | This value is not available for tapes created prior to May 13, 2015. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Worm => Bool | ||
| 131 | |||
| 132 | Set to C<true> if the archived tape is stored as write-once-read-many | ||
| 133 | (WORM). | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head1 SEE ALSO | ||
| 138 | |||
| 139 | This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway> | ||
| 140 | |||
| 141 | =head1 BUGS and CONTRIBUTIONS | ||
| 142 | |||
| 143 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 144 | |||
| 145 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 146 | |||
| 147 | =cut | ||
| 148 |