UpdateRestoreTestingPlan - AWS Backup

UpdateRestoreTestingPlan

This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.

RecoveryPointSelection can contain:

  • Algorithm

  • ExcludeVaults

  • IncludeVaults

  • RecoveryPointTypes

  • SelectionWindowDays

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

RestoreTestingPlanName

The name of the restore testing plan name.

Required: Yes

Request Body

The request accepts the following data in JSON format.

RestoreTestingPlan

Specifies the body of a restore testing plan.

Type: RestoreTestingPlanForUpdate object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "RestoreTestingPlanArn": "string", "RestoreTestingPlanName": "string", "UpdateTime": number }

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.

CreationTime

The time the resource testing plan was created.

Type: Timestamp

RestoreTestingPlanArn

Unique ARN (Amazon Resource Name) of the restore testing plan.

Type: String

RestoreTestingPlanName

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

Type: String

UpdateTime

The time the update completed for the restore testing plan.

Type: Timestamp

Errors

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

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

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

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: