libZSservicesZSamazonka-ebsZSamazonka-ebs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EBS.CompleteSnapshot

Description

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

Synopsis

Creating a Request

data CompleteSnapshot Source #

See: newCompleteSnapshot smart constructor.

Constructors

CompleteSnapshot' 

Fields

  • checksumAlgorithm :: Maybe ChecksumAlgorithm

    The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

  • checksum :: Maybe Text

    An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

    To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

  • checksumAggregationMethod :: Maybe ChecksumAggregationMethod

    The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

  • snapshotId :: Text

    The ID of the snapshot.

  • changedBlocksCount :: Natural

    The number of blocks that were written to the snapshot.

Instances

Instances details
Eq CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Read CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Show CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Generic CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Associated Types

type Rep CompleteSnapshot :: Type -> Type #

NFData CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Methods

rnf :: CompleteSnapshot -> () #

Hashable CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

ToJSON CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

AWSRequest CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Associated Types

type AWSResponse CompleteSnapshot #

ToHeaders CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

ToPath CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

ToQuery CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

type Rep CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

type Rep CompleteSnapshot = D1 ('MetaData "CompleteSnapshot" "Amazonka.EBS.CompleteSnapshot" "libZSservicesZSamazonka-ebsZSamazonka-ebs" 'False) (C1 ('MetaCons "CompleteSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :*: S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "checksumAggregationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAggregationMethod)) :*: (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changedBlocksCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))
type AWSResponse CompleteSnapshot Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

newCompleteSnapshot Source #

Create a value of CompleteSnapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checksumAlgorithm:CompleteSnapshot', completeSnapshot_checksumAlgorithm - The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

$sel:checksum:CompleteSnapshot', completeSnapshot_checksum - An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

$sel:checksumAggregationMethod:CompleteSnapshot', completeSnapshot_checksumAggregationMethod - The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

$sel:snapshotId:CompleteSnapshot', completeSnapshot_snapshotId - The ID of the snapshot.

$sel:changedBlocksCount:CompleteSnapshot', completeSnapshot_changedBlocksCount - The number of blocks that were written to the snapshot.

Request Lenses

completeSnapshot_checksumAlgorithm :: Lens' CompleteSnapshot (Maybe ChecksumAlgorithm) Source #

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

completeSnapshot_checksum :: Lens' CompleteSnapshot (Maybe Text) Source #

An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

completeSnapshot_checksumAggregationMethod :: Lens' CompleteSnapshot (Maybe ChecksumAggregationMethod) Source #

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

completeSnapshot_changedBlocksCount :: Lens' CompleteSnapshot Natural Source #

The number of blocks that were written to the snapshot.

Destructuring the Response

data CompleteSnapshotResponse Source #

See: newCompleteSnapshotResponse smart constructor.

Constructors

CompleteSnapshotResponse' 

Fields

Instances

Instances details
Eq CompleteSnapshotResponse Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Read CompleteSnapshotResponse Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Show CompleteSnapshotResponse Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Generic CompleteSnapshotResponse Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

Associated Types

type Rep CompleteSnapshotResponse :: Type -> Type #

NFData CompleteSnapshotResponse Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

type Rep CompleteSnapshotResponse Source # 
Instance details

Defined in Amazonka.EBS.CompleteSnapshot

type Rep CompleteSnapshotResponse = D1 ('MetaData "CompleteSnapshotResponse" "Amazonka.EBS.CompleteSnapshot" "libZSservicesZSamazonka-ebsZSamazonka-ebs" 'False) (C1 ('MetaCons "CompleteSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCompleteSnapshotResponse Source #

Create a value of CompleteSnapshotResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:CompleteSnapshotResponse', completeSnapshotResponse_status - The status of the snapshot.

$sel:httpStatus:CompleteSnapshotResponse', completeSnapshotResponse_httpStatus - The response's http status code.

Response Lenses