clients/client-ebs/README.md
AWS SDK for JavaScript EBS Client for Node.js, Browser and React Native.
<p>You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to your snapshots, read data on your snapshots, and identify the differences or changes between two snapshots. If you’re an independent software vendor (ISV) who offers backup services for Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on your Amazon EBS volumes through snapshots. This can be done without having to create new volumes from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p> <p>You can create incremental snapshots directly from data on-premises into volumes and the cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can write your on-premises data to an snapshot during a disaster. Then after recovery, you can restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and maintain complex mechanisms to copy data to and from Amazon EBS.</p> <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html">Accessing the Contents of an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas for the EBS direct APIs, see <a href="https://docs.aws.amazon.com/general/latest/gr/ebs-service.html">Amazon Elastic Block Store Endpoints and Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>To install this package, use the CLI of your favorite package manager:
npm install @aws-sdk/client-ebsyarn add @aws-sdk/client-ebspnpm add @aws-sdk/client-ebsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the EBSClient and
the commands you need, for example ListChangedBlocksCommand:
// ES5 example
const { EBSClient, ListChangedBlocksCommand } = require("@aws-sdk/client-ebs");
// ES6+ example
import { EBSClient, ListChangedBlocksCommand } from "@aws-sdk/client-ebs";
To send a request:
send operation on the client, providing the command object as input.const client = new EBSClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListChangedBlocksCommand(params);
We recommend using the await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
You can also use Promise chaining.
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
The aggregated client class is exported from the same package, but without the "Client" suffix.
EBS extends EBSClient and additionally supports all operations, waiters, and paginators as methods.
This style may be familiar to you from the AWS SDK for JavaScript v2.
If you are bundling the AWS SDK, we recommend using only the bare-bones client (EBSClient).
More details are in the blog post on
modular packages in AWS SDK for JavaScript.
import { EBS } from "@aws-sdk/client-ebs";
const client = new EBS({ region: "REGION" });
// async/await.
try {
const data = await client.listChangedBlocks(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listChangedBlocks(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listChangedBlocks(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
See also docs/ERROR_HANDLING.
Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-ebs package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
Command API Reference / Input / Output
</details> <details> <summary> GetSnapshotBlock </summary>Command API Reference / Input / Output
</details> <details> <summary> ListChangedBlocks </summary>Command API Reference / Input / Output
</details> <details> <summary> ListSnapshotBlocks </summary>Command API Reference / Input / Output
</details> <details> <summary> PutSnapshotBlock </summary> </details> <details> <summary> StartSnapshot </summary> </details>