Amazon Web Services - API Amazon Elastic Block Store

Amazon Web Services / Amazon Elastic Block Store

Amazon Elastic Block Store

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.

License: Apache 2.0 License

Resources

GET

/snapshots/{secondSnapshotId}/changedblocks

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.

Request

Path

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.

Query

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.

Header

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

Responses

200Success

Body

Name	Data Type	Description
`ListChangedBlocksResponse`	object

Properties


                        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.

PageToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockSize

BlockSize

The size of the block.

BlockSize integer


                        VolumeSize

VolumeSize

The size of the volume in GB.

VolumeSize integer


                        ExpiryTime

TimeStamp

The time when the block token expires.

TimeStamp dateTime


                        ChangedBlocks

ChangedBlocks

An array of objects containing information about the changed blocks.

ChangedBlocks array [ChangedBlock]


                        ChangedBlock

object

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

Properties

`SecondBlockToken`	BlockToken	The block token for the block index of the `second snapshot ID` specified in the `list changed blocks` operation.
`FirstBlockToken`	BlockToken	The block token for the block index of the `first snapshot ID` specified in the `list changed blocks` operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.
`BlockIndex`	BlockIndex	The block index.

480ValidationException

Body

Name	Data Type	Description
`ValidationException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

GET

/snapshots/{snapshotId}/blocks/{blockIndex}#blockToken

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

Request

Path

Name	Data Type	Description
`blockIndex`	integer	The block index of the block from which to get data. Obtain the `block index` by running the `list changed blocks` or `list snapshot blocks` operations.
`snapshotId`	string Pattern: `^snap-[0-9a-f]+$` Minimum: 1 Maximum: 64	The ID of the snapshot containing the block from which to get data.

Query

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 `block token` by running the `list changed blocks` or `list snapshot blocks` operations.

Header

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

Responses

200Success

Body

Name	Data Type	Description
`GetSnapshotBlockResponse`	object

Properties


                        BlockData

BlockData

The data content of the block.

BlockData password

480ValidationException

Body

Name	Data Type	Description
`ValidationException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

GET

/snapshots/{snapshotId}/blocks

Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

Request

Path

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.

Query

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.

Header

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

Responses

200Success

Body

Name	Data Type	Description
`ListSnapshotBlocksResponse`	object

Properties


                        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.

PageToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockSize

BlockSize

The size of the block.

BlockSize integer


                        VolumeSize

VolumeSize

The size of the volume in GB.

VolumeSize integer


                        ExpiryTime

TimeStamp

The time when the block token expires.

TimeStamp dateTime


                        Blocks

Blocks

An array of objects containing information about the blocks.

Blocks array [Block]


                        Block

object

A block of data in an Amazon Elastic Block Store snapshot.

Properties

`BlockToken`	BlockToken	The block token for the block index.
`BlockIndex`	BlockIndex	The block index.

480ValidationException

Body

Name	Data Type	Description
`ValidationException`

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`

Models

Block

BlockData

Name	Data Type	Description
`BlockData`	password

BlockIndex

Name	Data Type	Description
`BlockIndex`	integer

BlockSize

Name	Data Type	Description
`BlockSize`	integer

BlockToken

Name	Data Type	Description
`BlockToken`	string Pattern: `^[A-Za-z0-9+/=]+$` Maximum: 256

Blocks

Name Data Type Description

Blocks array [Block]


                        Block

object

A block of data in an Amazon Elastic Block Store snapshot.

Properties


                        BlockToken

BlockToken

The block token for the block index.

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockIndex

BlockIndex

The block index.

BlockIndex integer

ChangedBlock

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

Properties

Name Data Type Description


                        SecondBlockToken

BlockToken

The block token for the block index of the second snapshot ID specified in the list changed blocks operation.

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        FirstBlockToken

BlockToken

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

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockIndex

BlockIndex

The block index.

BlockIndex integer

ChangedBlocks

Name Data Type Description

ChangedBlocks array [ChangedBlock]


                        ChangedBlock

object

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

Properties


                        SecondBlockToken

BlockToken

The block token for the block index of the second snapshot ID specified in the list changed blocks operation.

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        FirstBlockToken

BlockToken

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockIndex

BlockIndex

The block index.

BlockIndex integer

Checksum

ChecksumAlgorithm

DataLength

GetSnapshotBlockRequest

GetSnapshotBlockResponse

ListChangedBlocksRequest

ListChangedBlocksResponse

Properties

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.

PageToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockSize

BlockSize

The size of the block.

BlockSize integer


                        VolumeSize

VolumeSize

The size of the volume in GB.

VolumeSize integer


                        ExpiryTime

TimeStamp

The time when the block token expires.

TimeStamp dateTime


                        ChangedBlocks

ChangedBlocks

An array of objects containing information about the changed blocks.

ChangedBlocks array [ChangedBlock]


                        ChangedBlock

object

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

Properties


                        SecondBlockToken

BlockToken

The block token for the block index of the second snapshot ID specified in the list changed blocks operation.

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        FirstBlockToken

BlockToken

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockIndex

BlockIndex

The block index.

BlockIndex integer

ListSnapshotBlocksRequest

ListSnapshotBlocksResponse

Properties

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.

PageToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockSize

BlockSize

The size of the block.

BlockSize integer


                        VolumeSize

VolumeSize

The size of the volume in GB.

VolumeSize integer


                        ExpiryTime

TimeStamp

The time when the block token expires.

TimeStamp dateTime


                        Blocks

Blocks

An array of objects containing information about the blocks.

Blocks array [Block]


                        Block

object

A block of data in an Amazon Elastic Block Store snapshot.

Properties


                        BlockToken

BlockToken

The block token for the block index.

BlockToken string
Pattern: ^[A-Za-z0-9+/=]+$
Maximum: 256


                        BlockIndex

BlockIndex

The block index.

BlockIndex integer

MaxResults

PageToken

ResourceNotFoundException

SnapshotId

TimeStamp

ValidationException

VolumeSize

Authentication

Api Key

Amazon Signature authorization v4

Location: header
Header Name: Authorization
Amazon-apigateway-authtype: awsSigv4

Contact

Name	`AWS`
External URL	`https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html`

Metadata (Technical Details)

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	[ { "url": "http://ebs.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1" ], "default": "us-east-1" } }, "description": "The Amazon EBS multi-region endpoint" }, { "url": "https://ebs.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1" ], "default": "us-east-1" } }, "description": "The Amazon EBS multi-region endpoint" }, { "url": "http://ebs.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon EBS endpoint for China (Beijing) and China (Ningxia)" }, { "url": "https://ebs.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The Amazon EBS endpoint for China (Beijing) and China (Ningxia)" } ]

Comments

Loading comments ...