describeUpdate method
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
When the status of the update is Succeeded
, the update is
complete. If an update fails, the status is Failed
, and an
error detail explains the reason for the failure.
May throw InvalidParameterException. May throw ClientException. May throw ServerException. May throw ResourceNotFoundException.
Parameter name
:
The name of the Amazon EKS cluster associated with the update.
Parameter updateId
:
The ID of the update to describe.
Parameter addonName
:
The name of the add-on. The name must match one of the names returned by
ListAddons
.
Parameter nodegroupName
:
The name of the Amazon EKS node group associated with the update.
Implementation
Future<DescribeUpdateResponse> describeUpdate({
required String name,
required String updateId,
String? addonName,
String? nodegroupName,
}) async {
ArgumentError.checkNotNull(name, 'name');
ArgumentError.checkNotNull(updateId, 'updateId');
final $query = <String, List<String>>{
if (addonName != null) 'addonName': [addonName],
if (nodegroupName != null) 'nodegroupName': [nodegroupName],
};
final response = await _protocol.send(
payload: null,
method: 'GET',
requestUri:
'/clusters/${Uri.encodeComponent(name)}/updates/${Uri.encodeComponent(updateId)}',
queryParams: $query,
exceptionFnMap: _exceptionFns,
);
return DescribeUpdateResponse.fromJson(response);
}