Skip to content

UpdateRumMetricDefinitionRequest

Source code in docs_src/capo_rum/types/update_rum_metric_definition_request.py
class UpdateRumMetricDefinitionRequest(TypedDict, closed=True):
    app_monitor_name: "capo_rum.types.app_monitor_name.AppMonitorName"
    """<p>The name of the CloudWatch RUM app monitor that sends these metrics.</p>"""
    destination: "capo_rum.types.metric_destination.MetricDestination"
    """<p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.</p>"""
    destination_arn: NotRequired["capo_rum.types.destination_arn.DestinationArn"]
    """<p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is <code>CloudWatch</code>, do not use this parameter.</p> <p>This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p>"""
    metric_definition: (
        "capo_rum.types.metric_definition_request.MetricDefinitionRequest"
    )
    """<p>A structure that contains the new definition that you want to use for this metric.</p>"""
    metric_definition_id: "capo_rum.types.metric_definition_id.MetricDefinitionId"
    """<p>The ID of the metric definition to update.</p>"""

app_monitor_name instance-attribute

app_monitor_name: AppMonitorName

The name of the CloudWatch RUM app monitor that sends these metrics.

destination instance-attribute

destination: MetricDestination

The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.

destination_arn instance-attribute

destination_arn: NotRequired[DestinationArn]

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

metric_definition instance-attribute

metric_definition: MetricDefinitionRequest

A structure that contains the new definition that you want to use for this metric.

metric_definition_id instance-attribute

metric_definition_id: MetricDefinitionId

The ID of the metric definition to update.