update_queue_environment ¶

def update_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,
    client_token: Optional["capo_deadline.types.client_token.ClientToken"] = None,
    priority: Optional["capo_deadline.types.priority.Priority"] = None,
    template_type: Optional[
        "capo_deadline.types.environment_template_type.EnvironmentTemplateType"
    ] = None,
    template: Optional[
        "capo_deadline.types.environment_template.EnvironmentTemplate"
    ] = None,
) -> "capo_deadline.types.update_queue_environment_response.UpdateQueueEnvironmentResponse":
    """<p>Updates the queue environment.</p>

    Args:
        farm_id: <p>The farm ID of the queue environment to update.</p>
        queue_id: <p>The queue ID of the queue environment to update.</p>
        queue_environment_id: <p>The queue environment ID to update.</p>
        client_token: <p>The unique token which the server uses to recognize retries of the same request.</p>
        priority: <p>The priority to update.</p>
        template_type: <p>The template type to update.</p>
        template: <p>The template to update.</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_environment_request.UpdateQueueEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.update_queue_environment_response.UpdateQueueEnvironmentResponse"
    ]:
        import capo_deadline._operations.deadline.update_queue_environment

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

    def _redact_input(
        input_: "capo_deadline.types.update_queue_environment_request.UpdateQueueEnvironmentRequest",
    ) -> dict[str, Any]:
        import capo_deadline.types.update_queue_environment_request

        return (
            capo_deadline.types.update_queue_environment_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateQueueEnvironment", redact_input=_redact_input),
    )
    input_: capo_deadline.types.update_queue_environment_request.UpdateQueueEnvironmentRequest = {
        "farm_id": farm_id,
        "queue_id": queue_id,
        "queue_environment_id": queue_environment_id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if priority is not None:
        input_["priority"] = priority
    if template_type is not None:
        input_["template_type"] = template_type
    if template is not None:
        input_["template"] = template

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