aws_sdk_cloudtrail/client/
put_insight_selectors.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 [`PutInsightSelectors`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`trail_name(impl Into<String>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::trail_name) / [`set_trail_name(Option<String>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::set_trail_name):<br>required: **false**<br><p>The name of the CloudTrail trail for which you want to change or add Insights selectors.</p> <p>You cannot use this parameter with the <code>EventDataStore</code> and <code>InsightsDestination</code> parameters.</p><br>
7    ///   - [`insight_selectors(InsightSelector)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::insight_selectors) / [`set_insight_selectors(Option<Vec::<InsightSelector>>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::set_insight_selectors):<br>required: **true**<br><p>Contains the Insights types you want to log on a specific category of events on a trail or event data store. <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid Insight types.The EventCategory field can specify <code>Management</code> or <code>Data</code> events or both. For event data store, you can log Insights for management events only.</p> <p>The <code>ApiCallRateInsight</code> Insights type analyzes write-only management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.</p> <p>The <code>ApiErrorRateInsight</code> Insights type analyzes management and data API calls that result in error codes. The error is shown if the API call is unsuccessful.</p><br>
8    ///   - [`event_data_store(impl Into<String>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::event_data_store) / [`set_event_data_store(Option<String>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::set_event_data_store):<br>required: **false**<br><p>The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the <code>EventDataStore</code> and <code>InsightsDestination</code> parameters.</p> <p>You cannot use this parameter with the <code>TrailName</code> parameter.</p><br>
9    ///   - [`insights_destination(impl Into<String>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::insights_destination) / [`set_insights_destination(Option<String>)`](crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::set_insights_destination):<br>required: **false**<br><p>The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the <code>EventDataStore</code> and <code>InsightsDestination</code> parameters.</p> <p>You cannot use this parameter with the <code>TrailName</code> parameter.</p><br>
10    /// - On success, responds with [`PutInsightSelectorsOutput`](crate::operation::put_insight_selectors::PutInsightSelectorsOutput) with field(s):
11    ///   - [`trail_arn(Option<String>)`](crate::operation::put_insight_selectors::PutInsightSelectorsOutput::trail_arn): <p>The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.</p>
12    ///   - [`insight_selectors(Option<Vec::<InsightSelector>>)`](crate::operation::put_insight_selectors::PutInsightSelectorsOutput::insight_selectors): <p>Contains the Insights types you want to log on a specific category of events in a trail or event data store. <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid Insight types.The EventCategory field can specify <code>Management</code> or <code>Data</code> events or both. For event data store, you can only log Insights for management events only.</p>
13    ///   - [`event_data_store_arn(Option<String>)`](crate::operation::put_insight_selectors::PutInsightSelectorsOutput::event_data_store_arn): <p>The Amazon Resource Name (ARN) of the source event data store for which you want to change or add Insights selectors.</p>
14    ///   - [`insights_destination(Option<String>)`](crate::operation::put_insight_selectors::PutInsightSelectorsOutput::insights_destination): <p>The ARN of the destination event data store that logs Insights events.</p>
15    /// - On failure, responds with [`SdkError<PutInsightSelectorsError>`](crate::operation::put_insight_selectors::PutInsightSelectorsError)
16    pub fn put_insight_selectors(&self) -> crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder {
17        crate::operation::put_insight_selectors::builders::PutInsightSelectorsFluentBuilder::new(self.handle.clone())
18    }
19}