describe_copy_job ¶

describe_copy_job(
    copy_job_id: string, *, config_overrides: Optional[BackupClientConfig] = None
) -> DescribeCopyJobOutput

Returns metadata associated with creating a copy of a resource.

Parameters:

copy_job_id (string) –

Uniquely identifies a copy job.

Raises:

InvalidParameterValueException –

Indicates that something is wrong with a parameter's value. For example, the value is out of range.
MissingParameterValueException –

Indicates that a required parameter is missing.
ResourceNotFoundException –

A resource that is required for the action doesn't exist.
ServiceUnavailableException –

The request failed due to a temporary failure of the server.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_backup/_services/backup.py

def describe_copy_job(
    self,
    copy_job_id: "capo_backup.types.string.string",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> "capo_backup.types.describe_copy_job_output.DescribeCopyJobOutput":
    """<p>Returns metadata associated with creating a copy of a resource.</p>

    Args:
        copy_job_id: <p>Uniquely identifies a copy job.</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.describe_copy_job_input.DescribeCopyJobInput]",
    ) -> OperationResponse[
        "capo_backup.types.describe_copy_job_output.DescribeCopyJobOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.describe_copy_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCopyJob")
    )
    input_: capo_backup.types.describe_copy_job_input.DescribeCopyJobInput = {
        "copy_job_id": copy_job_id
    }

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