ParallelComputingService / Client / list_compute_node_groups

list_compute_node_groups#

ParallelComputingService.Client.list_compute_node_groups(**kwargs)#

Returns a list of all compute node groups associated with a cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_compute_node_groups(
    clusterIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • clusterIdentifier (string) –

    [REQUIRED]

    The name or ID of the cluster to list compute node groups for.

  • nextToken (string) – The value of nextToken is a unique pagination token for each page of results returned. If nextToken is 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 an HTTP 400 InvalidToken error.

  • maxResults (integer) – The maximum number of results that are returned per call. You can use nextToken to 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.

Return type:

dict

Returns:

Response Syntax

{
    'computeNodeGroups': [
        {
            'name': 'string',
            'id': 'string',
            'arn': 'string',
            'clusterId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'UPDATE_FAILED'|'DELETED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • computeNodeGroups (list) –

      The list of compute node groups for the cluster.

      • (dict) –

        The object returned by the ListComputeNodeGroups API action.

        • name (string) –

          The name that identifies the compute node group.

        • id (string) –

          The generated unique ID of the compute node group.

        • arn (string) –

          The unique Amazon Resource Name (ARN) of the compute node group.

        • clusterId (string) –

          The ID of the cluster of the compute node group.

        • createdAt (datetime) –

          The date and time the resource was created.

        • modifiedAt (datetime) –

          The date and time the resource was modified.

        • status (string) –

          The provisioning status of the compute node group.

          Note

          The provisioning status doesn’t indicate the overall health of the compute node group.

    • nextToken (string) –

      The value of nextToken is a unique pagination token for each page of results returned. If nextToken is 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 an HTTP 400 InvalidToken error.

Exceptions