Skip to content

describe_virtual_cluster async

describe_virtual_cluster(
    id: ResourceIdString,
    *,
    config_overrides: Optional[AsyncEMRcontainersClientConfig] = None,
) -> DescribeVirtualClusterResponse

Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Parameters:

  • id (ResourceIdString) –

    The ID of the virtual cluster that will be described.

Raises:

Source code in docs_src/capo_emr_containers/_services/async_em_rcontainers.py
async def describe_virtual_cluster(
    self,
    id: "capo_emr_containers.types.resource_id_string.ResourceIdString",
    *,
    config_overrides: Optional[AsyncEMRcontainersClientConfig] = None,
) -> "capo_emr_containers.types.describe_virtual_cluster_response.DescribeVirtualClusterResponse":
    """<p>Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.</p>

    Args:
        id: <p>The ID of the virtual cluster that will be described.</p>

    Raises:
        capo_emr_containers.errors.internal_server_exception.InternalServerException: <p>This is an internal server exception.</p>
        capo_emr_containers.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_emr_containers.errors.validation_exception.ValidationException: <p>There are invalid parameters in the client request.</p>
        capo_emr_containers.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_emr_containers.types.describe_virtual_cluster_request.DescribeVirtualClusterRequest]",
    ) -> AsyncOperationResponse[
        "capo_emr_containers.types.describe_virtual_cluster_response.DescribeVirtualClusterResponse"
    ]:
        import capo_emr_containers._operations.aws_chicago_web_service.describe_virtual_cluster

        (
            output,
            http_response,
        ) = await capo_emr_containers._operations.aws_chicago_web_service.describe_virtual_cluster.async_describe_virtual_cluster(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVirtualCluster")
    )
    input_: capo_emr_containers.types.describe_virtual_cluster_request.DescribeVirtualClusterRequest = {
        "id": id
    }

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