ParallelComputingService / Paginator / ListClusters

ListClusters

class ParallelComputingService.Paginator.ListClusters

paginator = client.get_paginator('list_clusters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ParallelComputingService.Client.list_clusters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.