Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateMonitor

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

Request Syntax


PATCH /2023-10-12/monitors/monitorId HTTP/1.1
Content-type: application/json

{
   "displayName": "string",
   "roleArn": "string",
   "subdomain": "string"
}

URI Request Parameters

The request uses the following URI parameters.

monitorId

The unique identifier of the monitor to update.

Pattern: ^monitor-[0-9a-f]{32}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

displayName

The new value to use for the monitor's display name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

roleArn

The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$

Required: No

subdomain

The new value of the subdomain to use when forming the monitor URL.

Type: String

Pattern: ^[a-z0-9-]{1,100}$

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400