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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

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 #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods (==) :: ListClusters -> ListClusters -> Bool # (/=) :: ListClusters -> ListClusters -> Bool #
Data ListClusters #
Instance details Defined in Network.AWS.Snowball.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 #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods readsPrec :: Int -> ReadS ListClusters # readList :: ReadS [ListClusters] # readPrec :: ReadPrec ListClusters # readListPrec :: ReadPrec [ListClusters] #
Show ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods showsPrec :: Int -> ListClusters -> ShowS # show :: ListClusters -> String # showList :: [ListClusters] -> ShowS #
Generic ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Associated Types type Rep ListClusters :: * -> * # Methods from :: ListClusters -> Rep ListClusters x # to :: Rep ListClusters x -> ListClusters #
Hashable ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods hashWithSalt :: Int -> ListClusters -> Int # hash :: ListClusters -> Int #
ToJSON ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods toJSON :: ListClusters -> Value # toEncoding :: ListClusters -> Encoding # toJSONList :: [ListClusters] -> Value # toEncodingList :: [ListClusters] -> Encoding #
AWSRequest ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Associated Types type Rs ListClusters :: * # Methods request :: ListClusters -> Request ListClusters # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListClusters -> ClientResponse -> m (Response ListClusters) #
ToHeaders ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods toHeaders :: ListClusters -> [Header] #
ToPath ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods toPath :: ListClusters -> ByteString #
ToQuery ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods toQuery :: ListClusters -> QueryString #
NFData ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods rnf :: ListClusters -> () #
type Rep ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters type Rep ListClusters = D1 (MetaData "ListClusters" "Network.AWS.Snowball.ListClusters" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "ListClusters'" PrefixI True) (S1 (MetaSel (Just "_lcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lcMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))
type Rs ListClusters #
Instance details Defined in Network.AWS.Snowball.ListClusters type Rs ListClusters = ListClustersResponse

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 #

Arguments

:: Int	`lcrsResponseStatus`
-> 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 #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods (==) :: ListClustersResponse -> ListClustersResponse -> Bool # (/=) :: ListClustersResponse -> ListClustersResponse -> Bool #
Data ListClustersResponse #
Instance details Defined in Network.AWS.Snowball.ListClusters 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 #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods readsPrec :: Int -> ReadS ListClustersResponse # readList :: ReadS [ListClustersResponse] # readPrec :: ReadPrec ListClustersResponse # readListPrec :: ReadPrec [ListClustersResponse] #
Show ListClustersResponse #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods showsPrec :: Int -> ListClustersResponse -> ShowS # show :: ListClustersResponse -> String # showList :: [ListClustersResponse] -> ShowS #
Generic ListClustersResponse #
Instance details Defined in Network.AWS.Snowball.ListClusters Associated Types type Rep ListClustersResponse :: * -> * # Methods from :: ListClustersResponse -> Rep ListClustersResponse x # to :: Rep ListClustersResponse x -> ListClustersResponse #
NFData ListClustersResponse #
Instance details Defined in Network.AWS.Snowball.ListClusters Methods rnf :: ListClustersResponse -> () #
type Rep ListClustersResponse #
Instance details Defined in Network.AWS.Snowball.ListClusters type Rep ListClustersResponse = D1 (MetaData "ListClustersResponse" "Network.AWS.Snowball.ListClusters" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "ListClustersResponse'" PrefixI True) (S1 (MetaSel (Just "_lcrsClusterListEntries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ClusterListEntry])) :: (S1 (MetaSel (Just "_lcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_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.