Skip to content

describe_report_job

describe_report_job(
    report_job_id: ReportJobId, *, config_overrides: Optional[BackupClientConfig] = None
) -> DescribeReportJobOutput

Returns the details associated with creating a report as specified by its ReportJobId.

Parameters:

  • report_job_id (ReportJobId) –

    The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def describe_report_job(
    self,
    report_job_id: "capo_backup.types.report_job_id.ReportJobId",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> "capo_backup.types.describe_report_job_output.DescribeReportJobOutput":
    """<p>Returns the details associated with creating a report as specified by its <code>ReportJobId</code>.</p>

    Args:
        report_job_id: <p>The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.</p>

    Raises:
        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_report_job_input.DescribeReportJobInput]",
    ) -> OperationResponse[
        "capo_backup.types.describe_report_job_output.DescribeReportJobOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.describe_report_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReportJob")
    )
    input_: capo_backup.types.describe_report_job_input.DescribeReportJobInput = {
        "report_job_id": report_job_id
    }

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