Struct aws_sdk_rum::client::fluent_builders::BatchCreateRumMetricDefinitions

pub struct BatchCreateRumMetricDefinitions { /* private fields */ }

Fluent builder constructing a request to BatchCreateRumMetricDefinitions.

Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.

By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.

If you also send extended metrics, you can send metrics to Evidently as well as CloudWatch, and you can also optionally send the metrics with additional dimensions. The valid dimension names for the additional dimensions are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently.

The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.

The maximum number of metric definitions that one destination can contain is 2000.

Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.

You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.

If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.

Implementations

impl BatchCreateRumMetricDefinitions

pub async fn customize(
    self
) -> Result<CustomizableOperation<BatchCreateRumMetricDefinitions, AwsResponseRetryClassifier>, SdkError<BatchCreateRumMetricDefinitionsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<BatchCreateRumMetricDefinitionsOutput, SdkError<BatchCreateRumMetricDefinitionsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn app_monitor_name(self, input: impl Into<String>) -> Self

The name of the CloudWatch RUM app monitor that is to send the metrics.

pub fn set_app_monitor_name(self, input: Option<String>) -> Self

The name of the CloudWatch RUM app monitor that is to send the metrics.

pub fn destination(self, input: MetricDestination) -> Self

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.

pub fn set_destination(self, input: Option<MetricDestination>) -> Self

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.

pub fn destination_arn(self, input: impl Into<String>) -> Self

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.

pub fn set_destination_arn(self, input: Option<String>) -> Self

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.

pub fn metric_definitions(self, input: MetricDefinitionRequest) -> Self

Appends an item to MetricDefinitions.

To override the contents of this collection use set_metric_definitions.

An array of structures which define the metrics that you want to send.

pub fn set_metric_definitions(
    self,
    input: Option<Vec<MetricDefinitionRequest>>
) -> Self

An array of structures which define the metrics that you want to send.

Trait Implementations

impl Clone for BatchCreateRumMetricDefinitions

fn clone(&self) -> BatchCreateRumMetricDefinitions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchCreateRumMetricDefinitions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.