@aws-sdk/client-rbin
![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-rbin.svg)
Description
AWS SDK for JavaScript Rbin Client for Node.js, Browser and React Native.
This is the Recycle Bin API Reference. This documentation provides
descriptions and syntax for each of the actions and data types in Recycle Bin.
Recycle Bin is a resource recovery feature that enables you to restore accidentally
deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are
deleted, they are retained in the Recycle Bin for a time period that you specify.
You can restore a resource from the Recycle Bin at any time before its retention period
expires. After you restore a resource from the Recycle Bin, the resource is removed from the
Recycle Bin, and you can then use it in the same way you use any other resource of that type
in your account. If the retention period expires and the resource is not restored, the resource
is permanently deleted from the Recycle Bin and is no longer available for recovery. For more
information about Recycle Bin, see
Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
Installing
To install the this package, simply type add or install @aws-sdk/client-rbin
using your favorite package manager:
npm install @aws-sdk/client-rbin
yarn add @aws-sdk/client-rbin
pnpm add @aws-sdk/client-rbin
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the RbinClient
and
the commands you need, for example CreateRuleCommand
:
const { RbinClient, CreateRuleCommand } = require("@aws-sdk/client-rbin");
import { RbinClient, CreateRuleCommand } from "@aws-sdk/client-rbin";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new RbinClient({ region: "REGION" });
const params = {
};
const command = new CreateRuleCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-rbin";
const client = new AWS.Rbin({ region: "REGION" });
try {
const data = await client.createRule(params);
} catch (error) {
}
client
.createRule(params)
.then((data) => {
})
.catch((error) => {
});
client.createRule(params, (err, data) => {
});
Troubleshooting
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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-rbin
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.