EBS / Client / list_changed_blocks

list_changed_blocks#

EBS.Client.list_changed_blocks(**kwargs)#

Returns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

Note

You should always retry requests that receive server ( 5xx) error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_changed_blocks(
    FirstSnapshotId='string',
    SecondSnapshotId='string',
    NextToken='string',
    MaxResults=123,
    StartingBlockIndex=123
)
Parameters:

  • FirstSnapshotId (string) –

    The ID of the first snapshot to use for the comparison.

    Warning

    The FirstSnapshotID parameter must be specified with a SecondSnapshotId parameter; otherwise, an error occurs.

  • SecondSnapshotId (string) –

    [REQUIRED]

    The ID of the second snapshot to use for the comparison.

    Warning

    The SecondSnapshotId parameter must be specified with a FirstSnapshotID parameter; otherwise, an error occurs.

  • NextToken (string) –

    The token to request the next page of results.

    If you specify NextToken, then StartingBlockIndex is ignored.

  • MaxResults (integer) –

    The maximum number of blocks to be returned by the request.

    Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

    To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

  • StartingBlockIndex (integer) –

    The block index from which the comparison should start.

    The list in the response will start from this block index or the next valid block index in the snapshots.

    If you specify NextToken, then StartingBlockIndex is ignored.

Return type:

dict

Returns:

Response Syntax

{
    'ChangedBlocks': [
        {
            'BlockIndex': 123,
            'FirstBlockToken': 'string',
            'SecondBlockToken': 'string'
        },
    ],
    'ExpiryTime': datetime(2015, 1, 1),
    'VolumeSize': 123,
    'BlockSize': 123,
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ChangedBlocks (list) –

      An array of objects containing information about the changed blocks.

      • (dict) –

        A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.

        • BlockIndex (integer) –

          The block index.

        • FirstBlockToken (string) –

          The block token for the block index of the FirstSnapshotId specified in the ListChangedBlocks operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.

        • SecondBlockToken (string) –

          The block token for the block index of the SecondSnapshotId specified in the ListChangedBlocks operation.

    • ExpiryTime (datetime) –

      The time when the BlockToken expires.

    • VolumeSize (integer) –

      The size of the volume in GB.

    • BlockSize (integer) –

      The size of the blocks in the snapshot, in bytes.

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions