DescribeVirtualCluster - Amazon EMR Containers

DescribeVirtualCluster

Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, 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.

Request Syntax

GET /virtualclusters/virtualClusterId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

virtualClusterId

The ID of the virtual cluster that will be described.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-z]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "virtualCluster": { "arn": "string", "containerProvider": { "id": "string", "info": { "eksInfo": { "namespace": "string" } }, "type": "string" }, "createdAt": number, "id": "string", "name": "string", "state": "string", "tags": { "string" : "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

virtualCluster

This output displays information about the specified virtual cluster.

Type: VirtualCluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

This is an internal server exception.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

ValidationException

There are invalid parameters in the client request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: