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

CancelPracticeRun

Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.

Request Syntax


DELETE /practiceruns/zonalShiftId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

zonalShiftId

The identifier of a practice run zonal shift in Amazon Application Recovery Controller that you want to cancel.

Length Constraints: Minimum length of 6. Maximum length of 36.

Pattern: [A-Za-z0-9-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "awayFrom": "string",
   "comment": "string",
   "expiryTime": number,
   "resourceIdentifier": "string",
   "startTime": number,
   "status": "string",
   "zonalShiftId": "string"
}

Response Elements

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

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

awayFrom

The Availability Zone (for example, use1-az1) that traffic was moved away from for a resource that you specified for the practice run.

Type: String

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

comment

The initial comment that you entered about the practice run. Be aware that this comment can be overwritten by Amazon if the automatic check for balanced capacity fails. For more information, see Capacity checks for practice runs in the Amazon Application Recovery Controller Developer Guide.

Type: String

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

expiryTime

The expiry time (expiration time) for an on-demand practice run zonal shift is 30 minutes from the time when you start the practice run, unless you cancel it before that time. However, be aware that the expiryTime field for practice run zonal shifts always has a value of 1 minute.

Type: Timestamp

resourceIdentifier

The identifier for the resource that you canceled a practice run zonal shift for. The identifier is the Amazon Resource Name (ARN) for the resource.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

startTime

The time (UTC) when the zonal shift starts.

Type: Timestamp

status

A status for the practice run that you canceled (expected status is CANCELED).

The Status for a practice run zonal shift can have one of the following values:

Type: String

Valid Values: ACTIVE | EXPIRED | CANCELED

zonalShiftId

The identifier of the practice run zonal shift in Amazon Application Recovery Controller that was canceled.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 36.

Pattern: [A-Za-z0-9-]+

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The input requested a resource that was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an Amazon service.

HTTP Status Code: 400