Class ListVirtualClustersCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { EMRContainersClient, ListVirtualClustersCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import
// const { EMRContainersClient, ListVirtualClustersCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import
const client = new EMRContainersClient(config);
const input = { // ListVirtualClustersRequest
  containerProviderId: "STRING_VALUE",
  containerProviderType: "EKS",
  createdAfter: new Date("TIMESTAMP"),
  createdBefore: new Date("TIMESTAMP"),
  states: [ // VirtualClusterStates
    "RUNNING" || "TERMINATING" || "TERMINATED" || "ARRESTED",
  ],
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListVirtualClustersCommand(input);
const response = await client.send(command);
// { // ListVirtualClustersResponse
//   virtualClusters: [ // VirtualClusters
//     { // VirtualCluster
//       id: "STRING_VALUE",
//       name: "STRING_VALUE",
//       arn: "STRING_VALUE",
//       state: "RUNNING" || "TERMINATING" || "TERMINATED" || "ARRESTED",
//       containerProvider: { // ContainerProvider
//         type: "EKS", // required
//         id: "STRING_VALUE", // required
//         info: { // ContainerInfo Union: only one key present
//           eksInfo: { // EksInfo
//             namespace: "STRING_VALUE",
//           },
//         },
//       },
//       createdAt: new Date("TIMESTAMP"),
//       tags: { // TagMap
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListVirtualClustersCommandInput

Returns

ListVirtualClustersCommandOutput

See

• ListVirtualClustersCommandInput for command's input shape.
• ListVirtualClustersCommandOutput for command's response shape.
• config for EMRContainersClient's config shape.

Throws

InternalServerException (server fault)

This is an internal server exception.

Throws

ValidationException (client fault)

There are invalid parameters in the client request.

Throws

EMRContainersServiceException

Base exception class for all service exceptions from EMRContainers service.