:doc:`ParallelComputingService <../../pcs>` / Client / register_compute_node_group_instance

************************************
register_compute_node_group_instance
************************************



.. py:method:: ParallelComputingService.Client.register_compute_node_group_instance(**kwargs)

  

  

  .. warning::

    

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

    

   

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

  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pcs-2023-02-10/RegisterComputeNodeGroupInstance>`_  


  **Request Syntax**
  ::

    response = client.register_compute_node_group_instance(
        clusterIdentifier='string',
        bootstrapId='string'
    )
    
  :type clusterIdentifier: string
  :param clusterIdentifier: **[REQUIRED]** 

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

    

  
  :type bootstrapId: string
  :param bootstrapId: **[REQUIRED]** 

    The client-generated token to allow for retries.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nodeID': 'string',
          'sharedSecret': 'string',
          'endpoints': [
              {
                  'type': 'SLURMCTLD'|'SLURMDBD'|'SLURMRESTD',
                  'privateIpAddress': 'string',
                  'publicIpAddress': 'string',
                  'ipv6Address': '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) --* 

            For clusters that use IPv4, this is the endpoint's private IP address.

             

            Example: ``10.1.2.3``

             

            For clusters configured to use IPv6, this is an empty string.

            
          

          - **publicIpAddress** *(string) --* 

            The endpoint's public IP address.

             

            Example: ``192.0.2.1``

            
          

          - **ipv6Address** *(string) --* 

            The endpoint's IPv6 address.

             

            Example: ``2001:db8::1``

            
          

          - **port** *(string) --* 

            The endpoint's connection port number.

             

            Example: ``1234``

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ParallelComputingService.Client.exceptions.InternalServerException`

  
  *   :py:class:`ParallelComputingService.Client.exceptions.AccessDeniedException`

  