describe_return_shipping_label ¶

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

Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

Parameters:

job_id (JobId) –

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

Raises:

ConflictException –

You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.
InvalidJobStateException –

The action can't be performed because the job's current state doesn't allow that action to be performed.
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_return_shipping_label(
    self,
    job_id: "capo_snowball.types.job_id.JobId",
    *,
    config_overrides: Optional[SnowballClientConfig] = None,
) -> "capo_snowball.types.describe_return_shipping_label_result.DescribeReturnShippingLabelResult":
    """<p>Information on the shipping label of a Snow device that is being returned to Amazon Web Services.</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.conflict_exception.ConflictException: <p>You get this exception when you call <code>CreateReturnShippingLabel</code> more than once when other requests are not completed.</p>
        capo_snowball.errors.invalid_job_state_exception.InvalidJobStateException: <p>The action can't be performed because the job's current state doesn't allow that action to be performed.</p>
        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_return_shipping_label_request.DescribeReturnShippingLabelRequest]",
    ) -> OperationResponse[
        "capo_snowball.types.describe_return_shipping_label_result.DescribeReturnShippingLabelResult"
    ]:
        import capo_snowball._operations.awsie_snowball_job_management_service.describe_return_shipping_label

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReturnShippingLabel")
    )
    input_: capo_snowball.types.describe_return_shipping_label_request.DescribeReturnShippingLabelRequest = {
        "job_id": job_id
    }

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