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

StartPracticeRun

Start an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon also runs automated practice runs about weekly when you have enabled zonal autoshift.

For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

Request Syntax


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

{
   "awayFrom": "string",
   "comment": "string",
   "resourceIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

awayFrom

The Availability Zone (for example, use1-az1) that traffic is shifted away from for the resource that you specify for the practice run.

Type: String

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

Required: Yes

comment

The initial comment that you enter 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.

Required: Yes

resourceIdentifier

The identifier for the resource that you want to start 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.

Required: Yes

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 is shifted away from for the resource that you specify for the practice run.

Type: String

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

comment

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 want to shift traffic 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 (expected status is ACTIVE).

Type: String

Valid Values: ACTIVE | EXPIRED | CANCELED

zonalShiftId

The identifier of a practice run zonal shift.

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