amazonka-snowball-2.0: Amazon Import/Export Snowball SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Snowball.CreateAddress

Description

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.

Synopsis

Creating a Request

data CreateAddress Source #

See: newCreateAddress smart constructor.

Constructors

CreateAddress' 

Fields

  • address :: Address

    The address that you want the Snow device shipped to.

Instances

Instances details
ToJSON CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

toJSON :: CreateAddress -> Value #

toEncoding :: CreateAddress -> Encoding #

toJSONList :: [CreateAddress] -> Value #

toEncodingList :: [CreateAddress] -> Encoding #

ToHeaders CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

toHeaders :: CreateAddress -> [Header] #

ToPath CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

toPath :: CreateAddress -> ByteString #

ToQuery CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

toQuery :: CreateAddress -> QueryString #

AWSRequest CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Associated Types

type AWSResponse CreateAddress #

Methods

request :: (Service -> Service) -> CreateAddress -> Request CreateAddress #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAddress -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAddress))) #

Generic CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Associated Types

type Rep CreateAddress :: Type -> Type #

Methods

from :: CreateAddress -> Rep CreateAddress x #

to :: Rep CreateAddress x -> CreateAddress #

Read CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

readsPrec :: Int -> ReadS CreateAddress #

readList :: ReadS [CreateAddress] #

readPrec :: ReadPrec CreateAddress #

readListPrec :: ReadPrec [CreateAddress] #

Show CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

showsPrec :: Int -> CreateAddress -> ShowS #

show :: CreateAddress -> String #

showList :: [CreateAddress] -> ShowS #

NFData CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

rnf :: CreateAddress -> () #

Eq CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

(==) :: CreateAddress -> CreateAddress -> Bool #

(/=) :: CreateAddress -> CreateAddress -> Bool #

Hashable CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

hashWithSalt :: Int -> CreateAddress -> Int #

hash :: CreateAddress -> Int #

type AWSResponse CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

type AWSResponse CreateAddress = CreateAddressResponse
type Rep CreateAddress Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

type Rep CreateAddress = D1 ('MetaData "CreateAddress" "Amazonka.Snowball.CreateAddress" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CreateAddress'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Address)))

newCreateAddress Source #

Arguments

:: Address

$sel:address:CreateAddress'

-> CreateAddress 

Create a value of CreateAddress 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:address:CreateAddress', createAddress_address - The address that you want the Snow device shipped to.

Request Lenses

createAddress_address :: Lens' CreateAddress Address Source #

The address that you want the Snow device shipped to.

Destructuring the Response

data CreateAddressResponse Source #

See: newCreateAddressResponse smart constructor.

Constructors

CreateAddressResponse' 

Fields

  • addressId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateAddressResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Associated Types

type Rep CreateAddressResponse :: Type -> Type #

Methods

from :: CreateAddressResponse -> Rep CreateAddressResponse x #

to :: Rep CreateAddressResponse x -> CreateAddressResponse #

Read CreateAddressResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

readsPrec :: Int -> ReadS CreateAddressResponse #

readList :: ReadS [CreateAddressResponse] #

readPrec :: ReadPrec CreateAddressResponse #

readListPrec :: ReadPrec [CreateAddressResponse] #

Show CreateAddressResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

showsPrec :: Int -> CreateAddressResponse -> ShowS #

show :: CreateAddressResponse -> String #

showList :: [CreateAddressResponse] -> ShowS #

NFData CreateAddressResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

rnf :: CreateAddressResponse -> () #

Eq CreateAddressResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

Methods

(==) :: CreateAddressResponse -> CreateAddressResponse -> Bool #

(/=) :: CreateAddressResponse -> CreateAddressResponse -> Bool #

type Rep CreateAddressResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateAddress

type Rep CreateAddressResponse = D1 ('MetaData "CreateAddressResponse" "Amazonka.Snowball.CreateAddress" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CreateAddressResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAddressResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateAddressResponse'

-> CreateAddressResponse 

Create a value of CreateAddressResponse 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:

CreateAddressResponse, createAddressResponse_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 Snow device for that job shipped to.

$sel:httpStatus:CreateAddressResponse', createAddressResponse_httpStatus - The response's http status code.

Response Lenses

createAddressResponse_addressId :: Lens' CreateAddressResponse (Maybe Text) Source #

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

createAddressResponse_httpStatus :: Lens' CreateAddressResponse Int Source #

The response's http status code.