Skip to content

GetMonitorResponse

Source code in docs_src/capo_deadline/types/get_monitor_response.py
class GetMonitorResponse(TypedDict, closed=True):
    monitor_id: "capo_deadline.types.monitor_id.MonitorId"
    """<p>The unique identifier for the monitor.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<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>"""
    subdomain: "capo_deadline.types.subdomain.Subdomain"
    """<p>The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.</p>"""
    url: "capo_deadline.types.url.Url"
    """<p>The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.</p>"""
    role_arn: "capo_deadline.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.</p>"""
    identity_center_instance_arn: (
        "capo_deadline.types.identity_center_instance_arn.IdentityCenterInstanceArn"
    )
    """<p>The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.</p>"""
    identity_center_region: NotRequired["capo_deadline.types.region.Region"]
    """<p>The Region where IAM Identity Center is enabled.</p>"""
    identity_center_application_arn: "capo_deadline.types.identity_center_application_arn.IdentityCenterApplicationArn"
    """<p>The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The UNIX timestamp of the date and time that the monitor was created.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user name of the person that created the monitor.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The UNIX timestamp of the last date and time that the monitor was updated.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user name of the person that last updated the monitor.</p>"""

created_at instance-attribute

created_at: CreatedAt

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

created_by instance-attribute

created_by: CreatedBy

The user name of the person that created the monitor.

display_name instance-attribute

display_name: ResourceName

The name used to identify the monitor on the Deadline Cloud console.

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.

identity_center_application_arn instance-attribute

identity_center_application_arn: IdentityCenterApplicationArn

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

identity_center_instance_arn instance-attribute

identity_center_instance_arn: IdentityCenterInstanceArn

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

identity_center_region instance-attribute

identity_center_region: NotRequired[Region]

The Region where IAM Identity Center is enabled.

monitor_id instance-attribute

monitor_id: MonitorId

The unique identifier for the monitor.

role_arn instance-attribute

role_arn: IamRoleArn

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

subdomain instance-attribute

subdomain: Subdomain

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

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

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

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

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

url instance-attribute

url: Url

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