You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs makes it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots, and then use EC2 instances to compare the differences.
This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot. For more information about how to use the EBS direct APIs, see the EBS direct APIs User Guide. To view the currently supported AWS Regions and endpoints for the EBS direct APIs, see AWS Service Endpoints in the AWS General Reference.
Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.
Name | Data Type | Description |
---|---|---|
secondSnapshotId
|
string Pattern: ^snap-[0-9a-f]+$ Minimum: 1 Maximum: 64 |
The ID of the second snapshot to use for the comparison. |
Name | Data Type | Description |
---|---|---|
NextToken
|
string |
Pagination token |
MaxResults
|
string |
Pagination limit |
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. |
maxResults
|
integer Minimum: 100 Maximum: 10000 |
The number of results to return. |
pageToken
|
string Pattern: ^[A-Za-z0-9+/=]+$ Maximum: 256 |
The token to request the next page of results. |
firstSnapshotId
|
string Pattern: ^snap-[0-9a-f]+$ Minimum: 1 Maximum: 64 |
The ID of the first snapshot to use for the comparison. |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListChangedBlocksResponse
|
object |
NextToken
|
PageToken |
The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
||||||||||||||||||||
|
||||||||||||||||||||||
BlockSize
|
BlockSize |
The size of the block. |
||||||||||||||||||||
|
||||||||||||||||||||||
VolumeSize
|
VolumeSize |
The size of the volume in GB. |
||||||||||||||||||||
|
||||||||||||||||||||||
ExpiryTime
|
TimeStamp |
The time when the |
||||||||||||||||||||
|
||||||||||||||||||||||
ChangedBlocks
|
ChangedBlocks |
An array of objects containing information about the changed blocks. |
||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ValidationException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Returns the data in a block in an Amazon Elastic Block Store snapshot.
Name | Data Type | Description |
---|---|---|
blockIndex
|
integer |
The block index of the block from which to get data. Obtain the |
snapshotId
|
string Pattern: ^snap-[0-9a-f]+$ Minimum: 1 Maximum: 64 |
The ID of the snapshot containing the block from which to get data. |
Name | Data Type | Description |
---|---|---|
blockToken
|
string Pattern: ^[A-Za-z0-9+/=]+$ Maximum: 256 |
The block token of the block from which to get data. Obtain the |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetSnapshotBlockResponse
|
object |
BlockData
|
BlockData |
The data content of the block. |
||||
|
Name | Data Type | Description |
---|---|---|
ValidationException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.
Name | Data Type | Description |
---|---|---|
snapshotId
|
string Pattern: ^snap-[0-9a-f]+$ Minimum: 1 Maximum: 64 |
The ID of the snapshot from which to get block indexes and block tokens. |
Name | Data Type | Description |
---|---|---|
NextToken
|
string |
Pagination token |
MaxResults
|
string |
Pagination limit |
startingBlockIndex
|
integer |
The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot. |
maxResults
|
integer Minimum: 100 Maximum: 10000 |
The number of results to return. |
pageToken
|
string Pattern: ^[A-Za-z0-9+/=]+$ Maximum: 256 |
The token to request the next page of results. |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListSnapshotBlocksResponse
|
object |
NextToken
|
PageToken |
The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
|||||||||||||||||
|
|||||||||||||||||||
BlockSize
|
BlockSize |
The size of the block. |
|||||||||||||||||
|
|||||||||||||||||||
VolumeSize
|
VolumeSize |
The size of the volume in GB. |
|||||||||||||||||
|
|||||||||||||||||||
ExpiryTime
|
TimeStamp |
The time when the |
|||||||||||||||||
|
|||||||||||||||||||
Blocks
|
Blocks |
An array of objects containing information about the blocks. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ValidationException
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
A block of data in an Amazon Elastic Block Store snapshot.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
BlockToken
|
BlockToken |
The block token for the block index. |
||||
|
||||||
BlockIndex
|
BlockIndex |
The block index. |
||||
|
Name | Data Type | Description |
---|---|---|
BlockData
|
password |
Name | Data Type | Description |
---|---|---|
BlockIndex
|
integer |
Name | Data Type | Description |
---|---|---|
BlockSize
|
integer |
Name | Data Type | Description |
---|---|---|
BlockToken
|
string Pattern: ^[A-Za-z0-9+/=]+$ Maximum: 256 |
Name | Data Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Blocks
|
array [Block] | |||||||||||||||||||||||||
Properties
|
A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
SecondBlockToken
|
BlockToken |
The block token for the block index of the |
||||
|
||||||
FirstBlockToken
|
BlockToken |
The block token for the block index of the |
||||
|
||||||
BlockIndex
|
BlockIndex |
The block index. |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ChangedBlocks
|
array [ChangedBlock] | |||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Checksum
|
string Maximum: 64 |
Name | Data Type | Description |
---|---|---|
ChecksumAlgorithm
|
string Allowed values: - SHA256 Maximum: 32 |
Name | Data Type | Description |
---|---|---|
DataLength
|
integer |
Name | Data Type | Description |
---|---|---|
GetSnapshotBlockRequest
|
object |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
BlockData
|
BlockData |
The data content of the block. |
||||
|
Name | Data Type | Description |
---|---|---|
ListChangedBlocksRequest
|
object |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NextToken
|
PageToken |
The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
BlockSize
|
BlockSize |
The size of the block. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
VolumeSize
|
VolumeSize |
The size of the volume in GB. |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
ExpiryTime
|
TimeStamp |
The time when the |
|||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||
ChangedBlocks
|
ChangedBlocks |
An array of objects containing information about the changed blocks. |
|||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ListSnapshotBlocksRequest
|
object |
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NextToken
|
PageToken |
The token to use to retrieve the next page of results. This value is null when there are no more results to return. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
BlockSize
|
BlockSize |
The size of the block. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
VolumeSize
|
VolumeSize |
The size of the volume in GB. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
ExpiryTime
|
TimeStamp |
The time when the |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
Blocks
|
Blocks |
An array of objects containing information about the blocks. |
|||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
MaxResults
|
integer Minimum: 100 Maximum: 10000 |
Name | Data Type | Description |
---|---|---|
PageToken
|
string Pattern: ^[A-Za-z0-9+/=]+$ Maximum: 256 |
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
Name | Data Type | Description |
---|---|---|
SnapshotId
|
string Pattern: ^snap-[0-9a-f]+$ Minimum: 1 Maximum: 64 |
Name | Data Type | Description |
---|---|---|
TimeStamp
|
dateTime |
Name | Data Type | Description |
---|---|---|
ValidationException
|
Name | Data Type | Description |
---|---|---|
VolumeSize
|
integer |
Amazon Signature authorization v4
header
Authorization
awsSigv4
Name | AWS |
External URL | https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html |
Release | v4 |
Provider Name | amazonaws.com |
Service Name | ebs |
Origin - ContentType | application/json |
Origin - Url | https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ebs-2019-11-02.normal.json |
Origin - X-apisguru-driver | external |
Api Client Registration | https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct |
Preferred | Yes |
API Version | 2019-11-02 |
Servers |
|