| 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.EKS.ListClusters
Description
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
This operation returns paginated results.
Synopsis
- data ListClusters = ListClusters' {}
- newListClusters :: ListClusters
- listClusters_include :: Lens' ListClusters (Maybe [Text])
- listClusters_nextToken :: Lens' ListClusters (Maybe Text)
- listClusters_maxResults :: Lens' ListClusters (Maybe Natural)
- data ListClustersResponse = ListClustersResponse' {}
- newListClustersResponse :: Int -> ListClustersResponse
- listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_clusters :: 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:include:ListClusters', listClusters_include - Indicates whether connected clusters are included in the returned list.
Default value is 'ALL'.
$sel:nextToken:ListClusters', listClusters_nextToken - 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 token should be treated as an opaque identifier that is used only 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 you use this parameter, ListClusters returns
only maxResults results in a single page along with a nextToken
response element. You can see the remaining results of the initial
request by sending another ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If you don't
use this parameter, ListClusters returns up to 100 results and a
nextToken value if applicable.
Request Lenses
listClusters_include :: Lens' ListClusters (Maybe [Text]) Source #
Indicates whether connected clusters are included in the returned list. Default value is 'ALL'.
listClusters_nextToken :: 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.
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #
The maximum number of cluster results returned by ListClusters in
paginated output. When you use this parameter, ListClusters returns
only maxResults results in a single page along with a nextToken
response element. You can see the remaining results of the initial
request by sending another ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If you don't
use this parameter, 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
| |
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:nextToken:ListClusters', listClustersResponse_nextToken - The nextToken value to include in a future ListClusters request.
When the results of a ListClusters request exceed maxResults, you
can use this value to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:clusters:ListClustersResponse', listClustersResponse_clusters - A list of all of the clusters for your account in the specified Region.
$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.
Response Lenses
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, you
can use this value to retrieve the next page of results. This value is
null when there are no more results to return.
listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [Text]) Source #
A list of all of the clusters for your account in the specified Region.
listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #
The response's http status code.