Skip to content

monitor_instances

monitor_instances(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    instance_ids: Optional[InstanceIdStringList] = None,
    dry_run: Optional[Boolean] = None,
) -> MonitorInstancesResult

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:

  • instance_ids (Optional[InstanceIdStringList], default: None ) –

    The IDs of the instances.

  • dry_run (Optional[Boolean], default: 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def monitor_instances(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    instance_ids: Optional[
        "capo_ec2.types.instance_id_string_list.InstanceIdStringList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.monitor_instances_result.MonitorInstancesResult":
    """<p>Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitor your instances using CloudWatch</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>To disable detailed monitoring, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html">UnmonitorInstances</a>.</p>

    Args:
        instance_ids: <p>The IDs of the instances.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.monitor_instances_request.MonitorInstancesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.monitor_instances_result.MonitorInstancesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.monitor_instances

        output, http_response = (
            capo_ec2._operations.amazon_ec2.monitor_instances.monitor_instances(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("MonitorInstances")
    )
    input_: capo_ec2.types.monitor_instances_request.MonitorInstancesRequest = {}
    if instance_ids is not None:
        input_["instance_ids"] = instance_ids
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output