ParallelComputingService / Client / list_clusters

list_clusters¶

ParallelComputingService.Client.list_clusters(**kwargs)¶

Returns a list of running clusters in your account.

Request Syntax

response = client.list_clusters(
    nextToken='string',
    maxResults=123
)

Parameters:

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

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

Response Structure

(dict) –
- clusters (list) –
  
  The list of clusters.
  - (dict) –
    
    The object returned by the ListClusters API action.
    - name (string) –
      
      The name that identifies the cluster.
    - id (string) –
      
      The generated unique ID of the cluster.
    - arn (string) –
      
      The unique Amazon Resource Name (ARN) of the cluster.
    - 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 cluster.
      
      Note
      The provisioning status doesn’t indicate the overall health of the cluster.
      
      Warning
      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can’t use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
- 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

ParallelComputingService.Client.exceptions.ThrottlingException
ParallelComputingService.Client.exceptions.ValidationException
ParallelComputingService.Client.exceptions.ConflictException
ParallelComputingService.Client.exceptions.ResourceNotFoundException
ParallelComputingService.Client.exceptions.InternalServerException
ParallelComputingService.Client.exceptions.AccessDeniedException