Snowball / Client / create_return_shipping_label

create_return_shipping_label#

Snowball.Client.create_return_shipping_label(**kwargs)#

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

See also: AWS API Documentation

Request Syntax

response = client.create_return_shipping_label(
    JobId='string',
    ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD'
)
Parameters:
  • JobId (string) –

    [REQUIRED]

    The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000.

  • ShippingOption (string) – The shipping speed for a particular job. This speed doesn’t dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'InProgress'|'TimedOut'|'Succeeded'|'Failed'
}

Response Structure

  • (dict) –

    • Status (string) –

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

Exceptions

  • Snowball.Client.exceptions.InvalidResourceException

  • Snowball.Client.exceptions.InvalidJobStateException

  • Snowball.Client.exceptions.InvalidInputCombinationException

  • Snowball.Client.exceptions.ConflictException

  • Snowball.Client.exceptions.ReturnShippingLabelAlreadyExistsException