Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

RegisterComputeNodeGroupInstance

Important

This API action isn't intended for you to use.

AWS PCS uses this API action to register the compute nodes it launches in your account.

Request Syntax


{
   "bootstrapId": "string",
   "clusterIdentifier": "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.

bootstrapId

The client-generated token to allow for retries.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [\S]+

Required: Yes

clusterIdentifier

The name or ID of the cluster to register the compute node group instance in.

Type: String

Pattern: (pcs_[a-zA-Z0-9]+|[A-Za-z][A-Za-z0-9-]{2,40})

Required: Yes

Response Syntax


{
   "clusterName": "string",
   "computeNodeGroupId": "string",
   "computeNodeGroupName": "string",
   "endpoints": [ 
      { 
         "ipv6Address": "string",
         "port": "string",
         "privateIpAddress": "string",
         "publicIpAddress": "string",
         "type": "string"
      }
   ],
   "nodeID": "string",
   "nodeLifecycleActions": { 
      "scriptCachingPolicy": "string",
      "stages": { 
         "nodeBootstrapped": [ 
            { 
               "arguments": [ "string" ],
               "executionPolicy": "string",
               "name": "string",
               "onError": "string",
               "scriptSource": { 
                  "checksum": "string",
                  "s3VersionId": "string",
                  "scriptLocation": "string"
               }
            }
         ],
         "nodeReady": [ 
            { 
               "arguments": [ "string" ],
               "executionPolicy": "string",
               "name": "string",
               "onError": "string",
               "scriptSource": { 
                  "checksum": "string",
                  "s3VersionId": "string",
                  "scriptLocation": "string"
               }
            }
         ]
      }
   },
   "sharedSecret": "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.

clusterName

The name of the cluster that the compute node registered into.

Type: String

computeNodeGroupId

The ID of the compute node group that the compute node registered into.

Type: String

computeNodeGroupName

The name of the compute node group that the compute node registered into.

Type: String

endpoints

The list of endpoints available for interaction with the scheduler.

Type: Array of Endpoint objects

nodeID

The scheduler node ID for this instance.

Type: String

nodeLifecycleActions

The node lifecycle actions configured for the node group, including scripts to run when a compute node finishes bootstrapping or becomes ready to accept jobs.

Type: NodeLifecycleActions object

sharedSecret

For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

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.

HTTP Status Code: 400

InternalServerException

AWS PCS can't process your request right now. Try again later.

HTTP Status Code: 500