« blib/lib/Paws/StorageGateway/VTLDevice.pm
↑ Summary
blib/lib/Paws/StorageGateway/VolumeRecoveryPointInfo.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::StorageGateway::VolumeInfo; | ||
| 3 | use Moose; | ||
| 4 | has GatewayARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has GatewayId => (is => 'ro', isa => 'Str'); | ||
| 6 | has VolumeARN => (is => 'ro', isa => 'Str'); | ||
| 7 | has VolumeAttachmentStatus => (is => 'ro', isa => 'Str'); | ||
| 8 | has VolumeId => (is => 'ro', isa => 'Str'); | ||
| 9 | has VolumeSizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 10 | has VolumeType => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::StorageGateway::VolumeInfo | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::StorageGateway::VolumeInfo object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { GatewayARN => $value, ..., VolumeType => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::VolumeInfo object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->GatewayARN | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Describes a storage volume object. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 GatewayARN => Str | ||
| 48 | |||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | =head2 GatewayId => Str | ||
| 53 | |||
| 54 | The unique identifier assigned to your gateway during activation. This | ||
| 55 | ID becomes part of the gateway Amazon Resource Name (ARN), which you | ||
| 56 | use as input for other operations. | ||
| 57 | |||
| 58 | Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and | ||
| 59 | hyphens (-). | ||
| 60 | |||
| 61 | |||
| 62 | =head2 VolumeARN => Str | ||
| 63 | |||
| 64 | The Amazon Resource Name (ARN) for the storage volume. For example, the | ||
| 65 | following is a valid ARN: | ||
| 66 | |||
| 67 | C<arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB> | ||
| 68 | |||
| 69 | Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and | ||
| 70 | hyphens (-). | ||
| 71 | |||
| 72 | |||
| 73 | =head2 VolumeAttachmentStatus => Str | ||
| 74 | |||
| 75 | One of the VolumeStatus values that indicates the state of the storage | ||
| 76 | volume. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 VolumeId => Str | ||
| 80 | |||
| 81 | The unique identifier assigned to the volume. This ID becomes part of | ||
| 82 | the volume Amazon Resource Name (ARN), which you use as input for other | ||
| 83 | operations. | ||
| 84 | |||
| 85 | Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and | ||
| 86 | hyphens (-). | ||
| 87 | |||
| 88 | |||
| 89 | =head2 VolumeSizeInBytes => Int | ||
| 90 | |||
| 91 | The size of the volume in bytes. | ||
| 92 | |||
| 93 | Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and | ||
| 94 | hyphens (-). | ||
| 95 | |||
| 96 | |||
| 97 | =head2 VolumeType => Str | ||
| 98 | |||
| 99 | One of the VolumeType enumeration values describing the type of the | ||
| 100 | volume. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |