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.

Important

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.

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.

context: Information about the resources in use when the exception was thrown.

HTTP Status Code: 403

InternalServerErrorException

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

retryAfterSeconds: The number of seconds a client should wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

context: Information about the resources in use when the exception was thrown.
resourceId: The identifier of the resource that couldn't be found.
resourceType: The type of the resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

context: Information about the resources in use when the exception was thrown.
quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service that is being throttled.

HTTP Status Code: 429

ValidationException

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

context: Information about the resources in use when the exception was thrown.
fieldList: A list of fields that failed validation.
reason: The reason that the request failed validation.

HTTP Status Code: 400