describe_capability ¶

describe_capability(
    cluster_name: String,
    capability_name: String,
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> DescribeCapabilityResponse

Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation.

Parameters:

cluster_name (String) –

The name of the Amazon EKS cluster that contains the capability you want to describe.
capability_name (String) –

The name of the capability to describe.

Raises:

AccessDeniedException –

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.
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_capability(
    self,
    cluster_name: "capo_eks.types.string.String",
    capability_name: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> "capo_eks.types.describe_capability_response.DescribeCapabilityResponse":
    """<p>Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation.</p>

    Args:
        cluster_name: <p>The name of the Amazon EKS cluster that contains the capability you want to describe.</p>
        capability_name: <p>The name of the capability to describe.</p>

    Raises:
        capo_eks.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to perform the requested operation. The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html">IAM principal</a> making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide</i>. </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_capability_request.DescribeCapabilityRequest]",
    ) -> OperationResponse[
        "capo_eks.types.describe_capability_response.DescribeCapabilityResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_capability

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCapability")
    )
    input_: capo_eks.types.describe_capability_request.DescribeCapabilityRequest = {
        "cluster_name": cluster_name,
        "capability_name": capability_name,
    }

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