Skip to content

get_monitor

get_monitor(
    monitor_id: MonitorId, *, config_overrides: Optional[deadlineClientConfig] = None
) -> GetMonitorResponse

Gets information about the specified monitor.

Parameters:

  • monitor_id (MonitorId) –

    The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

Raises:

Source code in docs_src/capo_deadline/_services/deadline.py
def get_monitor(
    self,
    monitor_id: "capo_deadline.types.monitor_id.MonitorId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> "capo_deadline.types.get_monitor_response.GetMonitorResponse":
    """<p>Gets information about the specified monitor.</p>

    Args:
        monitor_id: <p>The unique identifier for the monitor. This ID is returned by the <code>CreateMonitor</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.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.get_monitor_request.GetMonitorRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.get_monitor_response.GetMonitorResponse"
    ]:
        import capo_deadline._operations.deadline.get_monitor

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMonitor")
    )
    input_: capo_deadline.types.get_monitor_request.GetMonitorRequest = {
        "monitor_id": monitor_id
    }

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