Instance / Action / monitor

monitor¶

EC2.Instance.monitor(**kwargs)¶

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.

Request Syntax

response = instance.monitor(
    MetricCategoryIds=[
        'string',
    ],
    DryRun=True|False
)

Parameters:

MetricCategoryIds (list) –
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.
- (string) –
DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceMonitorings': [
        {
            'InstanceId': 'string',
            'Monitoring': {
                'MetricCategoryIds': [
                    'string',
                ],
                'State': 'disabled'|'disabling'|'enabled'|'pending'
            }
        },
    ]
}

Response Structure

(dict) –
- InstanceMonitorings (list) –
  
  The monitoring information.
  - (dict) –
    
    Describes the monitoring of an instance.
    - InstanceId (string) –
      
      The ID of the instance.
    - Monitoring (dict) –
      
      The monitoring for the instance.
      - MetricCategoryIds (list) –
        
        The IDs of the metric categories that are associated with the instance.
        
        (string) –
      - State (string) –
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.