Skip to content

GetSnapshotBlockRequest

Source code in docs_src/capo_ebs/types/get_snapshot_block_request.py
class GetSnapshotBlockRequest(TypedDict, closed=True):
    snapshot_id: "capo_ebs.types.snapshot_id.SnapshotId"
    """<p>The ID of the snapshot containing the block from which to get data.</p> <important> <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important>"""
    block_index: "capo_ebs.types.block_index.BlockIndex"
    """<p>The block index of the block in which to read the data. A block index is a logical index in units of <code>512</code> 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/<code>524288</code>). The logical offset of the data must be <code>512</code> KiB aligned.</p>"""
    block_token: "capo_ebs.types.block_token.BlockToken"
    """<p>The block token of the block from which to get data. You can obtain the <code>BlockToken</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>"""

block_index instance-attribute

block_index: 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.

block_token instance-attribute

block_token: BlockToken

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

snapshot_id instance-attribute

snapshot_id: 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.