ListComputeNodeGroups
Returns a list of all compute node groups associated with a cluster.
Request Syntax
{
"clusterIdentifier": "string",
"maxResults": number,
"nextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- clusterIdentifier
-
The name or ID of the cluster to list compute node groups for.
Type: String
Pattern:
(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{3,40})Required: Yes
- maxResults
-
The maximum number of results that are returned per call. You can use
nextTokento 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.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
The value of
nextTokenis a unique pagination token for each page of results returned. IfnextTokenis 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 anHTTP 400 InvalidTokenerror.Type: String
Required: No
Response Syntax
{
"computeNodeGroups": [
{
"arn": "string",
"clusterId": "string",
"createdAt": "string",
"id": "string",
"modifiedAt": "string",
"name": "string",
"status": "string"
}
],
"nextToken": "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.
- computeNodeGroups
-
The list of compute node groups for the cluster.
Type: Array of ComputeNodeGroupSummary objects
- nextToken
-
The value of
nextTokenis a unique pagination token for each page of results returned. IfnextTokenis 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 anHTTP 400 InvalidTokenerror.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
HTTP Status Code: 400
-
- ConflictException
-
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
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
HTTP Status Code: 400
-
- InternalServerException
-
AWS PCS can't process your request right now. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
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
HTTP Status Code: 400
- ThrottlingException
-
Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
HTTP Status Code: 400
- ValidationException
-
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
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
