CompleteSnapshot

$result = $client->completeSnapshot([/* ... */]);
$promise = $client->completeSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->completeSnapshot([
    'ChangedBlocksCount' => <integer>, // REQUIRED
    'Checksum' => '<string>',
    'ChecksumAggregationMethod' => 'LINEAR',
    'ChecksumAlgorithm' => 'SHA256',
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Status' => 'completed|pending|error',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException:

The specified resource does not exist.

RequestThrottledException:

The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException:

Your current service quotas do not allow you to perform this action.

InternalServerException:

An internal error has occurred. For more information see Error retries.

GetSnapshotBlock

$result = $client->getSnapshotBlock([/* ... */]);
$promise = $client->getSnapshotBlockAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getSnapshotBlock([
    'BlockIndex' => <integer>, // REQUIRED
    'BlockToken' => '<string>', // REQUIRED
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BlockData' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Checksum' => '<string>',
    'ChecksumAlgorithm' => 'SHA256',
    'DataLength' => <integer>,
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException:

The specified resource does not exist.

RequestThrottledException:

The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException:

Your current service quotas do not allow you to perform this action.

InternalServerException:

An internal error has occurred. For more information see Error retries.

ListChangedBlocks

$result = $client->listChangedBlocks([/* ... */]);
$promise = $client->listChangedBlocksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listChangedBlocks([
    'FirstSnapshotId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SecondSnapshotId' => '<string>', // REQUIRED
    'StartingBlockIndex' => <integer>,
]);

Parameter Details

Result Syntax

[
    'BlockSize' => <integer>,
    'ChangedBlocks' => [
        [
            'BlockIndex' => <integer>,
            'FirstBlockToken' => '<string>',
            'SecondBlockToken' => '<string>',
        ],
        // ...
    ],
    'ExpiryTime' => <DateTime>,
    'NextToken' => '<string>',
    'VolumeSize' => <integer>,
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException:

The specified resource does not exist.

RequestThrottledException:

The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException:

Your current service quotas do not allow you to perform this action.

InternalServerException:

An internal error has occurred. For more information see Error retries.

ListSnapshotBlocks

$result = $client->listSnapshotBlocks([/* ... */]);
$promise = $client->listSnapshotBlocksAsync([/* ... */]);

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

Parameter Syntax

$result = $client->listSnapshotBlocks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SnapshotId' => '<string>', // REQUIRED
    'StartingBlockIndex' => <integer>,
]);

Parameter Details

Result Syntax

[
    'BlockSize' => <integer>,
    'Blocks' => [
        [
            'BlockIndex' => <integer>,
            'BlockToken' => '<string>',
        ],
        // ...
    ],
    'ExpiryTime' => <DateTime>,
    'NextToken' => '<string>',
    'VolumeSize' => <integer>,
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException:

The specified resource does not exist.

RequestThrottledException:

The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException:

Your current service quotas do not allow you to perform this action.

InternalServerException:

An internal error has occurred. For more information see Error retries.

PutSnapshotBlock

$result = $client->putSnapshotBlock([/* ... */]);
$promise = $client->putSnapshotBlockAsync([/* ... */]);

Writes a block of data to a snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-KiB sectors.

Parameter Syntax

$result = $client->putSnapshotBlock([
    'BlockData' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'BlockIndex' => <integer>, // REQUIRED
    'Checksum' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'SHA256', // REQUIRED
    'DataLength' => <integer>, // REQUIRED
    'Progress' => <integer>,
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Checksum' => '<string>',
    'ChecksumAlgorithm' => 'SHA256',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints of the EBS direct APIs.

ResourceNotFoundException:

The specified resource does not exist.

RequestThrottledException:

The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ServiceQuotaExceededException:

Your current service quotas do not allow you to perform this action.

InternalServerException:

An internal error has occurred. For more information see Error retries.

StartSnapshot

$result = $client->startSnapshot([/* ... */]);
$promise = $client->startSnapshotAsync([/* ... */]);

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

Parameter Syntax

$result = $client->startSnapshot([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Encrypted' => true || false,
    'KmsKeyArn' => '<string>',
    'ParentSnapshotId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Timeout' => <integer>,
    'VolumeSize' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BlockSize' => <integer>,
    'Description' => '<string>',
    'KmsKeyArn' => '<string>',
    'OwnerId' => '<string>',
    'ParentSnapshotId' => '<string>',
    'SnapshotId' => '<string>',
    'SseType' => 'sse-ebs|sse-kms|none',
    'StartTime' => <DateTime>,
    'Status' => 'completed|pending|error',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VolumeSize' => <integer>,
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints of the EBS direct APIs.

RequestThrottledException:

The number of API requests has exceeded the maximum allowed API request throttling limit for the snapshot. For more information see Error retries.

ResourceNotFoundException:

The specified resource does not exist.

ServiceQuotaExceededException:

Your current service quotas do not allow you to perform this action.

InternalServerException:

An internal error has occurred. For more information see Error retries.

ConcurrentLimitExceededException:

You have reached the limit for concurrent API requests. For more information, see Optimizing performance of the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

ConflictException:

The request uses the same client token as a previous, but non-identical request.