Skip to content

delete_monitor async

delete_monitor(
    monitor_id: MonitorId,
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> DeleteMonitorResponse

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

Parameters:

  • monitor_id (MonitorId) –

    The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.

Raises:

Source code in docs_src/capo_deadline/_services/async_deadline.py
async def delete_monitor(
    self,
    monitor_id: "capo_deadline.types.monitor_id.MonitorId",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> "capo_deadline.types.delete_monitor_response.DeleteMonitorResponse":
    """<p>Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.</p>

    Args:
        monitor_id: <p>The unique identifier of the monitor to delete. This ID is returned by the <code>CreateMonitor</code> operation, and is included in the response to the <code>GetMonitor</code> operation.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_deadline.types.delete_monitor_request.DeleteMonitorRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.delete_monitor_response.DeleteMonitorResponse"
    ]:
        import capo_deadline._operations.deadline.delete_monitor

        (
            output,
            http_response,
        ) = await capo_deadline._operations.deadline.delete_monitor.async_delete_monitor(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteMonitor")
    )
    input_: capo_deadline.types.delete_monitor_request.DeleteMonitorRequest = {
        "monitor_id": monitor_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output