address

Creates, updates, deletes, gets or lists an address resource.

Overview

Name	address
Type	Resource
Id	aws.snowball.address

Fields

The following fields are returned by SELECT queries:

describe_address

Name	Datatype	Description
address_id	string	The unique ID for an address. (pattern: <code>ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
city	string	The city in an address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
company	string	The name of the company to receive a Snow device at an address. (pattern: <code>.*</code>)
country	string	The country in an address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
is_restricted	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.
landmark	string	This field is no longer used and the value is ignored. (pattern: <code>.*</code>)
name	string	The name of a person to receive a Snow device at an address. (pattern: <code>.*</code>)
phone_number	string	The phone number associated with an address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
postal_code	string	The postal code in an address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
prefecture_or_district	string	This field is no longer used and the value is ignored. (pattern: <code>.*</code>)
state_or_province	string	The state or province in an address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
street_1	string	The first line in a street address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
street_2	string	The second line in a street address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
street_3	string	The third line in a street address that a Snow device is to be delivered to. (pattern: <code>.*</code>)
type	string	Differentiates between delivery address and pickup address in the customer account. Provided at job creation. (CUST_PICKUP, AWS_SHIP)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_address	select	region		Takes an AddressId and returns specific details about that address in the form of an Address object.
create_address	insert	region		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. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file:​//create-address.json.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_address

Takes an AddressId and returns specific details about that address in the form of an Address object.

SELECT
address_id,
city,
company,
country,
is_restricted,
landmark,
name,
phone_number,
postal_code,
prefecture_or_district,
state_or_province,
street_1,
street_2,
street_3,
type
FROM aws.snowball.address
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_address

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. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.

INSERT INTO aws.snowball.address (
Address,
region
)
SELECT 
'{{ Address }}',
'{{ region }}'
RETURNING
address_id
;

Manifest

# Description fields are for documentation purposes
- name: address
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the address resource.
  - name: Address
    description: |
      The address that you want the Snow device shipped to.
    value:
      AddressId: "{{ AddressId }}"
      Name: "{{ Name }}"
      Company: "{{ Company }}"
      Street1: "{{ Street1 }}"
      Street2: "{{ Street2 }}"
      Street3: "{{ Street3 }}"
      City: "{{ City }}"
      StateOrProvince: "{{ StateOrProvince }}"
      PrefectureOrDistrict: "{{ PrefectureOrDistrict }}"
      Landmark: "{{ Landmark }}"
      Country: "{{ Country }}"
      PostalCode: "{{ PostalCode }}"
      PhoneNumber: "{{ PhoneNumber }}"
      IsRestricted: {{ IsRestricted }}
      Type: "{{ Type }}"