ParallelComputingService / Paginator / ListQueues

ListQueues

class ParallelComputingService.Paginator.ListQueues

paginator = client.get_paginator('list_queues')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• clusterIdentifier (string) –

  [REQUIRED]

  The name or ID of the cluster to list queues for.

• 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

{
    'queues': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • queues (list) –

    The list of queues associated with the cluster.

    • (dict) –

      The object returned by the ListQueues API action.

      • name (string) –

        The name that identifies the queue.

      • id (string) –

        The generated unique ID of the queue.

      • arn (string) –

        The unique Amazon Resource Name (ARN) of the queue.

      • clusterId (string) –

        The ID of the cluster of the queue.

      • 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 queue.

        Note

        The provisioning status doesn’t indicate the overall health of the queue.

  • NextToken (string) –

    A token to resume pagination.