Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QuickSight.Types.DataSet

Description

Synopsis

data DataSet = DataSet' {
- fieldFolders :: Maybe (HashMap Text FieldFolder)
- columnGroups :: Maybe (NonEmpty ColumnGroup)
- lastUpdatedTime :: Maybe POSIX
- arn :: Maybe Text
- createdTime :: Maybe POSIX
- consumedSpiceCapacityInBytes :: Maybe Integer
- importMode :: Maybe DataSetImportMode
- physicalTableMap :: Maybe (HashMap Text PhysicalTable)
- dataSetId :: Maybe Text
- name :: Maybe Text
- dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration
- outputColumns :: Maybe [OutputColumn]
- rowLevelPermissionTagConfiguration :: Maybe RowLevelPermissionTagConfiguration
- rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet
- columnLevelPermissionRules :: Maybe (NonEmpty ColumnLevelPermissionRule)
- logicalTableMap :: Maybe (HashMap Text LogicalTable)
}
newDataSet :: DataSet
dataSet_fieldFolders :: Lens' DataSet (Maybe (HashMap Text FieldFolder))
dataSet_columnGroups :: Lens' DataSet (Maybe (NonEmpty ColumnGroup))
dataSet_lastUpdatedTime :: Lens' DataSet (Maybe UTCTime)
dataSet_arn :: Lens' DataSet (Maybe Text)
dataSet_createdTime :: Lens' DataSet (Maybe UTCTime)
dataSet_consumedSpiceCapacityInBytes :: Lens' DataSet (Maybe Integer)
dataSet_importMode :: Lens' DataSet (Maybe DataSetImportMode)
dataSet_physicalTableMap :: Lens' DataSet (Maybe (HashMap Text PhysicalTable))
dataSet_dataSetId :: Lens' DataSet (Maybe Text)
dataSet_name :: Lens' DataSet (Maybe Text)
dataSet_dataSetUsageConfiguration :: Lens' DataSet (Maybe DataSetUsageConfiguration)
dataSet_outputColumns :: Lens' DataSet (Maybe [OutputColumn])
dataSet_rowLevelPermissionTagConfiguration :: Lens' DataSet (Maybe RowLevelPermissionTagConfiguration)
dataSet_rowLevelPermissionDataSet :: Lens' DataSet (Maybe RowLevelPermissionDataSet)
dataSet_columnLevelPermissionRules :: Lens' DataSet (Maybe (NonEmpty ColumnLevelPermissionRule))
dataSet_logicalTableMap :: Lens' DataSet (Maybe (HashMap Text LogicalTable))

Documentation

data DataSet Source #

Dataset.

See: newDataSet smart constructor.

Constructors

DataSet'

Fields

fieldFolders :: Maybe (HashMap Text FieldFolder)
The folder that contains fields and nested subfolders for your dataset.
columnGroups :: Maybe (NonEmpty ColumnGroup)
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
lastUpdatedTime :: Maybe POSIX
The last time that this dataset was updated.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the resource.
createdTime :: Maybe POSIX
The time that this dataset was created.
consumedSpiceCapacityInBytes :: Maybe Integer
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
importMode :: Maybe DataSetImportMode
A value that indicates whether you want to import the data into SPICE.
physicalTableMap :: Maybe (HashMap Text PhysicalTable)
Declares the physical tables that are available in the underlying data sources.
dataSetId :: Maybe Text
The ID of the dataset.
name :: Maybe Text
A display name for the dataset.
dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
outputColumns :: Maybe [OutputColumn]
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
rowLevelPermissionTagConfiguration :: Maybe RowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.
rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet
The row-level security configuration for the dataset.
columnLevelPermissionRules :: Maybe (NonEmpty ColumnLevelPermissionRule)
A set of one or more definitions of a ColumnLevelPermissionRule .
logicalTableMap :: Maybe (HashMap Text LogicalTable)
Configures the combination and transformation of the data from the physical tables.

Instances

Instances details

Eq DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet Methods (==) :: DataSet -> DataSet -> Bool # (/=) :: DataSet -> DataSet -> Bool #
Show DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet Methods showsPrec :: Int -> DataSet -> ShowS # show :: DataSet -> String # showList :: [DataSet] -> ShowS #
Generic DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet Associated Types type Rep DataSet :: Type -> Type # Methods from :: DataSet -> Rep DataSet x # to :: Rep DataSet x -> DataSet #
NFData DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet Methods rnf :: DataSet -> () #
Hashable DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet Methods hashWithSalt :: Int -> DataSet -> Int # hash :: DataSet -> Int #
FromJSON DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet Methods parseJSON :: Value -> Parser DataSet # parseJSONList :: Value -> Parser [DataSet] #
type Rep DataSet Source #
Instance details Defined in Amazonka.QuickSight.Types.DataSet type Rep DataSet = D1 ('MetaData "DataSet" "Amazonka.QuickSight.Types.DataSet" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "DataSet'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "fieldFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text FieldFolder))) :: S1 ('MetaSel ('Just "columnGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ColumnGroup)))) :: (S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "consumedSpiceCapacityInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "importMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSetImportMode)) :: S1 ('MetaSel ('Just "physicalTableMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text PhysicalTable)))))) :: (((S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dataSetUsageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSetUsageConfiguration)) :: S1 ('MetaSel ('Just "outputColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputColumn])))) :: ((S1 ('MetaSel ('Just "rowLevelPermissionTagConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionTagConfiguration)) :: S1 ('MetaSel ('Just "rowLevelPermissionDataSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionDataSet))) :: (S1 ('MetaSel ('Just "columnLevelPermissionRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ColumnLevelPermissionRule))) :*: S1 ('MetaSel ('Just "logicalTableMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text LogicalTable))))))))

newDataSet :: DataSet Source #

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:

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

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

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

$sel:arn:DataSet', dataSet_arn - The Amazon Resource Name (ARN) of the resource.

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

$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:importMode:DataSet', dataSet_importMode - A value that indicates whether you want to import the data into SPICE.

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

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

$sel:name:DataSet', dataSet_name - A display name for the dataset.

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

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

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

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

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

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

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

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

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

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

dataSet_lastUpdatedTime :: Lens' DataSet (Maybe UTCTime) Source #

The last time that this dataset was updated.

dataSet_arn :: Lens' DataSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dataSet_createdTime :: Lens' DataSet (Maybe UTCTime) Source #

The time that this dataset was created.

dataSet_consumedSpiceCapacityInBytes :: Lens' DataSet (Maybe Integer) Source #

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

dataSet_importMode :: Lens' DataSet (Maybe DataSetImportMode) Source #

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

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

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

dataSet_dataSetId :: Lens' DataSet (Maybe Text) Source #

The ID of the dataset.

dataSet_name :: Lens' DataSet (Maybe Text) Source #

A display name for the dataset.

dataSet_dataSetUsageConfiguration :: Lens' DataSet (Maybe DataSetUsageConfiguration) Source #

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

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

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

dataSet_rowLevelPermissionTagConfiguration :: Lens' DataSet (Maybe RowLevelPermissionTagConfiguration) Source #

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

dataSet_rowLevelPermissionDataSet :: Lens' DataSet (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the dataset.

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

A set of one or more definitions of a ColumnLevelPermissionRule .

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

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