DeadlineCloud / Client / update_monitor
update_monitorΒΆ
- DeadlineCloud.Client.update_monitor(**kwargs)ΒΆ
Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call
UpdateMonitor.See also: AWS API Documentation
Request Syntax
response = client.update_monitor( monitorId='string', subdomain='string', displayName='string', roleArn='string' )
- Parameters:
monitorId (string) β
[REQUIRED]
The unique identifier of the monitor to update.
subdomain (string) β The new value of the subdomain to use when forming the monitor URL.
displayName (string) β
The new value to use for the monitorβs display name.
Warning
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.
roleArn (string) β The Amazon Resource Name of the new IAM role to use with the monitor.
- Return type:
dict
- Returns:
Response Syntax
{}Response Structure
(dict) β
Exceptions
DeadlineCloud.Client.exceptions.AccessDeniedExceptionDeadlineCloud.Client.exceptions.InternalServerErrorExceptionDeadlineCloud.Client.exceptions.ResourceNotFoundExceptionDeadlineCloud.Client.exceptions.ThrottlingExceptionDeadlineCloud.Client.exceptions.ValidationException