listUpdates method

Future<ListUpdatesResponse> listUpdates({
  1. required String name,
  2. String? addonName,
  3. int? maxResults,
  4. String? nextToken,
  5. String? nodegroupName,
})

Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.

May throw InvalidParameterException. May throw ClientException. May throw ServerException. May throw ResourceNotFoundException.

Parameter name : The name of the Amazon EKS cluster to list updates for.

Parameter addonName : The names of the installed add-ons that have available updates.

Parameter maxResults : The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates 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 ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.

Parameter nextToken : The nextToken value returned from a previous paginated ListUpdates 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.

Parameter nodegroupName : The name of the Amazon EKS managed node group to list updates for.

Implementation

Future<ListUpdatesResponse> listUpdates({
  required String name,
  String? addonName,
  int? maxResults,
  String? nextToken,
  String? nodegroupName,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (addonName != null) 'addonName': [addonName],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (nodegroupName != null) 'nodegroupName': [nodegroupName],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/clusters/${Uri.encodeComponent(name)}/updates',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListUpdatesResponse.fromJson(response);
}