Struct aws_sdk_quicksight::types::SnapshotFileSheetSelection

#[non_exhaustive]
pub struct SnapshotFileSheetSelection {
    pub sheet_id: String,
    pub selection_scope: SnapshotFileSheetSelectionScope,
    pub visual_ids: Option<Vec<String>>,
}

A structure that contains information that identifies the snapshot that needs to be generated.

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.

sheet_id: String

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

selection_scope: SnapshotFileSheetSelectionScope

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

visual_ids: Option<Vec<String>>

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Implementations

impl SnapshotFileSheetSelection

pub fn sheet_id(&self) -> &str

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

pub fn selection_scope(&self) -> &SnapshotFileSheetSelectionScope

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

pub fn visual_ids(&self) -> &[String]

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

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

impl SnapshotFileSheetSelection

pub fn builder() -> SnapshotFileSheetSelectionBuilder

Creates a new builder-style object to manufacture SnapshotFileSheetSelection.

Trait Implementations

impl Clone for SnapshotFileSheetSelection

fn clone(&self) -> SnapshotFileSheetSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotFileSheetSelection

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

Formats the value using the given formatter.

impl PartialEq for SnapshotFileSheetSelection

fn eq(&self, other: &SnapshotFileSheetSelection) -> 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 StructuralPartialEq for SnapshotFileSheetSelection