| 1 | |||
| 2 | package Paws::EBS::CompleteSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has ChangedBlocksCount => (is => 'ro', isa => 'Int', traits => ['ParamInHeader'], header_name => 'x-amz-ChangedBlocksCount', required => 1); | ||
| 5 | has Checksum => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-Checksum'); | ||
| 6 | has ChecksumAggregationMethod => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-Checksum-Aggregation-Method'); | ||
| 7 | has ChecksumAlgorithm => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-Checksum-Algorithm'); | ||
| 8 | has SnapshotId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'snapshotId', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CompleteSnapshot'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/snapshots/completion/{snapshotId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EBS::CompleteSnapshotResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EBS::CompleteSnapshot - Arguments for method CompleteSnapshot on L<Paws::EBS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CompleteSnapshot on the | ||
| 27 | L<Amazon Elastic Block Store|Paws::EBS> service. Use the attributes of this class | ||
| 28 | as arguments to method CompleteSnapshot. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CompleteSnapshot. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ebs = Paws->service('EBS'); | ||
| 35 | my $CompleteSnapshotResponse = $ebs->CompleteSnapshot( | ||
| 36 | ChangedBlocksCount => 1, | ||
| 37 | SnapshotId => 'MySnapshotId', | ||
| 38 | Checksum => 'MyChecksum', # OPTIONAL | ||
| 39 | ChecksumAggregationMethod => 'LINEAR', # OPTIONAL | ||
| 40 | ChecksumAlgorithm => 'SHA256', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Status = $CompleteSnapshotResponse->Status; | ||
| 45 | |||
| 46 | # Returns a L<Paws::EBS::CompleteSnapshotResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ebs/CompleteSnapshot> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> ChangedBlocksCount => Int | ||
| 55 | |||
| 56 | The number of blocks that were written to the snapshot. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 Checksum => Str | ||
| 61 | |||
| 62 | An aggregated Base-64 SHA256 checksum based on the checksums of each | ||
| 63 | written block. | ||
| 64 | |||
| 65 | To generate the aggregated checksum using the linear aggregation | ||
| 66 | method, arrange the checksums for each written block in ascending order | ||
| 67 | of their block index, concatenate them to form a single string, and | ||
| 68 | then generate the checksum on the entire string using the SHA256 | ||
| 69 | algorithm. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ChecksumAggregationMethod => Str | ||
| 74 | |||
| 75 | The aggregation method used to generate the checksum. Currently, the | ||
| 76 | only supported aggregation method is C<LINEAR>. | ||
| 77 | |||
| 78 | Valid values are: C<"LINEAR"> | ||
| 79 | |||
| 80 | =head2 ChecksumAlgorithm => Str | ||
| 81 | |||
| 82 | The algorithm used to generate the checksum. Currently, the only | ||
| 83 | supported algorithm is C<SHA256>. | ||
| 84 | |||
| 85 | Valid values are: C<"SHA256"> | ||
| 86 | |||
| 87 | =head2 B<REQUIRED> SnapshotId => Str | ||
| 88 | |||
| 89 | The ID of the snapshot. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method CompleteSnapshot in L<Paws::EBS> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |