DeadlineCloud / Client / list_monitors

list_monitors#

DeadlineCloud.Client.list_monitors(**kwargs)#

Gets a list of your monitors in Deadline Cloud.

See also: AWS API Documentation

Request Syntax

response = client.list_monitors(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

    • monitors (list) –

      A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.

      • (dict) –

        Provides information about a monitor in Deadline Cloud.

        • monitorId (string) –

          The unique identifier for the monitor.

        • displayName (string) –

          The name of the monitor that displays on the Deadline Cloud console.

          Warning

          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.

        • subdomain (string) –

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

        • url (string) –

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

        • 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.

        • identityCenterInstanceArn (string) –

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

        • identityCenterApplicationArn (string) –

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

        • 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.

        • updatedAt (datetime) –

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

        • updatedBy (string) –

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

Exceptions