Amazonka.EBS.GetSnapshotBlock

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

Creating a Request

data GetSnapshotBlock

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

ToHeaders GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

toHeaders :: GetSnapshotBlock -> [Header]

ToPath GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

toPath :: GetSnapshotBlock -> ByteString

ToQuery GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

toQuery :: GetSnapshotBlock -> QueryString

AWSRequest GetSnapshotBlock

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

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

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

readsPrec :: Int -> ReadS GetSnapshotBlock

readList :: ReadS [GetSnapshotBlock]

readPrec :: ReadPrec GetSnapshotBlock

readListPrec :: ReadPrec [GetSnapshotBlock]

Show GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

showsPrec :: Int -> GetSnapshotBlock -> ShowS

show :: GetSnapshotBlock -> String

showList :: [GetSnapshotBlock] -> ShowS

NFData GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

rnf :: GetSnapshotBlock -> ()

Eq GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

(==) :: GetSnapshotBlock -> GetSnapshotBlock -> Bool

(/=) :: GetSnapshotBlock -> GetSnapshotBlock -> Bool

Hashable GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

hashWithSalt :: Int -> GetSnapshotBlock -> Int

hash :: GetSnapshotBlock -> Int

type AWSResponse GetSnapshotBlock

Defined in Amazonka.EBS.GetSnapshotBlock

type AWSResponse GetSnapshotBlock = GetSnapshotBlockResponse

type Rep GetSnapshotBlock

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

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

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

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

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

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

Generic GetSnapshotBlockResponse

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

Defined in Amazonka.EBS.GetSnapshotBlock

Methods

showsPrec :: Int -> GetSnapshotBlockResponse -> ShowS

show :: GetSnapshotBlockResponse -> String

showList :: [GetSnapshotBlockResponse] -> ShowS

type Rep GetSnapshotBlockResponse

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

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)

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

getSnapshotBlockResponse_checksumAlgorithm :: Lens' GetSnapshotBlockResponse (Maybe ChecksumAlgorithm)

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

getSnapshotBlockResponse_dataLength :: Lens' GetSnapshotBlockResponse (Maybe Int)

The size of the data in the block.

getSnapshotBlockResponse_httpStatus :: Lens' GetSnapshotBlockResponse Int

The response's http status code.

getSnapshotBlockResponse_blockData :: Lens' GetSnapshotBlockResponse ResponseBody

The data content of the block.