Skip to content

describe_job

describe_job(
    job_id: JobId, *, config_overrides: Optional[SnowballClientConfig] = None
) -> DescribeJobResult

Returns information about a specific job including shipping information, job status, and other important metadata.

Parameters:

  • job_id (JobId) –

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Raises:

  • InvalidResourceException –

    The specified resource can't be found. Check the information you provided in your last request, and try again.

  • UnknownServiceError –

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

Source code in docs_src/capo_snowball/_services/snowball.py
def describe_job(
    self,
    job_id: "capo_snowball.types.job_id.JobId",
    *,
    config_overrides: Optional[SnowballClientConfig] = None,
) -> "capo_snowball.types.describe_job_result.DescribeJobResult":
    """<p>Returns information about a specific job including shipping information, job status, and other important metadata. </p>

    Args:
        job_id: <p>The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>

    Raises:
        capo_snowball.errors.invalid_resource_exception.InvalidResourceException: <p>The specified resource can't be found. Check the information you provided in your last request, and try again.</p>
        capo_snowball.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_snowball.types.describe_job_request.DescribeJobRequest]",
    ) -> OperationResponse[
        "capo_snowball.types.describe_job_result.DescribeJobResult"
    ]:
        import capo_snowball._operations.awsie_snowball_job_management_service.describe_job

        output, http_response = (
            capo_snowball._operations.awsie_snowball_job_management_service.describe_job.describe_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_snowball.types.describe_job_result.DescribeJobResult",
    ) -> dict[str, Any]:
        import capo_snowball.types.describe_job_result

        return capo_snowball.types.describe_job_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeJob", redact_output=_redact_output),
    )
    input_: capo_snowball.types.describe_job_request.DescribeJobRequest = {
        "job_id": job_id
    }

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