update_queue_limit_association ¶

update_queue_limit_association(
    farm_id: FarmId,
    queue_id: QueueId,
    limit_id: LimitId,
    status: UpdateQueueLimitAssociationStatus,
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> UpdateQueueLimitAssociationResponse

Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.

Parameters:

farm_id (FarmId) –

The unique identifier of the farm that contains the associated queues and limits.
queue_id (QueueId) –

The unique identifier of the queue associated to the limit.
limit_id (LimitId) –

The unique identifier of the limit associated to the queue.
status (UpdateQueueLimitAssociationStatus) –

Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately.

Raises:

AccessDeniedException –

You don't have permission to perform the action.
InternalServerErrorException –

Deadline Cloud can't process your request right now. Try again later.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a request rate quota.
ValidationException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_deadline/_services/deadline.py

def update_queue_limit_association(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    queue_id: "capo_deadline.types.queue_id.QueueId",
    limit_id: "capo_deadline.types.limit_id.LimitId",
    status: "capo_deadline.types.update_queue_limit_association_status.UpdateQueueLimitAssociationStatus",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> "capo_deadline.types.update_queue_limit_association_response.UpdateQueueLimitAssociationResponse":
    """<p>Updates the status of the queue. If you set the status to one of the <code>STOP_LIMIT_USAGE*</code> values, there will be a delay before the status transitions to the <code>STOPPED</code> state. </p>

    Args:
        farm_id: <p>The unique identifier of the farm that contains the associated queues and limits.</p>
        queue_id: <p>The unique identifier of the queue associated to the limit.</p>
        limit_id: <p>The unique identifier of the limit associated to the queue.</p>
        status: <p>Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately. </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.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.update_queue_limit_association_request.UpdateQueueLimitAssociationRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.update_queue_limit_association_response.UpdateQueueLimitAssociationResponse"
    ]:
        import capo_deadline._operations.deadline.update_queue_limit_association

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateQueueLimitAssociation")
    )
    input_: capo_deadline.types.update_queue_limit_association_request.UpdateQueueLimitAssociationRequest = {
        "farm_id": farm_id,
        "queue_id": queue_id,
        "limit_id": limit_id,
        "status": status,
    }

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