#[non_exhaustive]pub struct CreateDashboardInput {Show 15 fields
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>,
pub definition: Option<DashboardVersionDefinition>,
pub validation_strategy: Option<ValidationStrategy>,
pub folder_arns: Option<Vec<String>>,
pub link_sharing_configuration: Option<LinkSharingConfiguration>,
pub link_entities: Option<Vec<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 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.
Either a SourceEntity or a Definition must be provided in order for the request to be valid.
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:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. 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 isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. This option isCOLLAPSEDby 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.
definition: Option<DashboardVersionDefinition>The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Either a SourceEntity or a Definition must be provided in order for the request to be valid.
validation_strategy: Option<ValidationStrategy>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
folder_arns: Option<Vec<String>>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
link_sharing_configuration: Option<LinkSharingConfiguration>A structure that contains the permissions of a shareable link to the dashboard.
link_entities: Option<Vec<String>>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
Implementations§
Source§impl CreateDashboardInput
impl CreateDashboardInput
Sourcepub fn aws_account_id(&self) -> Option<&str>
pub fn aws_account_id(&self) -> Option<&str>
The ID of the Amazon Web Services account where you want to create the dashboard.
Sourcepub fn dashboard_id(&self) -> Option<&str>
pub fn dashboard_id(&self) -> Option<&str>
The ID for the dashboard, also added to the IAM policy.
Sourcepub fn parameters(&self) -> Option<&Parameters>
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.
Sourcepub fn permissions(&self) -> &[ResourcePermission]
pub fn permissions(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .permissions.is_none().
Sourcepub fn source_entity(&self) -> Option<&DashboardSourceEntity>
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.
Either a SourceEntity or a Definition must be provided in order for the request to be valid.
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().
Sourcepub fn version_description(&self) -> Option<&str>
pub fn version_description(&self) -> Option<&str>
A description for the first version of the dashboard being created.
Sourcepub fn dashboard_publish_options(&self) -> Option<&DashboardPublishOptions>
pub fn dashboard_publish_options(&self) -> Option<&DashboardPublishOptions>
Options for publishing the dashboard when you create it:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. 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 isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. This option isCOLLAPSEDby default.
Sourcepub fn theme_arn(&self) -> Option<&str>
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.
Sourcepub fn definition(&self) -> Option<&DashboardVersionDefinition>
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.
Either a SourceEntity or a Definition must be provided in order for the request to be valid.
Sourcepub fn validation_strategy(&self) -> Option<&ValidationStrategy>
pub fn validation_strategy(&self) -> Option<&ValidationStrategy>
The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
Sourcepub fn folder_arns(&self) -> &[String]
pub fn folder_arns(&self) -> &[String]
When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .folder_arns.is_none().
Sourcepub fn link_sharing_configuration(&self) -> Option<&LinkSharingConfiguration>
pub fn link_sharing_configuration(&self) -> Option<&LinkSharingConfiguration>
A structure that contains the permissions of a shareable link to the dashboard.
Sourcepub fn link_entities(&self) -> &[String]
pub fn link_entities(&self) -> &[String]
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .link_entities.is_none().
Source§impl CreateDashboardInput
impl CreateDashboardInput
Sourcepub fn builder() -> CreateDashboardInputBuilder
pub fn builder() -> CreateDashboardInputBuilder
Creates a new builder-style object to manufacture CreateDashboardInput.
Trait Implementations§
Source§impl Clone for CreateDashboardInput
impl Clone for CreateDashboardInput
Source§fn clone(&self) -> CreateDashboardInput
fn clone(&self) -> CreateDashboardInput
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateDashboardInput
impl Debug for CreateDashboardInput
Source§impl PartialEq for CreateDashboardInput
impl PartialEq for CreateDashboardInput
impl StructuralPartialEq for CreateDashboardInput
Auto Trait Implementations§
impl Freeze for CreateDashboardInput
impl RefUnwindSafe for CreateDashboardInput
impl Send for CreateDashboardInput
impl Sync for CreateDashboardInput
impl Unpin for CreateDashboardInput
impl UnwindSafe for CreateDashboardInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);