Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_shipping_label

get_shipping_label(**kwargs)

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

See also: AWS API Documentation

Request Syntax

response = client.get_shipping_label(
    jobIds=[
        'string',
    ],
    name='string',
    company='string',
    phoneNumber='string',
    country='string',
    stateOrProvince='string',
    city='string',
    postalCode='string',
    street1='string',
    street2='string',
    street3='string',
    APIVersion='string'
)
Parameters
  • jobIds (list) --

    [REQUIRED]

    • (string) --
  • name (string) -- Specifies the name of the person responsible for shipping this package.
  • company (string) -- Specifies the name of the company that will ship this package.
  • phoneNumber (string) -- Specifies the phone number of the person responsible for shipping this package.
  • country (string) -- Specifies the name of your country for the return address.
  • stateOrProvince (string) -- Specifies the name of your state or your province for the return address.
  • city (string) -- Specifies the name of your city for the return address.
  • postalCode (string) -- Specifies the postal code for the return address.
  • street1 (string) -- Specifies the first part of the street address for the return address, for example 1234 Main Street.
  • street2 (string) -- Specifies the optional second part of the street address for the return address, for example Suite 100.
  • street3 (string) -- Specifies the optional third part of the street address for the return address, for example c/o Jane Doe.
  • APIVersion (string) -- Specifies the version of the client tool.
Return type

dict

Returns

Response Syntax

{
    'ShippingLabelURL': 'string',
    'Warning': 'string'
}

Response Structure

  • (dict) --
    • ShippingLabelURL (string) --
    • Warning (string) --

Exceptions

  • ImportExport.Client.exceptions.InvalidJobIdException
  • ImportExport.Client.exceptions.ExpiredJobIdException
  • ImportExport.Client.exceptions.CanceledJobIdException
  • ImportExport.Client.exceptions.InvalidAccessKeyIdException
  • ImportExport.Client.exceptions.InvalidAddressException
  • ImportExport.Client.exceptions.InvalidVersionException
  • ImportExport.Client.exceptions.InvalidParameterException