monitors

Creates, updates, deletes, gets or lists a monitors resource.

Overview

Name	monitors
Type	Resource
Id	aws.deadline.monitors

Fields

The following fields are returned by SELECT queries:

get_monitor

Name	Datatype	Description
created_at	string (date-time)	The UNIX timestamp of the date and time that the monitor was created.
created_by	string	The user name of the person that created the monitor.
display_name	string	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	string	The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
identity_center_instance_arn	string	The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users. (pattern: <code>arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}</code>)
identity_center_region	string	The Region where IAM Identity Center is enabled. (pattern: <code>[a-z0-9-]+</code>)
monitor_id	string	The unique identifier for the monitor. (pattern: <code>monitor-[0-9a-f]{32}</code>)
role_arn	string	The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources. (pattern: <code>arn:(aws[a-zA-Z-]):iam::\d{12}:role(/[!-.0-~]+)/[\w+=,.@-]+</code>)
subdomain	string	The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. (pattern: <code>[a-z0-9-]{1,100}</code>)
updated_at	string (date-time)	The UNIX timestamp of the last date and time that the monitor was updated.
updated_by	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.

list_monitors

Name	Datatype	Description
created_at	string (date-time)	The UNIX timestamp of the date and time that the monitor was created.
created_by	string	The user name of the person that created the monitor.
display_name	string	The name of the monitor that displays 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	string	The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
identity_center_instance_arn	string	The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users. (pattern: <code>arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}</code>)
identity_center_region	string	The Region where IAM Identity Center is enabled. (pattern: <code>[a-z0-9-]+</code>)
monitor_id	string	The unique identifier for the monitor. (pattern: <code>monitor-[0-9a-f]{32}</code>)
role_arn	string	The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources. (pattern: <code>arn:(aws[a-zA-Z-]):iam::\d{12}:role(/[!-.0-~]+)/[\w+=,.@-]+</code>)
subdomain	string	The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com. (pattern: <code>[a-z0-9-]{1,100}</code>)
updated_at	string (date-time)	The UNIX timestamp of the date and time that the monitor was last updated.
updated_by	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_monitor	select	monitor_id, region		Gets information about the specified monitor.
list_monitors	select	region	nextToken, maxResults	Gets a list of your monitors in Deadline Cloud.
create_monitor	insert	region, displayName, identityCenterInstanceArn, subdomain, roleArn	X-Amz-Client-Token	Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.
update_monitor	update	monitor_id, region		Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
delete_monitor	delete	monitor_id, region		Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
monitor_id	string	The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.
region	string	AWS region (default: us-east-1)
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_monitor

Gets information about the specified monitor.

SELECT
created_at,
created_by,
display_name,
identity_center_application_arn,
identity_center_instance_arn,
identity_center_region,
monitor_id,
role_arn,
subdomain,
updated_at,
updated_by,
url
FROM aws.deadline.monitors
WHERE monitor_id = '{{ monitor_id }}' -- required
AND region = '{{ region }}' -- required
;

list_monitors

Gets a list of your monitors in Deadline Cloud.

SELECT
created_at,
created_by,
display_name,
identity_center_application_arn,
identity_center_instance_arn,
identity_center_region,
monitor_id,
role_arn,
subdomain,
updated_at,
updated_by,
url
FROM aws.deadline.monitors
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_monitor

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

INSERT INTO aws.deadline.monitors (
displayName,
identityCenterInstanceArn,
identityCenterRegion,
subdomain,
roleArn,
tags,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ displayName }}' /* required */,
'{{ identityCenterInstanceArn }}' /* required */,
'{{ identityCenterRegion }}',
'{{ subdomain }}' /* required */,
'{{ roleArn }}' /* required */,
'{{ tags }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
identity_center_application_arn,
monitor_id
;

Manifest

# Description fields are for documentation purposes
- name: monitors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the monitors resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: identityCenterInstanceArn
    value: "{{ identityCenterInstanceArn }}"
  - name: identityCenterRegion
    value: "{{ identityCenterRegion }}"
  - name: subdomain
    value: "{{ subdomain }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: tags
    value: "{{ tags }}"
  - name: X-Amz-Client-Token
    value: "{{ X-Amz-Client-Token }}"
    description: The unique token which the server uses to recognize retries of the same request.
    description: The unique token which the server uses to recognize retries of the same request.

UPDATE examples

update_monitor

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

UPDATE aws.deadline.monitors
SET 
subdomain = '{{ subdomain }}',
displayName = '{{ displayName }}',
roleArn = '{{ roleArn }}'
WHERE 
monitor_id = '{{ monitor_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_monitor

Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.

DELETE FROM aws.deadline.monitors
WHERE monitor_id = '{{ monitor_id }}' --required
AND region = '{{ region }}' --required
;