ARC - Region switch
Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to…
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
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. 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 .
Endpoints 22
Region switch plan
- POSTCreate plan
/#X-Amz-Target=ArcRegionSwitch.CreatePlanCreates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another. You must specify a name… - POSTDelete plan
/#X-Amz-Target=ArcRegionSwitch.DeletePlanDeletes a Region switch plan. You must specify the ARN of the plan to delete. You cannot delete a plan that has an active execution in progress. - POSTGet plan
/#X-Amz-Target=ArcRegionSwitch.GetPlanRetrieves detailed information about a Region switch plan. You must specify the ARN of the plan. - POSTList plans
/#X-Amz-Target=ArcRegionSwitch.ListPlansLists all Region switch plans in your Amazon Web Services account. - POSTList tags for resource
/#X-Amz-Target=ArcRegionSwitch.ListTagsForResourceLists the tags attached to a Region switch resource. - POSTTag resource
/#X-Amz-Target=ArcRegionSwitch.TagResourceAdds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs. - POSTUntag resource
/#X-Amz-Target=ArcRegionSwitch.UntagResourceRemoves tags from a Region switch resource. - POSTUpdate plan
/#X-Amz-Target=ArcRegionSwitch.UpdatePlanUpdates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and…
- POSTApprove plan execution step
/#X-Amz-Target=ArcRegionSwitch.ApprovePlanExecutionStepApproves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention… - POSTCancel plan execution
/#X-Amz-Target=ArcRegionSwitch.CancelPlanExecutionCancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed. You must specify… - POSTGet plan evaluation status
/#X-Amz-Target=ArcRegionSwitch.GetPlanEvaluationStatusRetrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any… - POSTGet plan execution
/#X-Amz-Target=ArcRegionSwitch.GetPlanExecutionRetrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID. - POSTGet plan in region
/#X-Amz-Target=ArcRegionSwitch.GetPlanInRegionRetrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information… - POSTList plan execution events
/#X-Amz-Target=ArcRegionSwitch.ListPlanExecutionEventsLists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process. - POSTList plan executions
/#X-Amz-Target=ArcRegionSwitch.ListPlanExecutionsLists the executions of a Region switch plan. This operation returns information about both current and historical executions. - POSTList plans in region
/#X-Amz-Target=ArcRegionSwitch.ListPlansInRegionLists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region. - POSTList route53 health checks
/#X-Amz-Target=ArcRegionSwitch.ListRoute53HealthChecksList the Amazon Route 53 health checks. - POSTList route53 health checks in region
/#X-Amz-Target=ArcRegionSwitch.ListRoute53HealthChecksInRegionList the Amazon Route 53 health checks in a specific Amazon Web Services Region. - POSTList service quota warnings
/#X-Amz-Target=ArcRegionSwitch.ListServiceQuotaWarningsLists the service quota warnings for the plans that you can access. Region switch creates a warning when the applied quota value in one Region of a plan is… - POSTStart plan execution
/#X-Amz-Target=ArcRegionSwitch.StartPlanExecutionStarts the execution of a Region switch plan. You can execute a plan in either graceful or ungraceful mode. Specifing ungraceful mode either changes the… - POSTUpdate plan execution
/#X-Amz-Target=ArcRegionSwitch.UpdatePlanExecutionUpdates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action. - POSTUpdate plan execution step
/#X-Amz-Target=ArcRegionSwitch.UpdatePlanExecutionStepUpdates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.
API details
- Base URL
https://arc-region-switch.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 22 operations on 22 pathsPOST 22
- Main resources
- Region switch plan 8
- Description format
- AWS Smithy model, API version
2022-07-26 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the ARC - Region switch in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ARC - Region switch collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Create plan” (POST /#X-Amz-Target=ArcRegionSwitch.CreatePlan), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ARC - Region switch?
Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to… It is listed under Developer tools and has 22 endpoints.
Who publishes the ARC - Region switch?
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 ARC - Region switch?
Requests go to https://arc-region-switch.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the ARC - Region switch?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the ARC - Region switch have?
22 operations on 22 paths (22 POST). The largest groups are Region switch plan.
Is forking the ARC - Region switch free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.