Skip to content

restore_backup

restore_backup(
    backup_id: BackupId, *, config_overrides: Optional[CloudHSMV2ClientConfig] = None
) -> RestoreBackupResponse

Restores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Parameters:

  • backup_id (BackupId) –

    The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

Raises:

Source code in docs_src/capo_cloudhsm_v2/_services/cloud_hsmv2.py
def restore_backup(
    self,
    backup_id: "capo_cloudhsm_v2.types.backup_id.BackupId",
    *,
    config_overrides: Optional[CloudHSMV2ClientConfig] = None,
) -> "capo_cloudhsm_v2.types.restore_backup_response.RestoreBackupResponse":
    """<p>Restores a specified CloudHSM backup that is in the <code>PENDING_DELETION</code> state. For more information on deleting a backup, see <a>DeleteBackup</a>.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.</p>

    Args:
        backup_id: <p>The ID of the backup to be restored. To find the ID of a backup, use the <a>DescribeBackups</a> operation.</p>

    Raises:
        capo_cloudhsm_v2.errors.cloud_hsm_access_denied_exception.CloudHsmAccessDeniedException: <p>The request was rejected because the requester does not have permission to perform the requested operation.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_internal_failure_exception.CloudHsmInternalFailureException: <p>The request was rejected because of an CloudHSM internal failure. The request can be retried.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_invalid_request_exception.CloudHsmInvalidRequestException: <p>The request was rejected because it is not a valid request.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_resource_not_found_exception.CloudHsmResourceNotFoundException: <p>The request was rejected because it refers to a resource that cannot be found.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_service_exception.CloudHsmServiceException: <p>The request was rejected because an error occurred.</p>
        capo_cloudhsm_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudhsm_v2.types.restore_backup_request.RestoreBackupRequest]",
    ) -> OperationResponse[
        "capo_cloudhsm_v2.types.restore_backup_response.RestoreBackupResponse"
    ]:
        import capo_cloudhsm_v2._operations.baldr_api_service.restore_backup

        output, http_response = (
            capo_cloudhsm_v2._operations.baldr_api_service.restore_backup.restore_backup(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RestoreBackup")
    )
    input_: capo_cloudhsm_v2.types.restore_backup_request.RestoreBackupRequest = {
        "backup_id": backup_id
    }

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