describe_insight ¶

describe_insight(
    cluster_name: String,
    id: String,
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> DescribeInsightResponse

Returns details about an insight that you specify using its ID.

Parameters:

cluster_name (String) –

The name of the cluster to describe the insight for.
id (String) –

The identity of the insight to describe.

Raises:

InvalidParameterException –

The specified parameter is invalid. Review the available parameters for the API request.
InvalidRequestException –

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
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_insight(
    self,
    cluster_name: "capo_eks.types.string.String",
    id: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> "capo_eks.types.describe_insight_response.DescribeInsightResponse":
    """<p>Returns details about an insight that you specify using its ID.</p>

    Args:
        cluster_name: <p>The name of the cluster to describe the insight for.</p>
        id: <p>The identity of the insight to describe.</p>

    Raises:
        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.invalid_request_exception.InvalidRequestException: <p>The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.</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_insight_request.DescribeInsightRequest]",
    ) -> OperationResponse[
        "capo_eks.types.describe_insight_response.DescribeInsightResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_insight

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeInsight")
    )
    input_: capo_eks.types.describe_insight_request.DescribeInsightRequest = {
        "cluster_name": cluster_name,
        "id": id,
    }

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