SnapshotFileSheetSelection - Amazon QuickSight
ContentsSee Also

SnapshotFileSheetSelection

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

Contents

Note

In the following list, the required parameters are described first.

SelectionScope

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.

Type: String

Valid Values: ALL_VISUALS | SELECTED_VISUALS

Required: Yes

SheetId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

VisualIds

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: