CreateRestoreTestingPlan - AWS Backup

CreateRestoreTestingPlan

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.

Request Syntax

PUT /restore-testing/plans HTTP/1.1 Content-type: application/json { "CreatorRequestId": "string", "RestoreTestingPlan": { "RecoveryPointSelection": { "Algorithm": "string", "ExcludeVaults": [ "string" ], "IncludeVaults": [ "string" ], "RecoveryPointTypes": [ "string" ], "SelectionWindowDays": number }, "RestoreTestingPlanName": "string", "ScheduleExpression": "string", "ScheduleExpressionTimezone": "string", "StartWindowHours": number }, "Tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

CreatorRequestId

This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Type: String

Required: No

RestoreTestingPlan

A restore testing plan must contain a unique RestoreTestingPlanName string you create and must contain a ScheduleExpression cron. You may optionally include a StartWindowHours integer and a CreatorRequestId string.

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

Type: RestoreTestingPlanForCreate object

Required: Yes

Tags

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.

Type: String to string map

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "CreationTime": number, "RestoreTestingPlanArn": "string", "RestoreTestingPlanName": "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.

CreationTime

The date and time a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.

Type: Timestamp

RestoreTestingPlanArn

An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan.

Type: String

RestoreTestingPlanName

This unique string is the name of the restore testing plan.

The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

Type: String

Errors

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

AlreadyExistsException

The required resource already exists.

HTTP Status Code: 400

ConflictException

AWS Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

HTTP Status Code: 400

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: