GetRestoreTestingPlanCommand

Suggest an Edit

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupClient, GetRestoreTestingPlanCommand } from "@aws-sdk/client-backup"; // ES Modules import
// const { BackupClient, GetRestoreTestingPlanCommand } = require("@aws-sdk/client-backup"); // CommonJS import
const client = new BackupClient(config);
const input = { // GetRestoreTestingPlanInput
  RestoreTestingPlanName: "STRING_VALUE", // required
};
const command = new GetRestoreTestingPlanCommand(input);
const response = await client.send(command);
// { // GetRestoreTestingPlanOutput
//   RestoreTestingPlan: { // RestoreTestingPlanForGet
//     CreationTime: new Date("TIMESTAMP"), // required
//     CreatorRequestId: "STRING_VALUE",
//     LastExecutionTime: new Date("TIMESTAMP"),
//     LastUpdateTime: new Date("TIMESTAMP"),
//     RecoveryPointSelection: { // RestoreTestingRecoveryPointSelection
//       Algorithm: "LATEST_WITHIN_WINDOW" || "RANDOM_WITHIN_WINDOW",
//       ExcludeVaults: [ // stringList
//         "STRING_VALUE",
//       ],
//       IncludeVaults: [
//         "STRING_VALUE",
//       ],
//       RecoveryPointTypes: [ // RestoreTestingRecoveryPointTypeList
//         "CONTINUOUS" || "SNAPSHOT",
//       ],
//       SelectionWindowDays: Number("int"),
//     },
//     RestoreTestingPlanArn: "STRING_VALUE", // required
//     RestoreTestingPlanName: "STRING_VALUE", // required
//     ScheduleExpression: "STRING_VALUE", // required
//     ScheduleExpressionTimezone: "STRING_VALUE",
//     StartWindowHours: Number("int"),
//   },
// };

GetRestoreTestingPlanCommand Input

See GetRestoreTestingPlanCommandInput for more details

Parameter
Type
Description
RestoreTestingPlanName
Required
string | undefined

Required unique name of the restore testing plan.

GetRestoreTestingPlanCommand Output

See GetRestoreTestingPlanCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RestoreTestingPlan
Required
RestoreTestingPlanForGet | undefined

Specifies the body of a restore testing plan. Includes RestoreTestingPlanName.

Throws

Name
Fault
Details
ResourceNotFoundException
client

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

ServiceUnavailableException
server

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

BackupServiceException
Base exception class for all service exceptions from Backup service.