Menu
AWS Snowball
API Reference

CreateAddress

Creates an address for a Snowball 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. If the address is invalid or unsupported, then an exception is thrown.

Request Syntax

{
   "Address": { 
      "AddressId": "string",
      "City": "string",
      "Company": "string",
      "Country": "string",
      "IsRestricted": boolean,
      "Landmark": "string",
      "Name": "string",
      "PhoneNumber": "string",
      "PostalCode": "string",
      "PrefectureOrDistrict": "string",
      "StateOrProvince": "string",
      "Street1": "string",
      "Street2": "string",
      "Street3": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Address

The address that you want the Snowball shipped to.

Type: Address object

Required: Yes

Response Syntax

{
   "AddressId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AddressId

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 Snowball for that job shipped to.

Type: String

Length Constraints: Minimum length of 1.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidAddressException

The address provided was invalid. Check the address with your region's carrier, and try again.

HTTP Status Code: 400

UnsupportedAddressException

The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact AWS Support.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: