Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

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.

post/2023-10-12/monitors

Headers

X-Amz-Client-Tokenstring

The unique token which the server uses to recognize retries of the same request.

Request body

displayNamestring required
<p>The name that you give the monitor that is displayed in 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>
identityCenterInstanceArnstring required

The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.

identityCenterRegionstring

The Region where IAM Identity Center is enabled. Required when IAM Identity Center is in a different Region than the monitor.

subdomainstring required

The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

roleArnstring required

The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.

tagsobject

The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Response

Success

monitorIdstring required

The unique identifier of the monitor.

identityCenterApplicationArnstring required

The Amazon Resource Name that IAM Identity Center assigns to the monitor.