Address
The address that you want the Snow device(s) associated with a specific job to be
shipped to. Addresses are validated at the time of creation. The address you provide must be
located within the serviceable area of your region. Although no individual elements of the
Address are required, if the address is invalid or unsupported, then an
exception is thrown.
Contents
- AddressId
-
The unique ID for an address.
Type: String
Length Constraints: Fixed length of 40.
Pattern:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: No
- City
-
The city in an address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Company
-
The name of the company to receive a Snow device at an address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Country
-
The country in an address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- IsRestricted
-
This field is not supported in your region.
Type: Boolean
Required: No
- Landmark
-
This field is no longer used and the value is ignored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Name
-
The name of a person to receive a Snow device at an address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- PhoneNumber
-
The phone number associated with an address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- PostalCode
-
The postal code in an address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- PrefectureOrDistrict
-
This field is no longer used and the value is ignored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- StateOrProvince
-
The state or province in an address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Street1
-
The first line in a street address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Street2
-
The second line in a street address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Street3
-
The third line in a street address that a Snow device is to be delivered to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*Required: No
- Type
-
Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
Type: String
Valid Values:
CUST_PICKUP | AWS_SHIPRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
