amazonka-ecs-1.6.1: Amazon EC2 Container Service 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.ECS.ListClusters

Contents

Description

Returns a list of existing clusters.

This operation returns paginated results.

Synopsis

Creating a Request

listClusters :: ListClusters Source #

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 - The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  • lcMaxResults - The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

data ListClusters Source #

See: listClusters smart constructor.

Instances
Eq ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Data ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.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 Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Show ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Generic ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Associated Types

type Rep ListClusters :: Type -> Type #

Hashable ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

ToJSON ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

AWSPager ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

AWSRequest ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Associated Types

type Rs ListClusters :: Type #

ToHeaders ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

ToPath ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

ToQuery ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

NFData ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Methods

rnf :: ListClusters -> () #

type Rep ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

type Rep ListClusters = D1 (MetaData "ListClusters" "Network.AWS.ECS.ListClusters" "amazonka-ecs-1.6.1-7o1YH8hMK1ABbFowaTE1Sy" 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 Int))))
type Rs ListClusters Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Request Lenses

lcNextToken :: Lens' ListClusters (Maybe Text) Source #

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

lcMaxResults :: Lens' ListClusters (Maybe Int) Source #

The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

Destructuring the Response

listClustersResponse Source #

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:

  • lcrsClusterARNs - The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
  • lcrsNextToken - The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
  • lcrsResponseStatus - -- | The response status code.

data ListClustersResponse Source #

See: listClustersResponse smart constructor.

Instances
Eq ListClustersResponse Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Data ListClustersResponse Source # 
Instance details

Defined in Network.AWS.ECS.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 Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Show ListClustersResponse Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Generic ListClustersResponse Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Associated Types

type Rep ListClustersResponse :: Type -> Type #

NFData ListClustersResponse Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

Methods

rnf :: ListClustersResponse -> () #

type Rep ListClustersResponse Source # 
Instance details

Defined in Network.AWS.ECS.ListClusters

type Rep ListClustersResponse = D1 (MetaData "ListClustersResponse" "Network.AWS.ECS.ListClusters" "amazonka-ecs-1.6.1-7o1YH8hMK1ABbFowaTE1Sy" False) (C1 (MetaCons "ListClustersResponse'" PrefixI True) (S1 (MetaSel (Just "_lcrsClusterARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_lcrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lcrsClusterARNs :: Lens' ListClustersResponse [Text] Source #

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

lcrsNextToken :: Lens' ListClustersResponse (Maybe Text) Source #

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

lcrsResponseStatus :: Lens' ListClustersResponse Int Source #

  • - | The response status code.