Snowball / Client / describe_return_shipping_label

describe_return_shipping_label#

Snowball.Client.describe_return_shipping_label(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_return_shipping_label(
    JobId='string'
)
Parameters:

JobId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'InProgress'|'TimedOut'|'Succeeded'|'Failed',
    'ExpirationDate': datetime(2015, 1, 1),
    'ReturnShippingLabelURI': 'string'
}

Response Structure

  • (dict) –

    • Status (string) –

      The status information of the task on a Snow device that is being returned to Amazon Web Services.

    • ExpirationDate (datetime) –

      The expiration date of the current return shipping label.

    • ReturnShippingLabelURI (string) –

      The pre-signed Amazon S3 URI used to download the return shipping label.

Exceptions