Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListVirtualClusters

Lists information about the 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?containerProviderId=containerProviderId&containerProviderType=containerProviderType&createdAfter=createdAfter&createdBefore=createdBefore&eksAccessEntryIntegrated=eksAccessEntryIntegrated&maxResults=maxResults&nextToken=nextToken&states=states HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

containerProviderId

The container provider ID of the virtual cluster.

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

Pattern: .*\S.*

containerProviderType

The container provider type of the virtual cluster. Amazon EKS is the only supported type as of now.

Valid Values: EKS

createdAfter

The date and time after which the virtual clusters are created.

createdBefore

The date and time before which the virtual clusters are created.

eksAccessEntryIntegrated

Optional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.

maxResults

The maximum number of virtual clusters that can be listed.

nextToken

The token for the next set of virtual clusters to return.

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

Pattern: .*\S.*

states

The states of the requested virtual clusters.

Array Members: Maximum number of 10 items.

Valid Values: RUNNING | TERMINATING | TERMINATED | ARRESTED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "virtualClusters": [ 
      { 
         "arn": "string",
         "containerProvider": { 
            "id": "string",
            "info": { ... },
            "type": "string"
         },
         "createdAt": "string",
         "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.

nextToken

This output displays the token for the next set of virtual clusters.

Type: String

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

Pattern: .*\S.*

virtualClusters

This output lists the specified virtual clusters.

Type: Array of VirtualCluster objects

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

ValidationException

There are invalid parameters in the client request.

HTTP Status Code: 400