Skip to content

get_restore_job_metadata

get_restore_job_metadata(
    restore_job_id: RestoreJobId,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> GetRestoreJobMetadataOutput

This request returns the metadata for the specified restore job.

Parameters:

  • restore_job_id (RestoreJobId) –

    This is a unique identifier of a restore job within Backup.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def get_restore_job_metadata(
    self,
    restore_job_id: "capo_backup.types.restore_job_id.RestoreJobId",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> (
    "capo_backup.types.get_restore_job_metadata_output.GetRestoreJobMetadataOutput"
):
    """<p>This request returns the metadata for the specified restore job.</p>

    Args:
        restore_job_id: <p>This is a unique identifier of a restore job within Backup.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        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_job_metadata_input.GetRestoreJobMetadataInput]",
    ) -> OperationResponse[
        "capo_backup.types.get_restore_job_metadata_output.GetRestoreJobMetadataOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.get_restore_job_metadata

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

    def _redact_output(
        output: "capo_backup.types.get_restore_job_metadata_output.GetRestoreJobMetadataOutput",
    ) -> dict[str, Any]:
        import capo_backup.types.get_restore_job_metadata_output

        return capo_backup.types.get_restore_job_metadata_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetRestoreJobMetadata", redact_output=_redact_output),
    )
    input_: capo_backup.types.get_restore_job_metadata_input.GetRestoreJobMetadataInput = {
        "restore_job_id": restore_job_id
    }

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