| 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.ListNodegroups
Description
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
This operation returns paginated results.
Synopsis
- data ListNodegroups = ListNodegroups' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- clusterName :: Text
- newListNodegroups :: Text -> ListNodegroups
- listNodegroups_nextToken :: Lens' ListNodegroups (Maybe Text)
- listNodegroups_maxResults :: Lens' ListNodegroups (Maybe Natural)
- listNodegroups_clusterName :: Lens' ListNodegroups Text
- data ListNodegroupsResponse = ListNodegroupsResponse' {
- nodegroups :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListNodegroupsResponse :: Int -> ListNodegroupsResponse
- listNodegroupsResponse_nodegroups :: Lens' ListNodegroupsResponse (Maybe [Text])
- listNodegroupsResponse_nextToken :: Lens' ListNodegroupsResponse (Maybe Text)
- listNodegroupsResponse_httpStatus :: Lens' ListNodegroupsResponse Int
Creating a Request
data ListNodegroups Source #
See: newListNodegroups smart constructor.
Constructors
| ListNodegroups' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListNodegroups |
Create a value of ListNodegroups 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:ListNodegroups', listNodegroups_nextToken - The nextToken value returned from a previous paginated
ListNodegroups 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.
$sel:maxResults:ListNodegroups', listNodegroups_maxResults - The maximum number of node group results returned by ListNodegroups in
paginated output. When you use this parameter, ListNodegroups 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 ListNodegroups request with the returned
nextToken value. This value can be between 1 and 100. If you don't
use this parameter, ListNodegroups returns up to 100 results and a
nextToken value if applicable.
$sel:clusterName:ListNodegroups', listNodegroups_clusterName - The name of the Amazon EKS cluster that you would like to list node
groups in.
Request Lenses
listNodegroups_nextToken :: Lens' ListNodegroups (Maybe Text) Source #
The nextToken value returned from a previous paginated
ListNodegroups 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.
listNodegroups_maxResults :: Lens' ListNodegroups (Maybe Natural) Source #
The maximum number of node group results returned by ListNodegroups in
paginated output. When you use this parameter, ListNodegroups 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 ListNodegroups request with the returned
nextToken value. This value can be between 1 and 100. If you don't
use this parameter, ListNodegroups returns up to 100 results and a
nextToken value if applicable.
listNodegroups_clusterName :: Lens' ListNodegroups Text Source #
The name of the Amazon EKS cluster that you would like to list node groups in.
Destructuring the Response
data ListNodegroupsResponse Source #
See: newListNodegroupsResponse smart constructor.
Constructors
| ListNodegroupsResponse' | |
Fields
| |
Instances
newListNodegroupsResponse Source #
Create a value of ListNodegroupsResponse 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:nodegroups:ListNodegroupsResponse', listNodegroupsResponse_nodegroups - A list of all of the node groups associated with the specified cluster.
$sel:nextToken:ListNodegroups', listNodegroupsResponse_nextToken - The nextToken value to include in a future ListNodegroups request.
When the results of a ListNodegroups 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:httpStatus:ListNodegroupsResponse', listNodegroupsResponse_httpStatus - The response's http status code.
Response Lenses
listNodegroupsResponse_nodegroups :: Lens' ListNodegroupsResponse (Maybe [Text]) Source #
A list of all of the node groups associated with the specified cluster.
listNodegroupsResponse_nextToken :: Lens' ListNodegroupsResponse (Maybe Text) Source #
The nextToken value to include in a future ListNodegroups request.
When the results of a ListNodegroups 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.
listNodegroupsResponse_httpStatus :: Lens' ListNodegroupsResponse Int Source #
The response's http status code.