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.GetSnapshotBlock

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the data in a block in an Amazon Elastic Block Store snapshot.

Synopsis

data GetSnapshotBlock = GetSnapshotBlock' {
- snapshotId :: Text
- blockIndex :: Natural
- blockToken :: Text
}
newGetSnapshotBlock :: Text -> Natural -> Text -> GetSnapshotBlock
getSnapshotBlock_snapshotId :: Lens' GetSnapshotBlock Text
getSnapshotBlock_blockIndex :: Lens' GetSnapshotBlock Natural
getSnapshotBlock_blockToken :: Lens' GetSnapshotBlock Text
data GetSnapshotBlockResponse = GetSnapshotBlockResponse' {
- checksum :: Maybe Text
- checksumAlgorithm :: Maybe ChecksumAlgorithm
- dataLength :: Maybe Int
- httpStatus :: Int
- blockData :: ResponseBody
}
newGetSnapshotBlockResponse :: Int -> ResponseBody -> GetSnapshotBlockResponse
getSnapshotBlockResponse_checksum :: Lens' GetSnapshotBlockResponse (Maybe Text)
getSnapshotBlockResponse_checksumAlgorithm :: Lens' GetSnapshotBlockResponse (Maybe ChecksumAlgorithm)
getSnapshotBlockResponse_dataLength :: Lens' GetSnapshotBlockResponse (Maybe Int)
getSnapshotBlockResponse_httpStatus :: Lens' GetSnapshotBlockResponse Int
getSnapshotBlockResponse_blockData :: Lens' GetSnapshotBlockResponse ResponseBody

Creating a Request

data GetSnapshotBlock Source #

See: newGetSnapshotBlock smart constructor.

Constructors

GetSnapshotBlock'

Fields

snapshotId :: Text
The ID of the snapshot containing the block from which to get data.
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 read 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.
blockToken :: Text
The block token of the block from which to get data. You can obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.

Instances

Instances details

