Returns backup job details for the specified BackupJobId.
Parameters:
-
backup_job_id
(string)
–
Uniquely identifies a request to Backup to back up a resource.
Raises:
Source code in docs_src/capo_backup/_services/backup.py
| def describe_backup_job(
self,
backup_job_id: "capo_backup.types.string.string",
*,
config_overrides: Optional[BackupClientConfig] = None,
) -> "capo_backup.types.describe_backup_job_output.DescribeBackupJobOutput":
"""<p>Returns backup job details for the specified <code>BackupJobId</code>.</p>
Args:
backup_job_id: <p>Uniquely identifies a request to Backup to back up a resource.</p>
Raises:
capo_backup.errors.dependency_failure_exception.DependencyFailureException: <p>A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.</p>
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.describe_backup_job_input.DescribeBackupJobInput]",
) -> OperationResponse[
"capo_backup.types.describe_backup_job_output.DescribeBackupJobOutput"
]:
import capo_backup._operations.cryo_controller_user_manager.describe_backup_job
output, http_response = (
capo_backup._operations.cryo_controller_user_manager.describe_backup_job.describe_backup_job(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeBackupJob")
)
input_: capo_backup.types.describe_backup_job_input.DescribeBackupJobInput = {
"backup_job_id": backup_job_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|