aws_sdk_rum/client/
put_rum_events.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 [`PutRumEvents`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::set_id):<br>required: **true**<br><p>The ID of the app monitor that is sending this data.</p><br>
7    ///   - [`batch_id(impl Into<String>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::batch_id) / [`set_batch_id(Option<String>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::set_batch_id):<br>required: **true**<br><p>A unique identifier for this batch of RUM event data.</p><br>
8    ///   - [`app_monitor_details(AppMonitorDetails)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::app_monitor_details) / [`set_app_monitor_details(Option<AppMonitorDetails>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::set_app_monitor_details):<br>required: **true**<br><p>A structure that contains information about the app monitor that collected this telemetry information.</p><br>
9    ///   - [`user_details(UserDetails)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::user_details) / [`set_user_details(Option<UserDetails>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::set_user_details):<br>required: **true**<br><p>A structure that contains information about the user session that this batch of events was collected from.</p><br>
10    ///   - [`rum_events(RumEvent)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::rum_events) / [`set_rum_events(Option<Vec::<RumEvent>>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::set_rum_events):<br>required: **true**<br><p>An array of structures that contain the telemetry event data.</p><br>
11    ///   - [`alias(impl Into<String>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::alias) / [`set_alias(Option<String>)`](crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::set_alias):<br>required: **false**<br><p>If the app monitor uses a resource-based policy that requires <code>PutRumEvents</code> requests to specify a certain alias, specify that alias here. This alias will be compared to the <code>rum:alias</code> context key in the resource-based policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html">Using resource-based policies with CloudWatch RUM</a>.</p><br>
12    /// - On success, responds with [`PutRumEventsOutput`](crate::operation::put_rum_events::PutRumEventsOutput)
13    /// - On failure, responds with [`SdkError<PutRumEventsError>`](crate::operation::put_rum_events::PutRumEventsError)
14    pub fn put_rum_events(&self) -> crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder {
15        crate::operation::put_rum_events::builders::PutRumEventsFluentBuilder::new(self.handle.clone())
16    }
17}