amazonka-snowball-1.6.0: Amazon Import/Export Snowball SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Snowball.DescribeAddresses

Contents

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.

Synopsis

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 # 
Data 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 # 
Show DescribeAddresses # 
Generic DescribeAddresses # 
Hashable DescribeAddresses # 
ToJSON DescribeAddresses # 
NFData DescribeAddresses # 

Methods

rnf :: DescribeAddresses -> () #

AWSPager DescribeAddresses # 
AWSRequest DescribeAddresses # 
ToHeaders DescribeAddresses # 
ToPath DescribeAddresses # 
ToQuery DescribeAddresses # 
type Rep DescribeAddresses # 
type Rep DescribeAddresses = D1 * (MetaData "DescribeAddresses" "Network.AWS.Snowball.DescribeAddresses" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "DescribeAddresses'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_daNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_daMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))
type Rs DescribeAddresses # 

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 #

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 # 
Data DescribeAddressesResponse # 

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 # 
Show DescribeAddressesResponse # 
Generic DescribeAddressesResponse # 
NFData DescribeAddressesResponse # 
type Rep DescribeAddressesResponse # 
type Rep DescribeAddressesResponse = D1 * (MetaData "DescribeAddressesResponse" "Network.AWS.Snowball.DescribeAddresses" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "DescribeAddressesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_drsAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Address]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_drsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_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.