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

GetMonitor

Gets information about the specified monitor.

Request Syntax


GET /2023-10-12/monitors/monitorId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

monitorId

The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "displayName": "string",
   "identityCenterApplicationArn": "string",
   "identityCenterInstanceArn": "string",
   "monitorId": "string",
   "roleArn": "string",
   "subdomain": "string",
   "updatedAt": "string",
   "updatedBy": "string",
   "url": "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.

createdAt

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

Type: Timestamp

createdBy

The user name of the person that created the monitor.

Type: String

displayName

The name used to identify the monitor on 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.

identityCenterApplicationArn

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

Type: String

identityCenterInstanceArn

The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating 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}

monitorId

The unique identifier for the monitor.

Type: String

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

roleArn

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

Type: String

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

subdomain

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

Type: String

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

updatedAt

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

Type: Timestamp

updatedBy

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

Type: String

url

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

Type: String

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

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

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