DeadlineCloud / Client / get_monitor

get_monitor#

DeadlineCloud.Client.get_monitor(**kwargs)#

Gets information about the specified monitor.

Request Syntax

response = client.get_monitor(
    monitorId='string'
)

Parameters:

monitorId (string) –

[REQUIRED]

The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'displayName': 'string',
    'identityCenterApplicationArn': 'string',
    'identityCenterInstanceArn': 'string',
    'monitorId': 'string',
    'roleArn': 'string',
    'subdomain': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'url': 'string'
}

Response Structure

(dict) –
- createdAt (datetime) –
  
  The UNIX timestamp of the date and time that the monitor was created.
- createdBy (string) –
  
  The user name of the person that created the monitor.
- displayName (string) –
  
  The name used to identify the monitor on the Deadline Cloud console.
- identityCenterApplicationArn (string) –
  
  The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
- identityCenterInstanceArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
- monitorId (string) –
  
  The unique identifier for the monitor.
- roleArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
- subdomain (string) –
  
  The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
- updatedAt (datetime) –
  
  The UNIX timestamp of the last date and time that the monitor was updated.
- updatedBy (string) –
  
  The user name of the person that last updated the monitor.
- url (string) –
  
  The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException