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

Contents

Description

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Synopsis

Creating a Request

listClusters :: ListClusters #

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

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

  • lcNextToken - HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.
  • lcMaxResults - The number of ClusterListEntry objects to return.

data ListClusters #

See: listClusters smart constructor.

Instances

Eq ListClusters # 
Data ListClusters # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListClusters -> c ListClusters #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListClusters #

toConstr :: ListClusters -> Constr #

dataTypeOf :: ListClusters -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListClusters) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListClusters) #

gmapT :: (forall b. Data b => b -> b) -> ListClusters -> ListClusters #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListClusters -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListClusters -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListClusters -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListClusters -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListClusters -> m ListClusters #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListClusters -> m ListClusters #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListClusters -> m ListClusters #

Read ListClusters # 
Show ListClusters # 
Generic ListClusters # 

Associated Types

type Rep ListClusters :: * -> * #

Hashable ListClusters # 
ToJSON ListClusters # 
NFData ListClusters # 

Methods

rnf :: ListClusters -> () #

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

Request Lenses

lcNextToken :: Lens' ListClusters (Maybe Text) #

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

lcMaxResults :: Lens' ListClusters (Maybe Natural) #

The number of ClusterListEntry objects to return.

Destructuring the Response

listClustersResponse #

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

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

  • lcrsClusterListEntries - Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.
  • lcrsNextToken - HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.
  • lcrsResponseStatus - -- | The response status code.

data ListClustersResponse #

See: listClustersResponse smart constructor.

Instances

Eq ListClustersResponse # 
Data ListClustersResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListClustersResponse -> c ListClustersResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListClustersResponse #

toConstr :: ListClustersResponse -> Constr #

dataTypeOf :: ListClustersResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListClustersResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListClustersResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListClustersResponse -> ListClustersResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListClustersResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListClustersResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListClustersResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListClustersResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListClustersResponse -> m ListClustersResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListClustersResponse -> m ListClustersResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListClustersResponse -> m ListClustersResponse #

Read ListClustersResponse # 
Show ListClustersResponse # 
Generic ListClustersResponse # 
NFData ListClustersResponse # 

Methods

rnf :: ListClustersResponse -> () #

type Rep ListClustersResponse # 
type Rep ListClustersResponse = D1 * (MetaData "ListClustersResponse" "Network.AWS.Snowball.ListClusters" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "ListClustersResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lcrsClusterListEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ClusterListEntry]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lcrsClusterListEntries :: Lens' ListClustersResponse [ClusterListEntry] #

Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

lcrsNextToken :: Lens' ListClustersResponse (Maybe Text) #

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

lcrsResponseStatus :: Lens' ListClustersResponse Int #

  • - | The response status code.