Skip to content

get_restore_testing_plan

get_restore_testing_plan(
    restore_testing_plan_name: str,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> GetRestoreTestingPlanOutput

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.

Parameters:

  • restore_testing_plan_name (str) –

    Required unique name of the restore testing plan.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def get_restore_testing_plan(
    self,
    restore_testing_plan_name: str,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> (
    "capo_backup.types.get_restore_testing_plan_output.GetRestoreTestingPlanOutput"
):
    """<p>Returns <code>RestoreTestingPlan</code> details for the specified <code>RestoreTestingPlanName</code>. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.</p>

    Args:
        restore_testing_plan_name: <p>Required unique name of the restore testing plan.</p>

    Raises:
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.get_restore_testing_plan_input.GetRestoreTestingPlanInput]",
    ) -> OperationResponse[
        "capo_backup.types.get_restore_testing_plan_output.GetRestoreTestingPlanOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.get_restore_testing_plan

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.get_restore_testing_plan.get_restore_testing_plan(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRestoreTestingPlan")
    )
    input_: capo_backup.types.get_restore_testing_plan_input.GetRestoreTestingPlanInput = {
        "restore_testing_plan_name": restore_testing_plan_name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output