« blib/lib/Paws/EBS/ListChangedBlocksResponse.pm
↑ Summary
blib/lib/Paws/EBS/ListSnapshotBlocksResponse.pm »
| 1 | |||
| 2 | package Paws::EBS::ListSnapshotBlocks; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'pageToken'); | ||
| 6 | has SnapshotId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'snapshotId', required => 1); | ||
| 7 | has StartingBlockIndex => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'startingBlockIndex'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListSnapshotBlocks'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/snapshots/{snapshotId}/blocks'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EBS::ListSnapshotBlocksResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EBS::ListSnapshotBlocks - Arguments for method ListSnapshotBlocks on L<Paws::EBS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListSnapshotBlocks on the | ||
| 26 | L<Amazon Elastic Block Store|Paws::EBS> service. Use the attributes of this class | ||
| 27 | as arguments to method ListSnapshotBlocks. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListSnapshotBlocks. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ebs = Paws->service('EBS'); | ||
| 34 | my $ListSnapshotBlocksResponse = $ebs->ListSnapshotBlocks( | ||
| 35 | SnapshotId => 'MySnapshotId', | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | NextToken => 'MyPageToken', # OPTIONAL | ||
| 38 | StartingBlockIndex => 1, # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $BlockSize = $ListSnapshotBlocksResponse->BlockSize; | ||
| 43 | my $Blocks = $ListSnapshotBlocksResponse->Blocks; | ||
| 44 | my $ExpiryTime = $ListSnapshotBlocksResponse->ExpiryTime; | ||
| 45 | my $NextToken = $ListSnapshotBlocksResponse->NextToken; | ||
| 46 | my $VolumeSize = $ListSnapshotBlocksResponse->VolumeSize; | ||
| 47 | |||
| 48 | # Returns a L<Paws::EBS::ListSnapshotBlocksResponse> object. | ||
| 49 | |||
| 50 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ebs/ListSnapshotBlocks> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 MaxResults => Int | ||
| 57 | |||
| 58 | The number of results to return. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 NextToken => Str | ||
| 63 | |||
| 64 | The token to request the next page of results. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> SnapshotId => Str | ||
| 69 | |||
| 70 | The ID of the snapshot from which to get block indexes and block | ||
| 71 | tokens. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 StartingBlockIndex => Int | ||
| 76 | |||
| 77 | The block index from which the list should start. The list in the | ||
| 78 | response will start from this block index or the next valid block index | ||
| 79 | in the snapshot. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method ListSnapshotBlocks in L<Paws::EBS> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |