Skip to content

PutSnapshotBlockRequest

Source code in docs_src/capo_ebs/types/put_snapshot_block_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class PutSnapshotBlockRequest(TypedDict, closed=True):
    snapshot_id: "capo_ebs.types.snapshot_id.SnapshotId"
    """<p>The ID of the snapshot.</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 write 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_data: "capo_ebs.types.block_data.BlockData"
    """<p>The data to write to the block.</p> <p>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 <b>x-amz-Checksum</b> header. Also, you must specify the checksum algorithm using the <b>x-amz-Checksum-Algorithm</b> 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums"> Using checksums with the EBS direct APIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"""
    data_length: "capo_ebs.types.data_length.DataLength"
    """<p>The size of the data to write to the block, in bytes. Currently, the only supported size is <code>524288</code> bytes.</p> <p>Valid values: <code>524288</code> </p>"""
    progress: NotRequired["capo_ebs.types.progress.Progress"]
    """<p>The progress of the write process, as a percentage.</p>"""
    checksum: "capo_ebs.types.checksum.Checksum"
    """<p>A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.</p>"""
    checksum_algorithm: "capo_ebs.types.checksum_algorithm.ChecksumAlgorithm"
    """<p>The algorithm used to generate the checksum. Currently, the only supported algorithm is <code>SHA256</code>.</p>"""

block_data instance-attribute 

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

block_index instance-attribute 

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

checksum instance-attribute 

checksum: Checksum

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

checksum_algorithm instance-attribute 

checksum_algorithm: ChecksumAlgorithm

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

data_length instance-attribute 

data_length: DataLength

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

Valid values: 524288

progress instance-attribute 

progress: NotRequired[Progress]

The progress of the write process, as a percentage.

snapshot_id instance-attribute 

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