Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Snowball.DescribeAddresses

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

This operation returns paginated results.

Creating a Request

describeAddresses :: DescribeAddresses #

Creates a value of DescribeAddresses with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

daNextToken - HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.
daMaxResults - The number of ADDRESS objects to return.

data DescribeAddresses #

See: describeAddresses smart constructor.

Instances

Eq DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods (==) :: DescribeAddresses -> DescribeAddresses -> Bool # (/=) :: DescribeAddresses -> DescribeAddresses -> Bool #
Data DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAddresses -> c DescribeAddresses # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAddresses # toConstr :: DescribeAddresses -> Constr # dataTypeOf :: DescribeAddresses -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAddresses) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAddresses) # gmapT :: (forall b. Data b => b -> b) -> DescribeAddresses -> DescribeAddresses # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAddresses -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAddresses -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeAddresses -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAddresses -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAddresses -> m DescribeAddresses # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAddresses -> m DescribeAddresses # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAddresses -> m DescribeAddresses #
Read DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods readsPrec :: Int -> ReadS DescribeAddresses # readList :: ReadS [DescribeAddresses] # readPrec :: ReadPrec DescribeAddresses # readListPrec :: ReadPrec [DescribeAddresses] #
Show DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods showsPrec :: Int -> DescribeAddresses -> ShowS # show :: DescribeAddresses -> String # showList :: [DescribeAddresses] -> ShowS #
Generic DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Associated Types type Rep DescribeAddresses :: * -> * # Methods from :: DescribeAddresses -> Rep DescribeAddresses x # to :: Rep DescribeAddresses x -> DescribeAddresses #
Hashable DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods hashWithSalt :: Int -> DescribeAddresses -> Int # hash :: DescribeAddresses -> Int #
ToJSON DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods toJSON :: DescribeAddresses -> Value # toEncoding :: DescribeAddresses -> Encoding # toJSONList :: [DescribeAddresses] -> Value # toEncodingList :: [DescribeAddresses] -> Encoding #
AWSPager DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods page :: DescribeAddresses -> Rs DescribeAddresses -> Maybe DescribeAddresses #
AWSRequest DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Associated Types type Rs DescribeAddresses :: * # Methods request :: DescribeAddresses -> Request DescribeAddresses # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeAddresses -> ClientResponse -> m (Response DescribeAddresses) #
ToHeaders DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods toHeaders :: DescribeAddresses -> [Header] #
ToPath DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods toPath :: DescribeAddresses -> ByteString #
ToQuery DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods toQuery :: DescribeAddresses -> QueryString #
NFData DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods rnf :: DescribeAddresses -> () #
type Rep DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses type Rep DescribeAddresses = D1 (MetaData "DescribeAddresses" "Network.AWS.Snowball.DescribeAddresses" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "DescribeAddresses'" PrefixI True) (S1 (MetaSel (Just "_daNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_daMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))
type Rs DescribeAddresses #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses type Rs DescribeAddresses = DescribeAddressesResponse

Request Lenses

daNextToken :: Lens' DescribeAddresses (Maybe Text) #

HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

daMaxResults :: Lens' DescribeAddresses (Maybe Natural) #

The number of ADDRESS objects to return.

Destructuring the Response

describeAddressesResponse #

Arguments

:: Int	`drsResponseStatus`
-> DescribeAddressesResponse

Creates a value of DescribeAddressesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

drsAddresses - The Snowball shipping addresses that were created for this account.
drsNextToken - HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.
drsResponseStatus - -- | The response status code.

data DescribeAddressesResponse #

See: describeAddressesResponse smart constructor.

Instances

Eq DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods (==) :: DescribeAddressesResponse -> DescribeAddressesResponse -> Bool # (/=) :: DescribeAddressesResponse -> DescribeAddressesResponse -> Bool #
Data DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeAddressesResponse -> c DescribeAddressesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeAddressesResponse # toConstr :: DescribeAddressesResponse -> Constr # dataTypeOf :: DescribeAddressesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeAddressesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeAddressesResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeAddressesResponse -> DescribeAddressesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAddressesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeAddressesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeAddressesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeAddressesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeAddressesResponse -> m DescribeAddressesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAddressesResponse -> m DescribeAddressesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeAddressesResponse -> m DescribeAddressesResponse #
Read DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods readsPrec :: Int -> ReadS DescribeAddressesResponse # readList :: ReadS [DescribeAddressesResponse] # readPrec :: ReadPrec DescribeAddressesResponse # readListPrec :: ReadPrec [DescribeAddressesResponse] #
Show DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods showsPrec :: Int -> DescribeAddressesResponse -> ShowS # show :: DescribeAddressesResponse -> String # showList :: [DescribeAddressesResponse] -> ShowS #
Generic DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Associated Types type Rep DescribeAddressesResponse :: * -> * # Methods from :: DescribeAddressesResponse -> Rep DescribeAddressesResponse x # to :: Rep DescribeAddressesResponse x -> DescribeAddressesResponse #
NFData DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses Methods rnf :: DescribeAddressesResponse -> () #
type Rep DescribeAddressesResponse #
Instance details Defined in Network.AWS.Snowball.DescribeAddresses type Rep DescribeAddressesResponse = D1 (MetaData "DescribeAddressesResponse" "Network.AWS.Snowball.DescribeAddresses" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "DescribeAddressesResponse'" PrefixI True) (S1 (MetaSel (Just "_drsAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Address])) :: (S1 (MetaSel (Just "_drsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

drsAddresses :: Lens' DescribeAddressesResponse [Address] #

The Snowball shipping addresses that were created for this account.

drsNextToken :: Lens' DescribeAddressesResponse (Maybe Text) #

HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.

drsResponseStatus :: Lens' DescribeAddressesResponse Int #

- | The response status code.