@aws-sdk/client-arc-region-switch

Description

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

Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.

Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.

For more information, see Region switch in ARC in the Amazon Application Recovery Controller User Guide.

Installing

To install this package, simply type add or install @aws-sdk/client-arc-region-switch
using your favorite package manager:
- npm install @aws-sdk/client-arc-region-switch
- yarn add @aws-sdk/client-arc-region-switch
- pnpm add @aws-sdk/client-arc-region-switch

Getting Started

$3

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

``js
// ES5 example
const { ARCRegionSwitchClient, ListPlansCommand } = require("@aws-sdk/client-arc-region-switch");
`

`ts
// ES6+ example
import { ARCRegionSwitchClient, ListPlansCommand } from "@aws-sdk/client-arc-region-switch";
`

$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 ARCRegionSwitchClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListPlansCommand(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-arc-region-switch";
const client = new AWS.ARCRegionSwitch({ region: "REGION" });

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

// Promises.
client
.listPlans(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listPlans(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-arc-region-switch` 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)

ApprovePlanExecutionStep

Command API Reference / Input / Output

CancelPlanExecution

Command API Reference / Input / Output

CreatePlan

Command API Reference / Input / Output

DeletePlan

Command API Reference / Input / Output

GetPlan

Command API Reference / Input / Output

GetPlanEvaluationStatus

Command API Reference / Input / Output

GetPlanExecution

Command API Reference / Input / Output

GetPlanInRegion

Command API Reference / Input / Output

ListPlanExecutionEvents

Command API Reference / Input / Output

ListPlanExecutions

Command API Reference / Input / Output

ListPlans

Command API Reference / Input / Output

ListPlansInRegion

Command API Reference / Input / Output

ListRoute53HealthChecks

Command API Reference / Input / Output

ListRoute53HealthChecksInRegion

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartPlanExecution

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdatePlan

Command API Reference / Input / Output

UpdatePlanExecution

Command API Reference / Input / Output

UpdatePlanExecutionStep

Command API Reference / Input / Output