ListComputeNodeGroupsCommand

Suggest an Edit

Returns a list of all compute node groups associated with a cluster.

Example Syntax

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

import { PCSClient, ListComputeNodeGroupsCommand } from "@aws-sdk/client-pcs"; // ES Modules import
// const { PCSClient, ListComputeNodeGroupsCommand } = require("@aws-sdk/client-pcs"); // CommonJS import
const client = new PCSClient(config);
const input = { // ListComputeNodeGroupsRequest
  clusterIdentifier: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListComputeNodeGroupsCommand(input);
const response = await client.send(command);
// { // ListComputeNodeGroupsResponse
//   computeNodeGroups: [ // ComputeNodeGroupList // required
//     { // ComputeNodeGroupSummary
//       name: "STRING_VALUE", // required
//       id: "STRING_VALUE", // required
//       arn: "STRING_VALUE", // required
//       clusterId: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       modifiedAt: new Date("TIMESTAMP"), // required
//       status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED" || "UPDATE_FAILED" || "DELETED", // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListComputeNodeGroupsCommand Input

See ListComputeNodeGroupsCommandInput for more details

Parameter
Type
Description
clusterIdentifier
Required
string | undefined

The name or ID of the cluster to list compute node groups for.

maxResults
number | undefined

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

nextToken
string | undefined

The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

ListComputeNodeGroupsCommand Output

See ListComputeNodeGroupsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
computeNodeGroups
Required
ComputeNodeGroupSummary[] | undefined

The list of compute node groups for the cluster.

nextToken
string | undefined

The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permission to perform the action.

Examples

  • The launch template instance profile doesn't pass iam:PassRole verification.

  • There is a mismatch between the account ID and cluster ID.

  • The cluster ID doesn't exist.

  • The EC2 instance isn't present.

ConflictException
client

Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.

Examples

  • A cluster with the same name already exists.

  • A cluster isn't in ACTIVE status.

  • A cluster to delete is in an unstable state. For example, because it still has ACTIVE node groups or queues.

  • A queue already exists in a cluster.

InternalServerException
server

Amazon Web Services PCS can't process your request right now. Try again later.

ResourceNotFoundException
client

The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.

Examples

ThrottlingException
client

Your request exceeded a request rate quota. Check the resource's request rate quota and try again.

ValidationException
client

The request isn't valid.

Examples

  • Your request contains malformed JSON or unsupported characters.

  • The scheduler version isn't supported.

  • There are networking related errors, such as network validation failure.

  • AMI type is CUSTOM and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.

PCSServiceException
Base exception class for all service exceptions from PCS service.