Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.
Request Syntax
{
"clusterIdentifier": "string",
"computeNodeGroupIdentifier": "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.
Type: String
Pattern:
(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,40})Required: Yes
- computeNodeGroupIdentifier
-
The name or ID of the compute node group.
Type: String
Pattern:
(pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,25})Required: Yes
Response Syntax
{
"computeNodeGroup": {
"amiId": "string",
"arn": "string",
"clusterId": "string",
"createdAt": "string",
"customLaunchTemplate": {
"id": "string",
"version": "string"
},
"errorInfo": [
{
"code": "string",
"message": "string"
}
],
"iamInstanceProfileArn": "string",
"id": "string",
"instanceConfigs": [
{
"instanceType": "string"
}
],
"modifiedAt": "string",
"name": "string",
"purchaseOption": "string",
"scalingConfiguration": {
"maxInstanceCount": number,
"minInstanceCount": number
},
"slurmConfiguration": {
"slurmCustomSettings": [
{
"parameterName": "string",
"parameterValue": "string"
}
]
},
"spotOptions": {
"allocationStrategy": "string"
},
"status": "string",
"subnetIds": [ "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.
- computeNodeGroup
-
A compute node group associated with a cluster.
Type: ComputeNodeGroup object
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:
