Copyright	(c) 2013-2021 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

Amazonka.ECS.ListClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of existing clusters.

This operation returns paginated results.

Synopsis

Creating a Request

data ListClusters Source #

See: newListClusters smart constructor.

Constructors

ListClusters'

Fields

nextToken :: Maybe Text
The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
maxResults :: 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.

Instances

Instances details

Eq ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods (==) :: ListClusters -> ListClusters -> Bool # (/=) :: ListClusters -> ListClusters -> Bool #
Read ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods readsPrec :: Int -> ReadS ListClusters # readList :: ReadS [ListClusters] # readPrec :: ReadPrec ListClusters # readListPrec :: ReadPrec [ListClusters] #
Show ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods showsPrec :: Int -> ListClusters -> ShowS # show :: ListClusters -> String # showList :: [ListClusters] -> ShowS #
Generic ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Associated Types type Rep ListClusters :: Type -> Type # Methods from :: ListClusters -> Rep ListClusters x # to :: Rep ListClusters x -> ListClusters #
NFData ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods rnf :: ListClusters -> () #
Hashable ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods hashWithSalt :: Int -> ListClusters -> Int # hash :: ListClusters -> Int #
ToJSON ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods toJSON :: ListClusters -> Value # toEncoding :: ListClusters -> Encoding # toJSONList :: [ListClusters] -> Value # toEncodingList :: [ListClusters] -> Encoding #
AWSPager ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods page :: ListClusters -> AWSResponse ListClusters -> Maybe ListClusters #
AWSRequest ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Associated Types type AWSResponse ListClusters # Methods request :: ListClusters -> Request ListClusters # response :: MonadResource m => Logger -> Service -> Proxy ListClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListClusters))) #
ToHeaders ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods toHeaders :: ListClusters -> [Header] #
ToPath ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods toPath :: ListClusters -> ByteString #
ToQuery ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods toQuery :: ListClusters -> QueryString #
type Rep ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters type Rep ListClusters = D1 ('MetaData "ListClusters" "Amazonka.ECS.ListClusters" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))
type AWSResponse ListClusters Source #
Instance details Defined in Amazonka.ECS.ListClusters type AWSResponse ListClusters = ListClustersResponse

newListClusters :: ListClusters Source #

Create a value of ListClusters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListClusters', listClusters_nextToken - The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

$sel:maxResults:ListClusters', listClusters_maxResults - 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.

Request Lenses

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

The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listClusters_maxResults :: 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

data ListClustersResponse Source #

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'

Fields

clusterArns :: Maybe [Text]
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
nextToken :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListClustersResponse Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods (==) :: ListClustersResponse -> ListClustersResponse -> Bool # (/=) :: ListClustersResponse -> ListClustersResponse -> Bool #
Read ListClustersResponse Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods readsPrec :: Int -> ReadS ListClustersResponse # readList :: ReadS [ListClustersResponse] # readPrec :: ReadPrec ListClustersResponse # readListPrec :: ReadPrec [ListClustersResponse] #
Show ListClustersResponse Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods showsPrec :: Int -> ListClustersResponse -> ShowS # show :: ListClustersResponse -> String # showList :: [ListClustersResponse] -> ShowS #
Generic ListClustersResponse Source #
Instance details Defined in Amazonka.ECS.ListClusters Associated Types type Rep ListClustersResponse :: Type -> Type # Methods from :: ListClustersResponse -> Rep ListClustersResponse x # to :: Rep ListClustersResponse x -> ListClustersResponse #
NFData ListClustersResponse Source #
Instance details Defined in Amazonka.ECS.ListClusters Methods rnf :: ListClustersResponse -> () #
type Rep ListClustersResponse Source #
Instance details Defined in Amazonka.ECS.ListClusters type Rep ListClustersResponse = D1 ('MetaData "ListClustersResponse" "Amazonka.ECS.ListClusters" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListClustersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListClustersResponse'`
-> ListClustersResponse

Create a value of ListClustersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clusterArns:ListClustersResponse', listClustersResponse_clusterArns - The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

$sel:nextToken:ListClusters', listClustersResponse_nextToken - 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.

$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.

Response Lenses

listClustersResponse_clusterArns :: Lens' ListClustersResponse (Maybe [Text]) Source #

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

listClustersResponse_nextToken :: 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.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #

The response's http status code.