1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::batch_create_rum_metric_definitions::_batch_create_rum_metric_definitions_output::BatchCreateRumMetricDefinitionsOutputBuilder;
pub use crate::operation::batch_create_rum_metric_definitions::_batch_create_rum_metric_definitions_input::BatchCreateRumMetricDefinitionsInputBuilder;
impl BatchCreateRumMetricDefinitionsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.batch_create_rum_metric_definitions();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `BatchCreateRumMetricDefinitions`.
///
/// <p>Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.</p>
/// <p>By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html">CloudWatch metrics that you can collect with CloudWatch RUM</a>.</p>
/// <p>In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.</p>
/// <ul>
/// <li>
/// <p>Extended metrics enable you to send metrics with additional dimensions not included in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch. The valid dimension names for the additional dimensions for extended metrics are <code>BrowserName</code>, <code>CountryCode</code>, <code>DeviceType</code>, <code>FileType</code>, <code>OSName</code>, and <code>PageId</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html"> Extended metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p></li>
/// <li>
/// <p>Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or to CloudWatch Evidently or to both. With custom metrics, you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events, custom attributes, or default attributes.</p>
/// <p>You can't send custom metrics to the <code>AWS/RUM</code> namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with <code>AWS/</code>. CloudWatch RUM prepends <code>RUM/CustomMetrics/</code> to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is <code>RUM/CustomMetrics/<i>your-custom-namespace</i> </code>.</p></li>
/// </ul>
/// <p>The maximum number of metric definitions that you can specify in one <code>BatchCreateRumMetricDefinitions</code> operation is 200.</p>
/// <p>The maximum number of metric definitions that one destination can contain is 2000.</p>
/// <p>Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
/// <p>You must have already created a destination for the metrics before you send them. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p>
/// <p>If some metric definitions specified in a <code>BatchCreateRumMetricDefinitions</code> operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct BatchCreateRumMetricDefinitionsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput,
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsError,
> for BatchCreateRumMetricDefinitionsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput,
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl BatchCreateRumMetricDefinitionsFluentBuilder {
/// Creates a new `BatchCreateRumMetricDefinitions`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the BatchCreateRumMetricDefinitions as a reference.
pub fn as_input(&self) -> &crate::operation::batch_create_rum_metric_definitions::builders::BatchCreateRumMetricDefinitionsInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitions::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitions::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsOutput,
crate::operation::batch_create_rum_metric_definitions::BatchCreateRumMetricDefinitionsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p>
pub fn app_monitor_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.app_monitor_name(input.into());
self
}
/// <p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p>
pub fn set_app_monitor_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_app_monitor_name(input);
self
}
/// <p>The name of the CloudWatch RUM app monitor that is to send the metrics.</p>
pub fn get_app_monitor_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_app_monitor_name()
}
/// <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>
pub fn destination(mut self, input: crate::types::MetricDestination) -> Self {
self.inner = self.inner.destination(input);
self
}
/// <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>
pub fn set_destination(mut self, input: ::std::option::Option<crate::types::MetricDestination>) -> Self {
self.inner = self.inner.set_destination(input);
self
}
/// <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>
pub fn get_destination(&self) -> &::std::option::Option<crate::types::MetricDestination> {
self.inner.get_destination()
}
/// <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>
pub fn destination_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.destination_arn(input.into());
self
}
/// <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>
pub fn set_destination_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_destination_arn(input);
self
}
/// <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>
pub fn get_destination_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_destination_arn()
}
/// Appends an item to `MetricDefinitions`.
///
/// To override the contents of this collection use [`set_metric_definitions`](Self::set_metric_definitions).
///
/// <p>An array of structures which define the metrics that you want to send.</p>
pub fn metric_definitions(mut self, input: crate::types::MetricDefinitionRequest) -> Self {
self.inner = self.inner.metric_definitions(input);
self
}
/// <p>An array of structures which define the metrics that you want to send.</p>
pub fn set_metric_definitions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricDefinitionRequest>>) -> Self {
self.inner = self.inner.set_metric_definitions(input);
self
}
/// <p>An array of structures which define the metrics that you want to send.</p>
pub fn get_metric_definitions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricDefinitionRequest>> {
self.inner.get_metric_definitions()
}
}