EBS / Client / complete_snapshot

complete_snapshot#

EBS.Client.complete_snapshot(**kwargs)#

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

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.complete_snapshot(
    SnapshotId='string',
    ChangedBlocksCount=123,
    Checksum='string',
    ChecksumAlgorithm='SHA256',
    ChecksumAggregationMethod='LINEAR'
)
Parameters:

  • SnapshotId (string) –

    [REQUIRED]

    The ID of the snapshot.

  • ChangedBlocksCount (integer) –

    [REQUIRED]

    The number of blocks that were written to the snapshot.

  • Checksum (string) –

    An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

    To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

  • ChecksumAlgorithm (string) – The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

  • ChecksumAggregationMethod (string) – The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'completed'|'pending'|'error'
}

Response Structure

  • (dict) –

    • Status (string) –

      The status of the snapshot.

Exceptions

  • EBS.Client.exceptions.AccessDeniedException

  • EBS.Client.exceptions.ValidationException

  • EBS.Client.exceptions.ResourceNotFoundException

  • EBS.Client.exceptions.RequestThrottledException

  • EBS.Client.exceptions.ServiceQuotaExceededException

  • EBS.Client.exceptions.InternalServerException