Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EBS.PutSnapshotBlock

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

Synopsis

data PutSnapshotBlock = PutSnapshotBlock' {
- progress :: Maybe Natural
- snapshotId :: Text
- blockIndex :: Natural
- dataLength :: Int
- checksum :: Text
- checksumAlgorithm :: ChecksumAlgorithm
- blockData :: HashedBody
}
newPutSnapshotBlock :: Text -> Natural -> Int -> Text -> ChecksumAlgorithm -> HashedBody -> PutSnapshotBlock
putSnapshotBlock_progress :: Lens' PutSnapshotBlock (Maybe Natural)
putSnapshotBlock_snapshotId :: Lens' PutSnapshotBlock Text
putSnapshotBlock_blockIndex :: Lens' PutSnapshotBlock Natural
putSnapshotBlock_dataLength :: Lens' PutSnapshotBlock Int
putSnapshotBlock_checksum :: Lens' PutSnapshotBlock Text
putSnapshotBlock_checksumAlgorithm :: Lens' PutSnapshotBlock ChecksumAlgorithm
putSnapshotBlock_blockData :: Lens' PutSnapshotBlock HashedBody
data PutSnapshotBlockResponse = PutSnapshotBlockResponse' {
- checksum :: Maybe Text
- checksumAlgorithm :: Maybe ChecksumAlgorithm
- httpStatus :: Int
}
newPutSnapshotBlockResponse :: Int -> PutSnapshotBlockResponse
putSnapshotBlockResponse_checksum :: Lens' PutSnapshotBlockResponse (Maybe Text)
putSnapshotBlockResponse_checksumAlgorithm :: Lens' PutSnapshotBlockResponse (Maybe ChecksumAlgorithm)
putSnapshotBlockResponse_httpStatus :: Lens' PutSnapshotBlockResponse Int

Creating a Request

data PutSnapshotBlock Source #

See: newPutSnapshotBlock smart constructor.

Constructors

PutSnapshotBlock'

Fields

progress :: Maybe Natural
The progress of the write process, as a percentage.
snapshotId :: Text
The ID of the snapshot.
If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..
blockIndex :: Natural
The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.
dataLength :: Int
The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes.
Valid values: 524288
checksum :: Text
A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.
checksumAlgorithm :: ChecksumAlgorithm
The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.
blockData :: HashedBody
The data to write to the block.
The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Instances

Instances details

ToBody PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods toBody :: PutSnapshotBlock -> RequestBody #
ToHeaders PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods toHeaders :: PutSnapshotBlock -> [Header] #
ToPath PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods toPath :: PutSnapshotBlock -> ByteString #
ToQuery PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods toQuery :: PutSnapshotBlock -> QueryString #
AWSRequest PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Associated Types type AWSResponse PutSnapshotBlock # Methods request :: (Service -> Service) -> PutSnapshotBlock -> Request PutSnapshotBlock # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutSnapshotBlock -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutSnapshotBlock))) #
Generic PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Associated Types type Rep PutSnapshotBlock :: Type -> Type # Methods from :: PutSnapshotBlock -> Rep PutSnapshotBlock x # to :: Rep PutSnapshotBlock x -> PutSnapshotBlock #
Show PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods showsPrec :: Int -> PutSnapshotBlock -> ShowS # show :: PutSnapshotBlock -> String # showList :: [PutSnapshotBlock] -> ShowS #
type AWSResponse PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock type AWSResponse PutSnapshotBlock = PutSnapshotBlockResponse
type Rep PutSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock type Rep PutSnapshotBlock = D1 ('MetaData "PutSnapshotBlock" "Amazonka.EBS.PutSnapshotBlock" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "PutSnapshotBlock'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "progress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "blockIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) :: ((S1 ('MetaSel ('Just "dataLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChecksumAlgorithm) :: S1 ('MetaSel ('Just "blockData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HashedBody)))))

newPutSnapshotBlock Source #

Arguments

:: Text	`$sel:snapshotId:PutSnapshotBlock'`
-> Natural	`PutSnapshotBlock`
-> Int	`$sel:dataLength:PutSnapshotBlock'`
-> Text	`PutSnapshotBlock`
-> ChecksumAlgorithm	`PutSnapshotBlock`
-> HashedBody	`$sel:blockData:PutSnapshotBlock'`
-> PutSnapshotBlock

Create a value of PutSnapshotBlock 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:progress:PutSnapshotBlock', putSnapshotBlock_progress - The progress of the write process, as a percentage.

$sel:snapshotId:PutSnapshotBlock', putSnapshotBlock_snapshotId - The ID of the snapshot.

If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..

PutSnapshotBlock, putSnapshotBlock_blockIndex - The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

$sel:dataLength:PutSnapshotBlock', putSnapshotBlock_dataLength - The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes.

Valid values: 524288

PutSnapshotBlock, putSnapshotBlock_checksum - A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

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

$sel:blockData:PutSnapshotBlock', putSnapshotBlock_blockData - The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Request Lenses

putSnapshotBlock_progress :: Lens' PutSnapshotBlock (Maybe Natural) Source #

The progress of the write process, as a percentage.

putSnapshotBlock_snapshotId :: Lens' PutSnapshotBlock Text Source #

The ID of the snapshot.

If the specified snapshot is encrypted, you must have permission to use the KMS key that was used to encrypt the snapshot. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide..

putSnapshotBlock_blockIndex :: Lens' PutSnapshotBlock Natural Source #

The block index of the block in which to write the data. A block index is a logical index in units of 512 KiB blocks. To identify the block index, divide the logical offset of the data in the logical volume by the block size (logical offset of data/524288). The logical offset of the data must be 512 KiB aligned.

putSnapshotBlock_dataLength :: Lens' PutSnapshotBlock Int Source #

The size of the data to write to the block, in bytes. Currently, the only supported size is 524288 bytes.

Valid values: 524288

putSnapshotBlock_checksum :: Lens' PutSnapshotBlock Text Source #

A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

putSnapshotBlock_checksumAlgorithm :: Lens' PutSnapshotBlock ChecksumAlgorithm Source #

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

putSnapshotBlock_blockData :: Lens' PutSnapshotBlock HashedBody Source #

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

Destructuring the Response

data PutSnapshotBlockResponse Source #

See: newPutSnapshotBlockResponse smart constructor.

Constructors

PutSnapshotBlockResponse'
Fields checksum :: Maybe Text The SHA256 checksum generated for the block data by Amazon EBS. checksumAlgorithm :: Maybe ChecksumAlgorithm The algorithm used by Amazon EBS to generate the checksum. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Associated Types type Rep PutSnapshotBlockResponse :: Type -> Type # Methods from :: PutSnapshotBlockResponse -> Rep PutSnapshotBlockResponse x # to :: Rep PutSnapshotBlockResponse x -> PutSnapshotBlockResponse #
Read PutSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods readsPrec :: Int -> ReadS PutSnapshotBlockResponse # readList :: ReadS [PutSnapshotBlockResponse] # readPrec :: ReadPrec PutSnapshotBlockResponse # readListPrec :: ReadPrec [PutSnapshotBlockResponse] #
Show PutSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods showsPrec :: Int -> PutSnapshotBlockResponse -> ShowS # show :: PutSnapshotBlockResponse -> String # showList :: [PutSnapshotBlockResponse] -> ShowS #
NFData PutSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods rnf :: PutSnapshotBlockResponse -> () #
Eq PutSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock Methods (==) :: PutSnapshotBlockResponse -> PutSnapshotBlockResponse -> Bool # (/=) :: PutSnapshotBlockResponse -> PutSnapshotBlockResponse -> Bool #
type Rep PutSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.PutSnapshotBlock type Rep PutSnapshotBlockResponse = D1 ('MetaData "PutSnapshotBlockResponse" "Amazonka.EBS.PutSnapshotBlock" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "PutSnapshotBlockResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutSnapshotBlockResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutSnapshotBlockResponse'`
-> PutSnapshotBlockResponse

Create a value of PutSnapshotBlockResponse 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:

PutSnapshotBlock, putSnapshotBlockResponse_checksum - The SHA256 checksum generated for the block data by Amazon EBS.

PutSnapshotBlock, putSnapshotBlockResponse_checksumAlgorithm - The algorithm used by Amazon EBS to generate the checksum.

$sel:httpStatus:PutSnapshotBlockResponse', putSnapshotBlockResponse_httpStatus - The response's http status code.

Response Lenses

putSnapshotBlockResponse_checksum :: Lens' PutSnapshotBlockResponse (Maybe Text) Source #

The SHA256 checksum generated for the block data by Amazon EBS.

putSnapshotBlockResponse_checksumAlgorithm :: Lens' PutSnapshotBlockResponse (Maybe ChecksumAlgorithm) Source #

The algorithm used by Amazon EBS to generate the checksum.

putSnapshotBlockResponse_httpStatus :: Lens' PutSnapshotBlockResponse Int Source #

The response's http status code.