@aws-sdk/client-arc-zonal-shift

Description

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

Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Application Recovery Controller (ARC).

You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.

You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.

For more information about using zonal shift and zonal autoshift, see the Amazon Application Recovery Controller Developer Guide.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { ARCZonalShiftClient, ListAutoshiftsCommand } = require("@aws-sdk/client-arc-zonal-shift");
`

`ts
// ES6+ example
import { ARCZonalShiftClient, ListAutoshiftsCommand } from "@aws-sdk/client-arc-zonal-shift";
`

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

const params = { /* input parameters / };
const command = new ListAutoshiftsCommand(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-zonal-shift";
const client = new AWS.ARCZonalShift({ region: "REGION" });

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

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

// callbacks.
client.listAutoshifts(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-zonal-shift` 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)

CancelPracticeRun

Command API Reference / Input / Output

CancelZonalShift

Command API Reference / Input / Output

CreatePracticeRunConfiguration

Command API Reference / Input / Output

DeletePracticeRunConfiguration

Command API Reference / Input / Output

GetAutoshiftObserverNotificationStatus

Command API Reference / Input / Output

GetManagedResource

Command API Reference / Input / Output

ListAutoshifts

Command API Reference / Input / Output

ListManagedResources

Command API Reference / Input / Output

ListZonalShifts

Command API Reference / Input / Output

StartPracticeRun

Command API Reference / Input / Output

StartZonalShift

Command API Reference / Input / Output

UpdateAutoshiftObserverNotificationStatus

Command API Reference / Input / Output

UpdatePracticeRunConfiguration

Command API Reference / Input / Output

UpdateZonalAutoshiftConfiguration

Command API Reference / Input / Output

UpdateZonalShift

Command API Reference / Input / Output