DeadlineCloud / Paginator / ListLimits

ListLimits#

class DeadlineCloud.Paginator.ListLimits#

paginator = client.get_paginator('list_limits')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

farmId (string) –
[REQUIRED]

The unique identifier of the farm that contains the limits.
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

{
    'limits': [
        {
            'displayName': 'string',
            'amountRequirementName': 'string',
            'maxCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'farmId': 'string',
            'limitId': 'string',
            'currentCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- limits (list) –
  
  A list of limits that the farm contains.
  - (dict) –
    
    Provides information about a specific limit.
    - displayName (string) –
      
      The name of the limit used in lists to identify the limit.
      
      Warning
      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
    - amountRequirementName (string) –
      
      The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
    - maxCount (integer) –
      
      The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won’t be scheduled until the resource is available.
      
      The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
    - createdAt (datetime) –
      
      The Unix timestamp of the date and time that the limit was created.
    - createdBy (string) –
      
      The user identifier of the person that created the limit.
    - updatedAt (datetime) –
      
      The Unix timestamp of the date and time that the limit was last updated.
    - updatedBy (string) –
      
      The user identifier of the person that last updated the limit.
    - farmId (string) –
      
      The unique identifier of the farm that contains the limit.
    - limitId (string) –
      
      The unique identifier of the limit.
    - currentCount (integer) –
      
      The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
- NextToken (string) –
  
  A token to resume pagination.