aws_sdk_cloudtrail/operation/start_dashboard_refresh/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_dashboard_refresh::_start_dashboard_refresh_output::StartDashboardRefreshOutputBuilder;
3
4pub use crate::operation::start_dashboard_refresh::_start_dashboard_refresh_input::StartDashboardRefreshInputBuilder;
5
6impl crate::operation::start_dashboard_refresh::builders::StartDashboardRefreshInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_dashboard_refresh();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartDashboardRefresh`.
24///
25/// <p>Starts a refresh of the specified dashboard.</p>
26/// <p>Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the <code>StartQuery</code> operation on your behalf. To provide permissions, run the <code>PutResourcePolicy</code> operation to attach a resource-based policy to each event data store. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard">Example: Allow CloudTrail to run queries to populate a dashboard</a> in the <i>CloudTrail User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct StartDashboardRefreshFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::start_dashboard_refresh::builders::StartDashboardRefreshInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
36        crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
37    > for StartDashboardRefreshFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
45            crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl StartDashboardRefreshFluentBuilder {
52    /// Creates a new `StartDashboardRefreshFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the StartDashboardRefresh as a reference.
61    pub fn as_input(&self) -> &crate::operation::start_dashboard_refresh::builders::StartDashboardRefreshInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::start_dashboard_refresh::StartDashboardRefresh::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::start_dashboard_refresh::StartDashboardRefresh::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
98        crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The name or ARN of the dashboard.</p>
113    pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.dashboard_id(input.into());
115        self
116    }
117    /// <p>The name or ARN of the dashboard.</p>
118    pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_dashboard_id(input);
120        self
121    }
122    /// <p>The name or ARN of the dashboard.</p>
123    pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_dashboard_id()
125    }
126    ///
127    /// Adds a key-value pair to `QueryParameterValues`.
128    ///
129    /// To override the contents of this collection use [`set_query_parameter_values`](Self::set_query_parameter_values).
130    ///
131    /// <p>The query parameter values for the dashboard</p>
132    /// <p>For custom dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>.</p>
133    /// <p>For managed dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, <code>$Period$</code>, and <code>$EventDataStoreId$</code>. The <code>$EventDataStoreId$</code> query parameter is required.</p>
134    pub fn query_parameter_values(
135        mut self,
136        k: impl ::std::convert::Into<::std::string::String>,
137        v: impl ::std::convert::Into<::std::string::String>,
138    ) -> Self {
139        self.inner = self.inner.query_parameter_values(k.into(), v.into());
140        self
141    }
142    /// <p>The query parameter values for the dashboard</p>
143    /// <p>For custom dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>.</p>
144    /// <p>For managed dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, <code>$Period$</code>, and <code>$EventDataStoreId$</code>. The <code>$EventDataStoreId$</code> query parameter is required.</p>
145    pub fn set_query_parameter_values(
146        mut self,
147        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
148    ) -> Self {
149        self.inner = self.inner.set_query_parameter_values(input);
150        self
151    }
152    /// <p>The query parameter values for the dashboard</p>
153    /// <p>For custom dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>.</p>
154    /// <p>For managed dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, <code>$Period$</code>, and <code>$EventDataStoreId$</code>. The <code>$EventDataStoreId$</code> query parameter is required.</p>
155    pub fn get_query_parameter_values(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
156        self.inner.get_query_parameter_values()
157    }
158}
aws_sdk_cloudtrail/operation/start_dashboard_refresh/builders.rs

aws_sdk_cloudtrail/operation/start_dashboard_refresh/
builders.rs
