update_monitor ¶

def update_monitor(
    self,
    monitor_name: "capo_internetmonitor.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[InternetMonitorClientConfig] = None,
    resources_to_add: Optional[
        "capo_internetmonitor.types.set_of_ar_ns.SetOfARNs"
    ] = None,
    resources_to_remove: Optional[
        "capo_internetmonitor.types.set_of_ar_ns.SetOfARNs"
    ] = None,
    status: Optional[
        "capo_internetmonitor.types.monitor_config_state.MonitorConfigState"
    ] = None,
    client_token: Optional[str] = None,
    max_city_networks_to_monitor: Optional[
        "capo_internetmonitor.types.max_city_networks_to_monitor.MaxCityNetworksToMonitor"
    ] = None,
    internet_measurements_log_delivery: Optional[
        "capo_internetmonitor.types.internet_measurements_log_delivery.InternetMeasurementsLogDelivery"
    ] = None,
    traffic_percentage_to_monitor: Optional[
        "capo_internetmonitor.types.traffic_percentage_to_monitor.TrafficPercentageToMonitor"
    ] = None,
    health_events_config: Optional[
        "capo_internetmonitor.types.health_events_config.HealthEventsConfig"
    ] = None,
) -> "capo_internetmonitor.types.update_monitor_output.UpdateMonitorOutput":
    """<p>Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.</p> <p>The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value</a> in the <i>Amazon CloudWatch User Guide</i>.</p>

    Args:
        monitor_name: <p>The name of the monitor. </p>
        resources_to_add: <p>The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.</p> <p>You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.</p> <note> <p>If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.</p> </note>
        resources_to_remove: <p>The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).</p>
        status: <p>The status for a monitor. The accepted values for <code>Status</code> with the <code>UpdateMonitor</code> API call are the following: <code>ACTIVE</code> and <code>INACTIVE</code>. The following values are <i>not</i> accepted: <code>PENDING</code>, and <code>ERROR</code>.</p>
        client_token: <p>A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.</p>
        max_city_networks_to_monitor: <p>The maximum number of city-networks to monitor for your application. 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. Setting this limit can help control billing costs.</p>
        internet_measurements_log_delivery: <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: <p>The percentage of the internet-facing traffic for your application that you want 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: <p>The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines 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>

    Raises:
        capo_internetmonitor.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
        capo_internetmonitor.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_internetmonitor.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded a service quota.</p>
        capo_internetmonitor.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request specifies a resource that doesn't exist.</p>
        capo_internetmonitor.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_internetmonitor.errors.validation_exception.ValidationException: <p>Invalid request.</p>
        capo_internetmonitor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_internetmonitor.types.update_monitor_input.UpdateMonitorInput]",
    ) -> OperationResponse[
        "capo_internetmonitor.types.update_monitor_output.UpdateMonitorOutput"
    ]:
        import capo_internetmonitor._operations.internet_monitor20210603.update_monitor

        output, http_response = (
            capo_internetmonitor._operations.internet_monitor20210603.update_monitor.update_monitor(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateMonitor")
    )
    input_: capo_internetmonitor.types.update_monitor_input.UpdateMonitorInput = {
        "monitor_name": monitor_name
    }
    if resources_to_add is not None:
        input_["resources_to_add"] = resources_to_add
    if resources_to_remove is not None:
        input_["resources_to_remove"] = resources_to_remove
    if status is not None:
        input_["status"] = status
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if max_city_networks_to_monitor is not None:
        input_["max_city_networks_to_monitor"] = max_city_networks_to_monitor
    if internet_measurements_log_delivery is not None:
        input_["internet_measurements_log_delivery"] = (
            internet_measurements_log_delivery
        )
    if traffic_percentage_to_monitor is not None:
        input_["traffic_percentage_to_monitor"] = traffic_percentage_to_monitor
    if health_events_config is not None:
        input_["health_events_config"] = health_events_config

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