Amazonka.Snowball.Types.Address

Documentation

data 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.

See: newAddress smart constructor.

Constructors

Address'

Fields

• addressId :: Maybe Text

  The unique ID for an address.

• city :: Maybe Text

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

• company :: Maybe Text

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

• country :: Maybe Text

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

• isRestricted :: Maybe Bool

  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 :: Maybe Text

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

• name :: Maybe Text

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

• phoneNumber :: Maybe Text

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

• postalCode :: Maybe Text

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

• prefectureOrDistrict :: Maybe Text

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

• stateOrProvince :: Maybe Text

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

• street1 :: Maybe Text

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

• street2 :: Maybe Text

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

• street3 :: Maybe Text

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

Instances

FromJSON Address

Defined in Amazonka.Snowball.Types.Address

Methods

parseJSON :: Value -> Parser Address

parseJSONList :: Value -> Parser [Address]

ToJSON Address

Defined in Amazonka.Snowball.Types.Address

Methods

toJSON :: Address -> Value

toEncoding :: Address -> Encoding

toJSONList :: [Address] -> Value

toEncodingList :: [Address] -> Encoding

Generic Address

Defined in Amazonka.Snowball.Types.Address

Associated Types

type Rep Address :: Type -> Type

Methods

from :: Address -> Rep Address x

to :: Rep Address x -> Address

Read Address

Defined in Amazonka.Snowball.Types.Address

Methods

readsPrec :: Int -> ReadS Address

readList :: ReadS [Address]

readPrec :: ReadPrec Address

readListPrec :: ReadPrec [Address]

Show Address

Defined in Amazonka.Snowball.Types.Address

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

NFData Address

Defined in Amazonka.Snowball.Types.Address

Methods

rnf :: Address -> ()

Eq Address

Defined in Amazonka.Snowball.Types.Address

Methods

(==) :: Address -> Address -> Bool

(/=) :: Address -> Address -> Bool

Hashable Address

Defined in Amazonka.Snowball.Types.Address

Methods

hashWithSalt :: Int -> Address -> Int

hash :: Address -> Int

type Rep Address

Defined in Amazonka.Snowball.Types.Address

type Rep Address = D1 ('MetaData "Address" "Amazonka.Snowball.Types.Address" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "Address'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "company") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isRestricted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "landmark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "postalCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "prefectureOrDistrict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "stateOrProvince") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "street1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "street2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "street3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newAddress :: Address

Create a value of Address with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addressId:Address', address_addressId - The unique ID for an address.

$sel:city:Address', address_city - The city in an address that a Snow device is to be delivered to.

$sel:company:Address', address_company - The name of the company to receive a Snow device at an address.

$sel:country:Address', address_country - The country in an address that a Snow device is to be delivered to.

$sel:isRestricted:Address', address_isRestricted - If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

$sel:landmark:Address', address_landmark - This field is no longer used and the value is ignored.

$sel:name:Address', address_name - The name of a person to receive a Snow device at an address.

$sel:phoneNumber:Address', address_phoneNumber - The phone number associated with an address that a Snow device is to be delivered to.

$sel:postalCode:Address', address_postalCode - The postal code in an address that a Snow device is to be delivered to.

$sel:prefectureOrDistrict:Address', address_prefectureOrDistrict - This field is no longer used and the value is ignored.

$sel:stateOrProvince:Address', address_stateOrProvince - The state or province in an address that a Snow device is to be delivered to.

$sel:street1:Address', address_street1 - The first line in a street address that a Snow device is to be delivered to.

$sel:street2:Address', address_street2 - The second line in a street address that a Snow device is to be delivered to.

$sel:street3:Address', address_street3 - The third line in a street address that a Snow device is to be delivered to.

address_addressId :: Lens' Address (Maybe Text)

The unique ID for an address.

address_city :: Lens' Address (Maybe Text)

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

address_company :: Lens' Address (Maybe Text)

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

address_country :: Lens' Address (Maybe Text)

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

address_isRestricted :: Lens' Address (Maybe Bool)

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

address_landmark :: Lens' Address (Maybe Text)

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

address_name :: Lens' Address (Maybe Text)

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

address_phoneNumber :: Lens' Address (Maybe Text)

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

address_postalCode :: Lens' Address (Maybe Text)

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

address_prefectureOrDistrict :: Lens' Address (Maybe Text)

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

address_stateOrProvince :: Lens' Address (Maybe Text)

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

address_street1 :: Lens' Address (Maybe Text)

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

address_street2 :: Lens' Address (Maybe Text)

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

address_street3 :: Lens' Address (Maybe Text)

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