Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Gets information about the specified monitor.

get/2023-10-12/monitors/{monitorId}

Path parameters

monitorIdstring required

The unique identifier for the monitor. This ID is returned by the <code>CreateMonitor</code> operation.

Response

Success

monitorIdstring required

The unique identifier for the monitor.

displayNamestring required
<p>The name used to identify the monitor on the Deadline Cloud console.</p> <important> <p>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.</p> </important>
subdomainstring required

The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

urlstring required

The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

roleArnstring required

The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

identityCenterInstanceArnstring required

The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.

identityCenterRegionstring

The Region where IAM Identity Center is enabled.

identityCenterApplicationArnstring required

The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.

createdAtstring date-time required

The UNIX timestamp of the date and time that the monitor was created.

createdBystring required

The user name of the person that created the monitor.

updatedAtstring date-time

The UNIX timestamp of the last date and time that the monitor was updated.

updatedBystring

The user name of the person that last updated the monitor.