DeadlineCloud / Client / list_queue_limit_associations

list_queue_limit_associations¶

DeadlineCloud.Client.list_queue_limit_associations(**kwargs)¶

Gets a list of the associations between queues and limits defined in a farm.

Request Syntax

response = client.list_queue_limit_associations(
    farmId='string',
    nextToken='string',
    maxResults=123,
    queueId='string',
    limitId='string'
)

Parameters:

farmId (string) –
[REQUIRED]

The unique identifier of the farm that contains the limits and associations.
nextToken (string) – The token for the next set of results, or null to start from the beginning.
maxResults (integer) – The maximum number of associations to return in each page of results.
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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Shared pagination field for List operation outputs (nextToken).
- 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.
    - 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.
    - 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.
- 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