Amazon Web Services, Inc.

Elastic Disaster Recovery Service

AWS Elastic Disaster Recovery Service.

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

AWS Elastic Disaster Recovery Service.

Endpoints 70

Source network

  • POSTAssociate source network stack/AssociateSourceNetworkStackAssociate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously…
  • POSTCreate source network/CreateSourceNetworkCreate a new Source Network resource for a provided VPC ID.
  • POSTDelete source network/DeleteSourceNetworkDelete Source Network resource.
  • POSTDescribe source networks/DescribeSourceNetworksLists all Source Networks or multiple Source Networks filtered by ID.
  • POSTExport source network cfn template/ExportSourceNetworkCfnTemplateExport the Source Network CloudFormation template to an S3 bucket.
  • POSTStart source network recovery/StartSourceNetworkRecoveryDeploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.
  • POSTStart source network replication/StartSourceNetworkReplicationStarts replication for a Source Network. This action would make the Source Network protected.
  • POSTStop source network replication/StopSourceNetworkReplicationStops replication for a Source Network. This action would make the Source Network unprotected.

Launch configuration template

  • POSTCreate launch configuration template/CreateLaunchConfigurationTemplateCreates a new Launch Configuration Template.
  • POSTDelete launch configuration template/DeleteLaunchConfigurationTemplateDeletes a single Launch Configuration Template by ID.
  • POSTDescribe launch configuration templates/DescribeLaunchConfigurationTemplatesLists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
  • POSTUpdate launch configuration template/UpdateLaunchConfigurationTemplateUpdates an existing Launch Configuration Template by ID.

Recovery plan

  • POSTCreate recovery plan/CreateRecoveryPlanCreates a Recovery Plan to orchestrate multi-server disaster recovery.
  • POSTStart recovery plan execution/StartRecoveryPlanExecutionStarts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time.

Replication configuration template

  • POSTCreate replication configuration template/CreateReplicationConfigurationTemplateCreates a new ReplicationConfigurationTemplate.
  • POSTDelete replication configuration template/DeleteReplicationConfigurationTemplateDeletes a single Replication Configuration Template by ID
  • POSTDescribe replication configuration templates/DescribeReplicationConfigurationTemplatesLists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
  • POSTUpdate replication configuration template/UpdateReplicationConfigurationTemplateUpdates a ReplicationConfigurationTemplate by ID.

Job

  • POSTDelete job/DeleteJobDeletes a single Job by ID.
  • POSTDescribe job log items/DescribeJobLogItemsRetrieves a detailed Job log with pagination.
  • POSTDescribe jobs/DescribeJobsReturns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest…

Recovery instance

  • POSTDelete recovery instance/DeleteRecoveryInstanceDeletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be…
  • POSTDescribe recovery instances/DescribeRecoveryInstancesLists all Recovery Instances or multiple Recovery Instances by ID.
  • POSTDisconnect recovery instance/DisconnectRecoveryInstanceDisconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery…
  • POSTGet failback replication configuration/GetFailbackReplicationConfigurationLists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
  • POSTReverse replication/ReverseReplicationStart replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts…
  • POSTStart failback launch/StartFailbackLaunchInitiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client…
  • POSTStop failback/StopFailbackStops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
  • POSTTerminate recovery instances/TerminateRecoveryInstancesInitiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the…
  • POSTUpdate failback replication configuration/UpdateFailbackReplicationConfigurationAllows you to update the failback replication configuration of a Recovery Instance by ID.

Source server

  • POSTDelete source server/DeleteSourceServerDeletes a single Source Server by ID. The Source Server must be disconnected first.
  • POSTDescribe recovery snapshots/DescribeRecoverySnapshotsLists all Recovery Snapshots for a single Source Server.
  • POSTDescribe source servers/DescribeSourceServersLists all Source Servers or multiple Source Servers filtered by ID.
  • POSTDisconnect source server/DisconnectSourceServerDisconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster…
  • POSTGet launch configuration/GetLaunchConfigurationGets a LaunchConfiguration, filtered by Source Server IDs.
  • POSTGet replication configuration/GetReplicationConfigurationGets a ReplicationConfiguration, filtered by Source Server ID.
  • POSTRetry data replication/RetryDataReplicationDeprecated. WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the…
  • POSTStart recovery/StartRecoveryLaunches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on…
  • POSTStart replication/StartReplicationStarts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.
  • POSTStop replication/StopReplicationStops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.
  • POSTUpdate launch configuration/UpdateLaunchConfigurationUpdates a LaunchConfiguration by Source Server ID.
  • POSTUpdate replication configuration/UpdateReplicationConfigurationAllows you to update a ReplicationConfiguration by Source Server ID.
  • POSTCancel recovery plan execution/CancelRecoveryPlanExecutionCancels an in-progress Recovery Plan execution. Remaining steps are skipped.
  • POSTCreate extended source server/CreateExtendedSourceServerCreate an extended source server in the target Account based on the source server in staging account.
  • POSTCreate recovery plan step/CreateRecoveryPlanStepCreates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).
  • POSTDelete launch action/DeleteLaunchActionDeletes a resource launch action.
  • POSTDelete recovery plan/DeleteRecoveryPlanDeletes a Recovery Plan. Cannot delete a plan that has an execution in a non-terminal status ( CREATED , IN_PROGRESS ).
  • POSTDelete recovery plan execution/DeleteRecoveryPlanExecutionDeletes a Recovery Plan execution record. Must be in a terminal status.
  • POSTDelete recovery plan step/DeleteRecoveryPlanStepDeletes a step from a Recovery Plan.
  • POSTGet recovery plan/GetRecoveryPlanGets a Recovery Plan by ARN.
  • POSTGet recovery plan execution/GetRecoveryPlanExecutionGets the details of a Recovery Plan execution.
  • POSTGet recovery plan execution step/GetRecoveryPlanExecutionStepGets the details of a step within a Recovery Plan execution.
  • POSTGet recovery plan step/GetRecoveryPlanStepGets a Recovery Plan step by ARN.
  • POSTInitialize service/InitializeServiceInitialize Elastic Disaster Recovery.
  • POSTList extensible source servers/ListExtensibleSourceServersReturns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account.…
  • POSTList launch actions/ListLaunchActionsLists resource launch actions.
  • POSTList recovery plan execution steps/ListRecoveryPlanExecutionStepsLists all steps within a Recovery Plan execution.
  • POSTList recovery plan executions/ListRecoveryPlanExecutionsLists executions of Recovery Plans, optionally filtered by plan or status.
  • POSTList recovery plan steps/ListRecoveryPlanStepsLists all steps in a Recovery Plan.
  • POSTList recovery plans/ListRecoveryPlansLists all Recovery Plans in the account.
  • GETList staging accounts/ListStagingAccounts?maxResults=0&nextToken=stringReturns an array of staging accounts for existing extended source servers.
  • GETList tags for resource/tags/:resourceArnList all tags for your Elastic Disaster Recovery resources.
  • POSTTag resource/tags/:resourceArnAdds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value…
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
  • POSTPut launch action/PutLaunchActionPuts a resource launch action.
  • POSTReorder recovery plan steps/ReorderRecoveryPlanStepsReorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.
  • POSTRetry recovery plan execution step/RetryRecoveryPlanExecutionStepRetries a failed SERVER type execution step.
  • POSTUpdate recovery plan/UpdateRecoveryPlanUpdates a Recovery Plan's name or description.
  • POSTUpdate recovery plan execution step/UpdateRecoveryPlanExecutionStepUpdates an execution step. Supports two actions: (1) skip a step that is in NOT_STARTED or FAILED status; (2) update the wait duration of a WAIT type step…
  • POSTUpdate recovery plan step/UpdateRecoveryPlanStepUpdates a Recovery Plan step's name or configuration. Step type is immutable.

API details

Base URL
https://drs.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
70 operations on 68 pathsPOST 67GET 2DELETE 1
1 marked deprecated
Main resources
Source server 12Recovery instance 9Source network 8Launch configuration template 4Replication configuration template 4Job 3Recovery plan 2
Description format
AWS Smithy model, API version 2020-02-26

How to test the Elastic Disaster Recovery Service 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 Elastic Disaster Recovery Service 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 “Associate source network stack” (POST /AssociateSourceNetworkStack), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Elastic Disaster Recovery Service?

AWS Elastic Disaster Recovery Service. It is listed under Developer tools and has 70 endpoints.

Who publishes the Elastic Disaster Recovery Service?

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 Elastic Disaster Recovery Service?

Requests go to https://drs.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Elastic Disaster Recovery Service?

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

How many endpoints does the Elastic Disaster Recovery Service have?

70 operations on 68 paths (67 POST, 2 GET, 1 DELETE). The largest groups are Source server, Recovery instance, Source network, Launch configuration template.

Is forking the Elastic Disaster Recovery Service 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.