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 (ARN) of the new IAM role to use with the monitor.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException