Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Snowball.Types.Address

Description

Synopsis

data Address = Address' {
- isRestricted :: Maybe Bool
- street3 :: Maybe Text
- landmark :: Maybe Text
- postalCode :: Maybe Text
- country :: Maybe Text
- stateOrProvince :: Maybe Text
- street2 :: Maybe Text
- addressId :: Maybe Text
- city :: Maybe Text
- phoneNumber :: Maybe Text
- company :: Maybe Text
- name :: Maybe Text
- prefectureOrDistrict :: Maybe Text
- street1 :: Maybe Text
}
newAddress :: Address
address_isRestricted :: Lens' Address (Maybe Bool)
address_street3 :: Lens' Address (Maybe Text)
address_landmark :: Lens' Address (Maybe Text)
address_postalCode :: Lens' Address (Maybe Text)
address_country :: Lens' Address (Maybe Text)
address_stateOrProvince :: Lens' Address (Maybe Text)
address_street2 :: Lens' Address (Maybe Text)
address_addressId :: Lens' Address (Maybe Text)
address_city :: Lens' Address (Maybe Text)
address_phoneNumber :: Lens' Address (Maybe Text)
address_company :: Lens' Address (Maybe Text)
address_name :: Lens' Address (Maybe Text)
address_prefectureOrDistrict :: Lens' Address (Maybe Text)
address_street1 :: Lens' Address (Maybe Text)

Documentation

data Address Source #

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

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.
street3 :: Maybe Text
The third line in a street address that a Snow device is to be delivered to.
landmark :: Maybe Text
This field is no longer used and the value is ignored.
postalCode :: Maybe Text
The postal code in an address that a Snow device is to be delivered to.
country :: Maybe Text
The country in an address that a Snow device is to be delivered to.
stateOrProvince :: Maybe Text
The state or province in an 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.
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.
phoneNumber :: Maybe Text
The phone number associated with 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.
name :: Maybe Text
The name of a person to receive a Snow device at an address.
prefectureOrDistrict :: Maybe Text
This field is no longer used and the value is ignored.
street1 :: Maybe Text
The first line in a street address that a Snow device is to be delivered to.

Instances

Instances details

Eq Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Read Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods readsPrec :: Int -> ReadS Address # readList :: ReadS [Address] # readPrec :: ReadPrec Address # readListPrec :: ReadPrec [Address] #
Show Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #
Generic Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Associated Types type Rep Address :: Type -> Type # Methods from :: Address -> Rep Address x # to :: Rep Address x -> Address #
NFData Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods rnf :: Address -> () #
Hashable Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods hashWithSalt :: Int -> Address -> Int # hash :: Address -> Int #
ToJSON Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods toJSON :: Address -> Value # toEncoding :: Address -> Encoding # toJSONList :: [Address] -> Value # toEncodingList :: [Address] -> Encoding #
FromJSON Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address Methods parseJSON :: Value -> Parser Address # parseJSONList :: Value -> Parser [Address] #
type Rep Address Source #
Instance details Defined in Amazonka.Snowball.Types.Address type Rep Address = D1 ('MetaData "Address" "Amazonka.Snowball.Types.Address" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "Address'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "isRestricted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "street3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "landmark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "postalCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stateOrProvince") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "street2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "company") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "prefectureOrDistrict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "street1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newAddress :: Address Source #

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: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:street3:Address', address_street3 - The third line in a street address that a Snow device is to be delivered to.

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

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

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

$sel:stateOrProvince:Address', address_stateOrProvince - The state or province in an 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: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:phoneNumber:Address', address_phoneNumber - The phone number associated with 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:name:Address', address_name - The name of a person to receive a Snow device at an address.

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

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

address_isRestricted :: Lens' Address (Maybe Bool) Source #

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_street3 :: Lens' Address (Maybe Text) Source #

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

address_landmark :: Lens' Address (Maybe Text) Source #

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

address_postalCode :: Lens' Address (Maybe Text) Source #

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

address_country :: Lens' Address (Maybe Text) Source #

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

address_stateOrProvince :: Lens' Address (Maybe Text) Source #

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

address_street2 :: Lens' Address (Maybe Text) Source #

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

address_addressId :: Lens' Address (Maybe Text) Source #

The unique ID for an address.

address_city :: Lens' Address (Maybe Text) Source #

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

address_phoneNumber :: Lens' Address (Maybe Text) Source #

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

address_company :: Lens' Address (Maybe Text) Source #

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

address_name :: Lens' Address (Maybe Text) Source #

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

address_prefectureOrDistrict :: Lens' Address (Maybe Text) Source #

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

address_street1 :: Lens' Address (Maybe Text) Source #

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