DeadlineCloud / Paginator / ListMonitors

ListMonitors

class DeadlineCloud.Paginator.ListMonitors

paginator = client.get_paginator('list_monitors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_monitors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.