GetMonitorCommand

Suggest an Edit

Gets information about the specified monitor.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DeadlineClient, GetMonitorCommand } from "@aws-sdk/client-deadline"; // ES Modules import
// const { DeadlineClient, GetMonitorCommand } = require("@aws-sdk/client-deadline"); // CommonJS import
const client = new DeadlineClient(config);
const input = { // GetMonitorRequest
  monitorId: "STRING_VALUE", // required
};
const command = new GetMonitorCommand(input);
const response = await client.send(command);
// { // GetMonitorResponse
//   monitorId: "STRING_VALUE", // required
//   displayName: "STRING_VALUE", // required
//   subdomain: "STRING_VALUE", // required
//   url: "STRING_VALUE", // required
//   roleArn: "STRING_VALUE", // required
//   identityCenterInstanceArn: "STRING_VALUE", // required
//   identityCenterApplicationArn: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"), // required
//   createdBy: "STRING_VALUE", // required
//   updatedAt: new Date("TIMESTAMP"),
//   updatedBy: "STRING_VALUE",
// };

GetMonitorCommand Input

See GetMonitorCommandInput for more details

Parameter
Type
Description
monitorId
Required
string | undefined

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

GetMonitorCommand Output

See GetMonitorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
createdAt
Required
Date | undefined

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

createdBy
Required
string | undefined

The user name of the person that created the monitor.

displayName
Required
string | undefined

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.

identityCenterApplicationArn
Required
string | undefined

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

identityCenterInstanceArn
Required
string | undefined

The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

monitorId
Required
string | undefined

The unique identifier for the monitor.

roleArn
Required
string | undefined

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

subdomain
Required
string | undefined

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

url
Required
string | undefined

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

updatedAt
Date | undefined

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

updatedBy
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permission to perform the action.

InternalServerErrorException
server

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

ResourceNotFoundException
client

The requested resource can't be found.

ThrottlingException
client

Your request exceeded a request rate quota.

ValidationException
client

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

DeadlineServiceException
Base exception class for all service exceptions from Deadline service.