Skip to content

list_queue_limit_associations

list_queue_limit_associations(
    farm_id: FarmId,
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    queue_id: Optional[QueueId] = None,
    limit_id: Optional[LimitId] = None,
) -> ListQueueLimitAssociationsResponse

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

Parameters:

  • farm_id (FarmId) –

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

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of results, or null to start from the beginning.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of associations to return in each page of results.

  • queue_id (Optional[QueueId], default: None ) –

    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.

  • limit_id (Optional[LimitId], default: None ) –

    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.

Raises:

Source code in docs_src/capo_deadline/_services/deadline.py
def list_queue_limit_associations(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    next_token: Optional["capo_deadline.types.next_token.NextToken"] = None,
    max_results: Optional["capo_deadline.types.max_results.MaxResults"] = None,
    queue_id: Optional["capo_deadline.types.queue_id.QueueId"] = None,
    limit_id: Optional["capo_deadline.types.limit_id.LimitId"] = None,
) -> "capo_deadline.types.list_queue_limit_associations_response.ListQueueLimitAssociationsResponse":
    """<p>Gets a list of the associations between queues and limits defined in a farm.</p>

    Args:
        farm_id: <p>The unique identifier of the farm that contains the limits and associations.</p>
        next_token: <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
        max_results: <p>The maximum number of associations to return in each page of results.</p>
        queue_id: <p>Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the <code>queueId</code> and the <code>limitId</code>, only the specified limit is returned if it exists.</p>
        limit_id: <p>Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the <code>queueId</code> and the <code>limitId</code>, only the specified limit is returned if it exists.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.list_queue_limit_associations_request.ListQueueLimitAssociationsRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.list_queue_limit_associations_response.ListQueueLimitAssociationsResponse"
    ]:
        import capo_deadline._operations.deadline.list_queue_limit_associations

        output, http_response = (
            capo_deadline._operations.deadline.list_queue_limit_associations.list_queue_limit_associations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListQueueLimitAssociations")
    )
    input_: capo_deadline.types.list_queue_limit_associations_request.ListQueueLimitAssociationsRequest = {
        "farm_id": farm_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if queue_id is not None:
        input_["queue_id"] = queue_id
    if limit_id is not None:
        input_["limit_id"] = limit_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output