listClusters method

Future<ListClustersResponse> listClusters({ int? maxResults, String? nextToken, })

Lists the Amazon EKS clusters in your AWS account in the specified Region.

May throw InvalidParameterException. May throw ClientException. May throw ServerException. May throw ServiceUnavailableException.

Parameter 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.

Parameter 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.

Implementation

Future<ListClustersResponse> listClusters({
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/clusters',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListClustersResponse.fromJson(response);
}