create_address

Snowball.Client.create_address(**kwargs)

Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

See also: AWS API Documentation

Request Syntax

response = client.create_address(
    Address={
        'AddressId': 'string',
        'Name': 'string',
        'Company': 'string',
        'Street1': 'string',
        'Street2': 'string',
        'Street3': 'string',
        'City': 'string',
        'StateOrProvince': 'string',
        'PrefectureOrDistrict': 'string',
        'Landmark': 'string',
        'Country': 'string',
        'PostalCode': 'string',
        'PhoneNumber': 'string',
        'IsRestricted': True|False
    }
)

Parameters

Address (dict) --

[REQUIRED]

The address that you want the Snow device shipped to.

• AddressId (string) --

  The unique ID for an address.

• Name (string) --

  The name of a person to receive a Snow device at an address.

• Company (string) --

  The name of the company to receive a Snow device at an address.

• Street1 (string) --

  The first line in a street address that a Snow device is to be delivered to.

• Street2 (string) --

  The second line in a street address that a Snow device is to be delivered to.

• Street3 (string) --

  The third line in a street address that a Snow device is to be delivered to.

• City (string) --

  The city in an address that a Snow device is to be delivered to.

• StateOrProvince (string) --

  The state or province in an address that a Snow device is to be delivered to.

• PrefectureOrDistrict (string) --

  This field is no longer used and the value is ignored.

• Landmark (string) --

  This field is no longer used and the value is ignored.

• Country (string) --

  The country in an address that a Snow device is to be delivered to.

• PostalCode (string) --

  The postal code in an address that a Snow device is to be delivered to.

• PhoneNumber (string) --

  The phone number associated with an address that a Snow device is to be delivered to.

• IsRestricted (boolean) --

  If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

Return type

dict

Returns

Response Syntax

{
    'AddressId': 'string'
}

Response Structure

• (dict) --
  • AddressId (string) --

    The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snow device for that job shipped to.

Exceptions

• Snowball.Client.exceptions.InvalidAddressException
• Snowball.Client.exceptions.UnsupportedAddressException

Examples

This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

response = client.create_address(
    Address={
        'City': 'Seattle',
        'Company': 'My Company's Name',
        'Country': 'USA',
        'Name': 'My Name',
        'PhoneNumber': '425-555-5555',
        'PostalCode': '98101',
        'StateOrProvince': 'WA',
        'Street1': '123 Main Street',
    },
)

print(response)

Expected Output:

{
    'AddressId': 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
    'ResponseMetadata': {
        '...': '...',
    },
}