DescribeMonitorCommand

Suggest an Edit

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:

  • Baseline

  • CreationTime

  • LastEvaluationTime

  • LastEvaluationState

  • LastModificationTime

  • Message

  • Status

Example Syntax

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

import { ForecastClient, DescribeMonitorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
// const { ForecastClient, DescribeMonitorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
const client = new ForecastClient(config);
const input = { // DescribeMonitorRequest
  MonitorArn: "STRING_VALUE", // required
};
const command = new DescribeMonitorCommand(input);
const response = await client.send(command);
// { // DescribeMonitorResponse
//   MonitorName: "STRING_VALUE",
//   MonitorArn: "STRING_VALUE",
//   ResourceArn: "STRING_VALUE",
//   Status: "STRING_VALUE",
//   LastEvaluationTime: new Date("TIMESTAMP"),
//   LastEvaluationState: "STRING_VALUE",
//   Baseline: { // Baseline
//     PredictorBaseline: { // PredictorBaseline
//       BaselineMetrics: [ // BaselineMetrics
//         { // BaselineMetric
//           Name: "STRING_VALUE",
//           Value: Number("double"),
//         },
//       ],
//     },
//   },
//   Message: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   LastModificationTime: new Date("TIMESTAMP"),
//   EstimatedEvaluationTimeRemainingInMinutes: Number("long"),
// };

DescribeMonitorCommand Input

See DescribeMonitorCommandInput for more details

Parameter
Type
Description
MonitorArn
Required
string | undefined

The Amazon Resource Name (ARN) of the monitor resource to describe.

DescribeMonitorCommand Output

See DescribeMonitorCommandOutput for details

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

Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.

CreationTime
Date | undefined

The timestamp for when the monitor resource was created.

EstimatedEvaluationTimeRemainingInMinutes
number | undefined

The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

LastEvaluationState
string | undefined

The state of the monitor's latest evaluation.

LastEvaluationTime
Date | undefined

The timestamp of the latest evaluation completed by the monitor.

LastModificationTime
Date | undefined

The timestamp of the latest modification to the monitor.

Message
string | undefined

An error message, if any, for the monitor.

MonitorArn
string | undefined

The Amazon Resource Name (ARN) of the monitor resource described.

MonitorName
string | undefined

The name of the monitor.

ResourceArn
string | undefined

The Amazon Resource Name (ARN) of the auto predictor being monitored.

Status
string | undefined

The status of the monitor resource.

Throws

Name
Fault
Details
InvalidInputException
client

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

ResourceNotFoundException
client

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

ForecastServiceException
Base exception class for all service exceptions from Forecast service.