Struct aws_sdk_quicksight::input::CreateDashboardInput

#[non_exhaustive]
pub struct CreateDashboardInput {
    pub aws_account_id: Option<String>,
    pub dashboard_id: Option<String>,
    pub name: Option<String>,
    pub parameters: Option<Parameters>,
    pub permissions: Option<Vec<ResourcePermission>>,
    pub source_entity: Option<DashboardSourceEntity>,
    pub tags: Option<Vec<Tag>>,
    pub version_description: Option<String>,
    pub dashboard_publish_options: Option<DashboardPublishOptions>,
    pub theme_arn: Option<String>,
}

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 where you want to create the dashboard.

dashboard_id: Option<String>

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

name: Option<String>

The display name of the dashboard.

parameters: Option<Parameters>

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.

permissions: Option<Vec<ResourcePermission>>

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.

source_entity: Option<DashboardSourceEntity>

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.

tags: Option<Vec<Tag>>

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

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

Implementations

impl CreateDashboardInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateDashboard, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateDashboard>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateDashboardInput

impl CreateDashboardInput

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

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

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

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

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

The display name of the dashboard.

pub fn parameters(&self) -> Option<&Parameters>

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) -> Option<&[ResourcePermission]>

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) -> Option<&DashboardSourceEntity>

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) -> Option<&[Tag]>

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

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 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 Clone for CreateDashboardInput

fn clone(&self) -> CreateDashboardInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDashboardInput

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

Formats the value using the given formatter.

impl PartialEq<CreateDashboardInput> for CreateDashboardInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for CreateDashboardInput