pub struct StartDashboardRefreshFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartDashboardRefresh
.
Starts a refresh of the specified dashboard.
Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery
operation on your behalf. To provide permissions, run the PutResourcePolicy
operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.
Implementations§
Source§impl StartDashboardRefreshFluentBuilder
impl StartDashboardRefreshFluentBuilder
Sourcepub fn as_input(&self) -> &StartDashboardRefreshInputBuilder
pub fn as_input(&self) -> &StartDashboardRefreshInputBuilder
Access the StartDashboardRefresh as a reference.
Sourcepub async fn send(
self,
) -> Result<StartDashboardRefreshOutput, SdkError<StartDashboardRefreshError, HttpResponse>>
pub async fn send( self, ) -> Result<StartDashboardRefreshOutput, SdkError<StartDashboardRefreshError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartDashboardRefreshOutput, StartDashboardRefreshError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartDashboardRefreshOutput, StartDashboardRefreshError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn dashboard_id(self, input: impl Into<String>) -> Self
pub fn dashboard_id(self, input: impl Into<String>) -> Self
The name or ARN of the dashboard.
Sourcepub fn set_dashboard_id(self, input: Option<String>) -> Self
pub fn set_dashboard_id(self, input: Option<String>) -> Self
The name or ARN of the dashboard.
Sourcepub fn get_dashboard_id(&self) -> &Option<String>
pub fn get_dashboard_id(&self) -> &Option<String>
The name or ARN of the dashboard.
Sourcepub fn query_parameter_values(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn query_parameter_values( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to QueryParameterValues
.
To override the contents of this collection use set_query_parameter_values
.
The query parameter values for the dashboard
For custom dashboards, the following query parameters are valid: $StartTime$
, $EndTime$
, and $Period$
.
For managed dashboards, the following query parameters are valid: $StartTime$
, $EndTime$
, $Period$
, and $EventDataStoreId$
. The $EventDataStoreId$
query parameter is required.
Sourcepub fn set_query_parameter_values(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_query_parameter_values( self, input: Option<HashMap<String, String>>, ) -> Self
The query parameter values for the dashboard
For custom dashboards, the following query parameters are valid: $StartTime$
, $EndTime$
, and $Period$
.
For managed dashboards, the following query parameters are valid: $StartTime$
, $EndTime$
, $Period$
, and $EventDataStoreId$
. The $EventDataStoreId$
query parameter is required.
Sourcepub fn get_query_parameter_values(&self) -> &Option<HashMap<String, String>>
pub fn get_query_parameter_values(&self) -> &Option<HashMap<String, String>>
The query parameter values for the dashboard
For custom dashboards, the following query parameters are valid: $StartTime$
, $EndTime$
, and $Period$
.
For managed dashboards, the following query parameters are valid: $StartTime$
, $EndTime$
, $Period$
, and $EventDataStoreId$
. The $EventDataStoreId$
query parameter is required.
Trait Implementations§
Source§impl Clone for StartDashboardRefreshFluentBuilder
impl Clone for StartDashboardRefreshFluentBuilder
Source§fn clone(&self) -> StartDashboardRefreshFluentBuilder
fn clone(&self) -> StartDashboardRefreshFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartDashboardRefreshFluentBuilder
impl !RefUnwindSafe for StartDashboardRefreshFluentBuilder
impl Send for StartDashboardRefreshFluentBuilder
impl Sync for StartDashboardRefreshFluentBuilder
impl Unpin for StartDashboardRefreshFluentBuilder
impl !UnwindSafe for StartDashboardRefreshFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);