aws-sdk-cloudtrail 1.104.0

AWS SDK for AWS CloudTrail
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_insights_data::_list_insights_data_input::ListInsightsDataInputBuilder;

pub use crate::operation::list_insights_data::_list_insights_data_output::ListInsightsDataOutputBuilder;

impl crate::operation::list_insights_data::builders::ListInsightsDataInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::list_insights_data::ListInsightsDataOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_insights_data::ListInsightsDataError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_insights_data();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListInsightsData`.
///
/// <p>Returns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days.</p>
/// <p>ListInsightsData supports the following Dimensions for Insights events:</p>
/// <ul>
/// <li>
/// <p>Event ID</p></li>
/// <li>
/// <p>Event name</p></li>
/// <li>
/// <p>Event source</p></li>
/// </ul>
/// <p>All dimensions are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.</p>
/// <p>The rate of ListInsightsData requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListInsightsDataFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_insights_data::builders::ListInsightsDataInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_insights_data::ListInsightsDataOutput,
        crate::operation::list_insights_data::ListInsightsDataError,
    > for ListInsightsDataFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_insights_data::ListInsightsDataOutput,
            crate::operation::list_insights_data::ListInsightsDataError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListInsightsDataFluentBuilder {
    /// Creates a new `ListInsightsDataFluentBuilder`.
    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 ListInsightsData as a reference.
    pub fn as_input(&self) -> &crate::operation::list_insights_data::builders::ListInsightsDataInputBuilder {
        &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::list_insights_data::ListInsightsDataOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_insights_data::ListInsightsDataError,
            ::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::list_insights_data::ListInsightsData::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_insights_data::ListInsightsData::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::list_insights_data::ListInsightsDataOutput,
        crate::operation::list_insights_data::ListInsightsDataError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::list_insights_data::paginator::ListInsightsDataPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_insights_data::paginator::ListInsightsDataPaginator {
        crate::operation::list_insights_data::paginator::ListInsightsDataPaginator::new(self.handle, self.inner)
    }
    /// <p>The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.</p>
    pub fn insight_source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.insight_source(input.into());
        self
    }
    /// <p>The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.</p>
    pub fn set_insight_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_insight_source(input);
        self
    }
    /// <p>The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.</p>
    pub fn get_insight_source(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_insight_source()
    }
    /// <p>Specifies the category of events returned. To fetch Insights events, specify <code>InsightsEvents</code> as the value of <code>DataType</code></p>
    pub fn data_type(mut self, input: crate::types::ListInsightsDataType) -> Self {
        self.inner = self.inner.data_type(input);
        self
    }
    /// <p>Specifies the category of events returned. To fetch Insights events, specify <code>InsightsEvents</code> as the value of <code>DataType</code></p>
    pub fn set_data_type(mut self, input: ::std::option::Option<crate::types::ListInsightsDataType>) -> Self {
        self.inner = self.inner.set_data_type(input);
        self
    }
    /// <p>Specifies the category of events returned. To fetch Insights events, specify <code>InsightsEvents</code> as the value of <code>DataType</code></p>
    pub fn get_data_type(&self) -> &::std::option::Option<crate::types::ListInsightsDataType> {
        self.inner.get_data_type()
    }
    ///
    /// Adds a key-value pair to `Dimensions`.
    ///
    /// To override the contents of this collection use [`set_dimensions`](Self::set_dimensions).
    ///
    /// <p>Contains a map of dimensions. Currently the map can contain only one item.</p>
    pub fn dimensions(mut self, k: crate::types::ListInsightsDataDimensionKey, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.dimensions(k, v.into());
        self
    }
    /// <p>Contains a map of dimensions. Currently the map can contain only one item.</p>
    pub fn set_dimensions(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<crate::types::ListInsightsDataDimensionKey, ::std::string::String>>,
    ) -> Self {
        self.inner = self.inner.set_dimensions(input);
        self
    }
    /// <p>Contains a map of dimensions. Currently the map can contain only one item.</p>
    pub fn get_dimensions(
        &self,
    ) -> &::std::option::Option<::std::collections::HashMap<crate::types::ListInsightsDataDimensionKey, ::std::string::String>> {
        self.inner.get_dimensions()
    }
    /// <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>
    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.start_time(input);
        self
    }
    /// <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>
    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_start_time(input);
        self
    }
    /// <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>
    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_start_time()
    }
    /// <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>
    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.end_time(input);
        self
    }
    /// <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>
    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_end_time(input);
        self
    }
    /// <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>
    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_end_time()
    }
    /// <p>The number of events to return. Possible values are 1 through 50. The default is 50.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <p>The number of events to return. Possible values are 1 through 50. The default is 50.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <p>The number of events to return. Possible values are 1 through 50. The default is 50.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <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>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <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>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <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>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
}