MonitorSummary
Provides information about a monitor in Deadline Cloud.
Contents
- createdAt
-
The UNIX timestamp of the date and time that the monitor was created.
Type: Timestamp
Required: Yes
- createdBy
-
The user name of the person that created the monitor.
Type: String
Required: Yes
- displayName
-
The name of the monitor that displays on the Deadline Cloud console.
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: Yes
- identityCenterApplicationArn
-
The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
Type: String
Required: Yes
- identityCenterInstanceArn
-
The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
Type: String
Pattern:
arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}
Required: Yes
- monitorId
-
The unique identifier for the monitor.
Type: String
Pattern:
monitor-[0-9a-f]{32}
Required: Yes
- roleArn
-
The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
Type: String
Pattern:
arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+
Required: Yes
- subdomain
-
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Type: String
Pattern:
[a-z0-9-]{1,100}
Required: Yes
- url
-
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Type: String
Required: Yes
- updatedAt
-
The UNIX timestamp of the date and time that the monitor was last updated.
Type: Timestamp
Required: No
- updatedBy
-
The user name of the person that last updated the monitor.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: