| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ECS.ListClusters
Description
Returns a list of existing clusters.
This operation returns paginated results.
Synopsis
- data ListClusters = ListClusters' {}
- newListClusters :: ListClusters
- listClusters_maxResults :: Lens' ListClusters (Maybe Int)
- listClusters_nextToken :: Lens' ListClusters (Maybe Text)
- data ListClustersResponse = ListClustersResponse' {
- clusterArns :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListClustersResponse :: Int -> ListClustersResponse
- listClustersResponse_clusterArns :: Lens' ListClustersResponse (Maybe [Text])
- listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_httpStatus :: Lens' ListClustersResponse Int
Creating a Request
data ListClusters Source #
See: newListClusters smart constructor.
Constructors
| ListClusters' | |
Fields
| |
Instances
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:maxResults:ListClusters', listClusters_maxResults - The maximum number of cluster results that ListClusters returned 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 isn't used, then ListClusters returns up to 100 results and
a nextToken value if applicable.
ListClusters, listClusters_nextToken - The nextToken value returned from a ListClusters request indicating
that more results are available to fulfill the request and further calls
are needed. If maxResults was provided, it's 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.
Request Lenses
listClusters_maxResults :: Lens' ListClusters (Maybe Int) Source #
The maximum number of cluster results that ListClusters returned 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 isn't used, then ListClusters returns up to 100 results and
a nextToken value if applicable.
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
are needed. If maxResults was provided, it's 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.
Destructuring the Response
data ListClustersResponse Source #
See: newListClustersResponse smart constructor.
Constructors
| ListClustersResponse' | |
Fields
| |
Instances
newListClustersResponse Source #
Arguments
| :: Int | |
| -> 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
that's associated with your account.
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 that's 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.