DataSet - Amazon QuickSight

DataSet

Dataset.

Contents

Note

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

Arn

The Amazon Resource Name (ARN) of the resource.

Type: String

Required: No

ColumnGroups

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Type: Array of ColumnGroup objects

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

Required: No

ColumnLevelPermissionRules

A set of one or more definitions of a ColumnLevelPermissionRule .

Type: Array of ColumnLevelPermissionRule objects

Array Members: Minimum number of 1 item.

Required: No

ConsumedSpiceCapacityInBytes

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

Type: Long

Required: No

CreatedTime

The time that this dataset was created.

Type: Timestamp

Required: No

DataSetId

The ID of the dataset.

Type: String

Required: No

DatasetParameters

The parameters that are declared in a dataset.

Type: Array of DatasetParameter objects

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

Required: No

DataSetUsageConfiguration

The usage configuration to apply to child datasets that reference this dataset as a source.

Type: DataSetUsageConfiguration object

Required: No

FieldFolders

The folder that contains fields and nested subfolders for your dataset.

Type: String to FieldFolder object map

Key Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

ImportMode

A value that indicates whether you want to import the data into SPICE.

Type: String

Valid Values: SPICE | DIRECT_QUERY

Required: No

LastUpdatedTime

The last time that this dataset was updated.

Type: Timestamp

Required: No

LogicalTableMap

Configures the combination and transformation of the data from the physical tables.

Type: String to LogicalTable object map

Map Entries: Maximum number of 64 items.

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [0-9a-zA-Z-]*

Required: No

Name

A display name for the dataset.

Type: String

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

Required: No

OutputColumns

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Type: Array of OutputColumn objects

Required: No

PhysicalTableMap

Declares the physical tables that are available in the underlying data sources.

Type: String to PhysicalTable object map

Map Entries: Minimum number of 0 items. Maximum number of 32 items.

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [0-9a-zA-Z-]*

Required: No

RowLevelPermissionDataSet

The row-level security configuration for the dataset.

Type: RowLevelPermissionDataSet object

Required: No

RowLevelPermissionTagConfiguration

The element you can use to define tags for row-level security.

Type: RowLevelPermissionTagConfiguration object

Required: No

See Also

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