Skip to content

describe_eks_anywhere_subscription

describe_eks_anywhere_subscription(
    id: String, *, config_overrides: Optional[EKSClientConfig] = None
) -> DescribeEksAnywhereSubscriptionResponse

Returns descriptive information about a subscription.

Parameters:

  • id (String) –

    The ID of the subscription.

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.

  • 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/eks.py
def describe_eks_anywhere_subscription(
    self,
    id: "capo_eks.types.string.String",
    *,
    config_overrides: Optional[EKSClientConfig] = None,
) -> "capo_eks.types.describe_eks_anywhere_subscription_response.DescribeEksAnywhereSubscriptionResponse":
    """<p>Returns descriptive information about a subscription.</p>

    Args:
        id: <p>The ID of the subscription.</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.
    """

    def _handler(
        req: "OperationRequest[capo_eks.types.describe_eks_anywhere_subscription_request.DescribeEksAnywhereSubscriptionRequest]",
    ) -> OperationResponse[
        "capo_eks.types.describe_eks_anywhere_subscription_response.DescribeEksAnywhereSubscriptionResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_eks_anywhere_subscription

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEksAnywhereSubscription")
    )
    input_: capo_eks.types.describe_eks_anywhere_subscription_request.DescribeEksAnywhereSubscriptionRequest = {
        "id": id
    }

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