DeadlineCloud / Paginator / ListQueueFleetAssociations

ListQueueFleetAssociations

class DeadlineCloud.Paginator.ListQueueFleetAssociations

paginator = client.get_paginator('list_queue_fleet_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_queue_fleet_associations().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the queue-fleet association list.

• queueId (string) – The queue ID for the queue-fleet association list.

• fleetId (string) – The fleet ID for the queue-fleet association list.

• 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

{
    'queueFleetAssociations': [
        {
            'queueId': 'string',
            'fleetId': 'string',
            'status': 'ACTIVE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS'|'STOPPED',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • queueFleetAssociations (list) –

    The queue-fleet associations on the list.

    • (dict) –

      The details of a queue-fleet association.

      • queueId (string) –

        The queue ID.

      • fleetId (string) –

        The fleet ID.

      • status (string) –

        The status of task scheduling in the queue-fleet association.

        • ACTIVE–Association is active.

        • STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped scheduling new tasks and is completing current tasks.

        • STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped scheduling new tasks and is canceling current tasks.

        • STOPPED–Association has been stopped.

      • createdAt (datetime) –

        The date and time the resource was created.

      • createdBy (string) –

        The user or system that created this resource.

      • updatedAt (datetime) –

        The date and time the resource was updated.

      • updatedBy (string) –

        The user or system that updated this resource.

  • NextToken (string) –

    A token to resume pagination.