Skip to content

EC2  >  Operations  >  monitor_instances

monitor_instances

Operation

monitor_instances async

monitor_instances(request: MonitorInstancesInput | MonitorInstancesInputDict, /, *, plugins: list[Plugin] | None = None) -> MonitorInstancesOutput
monitor_instances(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[MonitorInstancesInputDict]) -> MonitorInstancesOutput

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.

To disable detailed monitoring, see UnmonitorInstances.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
MonitorInstancesOutput

An instance of MonitorInstancesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

MonitorInstancesInput dataclass

Bases: _SerdeShape

Dataclass for MonitorInstancesInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

instance_ids class-attribute instance-attribute
instance_ids: list[str] | None = ...

The IDs of the instances.

metric_category_ids class-attribute instance-attribute
metric_category_ids: list[str] | None = ...

The IDs of the metric categories to associate with the instances. The specified metric categories are added to any metric categories that are already associated with the instances.

Dictionaries

MonitorInstancesInputDict

Bases: TypedDict

Dictionary form of MonitorInstancesInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

instance_ids instance-attribute
instance_ids: Required[Sequence[str]]

The IDs of the instances.

metric_category_ids instance-attribute
metric_category_ids: Sequence[str] | None

The IDs of the metric categories to associate with the instances. The specified metric categories are added to any metric categories that are already associated with the instances.

Output

MonitorInstancesOutput dataclass

Bases: _SerdeShape

Dataclass for MonitorInstancesOutput structure.

Attributes

instance_monitorings class-attribute instance-attribute
instance_monitorings: list[InstanceMonitoring] | None = ...

The monitoring information.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.