Skip to content

delete_nodegroup async

delete_nodegroup(
    cluster_name: String,
    nodegroup_name: String,
    *,
    config_overrides: Optional[AsyncEKSClientConfig] = None,
) -> DeleteNodegroupResponse

Deletes a managed node group.

Parameters:

  • cluster_name (String) –

    The name of your cluster.

  • nodegroup_name (String) –

    The name of the node group to delete.

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.

  • ResourceInUseException –

    The specified resource is in use.

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

  • ServiceUnavailableException –

    The service is unavailable. Back off and retry the operation.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_eks/_services/async_eks.py
async def delete_nodegroup(
    self,
    cluster_name: "capo_eks.types.string.String",
    nodegroup_name: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[AsyncEKSClientConfig] = None,
) -> "capo_eks.types.delete_nodegroup_response.DeleteNodegroupResponse":
    """<p>Deletes a managed node group.</p>

    Args:
        cluster_name: <p>The name of your cluster.</p>
        nodegroup_name: <p>The name of the node group to delete.</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_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</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.service_unavailable_exception.ServiceUnavailableException: <p>The service is unavailable. Back off and retry the operation.</p>
        capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_eks.types.delete_nodegroup_request.DeleteNodegroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_eks.types.delete_nodegroup_response.DeleteNodegroupResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.delete_nodegroup

        (
            output,
            http_response,
        ) = await capo_eks._operations.aws_wesley_frontend.delete_nodegroup.async_delete_nodegroup(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteNodegroup")
    )
    input_: capo_eks.types.delete_nodegroup_request.DeleteNodegroupRequest = {
        "cluster_name": cluster_name,
        "nodegroup_name": nodegroup_name,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output