quicksight/aws.sdk.kotlin.services.quicksight.model/SnapshotFileSheetSelection

SnapshotFileSheetSelection

class SnapshotFileSheetSelection

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

Types

Builder

class Builder

Companion

object Companion

Properties

selectionScope

val selectionScope: 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.

sheetId

val sheetId: String

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

visualIds

val visualIds: List<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.

Functions

copy

inline fun copy(block: SnapshotFileSheetSelection.Builder.() -> Unit = {}): SnapshotFileSheetSelection

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String