Amazon Web Services, Inc.

AWS ARC - Zonal Shift

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…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 15

Zonal shift

  • DELETECancel practice run/practiceruns/:zonalShiftIdCancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.
  • DELETECancel zonal shift/zonalshifts/:zonalShiftIdCancel a zonal shift in Amazon Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID. A zonal shift can be one that you've…
  • PATCHUpdate zonal shift/zonalshifts/:zonalShiftIdUpdate an active zonal shift in Amazon Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new…

Practice run configuration

  • POSTCreate practice run configuration/configurationA practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked…
  • DELETEDelete practice run configuration/configuration/:resourceIdentifierDeletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift…
  • PATCHUpdate practice run configuration/configuration/:resourceIdentifierUpdate a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add,…

Autoshift observer notification

  • GETGet autoshift observer notification status/autoshift-observer-notificationReturns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift…
  • PUTUpdate autoshift observer notification status/autoshift-observer-notificationUpdate the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an…

Managed

  • GETGet managed resource/managedresources/:resourceIdentifierGet information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region.…
  • PUTUpdate zonal autoshift configuration/managedresources/:resourceIdentifierThe zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a…
  • GETList managed resources/managedresources?nextToken=string&maxResults=0Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application…

Autoshift

  • GETList autoshifts/autoshifts?nextToken=string&status=string&maxResults=0Returns the autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status…

Zonal shifts

  • GETList zonal shifts/zonalshifts?nextToken=string&status=string&maxResults=0&resourceIdentifier=stringLists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.…
  • POSTStart zonal shift/zonalshiftsYou start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application…
  • POSTStart practice run/practicerunsStart an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run…

API details

Base URL
https://arc-zonal-shift.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
15 operations on 10 pathsGET 5POST 3DELETE 3PUT 2PATCH 2
Main resources
Managed 3Practice run configuration 3Zonal shift 3Zonal shifts 3Autoshift observer notification 2Autoshift 1
Description format
AWS Smithy model, API version 2022-10-30

How to test the AWS ARC - Zonal Shift in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS ARC - Zonal Shift collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel practice run” (DELETE /practiceruns/:zonalShiftId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS ARC - Zonal Shift?

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… It is listed under Developer tools and has 15 endpoints.

Who publishes the AWS ARC - Zonal Shift?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS ARC - Zonal Shift?

Requests go to https://arc-zonal-shift.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS ARC - Zonal Shift?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS ARC - Zonal Shift have?

15 operations on 10 paths (5 GET, 3 POST, 3 DELETE, 2 PUT, 2 PATCH). The largest groups are Managed, Practice run configuration, Zonal shift, Zonal shifts.

Is forking the AWS ARC - Zonal Shift free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.