Struct aws_sdk_quicksight::input::UpdateDashboardInput
source · #[non_exhaustive]pub struct UpdateDashboardInput { /* private fields */ }
Implementations§
source§impl UpdateDashboardInput
impl UpdateDashboardInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateDashboard, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateDashboard, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<UpdateDashboard
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture UpdateDashboardInput
.
source§impl UpdateDashboardInput
impl UpdateDashboardInput
sourcepub fn aws_account_id(&self) -> Option<&str>
pub fn aws_account_id(&self) -> Option<&str>
The ID of the Amazon Web Services account that contains the dashboard that you're updating.
sourcepub fn dashboard_id(&self) -> Option<&str>
pub fn dashboard_id(&self) -> Option<&str>
The ID for the dashboard.
sourcepub fn source_entity(&self) -> Option<&DashboardSourceEntity>
pub fn source_entity(&self) -> Option<&DashboardSourceEntity>
The entity that you are using as a source when you update the dashboard. In SourceEntity
, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate
entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
sourcepub fn parameters(&self) -> Option<&Parameters>
pub fn parameters(&self) -> Option<&Parameters>
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
sourcepub fn version_description(&self) -> Option<&str>
pub fn version_description(&self) -> Option<&str>
A description for the first version of the dashboard being created.
sourcepub fn dashboard_publish_options(&self) -> Option<&DashboardPublishOptions>
pub fn dashboard_publish_options(&self) -> Option<&DashboardPublishOptions>
Options for publishing the dashboard when you create it:
-
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default. -
AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default. -
VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
sourcepub fn theme_arn(&self) -> Option<&str>
pub fn theme_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
sourcepub fn definition(&self) -> Option<&DashboardVersionDefinition>
pub fn definition(&self) -> Option<&DashboardVersionDefinition>
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Trait Implementations§
source§impl Clone for UpdateDashboardInput
impl Clone for UpdateDashboardInput
source§fn clone(&self) -> UpdateDashboardInput
fn clone(&self) -> UpdateDashboardInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateDashboardInput
impl Debug for UpdateDashboardInput
source§impl PartialEq<UpdateDashboardInput> for UpdateDashboardInput
impl PartialEq<UpdateDashboardInput> for UpdateDashboardInput
source§fn eq(&self, other: &UpdateDashboardInput) -> bool
fn eq(&self, other: &UpdateDashboardInput) -> bool
self
and other
values to be equal, and is used
by ==
.