ToHeaders GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods toHeaders :: GetSnapshotBlock -> [Header] #
ToPath GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods toPath :: GetSnapshotBlock -> ByteString #
ToQuery GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods toQuery :: GetSnapshotBlock -> QueryString #
AWSRequest GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Associated Types type AWSResponse GetSnapshotBlock # Methods request :: (Service -> Service) -> GetSnapshotBlock -> Request GetSnapshotBlock # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSnapshotBlock -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSnapshotBlock))) #
Generic GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Associated Types type Rep GetSnapshotBlock :: Type -> Type # Methods from :: GetSnapshotBlock -> Rep GetSnapshotBlock x # to :: Rep GetSnapshotBlock x -> GetSnapshotBlock #
Read GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods readsPrec :: Int -> ReadS GetSnapshotBlock # readList :: ReadS [GetSnapshotBlock] # readPrec :: ReadPrec GetSnapshotBlock # readListPrec :: ReadPrec [GetSnapshotBlock] #
Show GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods showsPrec :: Int -> GetSnapshotBlock -> ShowS # show :: GetSnapshotBlock -> String # showList :: [GetSnapshotBlock] -> ShowS #
NFData GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods rnf :: GetSnapshotBlock -> () #
Eq GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods (==) :: GetSnapshotBlock -> GetSnapshotBlock -> Bool # (/=) :: GetSnapshotBlock -> GetSnapshotBlock -> Bool #
Hashable GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods hashWithSalt :: Int -> GetSnapshotBlock -> Int # hash :: GetSnapshotBlock -> Int #
type AWSResponse GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock type AWSResponse GetSnapshotBlock = GetSnapshotBlockResponse
type Rep GetSnapshotBlock Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock type Rep GetSnapshotBlock = D1 ('MetaData "GetSnapshotBlock" "Amazonka.EBS.GetSnapshotBlock" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "GetSnapshotBlock'" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "blockIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "blockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetSnapshotBlock Source #

Arguments

:: Text	`$sel:snapshotId:GetSnapshotBlock'`
-> Natural	`GetSnapshotBlock`
-> Text	`GetSnapshotBlock`
-> GetSnapshotBlock

Create a value of GetSnapshotBlock 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:snapshotId:GetSnapshotBlock', getSnapshotBlock_snapshotId - The ID of the snapshot containing the block from which to get data.

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.

GetSnapshotBlock, getSnapshotBlock_blockIndex - The block index of the block in which to read 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.

GetSnapshotBlock, getSnapshotBlock_blockToken - The block token of the block from which to get data. You can obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.

Request Lenses

getSnapshotBlock_snapshotId :: Lens' GetSnapshotBlock Text Source #

The ID of the snapshot containing the block from which to get data.

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.

getSnapshotBlock_blockIndex :: Lens' GetSnapshotBlock Natural Source #

The block index of the block in which to read 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.

getSnapshotBlock_blockToken :: Lens' GetSnapshotBlock Text Source #

The block token of the block from which to get data. You can obtain the BlockToken by running the ListChangedBlocks or ListSnapshotBlocks operations.

Destructuring the Response

data GetSnapshotBlockResponse Source #

See: newGetSnapshotBlockResponse smart constructor.

Constructors

GetSnapshotBlockResponse'
Fields checksum :: Maybe Text The checksum generated for the block, which is Base64 encoded. checksumAlgorithm :: Maybe ChecksumAlgorithm The algorithm used to generate the checksum for the block, such as SHA256. dataLength :: Maybe Int The size of the data in the block. httpStatus :: Int The response's http status code. blockData :: ResponseBody The data content of the block.

Instances

Instances details

Generic GetSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Associated Types type Rep GetSnapshotBlockResponse :: Type -> Type # Methods from :: GetSnapshotBlockResponse -> Rep GetSnapshotBlockResponse x # to :: Rep GetSnapshotBlockResponse x -> GetSnapshotBlockResponse #
Show GetSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock Methods showsPrec :: Int -> GetSnapshotBlockResponse -> ShowS # show :: GetSnapshotBlockResponse -> String # showList :: [GetSnapshotBlockResponse] -> ShowS #
type Rep GetSnapshotBlockResponse Source #
Instance details Defined in Amazonka.EBS.GetSnapshotBlock type Rep GetSnapshotBlockResponse = D1 ('MetaData "GetSnapshotBlockResponse" "Amazonka.EBS.GetSnapshotBlock" "amazonka-ebs-2.0-64shgDr10jT2ab25iSOcZ1" 'False) (C1 ('MetaCons "GetSnapshotBlockResponse'" '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 "dataLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "blockData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResponseBody)))))

newGetSnapshotBlockResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSnapshotBlockResponse'`
-> ResponseBody	`$sel:blockData:GetSnapshotBlockResponse'`
-> GetSnapshotBlockResponse

Create a value of GetSnapshotBlockResponse 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:checksum:GetSnapshotBlockResponse', getSnapshotBlockResponse_checksum - The checksum generated for the block, which is Base64 encoded.

$sel:checksumAlgorithm:GetSnapshotBlockResponse', getSnapshotBlockResponse_checksumAlgorithm - The algorithm used to generate the checksum for the block, such as SHA256.

$sel:dataLength:GetSnapshotBlockResponse', getSnapshotBlockResponse_dataLength - The size of the data in the block.

$sel:httpStatus:GetSnapshotBlockResponse', getSnapshotBlockResponse_httpStatus - The response's http status code.

$sel:blockData:GetSnapshotBlockResponse', getSnapshotBlockResponse_blockData - The data content of the block.

Response Lenses

getSnapshotBlockResponse_checksum :: Lens' GetSnapshotBlockResponse (Maybe Text) Source #

The checksum generated for the block, which is Base64 encoded.

getSnapshotBlockResponse_checksumAlgorithm :: Lens' GetSnapshotBlockResponse (Maybe ChecksumAlgorithm) Source #

The algorithm used to generate the checksum for the block, such as SHA256.

getSnapshotBlockResponse_dataLength :: Lens' GetSnapshotBlockResponse (Maybe Int) Source #

The size of the data in the block.

getSnapshotBlockResponse_httpStatus :: Lens' GetSnapshotBlockResponse Int Source #

The response's http status code.

getSnapshotBlockResponse_blockData :: Lens' GetSnapshotBlockResponse ResponseBody Source #

The data content of the block.