ParallelComputingService / Client / register_compute_node_group_instance

register_compute_node_group_instance#

ParallelComputingService.Client.register_compute_node_group_instance(**kwargs)#

Warning

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

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

See also: AWS API Documentation

Request Syntax

response = client.register_compute_node_group_instance(
    clusterIdentifier='string',
    bootstrapId='string'
)
Parameters:

  • clusterIdentifier (string) –

    [REQUIRED]

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

  • bootstrapId (string) –

    [REQUIRED]

    The client-generated token to allow for retries.

Return type:

dict

Returns:

Response Syntax

{
    'nodeID': 'string',
    'sharedSecret': 'string',
    'endpoints': [
        {
            'type': 'SLURMCTLD'|'SLURMDBD',
            'privateIpAddress': 'string',
            'publicIpAddress': 'string',
            'port': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nodeID (string) –

      The scheduler node ID for this instance.

    • sharedSecret (string) –

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

    • endpoints (list) –

      The list of endpoints available for interaction with the scheduler.

      • (dict) –

        An endpoint available for interaction with the scheduler.

        • type (string) –

          Indicates the type of endpoint running at the specific IP address.

        • privateIpAddress (string) –

          The endpoint’s private IP address.

          Example: 2.2.2.2

        • publicIpAddress (string) –

          The endpoint’s public IP address.

          Example: 1.1.1.1

        • port (string) –

          The endpoint’s connection port number.

          Example: 1234

Exceptions