update_monitor_settings async ¶

async def update_monitor_settings(
    self,
    monitor_id: "capo_deadline.types.monitor_id.MonitorId",
    settings: "capo_deadline.types.settings_map.SettingsMap",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
) -> "capo_deadline.types.update_monitor_settings_response.UpdateMonitorSettingsResponse":
    """<p>Updates the settings for a Deadline Cloud monitor. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to delete a key.</p>

    Args:
        monitor_id: <p>The unique identifier of the monitor to update settings for.</p>
        settings: <p>The monitor settings to update as key-value pairs. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to delete a key.</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.

    Examples:
        Update monitor settings

        >>> await client.update_monitor_settings(monitor_id='monitor-1234567890abcdef1234567890abcdef', settings={'idcApplicationArn': 'arn:aws:sso::123456789012:application/ins-1234567890abcdef/apl-1234567890abcdef'})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_deadline.types.update_monitor_settings_request.UpdateMonitorSettingsRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.update_monitor_settings_response.UpdateMonitorSettingsResponse"
    ]:
        import capo_deadline._operations.deadline.update_monitor_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateMonitorSettings")
    )
    input_: capo_deadline.types.update_monitor_settings_request.UpdateMonitorSettingsRequest = {
        "monitor_id": monitor_id,
        "settings": settings,
    }

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