Skip to content

delete_queue_environment

delete_queue_environment(
    farm_id: FarmId,
    queue_id: QueueId,
    queue_environment_id: QueueEnvironmentId,
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> DeleteQueueEnvironmentResponse

Deletes a queue environment.

Parameters:

  • farm_id (FarmId) –

    The farm ID of the farm from which to remove the queue environment.

  • queue_id (QueueId) –

    The queue ID of the queue environment to delete.

  • queue_environment_id (QueueEnvironmentId) –

    The queue environment ID of the queue environment to delete.

Raises:

Source code in docs_src/capo_deadline/_services/deadline.py
def delete_queue_environment(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    queue_id: "capo_deadline.types.queue_id.QueueId",
    queue_environment_id: "capo_deadline.types.queue_environment_id.QueueEnvironmentId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> "capo_deadline.types.delete_queue_environment_response.DeleteQueueEnvironmentResponse":
    """<p>Deletes a queue environment.</p>

    Args:
        farm_id: <p>The farm ID of the farm from which to remove the queue environment.</p>
        queue_id: <p>The queue ID of the queue environment to delete.</p>
        queue_environment_id: <p>The queue environment ID of the queue environment to delete.</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.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.delete_queue_environment_request.DeleteQueueEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.delete_queue_environment_response.DeleteQueueEnvironmentResponse"
    ]:
        import capo_deadline._operations.deadline.delete_queue_environment

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteQueueEnvironment")
    )
    input_: capo_deadline.types.delete_queue_environment_request.DeleteQueueEnvironmentRequest = {
        "farm_id": farm_id,
        "queue_id": queue_id,
        "queue_environment_id": queue_environment_id,
    }

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