list_updates ¶

def list_updates(
    self,
    name: "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,
    next_token: Optional["capo_eks.types.string.String"] = None,
    max_results: Optional[
        "capo_eks.types.list_updates_request_max_results.ListUpdatesRequestMaxResults"
    ] = None,
) -> "capo_eks.types.list_updates_response.ListUpdatesResponse":
    """<p>Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.</p>

    Args:
        name: <p>The name of the Amazon EKS cluster to list updates for.</p>
        nodegroup_name: <p>The name of the Amazon EKS managed node group to list updates for.</p>
        addon_name: <p>The names of the installed add-ons that have available updates.</p>
        capability_name: <p>The name of the capability for which you want to list updates.</p>
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated request, where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</p> </note>
        max_results: <p>The maximum number of results, returned in paginated output. You receive <code>maxResults</code> in a single page, along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <code>nextToken</code> value, if applicable, are returned.</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.list_updates_request.ListUpdatesRequest]",
    ) -> OperationResponse[
        "capo_eks.types.list_updates_response.ListUpdatesResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.list_updates

        output, http_response = (
            capo_eks._operations.aws_wesley_frontend.list_updates.list_updates(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListUpdates")
    )
    input_: capo_eks.types.list_updates_request.ListUpdatesRequest = {"name": name}
    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
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output