Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateMonitor

Creates an AWS 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.

Request Syntax


POST /2023-10-12/monitors HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json

{
   "displayName": "string",
   "identityCenterInstanceArn": "string",
   "roleArn": "string",
   "subdomain": "string"
}

URI Request Parameters

The request uses the following URI parameters.

clientToken

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Request Body

The request accepts the following data in JSON format.

displayName

The name that you give the monitor that is displayed in the Deadline Cloud console.

Important

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

identityCenterInstanceArn

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

Type: String

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

roleArn

The Amazon Resource Name (ARN) 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.

Type: String

Pattern: arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+

Required: Yes

subdomain

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

Type: String

Pattern: [a-z0-9-]{1,100}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "identityCenterApplicationArn": "string",
   "monitorId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

identityCenterApplicationArn

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

Type: String

monitorId

The unique identifier of the monitor.

Type: String

Pattern: monitor-[0-9a-f]{32}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500

ServiceQuotaExceededException

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

HTTP Status Code: 402

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400