Amazon Import/Export Snowball

2020/10/09 - Amazon Import/Export Snowball - 3 new api methods

Changes  We added new APIs to allow customers to better manage their device shipping. You can check if your shipping label expired, generate a new label, and tell us that you received or shipped your job.

CreateReturnShippingLabel (new) Link ¶

Creates a shipping label that will be used to return the Snow device to AWS.

See also: AWS API Documentation

Request Syntax

client.create_return_shipping_label(
    JobId='string',
    ShippingOption='SECOND_DAY'|'NEXT_DAY'|'EXPRESS'|'STANDARD'
)
type JobId

string

param JobId

[REQUIRED]

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

type ShippingOption

string

param ShippingOption

The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

rtype

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 AWS.

UpdateJobShipmentState (new) Link ¶

Updates the state when a the shipment states changes to a different state.

See also: AWS API Documentation

Request Syntax

client.update_job_shipment_state(
    JobId='string',
    ShipmentState='RECEIVED'|'RETURNED'
)
type JobId

string

param JobId

[REQUIRED]

The job ID of the job whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000 .

type ShipmentState

string

param ShipmentState

[REQUIRED]

The state of a device when it is being shipped.

Set to RECEIVED when the device arrives at your location.

Set to RETURNED when you have returned the device to AWS.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeReturnShippingLabel (new) Link ¶

Information on the shipping label of a Snow device that is being returned to AWS.

See also: AWS API Documentation

Request Syntax

client.describe_return_shipping_label(
    JobId='string'
)
type JobId

string

param JobId

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

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) --

    • Status (string) --

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

    • ExpirationDate (datetime) --

      The expiration date of the current return shipping label.