Struct aws_sdk_quicksight::client::fluent_builders::UpdateDashboard

source · [−]

pub struct UpdateDashboard { /* private fields */ }

Expand description

Fluent builder constructing a request to UpdateDashboard.

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Implementations

source

impl UpdateDashboard

source

pub async fn send(
self
) -> Result<UpdateDashboardOutput, SdkError<UpdateDashboardError>>

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.

source

pub fn aws_account_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_aws_account_id(self, input: Option<String>) -> Self

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

source

pub fn dashboard_id(self, input: impl Into<String>) -> Self

The ID for the dashboard.

source

pub fn set_dashboard_id(self, input: Option<String>) -> Self

The ID for the dashboard.

source

pub fn name(self, input: impl Into<String>) -> Self

The display name of the dashboard.

source

pub fn set_name(self, input: Option<String>) -> Self

The display name of the dashboard.

source

pub fn source_entity(self, input: DashboardSourceEntity) -> Self

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.

source

pub fn set_source_entity(self, input: Option<DashboardSourceEntity>) -> Self

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.

source

pub fn parameters(self, input: Parameters) -> Self

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.

source

pub fn set_parameters(self, input: Option<Parameters>) -> Self

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.

source

pub fn version_description(self, input: impl Into<String>) -> Self

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

source

pub fn set_version_description(self, input: Option<String>) -> Self

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

source

pub fn dashboard_publish_options(self, input: DashboardPublishOptions) -> Self

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.

source

pub fn set_dashboard_publish_options(
self,
input: Option<DashboardPublishOptions>
) -> Self

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.

source

pub fn theme_arn(self, input: impl Into<String>) -> Self

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.

source

pub fn set_theme_arn(self, input: Option<String>) -> Self

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.