// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_dashboard_refresh::_start_dashboard_refresh_input::StartDashboardRefreshInputBuilder;
pub use crate::operation::start_dashboard_refresh::_start_dashboard_refresh_output::StartDashboardRefreshOutputBuilder;
impl crate::operation::start_dashboard_refresh::builders::StartDashboardRefreshInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.start_dashboard_refresh();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `StartDashboardRefresh`.
///
/// <p>Starts a refresh of the specified dashboard.</p>
/// <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>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartDashboardRefreshFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_dashboard_refresh::builders::StartDashboardRefreshInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
> for StartDashboardRefreshFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::start_dashboard_refresh::StartDashboardRefreshOutput,
crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl StartDashboardRefreshFluentBuilder {
/// Creates a new `StartDashboardRefreshFluentBuilder`.
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 StartDashboardRefresh as a reference.
pub fn as_input(&self) -> &crate::operation::start_dashboard_refresh::builders::StartDashboardRefreshInputBuilder {
&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::start_dashboard_refresh::StartDashboardRefreshOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
::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::start_dashboard_refresh::StartDashboardRefresh::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::start_dashboard_refresh::StartDashboardRefresh::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::start_dashboard_refresh::StartDashboardRefreshOutput,
crate::operation::start_dashboard_refresh::StartDashboardRefreshError,
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
}
/// <p>The name or ARN of the dashboard.</p>
pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.dashboard_id(input.into());
self
}
/// <p>The name or ARN of the dashboard.</p>
pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_dashboard_id(input);
self
}
/// <p>The name or ARN of the dashboard.</p>
pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_dashboard_id()
}
///
/// Adds a key-value pair to `QueryParameterValues`.
///
/// To override the contents of this collection use [`set_query_parameter_values`](Self::set_query_parameter_values).
///
/// <p>The query parameter values for the dashboard</p>
/// <p>For custom dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>.</p>
/// <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>
pub fn query_parameter_values(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.query_parameter_values(k.into(), v.into());
self
}
/// <p>The query parameter values for the dashboard</p>
/// <p>For custom dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>.</p>
/// <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>
pub fn set_query_parameter_values(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.inner = self.inner.set_query_parameter_values(input);
self
}
/// <p>The query parameter values for the dashboard</p>
/// <p>For custom dashboards, the following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>.</p>
/// <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>
pub fn get_query_parameter_values(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.inner.get_query_parameter_values()
}
}