Describes an update to an Amazon EKS resource.
When the status of the update is Successful, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.
Parameters:
-
name
(String)
–
The name of the Amazon EKS cluster associated with the update.
-
update_id
(String)
–
The ID of the update to describe.
-
nodegroup_name
(Optional[String], default:
None
)
–
The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.
-
addon_name
(Optional[String], default:
None
)
–
The name of the add-on. The name must match one of the names returned by ListAddons . This parameter is required if the update is an add-on update.
-
capability_name
(Optional[String], default:
None
)
–
The name of the capability for which you want to describe updates.
Raises:
-
ClientException
–
These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.
-
InvalidParameterException
–
The specified parameter is invalid. Review the available parameters for the API request.
-
ResourceNotFoundException
–
The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.
-
ServerException
–
These errors are usually caused by a server-side issue.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_eks/_services/eks.py
| def describe_update(
self,
name: "capo_eks.types.string.String",
update_id: "capo_eks.types.string.String",
*,
config_overrides: Optional[EKSClientConfig] = None,
nodegroup_name: Optional["capo_eks.types.string.String"] = None,
addon_name: Optional["capo_eks.types.string.String"] = None,
capability_name: Optional["capo_eks.types.string.String"] = None,
) -> "capo_eks.types.describe_update_response.DescribeUpdateResponse":
"""<p>Describes an update to an Amazon EKS resource.</p> <p>When the status of the update is <code>Successful</code>, the update is complete. If an update fails, the status is <code>Failed</code>, and an error detail explains the reason for the failure.</p>
Args:
name: <p>The name of the Amazon EKS cluster associated with the update.</p>
update_id: <p>The ID of the update to describe.</p>
nodegroup_name: <p>The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.</p>
addon_name: <p>The name of the add-on. The name must match one of the names returned by <a href="https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html"> <code>ListAddons</code> </a>. This parameter is required if the update is an add-on update.</p>
capability_name: <p>The name of the capability for which you want to describe updates.</p>
Raises:
capo_eks.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html">IAM principal</a> that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.</p>
capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
capo_eks.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. You can view your available clusters with <code>ListClusters</code>. You can view your available managed node groups with <code>ListNodegroups</code>. Amazon EKS clusters and node groups are Amazon Web Services Region specific.</p>
capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_eks.types.describe_update_request.DescribeUpdateRequest]",
) -> OperationResponse[
"capo_eks.types.describe_update_response.DescribeUpdateResponse"
]:
import capo_eks._operations.aws_wesley_frontend.describe_update
output, http_response = (
capo_eks._operations.aws_wesley_frontend.describe_update.describe_update(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeUpdate")
)
input_: capo_eks.types.describe_update_request.DescribeUpdateRequest = {
"name": name,
"update_id": update_id,
}
if nodegroup_name is not None:
input_["nodegroup_name"] = nodegroup_name
if addon_name is not None:
input_["addon_name"] = addon_name
if capability_name is not None:
input_["capability_name"] = capability_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|