aws_sdk_cloudtrail/client/

list_insights_data.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListInsightsData`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`insight_source(impl Into<String>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::insight_source) / [`set_insight_source(Option<String>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_insight_source):<br>required: **true**<br><p>The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.</p><br>
    ///   - [`data_type(ListInsightsDataType)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::data_type) / [`set_data_type(Option<ListInsightsDataType>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_data_type):<br>required: **true**<br><p>Specifies the category of events returned. To fetch Insights events, specify <code>InsightsEvents</code> as the value of <code>DataType</code></p><br>
    ///   - [`dimensions(ListInsightsDataDimensionKey, impl Into<String>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::dimensions) / [`set_dimensions(Option<HashMap::<ListInsightsDataDimensionKey, String>>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_dimensions):<br>required: **false**<br><p>Contains a map of dimensions. Currently the map can contain only one item.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_start_time):<br>required: **false**<br><p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p><br>
    ///   - [`end_time(DateTime)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_end_time):<br>required: **false**<br><p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_max_results):<br>required: **false**<br><p>The number of events to return. Possible values are 1 through 50. The default is 50.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified a EventName as a dimension with <code>PutObject</code> as a value, the call with NextToken should include those same parameters.</p><br>
    /// - On success, responds with [`ListInsightsDataOutput`](crate::operation::list_insights_data::ListInsightsDataOutput) with field(s):
    ///   - [`events(Option<Vec::<Event>>)`](crate::operation::list_insights_data::ListInsightsDataOutput::events): <p>A list of events returned based on the InsightSource, DataType or Dimensions specified. The events list is sorted by time. The most recent event is listed first.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_insights_data::ListInsightsDataOutput::next_token): <p>The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified a EventName as a dimension with <code>PutObject</code> as a value, the call with NextToken should include those same parameters.</p>
    /// - On failure, responds with [`SdkError<ListInsightsDataError>`](crate::operation::list_insights_data::ListInsightsDataError)
    pub fn list_insights_data(&self) -> crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder {
        crate::operation::list_insights_data::builders::ListInsightsDataFluentBuilder::new(self.handle.clone())
    }
}