describe_cluster ¶

def describe_cluster(
    self,
    name: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> "capo_eks.types.describe_cluster_response.DescribeClusterResponse":
    """<p>Describes an Amazon EKS cluster.</p> <p>The API server endpoint and certificate authority data returned by this operation are required for <code>kubelet</code> and <code>kubectl</code> to communicate with your Kubernetes API server. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html">Creating or updating a <code>kubeconfig</code> file for an Amazon EKS cluster</a>.</p> <note> <p>The API server endpoint and certificate authority data aren't available until the cluster reaches the <code>ACTIVE</code> state.</p> </note>

    Args:
        name: <p>The name of your cluster.</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.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.

    Examples:
        To describe a cluster
        This example command provides a description of the specified cluster in your default region.

        >>> client.describe_cluster(name='devel')
    """

    def _handler(
        req: "OperationRequest[capo_eks.types.describe_cluster_request.DescribeClusterRequest]",
    ) -> OperationResponse[
        "capo_eks.types.describe_cluster_response.DescribeClusterResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_cluster

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCluster")
    )
    input_: capo_eks.types.describe_cluster_request.DescribeClusterRequest = {
        "name": name
    }

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