Struct aws_sdk_quicksight::input::CreateDashboardInput [−][src]
#[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)
This struct is marked as non-exhaustive
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 IAMpolicy.
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 IAMaction 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 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.
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
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.
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
pub fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateDashboard, AwsErrorRetryPolicy>, BuildError>
pub fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateDashboard, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateDashboard
>
Creates a new builder-style object to manufacture CreateDashboardInput
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for CreateDashboardInput
impl Send for CreateDashboardInput
impl Sync for CreateDashboardInput
impl Unpin for CreateDashboardInput
impl UnwindSafe for CreateDashboardInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more