Network.AWS.ECS.ListClusters

Returns a list of existing clusters.

See: AWS API Reference for ListClusters.

This operation returns paginated results.

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
• lcMaxResults

data ListClusters

See: listClusters smart constructor.

Instances

Eq ListClusters

Methods

(==) :: ListClusters -> ListClusters -> Bool

(/=) :: ListClusters -> ListClusters -> Bool

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

Methods

readsPrec :: Int -> ReadS ListClusters

readList :: ReadS [ListClusters]

readPrec :: ReadPrec ListClusters

readListPrec :: ReadPrec [ListClusters]

Show ListClusters

Methods

showsPrec :: Int -> ListClusters -> ShowS

show :: ListClusters -> String

showList :: [ListClusters] -> ShowS

Generic ListClusters

Associated Types

type Rep ListClusters :: * -> *

Methods

from :: ListClusters -> Rep ListClusters x

to :: Rep ListClusters x -> ListClusters

ToJSON ListClusters

Methods

toJSON :: ListClusters -> Value

toEncoding :: ListClusters -> Encoding

toJSONList :: [ListClusters] -> Value

toEncodingList :: [ListClusters] -> Encoding

AWSPager ListClusters

Methods

page :: ListClusters -> Rs ListClusters -> Maybe ListClusters

AWSRequest ListClusters

Associated Types

type Rs ListClusters :: *

Methods

request :: ListClusters -> Request ListClusters

response :: MonadResource m => Logger -> Service -> Proxy * ListClusters -> ClientResponse -> m (Response ListClusters)

ToQuery ListClusters

Methods

toQuery :: ListClusters -> QueryString

ToPath ListClusters

Methods

toPath :: ListClusters -> ByteString

ToHeaders ListClusters

Methods

toHeaders :: ListClusters -> [Header]

type Rep ListClusters

type Rep ListClusters = D1 (MetaData "ListClusters" "Network.AWS.ECS.ListClusters" "amazonka-ecs-1.3.7-Ha9ctxkGfT14fSx4QrugPG" 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 Int)))))

type Rs ListClusters

type Rs ListClusters = ListClustersResponse

Request Lenses

lcNextToken :: Lens' ListClusters (Maybe Text)

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. This value is null when there are no more results to return.

lcMaxResults :: Lens' ListClusters (Maybe Int)

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

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:

• lcrsClusterARNs
• lcrsNextToken
• lcrsResponseStatus

data ListClustersResponse

See: listClustersResponse smart constructor.

Instances

Eq ListClustersResponse

Methods

(==) :: ListClustersResponse -> ListClustersResponse -> Bool

(/=) :: ListClustersResponse -> ListClustersResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS ListClustersResponse

readList :: ReadS [ListClustersResponse]

readPrec :: ReadPrec ListClustersResponse

readListPrec :: ReadPrec [ListClustersResponse]

Show ListClustersResponse

Methods

showsPrec :: Int -> ListClustersResponse -> ShowS

show :: ListClustersResponse -> String

showList :: [ListClustersResponse] -> ShowS

Generic ListClustersResponse

Associated Types

type Rep ListClustersResponse :: * -> *

Methods

from :: ListClustersResponse -> Rep ListClustersResponse x

to :: Rep ListClustersResponse x -> ListClustersResponse

type Rep ListClustersResponse

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

Response Lenses

lcrsClusterARNs :: Lens' ListClustersResponse [Text]

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

lcrsNextToken :: Lens' ListClustersResponse (Maybe Text)

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

The response status code.