Skip to content

EC2  >  Operations  >  unmonitor_instances

unmonitor_instances

Operation

unmonitor_instances async

unmonitor_instances(request: UnmonitorInstancesInput | UnmonitorInstancesInputDict, /, *, plugins: list[Plugin] | None = None) -> UnmonitorInstancesOutput
unmonitor_instances(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UnmonitorInstancesInputDict]) -> UnmonitorInstancesOutput

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

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
UnmonitorInstancesOutput

An instance of UnmonitorInstancesOutput.

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

UnmonitorInstancesInput dataclass

Bases: _SerdeShape

Dataclass for UnmonitorInstancesInput 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 remove from the instances. If you specify metric categories, only those metric categories are removed and detailed monitoring remains enabled. If you don't specify metric categories, detailed monitoring and all metric categories are turned off.

Dictionaries

UnmonitorInstancesInputDict

Bases: TypedDict

Dictionary form of UnmonitorInstancesInput.

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 remove from the instances. If you specify metric categories, only those metric categories are removed and detailed monitoring remains enabled. If you don't specify metric categories, detailed monitoring and all metric categories are turned off.

Output

UnmonitorInstancesOutput dataclass

Bases: _SerdeShape

Dataclass for UnmonitorInstancesOutput 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.