Class ListKxClustersCommandProtected

Returns a list of clusters.

Example

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

import { FinspaceClient, ListKxClustersCommand } from "@aws-sdk/client-finspace"; // ES Modules import
// const { FinspaceClient, ListKxClustersCommand } = require("@aws-sdk/client-finspace"); // CommonJS import
const client = new FinspaceClient(config);
const input = { // ListKxClustersRequest
  environmentId: "STRING_VALUE", // required
  clusterType: "HDB" || "RDB" || "GATEWAY",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListKxClustersCommand(input);
const response = await client.send(command);
// { // ListKxClustersResponse
//   kxClusterSummaries: [ // KxClusters
//     { // KxCluster
//       status: "PENDING" || "CREATING" || "CREATE_FAILED" || "RUNNING" || "UPDATING" || "DELETING" || "DELETED" || "DELETE_FAILED",
//       statusReason: "STRING_VALUE",
//       clusterName: "STRING_VALUE",
//       clusterType: "HDB" || "RDB" || "GATEWAY",
//       clusterDescription: "STRING_VALUE",
//       releaseLabel: "STRING_VALUE",
//       initializationScript: "STRING_VALUE",
//       executionRole: "STRING_VALUE",
//       azMode: "SINGLE" || "MULTI",
//       availabilityZoneId: "STRING_VALUE",
//       lastModifiedTimestamp: new Date("TIMESTAMP"),
//       createdTimestamp: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListKxClustersCommandInput

Returns

ListKxClustersCommandOutput

See

• ListKxClustersCommandInput for command's input shape.
• ListKxClustersCommandOutput for command's response shape.
• config for FinspaceClient's config shape.

Throws

AccessDeniedException (client fault)

You do not have sufficient access to perform this action.

Throws

ConflictException (client fault)

There was a conflict with this action, and it could not be completed.

Throws

InternalServerException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

LimitExceededException (client fault)

A service limit or quota is exceeded.

Throws

ResourceNotFoundException (client fault)

One or more resources can't be found.

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

ValidationException (client fault)

The input fails to satisfy the constraints specified by an AWS service.

Throws

FinspaceServiceException

Base exception class for all service exceptions from Finspace service.