DeadlineCloud / Paginator / ListQueueLimitAssociations

ListQueueLimitAssociations

class DeadlineCloud.Paginator.ListQueueLimitAssociations

paginator = client.get_paginator('list_queue_limit_associations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The unique identifier of the farm that contains the limits and associations.

• queueId (string) – Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.

• limitId (string) – Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.

• 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

{
    'queueLimitAssociations': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'queueId': 'string',
            'limitId': 'string',
            'status': 'ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'|'STOPPED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • queueLimitAssociations (list) –

    A list of associations between limits and queues in the farm specified in the request.

    • (dict) –

      Provides information about the association between a queue and a limit.

      • createdAt (datetime) –

        The Unix timestamp of the date and time that the association was created.

      • createdBy (string) –

        The user identifier of the person that created the association.

      • updatedAt (datetime) –

        The Unix timestamp of the date and time that the association was last updated.

      • updatedBy (string) –

        The user identifier of the person that updated the association.

      • queueId (string) –

        The unique identifier of the queue in the association.

      • limitId (string) –

        The unique identifier of the limit in the association.

      • status (string) –

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

        • ACTIVE - Association is active.

        • STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new tasks and is completing current tasks.

        • STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new tasks and is canceling current tasks.

        • STOPPED - Association has been stopped.

  • NextToken (string) –

    A token to resume pagination.