Struct aws_sdk_quicksight::operation::update_dashboard::UpdateDashboardInput

#[non_exhaustive]
pub struct UpdateDashboardInput {
    pub aws_account_id: Option<String>,
    pub dashboard_id: Option<String>,
    pub name: Option<String>,
    pub source_entity: Option<DashboardSourceEntity>,
    pub parameters: Option<Parameters>,
    pub version_description: Option<String>,
    pub dashboard_publish_options: Option<DashboardPublishOptions>,
    pub theme_arn: Option<String>,
    pub definition: Option<DashboardVersionDefinition>,
    pub validation_strategy: Option<ValidationStrategy>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aws_account_id: Option<String>

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

dashboard_id: Option<String>

The ID for the dashboard.

name: Option<String>

The display name of the dashboard.

source_entity: 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.

parameters: 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.

version_description: Option<String>

A description for the first version of the dashboard being created.

dashboard_publish_options: Option<DashboardPublishOptions>

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

theme_arn: Option<String>

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.

definition: Option<DashboardVersionDefinition>

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

validation_strategy: Option<ValidationStrategy>

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

Implementations

impl UpdateDashboardInput

pub fn aws_account_id(&self) -> Option<&str>

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

pub fn dashboard_id(&self) -> Option<&str>

The ID for the dashboard.

pub fn name(&self) -> Option<&str>

The display name of the dashboard.

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.

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.

pub fn version_description(&self) -> Option<&str>

A description for the first version of the dashboard being created.

pub fn dashboard_publish_options(&self) -> Option<&DashboardPublishOptions>

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

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.

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.

pub fn validation_strategy(&self) -> Option<&ValidationStrategy>

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

impl UpdateDashboardInput

pub fn builder() -> UpdateDashboardInputBuilder

Creates a new builder-style object to manufacture UpdateDashboardInput.

Trait Implementations

impl Clone for UpdateDashboardInput

fn clone(&self) -> UpdateDashboardInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateDashboardInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateDashboardInput

fn eq(&self, other: &UpdateDashboardInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateDashboardInput