Struct aws_sdk_quicksight::operation::describe_dashboard_definition::DescribeDashboardDefinitionOutput

#[non_exhaustive]
pub struct DescribeDashboardDefinitionOutput {
    pub dashboard_id: Option<String>,
    pub errors: Option<Vec<DashboardError>>,
    pub name: Option<String>,
    pub resource_status: Option<ResourceStatus>,
    pub theme_arn: Option<String>,
    pub definition: Option<DashboardVersionDefinition>,
    pub status: i32,
    pub request_id: Option<String>,
    pub dashboard_publish_options: Option<DashboardPublishOptions>,
    /* private fields */
}

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.

dashboard_id: Option<String>

The ID of the dashboard described.

errors: Option<Vec<DashboardError>>

Errors associated with this dashboard version.

name: Option<String>

The display name of the dashboard.

resource_status: Option<ResourceStatus>

Status associated with the dashboard version.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

theme_arn: Option<String>

The ARN of the theme of 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.

status: i32

The HTTP status of the request.

request_id: Option<String>

The Amazon Web Services request ID for this operation.

dashboard_publish_options: Option<DashboardPublishOptions>

Options for publishing the dashboard:

• 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.

Implementations

impl DescribeDashboardDefinitionOutput

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

The ID of the dashboard described.

pub fn errors(&self) -> &[DashboardError]

Errors associated with this dashboard version.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .errors.is_none().

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

The display name of the dashboard.

pub fn resource_status(&self) -> Option<&ResourceStatus>

Status associated with the dashboard version.

• CREATION_IN_PROGRESS

• CREATION_SUCCESSFUL

• CREATION_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_SUCCESSFUL

• UPDATE_FAILED

• DELETED

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

The ARN of the theme of the dashboard.

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.

pub fn status(&self) -> i32

The HTTP status of the request.

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

The Amazon Web Services request ID for this operation.

pub fn dashboard_publish_options(&self) -> Option<&DashboardPublishOptions>

Options for publishing the dashboard:

• 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.

impl DescribeDashboardDefinitionOutput

pub fn builder() -> DescribeDashboardDefinitionOutputBuilder

Creates a new builder-style object to manufacture DescribeDashboardDefinitionOutput.

Trait Implementations

impl Clone for DescribeDashboardDefinitionOutput

fn clone(&self) -> DescribeDashboardDefinitionOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDashboardDefinitionOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeDashboardDefinitionOutput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeDashboardDefinitionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeDashboardDefinitionOutput