DeadlineCloud / Client / list_limits

list_limits#

DeadlineCloud.Client.list_limits(**kwargs)#

Gets a list of limits defined in the specified farm.

Request Syntax

response = client.list_limits(
    farmId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

farmId (string) –
[REQUIRED]

The unique identifier of the farm that contains the limits.
nextToken (string) – The token for the next set of results, or null to start from the beginning.
maxResults (integer) – The maximum number of limits to return in each page of results.

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) –
  
  If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException