Struct aws_sdk_quicksight::client::fluent_builders::CreateDashboard

pub struct CreateDashboard<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to CreateDashboard.

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Implementations

impl<C, M, R> CreateDashboard<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateDashboardOutput, SdkError<CreateDashboardError>> where
    R::Policy: SmithyRetryPolicy<CreateDashboardInputOperationOutputAlias, CreateDashboardOutput, CreateDashboardError, CreateDashboardInputOperationRetryAlias>, 

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.

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

The ID of the Amazon Web Services account where you want to create the dashboard.

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

The ID of the Amazon Web Services account where you want to create the dashboard.

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

The ID for the dashboard, also added to the IAM policy.

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

The ID for the dashboard, also added to the IAM policy.

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

The display name of the dashboard.

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

The display name of the dashboard.

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

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

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

pub fn permissions(self, input: ResourcePermission) -> Self

Appends an item to Permissions.

To override the contents of this collection use set_permissions.

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

pub fn set_permissions(self, input: Option<Vec<ResourcePermission>>) -> Self

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

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

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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 set_source_entity(self, input: Option<DashboardSourceEntity>) -> Self

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create 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 SourceTemplateARN 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 tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

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

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

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

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

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.

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.

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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

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 is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateDashboard<C, M, R>

fn clone(&self) -> CreateDashboard<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateDashboard<C, M, R>

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

Formats the value using the given formatter.