Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateRecoveryPlanStep

Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).

Request Syntax


POST /CreateRecoveryPlanStep HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "recoveryPlanArn": "string",
   "stepName": "string",
   "stepOrder": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique string provided to ensure request idempotency.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

configuration

The type-specific configuration of the step. Exactly one of serverStepConfiguration or waitStepConfiguration must be set.

Type: RecoveryPlanStepConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

recoveryPlanArn

The ARN of the Recovery Plan to add the step to.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+

Required: Yes

stepName

The name of the step.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9][a-zA-Z0-9 _-]*

Required: Yes

stepOrder

The 1-based position of the step within the Recovery Plan.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "recoveryPlanStep": { 
      "configuration": { ... },
      "createdAt": "string",
      "recoveryPlanStepArn": "string",
      "stepName": "string",
      "stepOrder": number,
      "updatedAt": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

recoveryPlanStep

The created Recovery Plan step.

Type: RecoveryPlanStep object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the target resource.

resourceId: The ID of the resource.
resourceType: The type of the resource.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

retryAfterSeconds: The number of seconds after which the request should be safe to retry.

HTTP Status Code: 500

ResourceNotFoundException

The resource for this operation was not found.

resourceId: The ID of the resource.
resourceType: The type of the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The request could not be completed because its exceeded the service quota.

quotaCode: Quota code.
resourceId: The ID of the resource.
resourceType: The type of the resource.
serviceCode: Service code.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

quotaCode: Quota code.
retryAfterSeconds: The number of seconds after which the request should be safe to retry.
serviceCode: Service code.

HTTP Status Code: 429

UninitializedAccountException

The account performing the request has not been initialized.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

fieldList: A list of fields that failed validation.
reason: Validation exception reason.

HTTP Status Code: 400