UnmonitorInstancesCommand

Suggest an Edit

Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes  in the Amazon EC2 User Guide.

Example Syntax

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

import { EC2Client, UnmonitorInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, UnmonitorInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // UnmonitorInstancesRequest
  InstanceIds: [ // InstanceIdStringList // required
    "STRING_VALUE",
  ],
  DryRun: true || false,
};
const command = new UnmonitorInstancesCommand(input);
const response = await client.send(command);
// { // UnmonitorInstancesResult
//   InstanceMonitorings: [ // InstanceMonitoringList
//     { // InstanceMonitoring
//       InstanceId: "STRING_VALUE",
//       Monitoring: { // Monitoring
//         State: "disabled" || "disabling" || "enabled" || "pending",
//       },
//     },
//   ],
// };

UnmonitorInstancesCommand Input

See UnmonitorInstancesCommandInput for more details

Parameter
Type
Description
InstanceIds
Required
string[] | undefined

The IDs of the instances.

DryRun
boolean | undefined

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

UnmonitorInstancesCommand Output

See UnmonitorInstancesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
InstanceMonitorings
InstanceMonitoring[] | undefined

The monitoring information.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.