@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

$3

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:

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

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

$3

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.

`js
// 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:

`js
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

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

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

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

`js
// callbacks.
client.send(command, (err, data) => {
// 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

`ts
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) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listBackupJobs(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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)

AssociateBackupVaultMpaApprovalTeam

Command API Reference / Input / Output

CancelLegalHold

Command API Reference / Input / Output

CreateBackupPlan

Command API Reference / Input / Output

CreateBackupSelection

Command API Reference / Input / Output

CreateBackupVault

Command API Reference / Input / Output

CreateFramework

Command API Reference / Input / Output

CreateLegalHold

Command API Reference / Input / Output

CreateLogicallyAirGappedBackupVault

Command API Reference / Input / Output

CreateReportPlan

Command API Reference / Input / Output

CreateRestoreAccessBackupVault

Command API Reference / Input / Output

CreateRestoreTestingPlan

Command API Reference / Input / Output

CreateRestoreTestingSelection

Command API Reference / Input / Output

CreateTieringConfiguration

Command API Reference / Input / Output

DeleteBackupPlan

Command API Reference / Input / Output

DeleteBackupSelection

Command API Reference / Input / Output

DeleteBackupVault

Command API Reference / Input / Output

DeleteBackupVaultAccessPolicy

Command API Reference / Input / Output

DeleteBackupVaultLockConfiguration

Command API Reference / Input / Output

DeleteBackupVaultNotifications

Command API Reference / Input / Output

DeleteFramework

Command API Reference / Input / Output

DeleteRecoveryPoint

Command API Reference / Input / Output

DeleteReportPlan

Command API Reference / Input / Output

DeleteRestoreTestingPlan

Command API Reference / Input / Output

DeleteRestoreTestingSelection

Command API Reference / Input / Output

DeleteTieringConfiguration

Command API Reference / Input / Output

DescribeBackupJob

Command API Reference / Input / Output

DescribeBackupVault

Command API Reference / Input / Output

DescribeCopyJob

Command API Reference / Input / Output

DescribeFramework

Command API Reference / Input / Output

DescribeGlobalSettings

Command API Reference / Input / Output

DescribeProtectedResource

Command API Reference / Input / Output

DescribeRecoveryPoint

Command API Reference / Input / Output

DescribeRegionSettings

Command API Reference / Input / Output

DescribeReportJob

Command API Reference / Input / Output

DescribeReportPlan

Command API Reference / Input / Output

DescribeRestoreJob

Command API Reference / Input / Output

DescribeScanJob

Command API Reference / Input / Output

DisassociateBackupVaultMpaApprovalTeam

Command API Reference / Input / Output

DisassociateRecoveryPoint

Command API Reference / Input / Output

DisassociateRecoveryPointFromParent

Command API Reference / Input / Output

ExportBackupPlanTemplate

Command API Reference / Input / Output

GetBackupPlan

Command API Reference / Input / Output

GetBackupPlanFromJSON

Command API Reference / Input / Output

GetBackupPlanFromTemplate

Command API Reference / Input / Output

GetBackupSelection

Command API Reference / Input / Output

GetBackupVaultAccessPolicy

Command API Reference / Input / Output

GetBackupVaultNotifications

Command API Reference / Input / Output

GetLegalHold

Command API Reference / Input / Output

GetRecoveryPointIndexDetails

Command API Reference / Input / Output

GetRecoveryPointRestoreMetadata

Command API Reference / Input / Output

GetRestoreJobMetadata

Command API Reference / Input / Output

GetRestoreTestingInferredMetadata

Command API Reference / Input / Output

GetRestoreTestingPlan

Command API Reference / Input / Output

GetRestoreTestingSelection

Command API Reference / Input / Output

GetSupportedResourceTypes

Command API Reference / Input / Output

GetTieringConfiguration

Command API Reference / Input / Output

ListBackupJobs

Command API Reference / Input / Output

ListBackupJobSummaries

Command API Reference / Input / Output

ListBackupPlans

Command API Reference / Input / Output

ListBackupPlanTemplates

Command API Reference / Input / Output

ListBackupPlanVersions

Command API Reference / Input / Output

ListBackupSelections

Command API Reference / Input / Output

ListBackupVaults

Command API Reference / Input / Output

ListCopyJobs

Command API Reference / Input / Output

ListCopyJobSummaries

Command API Reference / Input / Output

ListFrameworks

Command API Reference / Input / Output

ListIndexedRecoveryPoints

Command API Reference / Input / Output

ListLegalHolds

Command API Reference / Input / Output

ListProtectedResources

Command API Reference / Input / Output

ListProtectedResourcesByBackupVault

Command API Reference / Input / Output

ListRecoveryPointsByBackupVault

Command API Reference / Input / Output

ListRecoveryPointsByLegalHold

Command API Reference / Input / Output

ListRecoveryPointsByResource

Command API Reference / Input / Output

ListReportJobs

Command API Reference / Input / Output

ListReportPlans

Command API Reference / Input / Output

ListRestoreAccessBackupVaults

Command API Reference / Input / Output

ListRestoreJobs

Command API Reference / Input / Output

ListRestoreJobsByProtectedResource

Command API Reference / Input / Output

ListRestoreJobSummaries

Command API Reference / Input / Output

ListRestoreTestingPlans

Command API Reference / Input / Output

ListRestoreTestingSelections

Command API Reference / Input / Output

ListScanJobs

Command API Reference / Input / Output

ListScanJobSummaries

Command API Reference / Input / Output

ListTags

Command API Reference / Input / Output

ListTieringConfigurations

Command API Reference / Input / Output

PutBackupVaultAccessPolicy

Command API Reference / Input / Output

PutBackupVaultLockConfiguration

Command API Reference / Input / Output

PutBackupVaultNotifications

Command API Reference / Input / Output

PutRestoreValidationResult

Command API Reference / Input / Output

RevokeRestoreAccessBackupVault

Command API Reference / Input / Output

StartBackupJob

Command API Reference / Input / Output

StartCopyJob

Command API Reference / Input / Output

StartReportJob

Command API Reference / Input / Output

StartRestoreJob

Command API Reference / Input / Output

StartScanJob

Command API Reference / Input / Output

StopBackupJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateBackupPlan

Command API Reference / Input / Output

UpdateFramework

Command API Reference / Input / Output

UpdateGlobalSettings

Command API Reference / Input / Output

UpdateRecoveryPointIndexSettings

Command API Reference / Input / Output

UpdateRecoveryPointLifecycle

Command API Reference / Input / Output

UpdateRegionSettings

Command API Reference / Input / Output

UpdateReportPlan

Command API Reference / Input / Output

UpdateRestoreTestingPlan

Command API Reference / Input / Output

UpdateRestoreTestingSelection

Command API Reference / Input / Output

UpdateTieringConfiguration

Command API Reference / Input / Output