SnapshotFile

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

Contents

Note

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

FormatType

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

Type: String

Valid Values: CSV | PDF | EXCEL

Required: Yes

SheetSelections

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

Type: Array of SnapshotFileSheetSelection objects

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

Required: Yes

See Also

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

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3