aws_sdk_rum/client/
batch_create_rum_metric_definitions.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`BatchCreateRumMetricDefinitions`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`app_monitor_name(impl Into<String>)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::app_monitor_name) / [`set_app_monitor_name(Option<String>)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::set_app_monitor_name):<br>required: **true**<br><p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p><br>
7    ///   - [`destination(MetricDestination)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::destination) / [`set_destination(Option<MetricDestination>)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::set_destination):<br>required: **true**<br><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 Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.</p><br>
8    ///   - [`destination_arn(impl Into<String>)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::destination_arn) / [`set_destination_arn(Option<String>)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::set_destination_arn):<br>required: **false**<br><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><br>
9    ///   - [`metric_definitions(MetricDefinitionRequest)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::metric_definitions) / [`set_metric_definitions(Option<Vec::<MetricDefinitionRequest>>)`](crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::set_metric_definitions):<br>required: **true**<br><p>An array of structures which define the metrics that you want to send.</p><br>
10    /// - On success, responds with [`BatchCreateRumMetricDefinitionsOutput`](crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput) with field(s):
11    ///   - [`errors(Vec::<BatchCreateRumMetricDefinitionsError>)`](crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput::errors): <p>An array of error objects, if the operation caused any errors.</p>
12    ///   - [`metric_definitions(Option<Vec::<MetricDefinition>>)`](crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput::metric_definitions): <p>An array of structures that define the extended metrics.</p>
13    /// - On failure, responds with [`SdkError<BatchCreateRumMetricDefinitionsError>`](crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsError)
14    pub fn batch_create_rum_metric_definitions(
15        &self,
16    ) -> crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder {
17        crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsFluentBuilder::new(self.handle.clone())
18    }
19}