update_monitor ¶

def update_monitor(
    self,
    monitor_id: "capo_deadline.types.monitor_id.MonitorId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    subdomain: Optional["capo_deadline.types.subdomain.Subdomain"] = None,
    display_name: Optional["capo_deadline.types.resource_name.ResourceName"] = None,
    role_arn: Optional["capo_deadline.types.iam_role_arn.IamRoleArn"] = None,
) -> "capo_deadline.types.update_monitor_response.UpdateMonitorResponse":
    """<p>Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call <code>UpdateMonitor</code>.</p>

    Args:
        monitor_id: <p>The unique identifier of the monitor to update.</p>
        subdomain: <p>The new value of the subdomain to use when forming the monitor URL.</p>
        display_name: <p>The new value to use for the monitor's display name.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
        role_arn: <p>The Amazon Resource Name of the new IAM role to use with the monitor.</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_monitor_request.UpdateMonitorRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.update_monitor_response.UpdateMonitorResponse"
    ]:
        import capo_deadline._operations.deadline.update_monitor

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateMonitor")
    )
    input_: capo_deadline.types.update_monitor_request.UpdateMonitorRequest = {
        "monitor_id": monitor_id
    }
    if subdomain is not None:
        input_["subdomain"] = subdomain
    if display_name is not None:
        input_["display_name"] = display_name
    if role_arn is not None:
        input_["role_arn"] = role_arn

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