Amazon Elastic Block Store


RELEASED
2019-11-02 - Released at 2019-11-02 00:00

v4 from 2019-11-02

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
GET
/snapshots/{snapshotId}/blocks/{blockIndex}#blockToken
GET
/snapshots/{snapshotId}/blocks

Models

BlockData
BlockSize
Blocks
ChangedBlocks
GetSnapshotBlockResponse
ListChangedBlocksResponse
ListSnapshotBlocksResponse
PageToken
ResourceNotFoundException
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 ...