Amazonka.QuickSight.Types.DataSet

Documentation

data DataSet

Dataset.

See: newDataSet smart constructor.

Constructors

DataSet'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the resource.

• columnGroups :: Maybe (NonEmpty ColumnGroup)

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

• columnLevelPermissionRules :: Maybe (NonEmpty ColumnLevelPermissionRule)

  A set of one or more definitions of a ColumnLevelPermissionRule .

• consumedSpiceCapacityInBytes :: Maybe Integer

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

• createdTime :: Maybe POSIX

  The time that this dataset was created.

• dataSetId :: Maybe Text

  The ID of the dataset.

• dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration

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

• fieldFolders :: Maybe (HashMap Text FieldFolder)

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

• importMode :: Maybe DataSetImportMode

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

• lastUpdatedTime :: Maybe POSIX

  The last time that this dataset was updated.

• logicalTableMap :: Maybe (HashMap Text LogicalTable)

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

• name :: Maybe Text

  A display name for the dataset.

• outputColumns :: Maybe [OutputColumn]

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

• physicalTableMap :: Maybe (HashMap Text PhysicalTable)

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

• rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet

  The row-level security configuration for the dataset.

• rowLevelPermissionTagConfiguration :: Maybe RowLevelPermissionTagConfiguration

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

Instances

FromJSON DataSet

Defined in Amazonka.QuickSight.Types.DataSet

Methods

parseJSON :: Value -> Parser DataSet

parseJSONList :: Value -> Parser [DataSet]

Generic DataSet

Defined in Amazonka.QuickSight.Types.DataSet

Associated Types

type Rep DataSet :: Type -> Type

Methods

from :: DataSet -> Rep DataSet x

to :: Rep DataSet x -> DataSet

Show DataSet

Defined in Amazonka.QuickSight.Types.DataSet

Methods

showsPrec :: Int -> DataSet -> ShowS

show :: DataSet -> String

showList :: [DataSet] -> ShowS

NFData DataSet

Defined in Amazonka.QuickSight.Types.DataSet

Methods

rnf :: DataSet -> ()

Eq DataSet

Defined in Amazonka.QuickSight.Types.DataSet

Methods

(==) :: DataSet -> DataSet -> Bool

(/=) :: DataSet -> DataSet -> Bool

Hashable DataSet

Defined in Amazonka.QuickSight.Types.DataSet

Methods

hashWithSalt :: Int -> DataSet -> Int

hash :: DataSet -> Int

type Rep DataSet

Defined in Amazonka.QuickSight.Types.DataSet

type Rep DataSet = D1 ('MetaData "DataSet" "Amazonka.QuickSight.Types.DataSet" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DataSet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "columnGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ColumnGroup)))) :*: (S1 ('MetaSel ('Just "columnLevelPermissionRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ColumnLevelPermissionRule))) :*: S1 ('MetaSel ('Just "consumedSpiceCapacityInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: ((S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dataSetUsageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSetUsageConfiguration)) :*: S1 ('MetaSel ('Just "fieldFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text FieldFolder)))))) :*: (((S1 ('MetaSel ('Just "importMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSetImportMode)) :*: S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "logicalTableMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text LogicalTable))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "outputColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputColumn])) :*: S1 ('MetaSel ('Just "physicalTableMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text PhysicalTable)))) :*: (S1 ('MetaSel ('Just "rowLevelPermissionDataSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionDataSet)) :*: S1 ('MetaSel ('Just "rowLevelPermissionTagConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionTagConfiguration)))))))

newDataSet :: DataSet

Create a value of DataSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DataSet, dataSet_arn - The Amazon Resource Name (ARN) of the resource.

$sel:columnGroups:DataSet', dataSet_columnGroups - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

$sel:columnLevelPermissionRules:DataSet', dataSet_columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

$sel:consumedSpiceCapacityInBytes:DataSet', dataSet_consumedSpiceCapacityInBytes - The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

$sel:createdTime:DataSet', dataSet_createdTime - The time that this dataset was created.

$sel:dataSetId:DataSet', dataSet_dataSetId - The ID of the dataset.

$sel:dataSetUsageConfiguration:DataSet', dataSet_dataSetUsageConfiguration - The usage configuration to apply to child datasets that reference this dataset as a source.

$sel:fieldFolders:DataSet', dataSet_fieldFolders - The folder that contains fields and nested subfolders for your dataset.

$sel:importMode:DataSet', dataSet_importMode - A value that indicates whether you want to import the data into SPICE.

$sel:lastUpdatedTime:DataSet', dataSet_lastUpdatedTime - The last time that this dataset was updated.

$sel:logicalTableMap:DataSet', dataSet_logicalTableMap - Configures the combination and transformation of the data from the physical tables.

DataSet, dataSet_name - A display name for the dataset.

$sel:outputColumns:DataSet', dataSet_outputColumns - The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

$sel:physicalTableMap:DataSet', dataSet_physicalTableMap - Declares the physical tables that are available in the underlying data sources.

$sel:rowLevelPermissionDataSet:DataSet', dataSet_rowLevelPermissionDataSet - The row-level security configuration for the dataset.

$sel:rowLevelPermissionTagConfiguration:DataSet', dataSet_rowLevelPermissionTagConfiguration - The element you can use to define tags for row-level security.

dataSet_arn :: Lens' DataSet (Maybe Text)

The Amazon Resource Name (ARN) of the resource.

dataSet_columnGroups :: Lens' DataSet (Maybe (NonEmpty ColumnGroup))

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

dataSet_columnLevelPermissionRules :: Lens' DataSet (Maybe (NonEmpty ColumnLevelPermissionRule))

A set of one or more definitions of a ColumnLevelPermissionRule .

dataSet_consumedSpiceCapacityInBytes :: Lens' DataSet (Maybe Integer)

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

dataSet_createdTime :: Lens' DataSet (Maybe UTCTime)

The time that this dataset was created.

dataSet_dataSetId :: Lens' DataSet (Maybe Text)

The ID of the dataset.

dataSet_dataSetUsageConfiguration :: Lens' DataSet (Maybe DataSetUsageConfiguration)

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

dataSet_fieldFolders :: Lens' DataSet (Maybe (HashMap Text FieldFolder))

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

dataSet_importMode :: Lens' DataSet (Maybe DataSetImportMode)

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

dataSet_lastUpdatedTime :: Lens' DataSet (Maybe UTCTime)

The last time that this dataset was updated.

dataSet_logicalTableMap :: Lens' DataSet (Maybe (HashMap Text LogicalTable))

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

dataSet_name :: Lens' DataSet (Maybe Text)

A display name for the dataset.

dataSet_outputColumns :: Lens' DataSet (Maybe [OutputColumn])

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

dataSet_physicalTableMap :: Lens' DataSet (Maybe (HashMap Text PhysicalTable))

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

dataSet_rowLevelPermissionDataSet :: Lens' DataSet (Maybe RowLevelPermissionDataSet)

The row-level security configuration for the dataset.

dataSet_rowLevelPermissionTagConfiguration :: Lens' DataSet (Maybe RowLevelPermissionTagConfiguration)

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