@aws-sdk/client-backup

v3.686.0

AWS SDK for JavaScript Backup Client for Node.js, Browser and React Native For more information about how to use this package see README

Latest version published 8 days ago

License: Apache-2.0

NPM

GitHub

Package Health Score

92 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.686.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.682.0	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.632.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.631.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.405.0	\|	09/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (27,458)

GitHub Stars: 3.04K
Forks: 571
Contributors: 150

Direct Usage Popularity

The npm package @aws-sdk/client-backup receives a total of 27,458 downloads a week. As such, we scored @aws-sdk/client-backup popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @aws-sdk/client-backup, we found that it has been starred 3,044 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 150
Funding: No

A good and healthy external contribution signal for @aws-sdk/client-backup project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 188
Open PR: 15
Last Release: 8 days ago
Last Commit: 2 months ago

Further analysis of the maintenance status of @aws-sdk/client-backup based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @aws-sdk/client-backup demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.0.0

Age: 5 years
Dependencies: 43 Direct
Versions: 418
Install Size: 1.89 MB
Dist-tags: 5
# of Files: 419
Maintainers: 5
TS Typings: No

@aws-sdk/client-backup has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@aws-sdk/client-backup

Description

AWS SDK for JavaScript Backup Client for Node.js, Browser and React Native.

Backup

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Installing

To install this package, simply type add or install @aws-sdk/client-backup using your favorite package manager:

npm install @aws-sdk/client-backup
yarn add @aws-sdk/client-backup
pnpm add @aws-sdk/client-backup

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the BackupClient and the commands you need, for example ListBackupJobsCommand:

// ES5 example
const { BackupClient, ListBackupJobsCommand } = require("@aws-sdk/client-backup");

// ES6+ example
import { BackupClient, ListBackupJobsCommand } from "@aws-sdk/client-backup";

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.

// a client can be shared by different commands.
const client = new BackupClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListBackupJobsCommand(params);

Async/await

We recommend using 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.
}

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) =&gt; {
    // process data.
  },
  (error) =&gt; {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) =&gt; {
    // process data.
  })
  .catch((error) =&gt; {
    // error handling.
  })
  .finally(() =&gt; {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) =&gt; {
  // process err and 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-backup";
const client = new AWS.Backup({ region: "REGION" });

// async/await.
try {
  const data = await client.listBackupJobs(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listBackupJobs(params)
  .then((data) =&gt; {
    // process data.
  })
  .catch((error) =&gt; {
    // error handling.
  });

// callbacks.
client.listBackupJobs(params, (err, data) =&gt; {
  // process err and 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);
  // 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;
   * }
   */
}

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.

Visit Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

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-backup 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.

Client Commands (Operations List)

CancelLegalHold

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (27,458)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@aws-sdk/client-backup

Description

Installing

Getting Started

Import

Usage

Async/await

Promises

Callbacks

v2 compatible style

Troubleshooting

Getting Help

Contributing

License

Client Commands (Operations List)

@aws-sdk/client-backup dependencies

@aws-sdk/client-backup development dependencies

FAQs

What is @aws-sdk/client-backup?

Is @aws-sdk/client-backup popular?

Is @aws-sdk/client-backup well maintained?

Is @aws-sdk/client-backup safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues