Skip to content

GetMonitorOutput

Source code in docs_src/capo_internetmonitor/types/get_monitor_output.py
class GetMonitorOutput(TypedDict, closed=True):
    monitor_name: "capo_internetmonitor.types.resource_name.ResourceName"
    """<p>The name of the monitor.</p>"""
    monitor_arn: "capo_internetmonitor.types.monitor_arn.MonitorArn"
    """<p>The Amazon Resource Name (ARN) of the monitor.</p>"""
    resources: "capo_internetmonitor.types.set_of_ar_ns.SetOfARNs"
    """<p>The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).</p>"""
    status: "capo_internetmonitor.types.monitor_config_state.MonitorConfigState"
    """<p>The status of the monitor.</p>"""
    created_at: "datetime.datetime"
    """<p>The time when the monitor was created.</p>"""
    modified_at: "datetime.datetime"
    """<p>The last time that the monitor was modified.</p>"""
    processing_status: NotRequired[
        "capo_internetmonitor.types.monitor_processing_status_code.MonitorProcessingStatusCode"
    ]
    """<p>The health of the data processing for the monitor.</p>"""
    processing_status_info: NotRequired["str"]
    """<p>Additional information about the health of the data processing for the monitor.</p>"""
    tags: NotRequired["capo_internetmonitor.types.tag_map.TagMap"]
    """<p>The tags that have been added to monitor.</p>"""
    max_city_networks_to_monitor: NotRequired[
        "capo_internetmonitor.types.max_city_networks_to_monitor.MaxCityNetworksToMonitor"
    ]
    """<p>The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.</p> <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>"""
    internet_measurements_log_delivery: NotRequired[
        "capo_internetmonitor.types.internet_measurements_log_delivery.InternetMeasurementsLogDelivery"
    ]
    """<p>Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.</p>"""
    traffic_percentage_to_monitor: NotRequired[
        "capo_internetmonitor.types.traffic_percentage_to_monitor.TrafficPercentageToMonitor"
    ]
    """<p>The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.</p> <p>To learn more, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor </a> in the Amazon CloudWatch Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>"""
    health_events_config: NotRequired[
        "capo_internetmonitor.types.health_events_config.HealthEventsConfig"
    ]
    """<p>The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview"> Change health event thresholds</a> in the Internet Monitor section of the <i>CloudWatch User Guide</i>.</p>"""

created_at instance-attribute

created_at: datetime

The time when the monitor was created.

health_events_config instance-attribute

health_events_config: NotRequired[HealthEventsConfig]

The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

internet_measurements_log_delivery instance-attribute

internet_measurements_log_delivery: NotRequired[InternetMeasurementsLogDelivery]

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

max_city_networks_to_monitor instance-attribute

max_city_networks_to_monitor: NotRequired[MaxCityNetworksToMonitor]

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

modified_at instance-attribute

modified_at: datetime

The last time that the monitor was modified.

monitor_arn instance-attribute

monitor_arn: MonitorArn

The Amazon Resource Name (ARN) of the monitor.

monitor_name instance-attribute

monitor_name: ResourceName

The name of the monitor.

processing_status instance-attribute

processing_status: NotRequired[MonitorProcessingStatusCode]

The health of the data processing for the monitor.

processing_status_info instance-attribute

processing_status_info: NotRequired[str]

Additional information about the health of the data processing for the monitor.

resources instance-attribute

resources: SetOfARNs

The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

status instance-attribute

The status of the monitor.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that have been added to monitor.

traffic_percentage_to_monitor instance-attribute

traffic_percentage_to_monitor: NotRequired[TrafficPercentageToMonitor]

The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.