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.UpdateDataSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a dataset.

Synopsis

data UpdateDataSet = UpdateDataSet' {
- fieldFolders :: Maybe (HashMap Text FieldFolder)
- columnGroups :: Maybe (NonEmpty ColumnGroup)
- dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration
- rowLevelPermissionTagConfiguration :: Maybe RowLevelPermissionTagConfiguration
- rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet
- columnLevelPermissionRules :: Maybe (NonEmpty ColumnLevelPermissionRule)
- logicalTableMap :: Maybe (HashMap Text LogicalTable)
- awsAccountId :: Text
- dataSetId :: Text
- name :: Text
- physicalTableMap :: HashMap Text PhysicalTable
- importMode :: DataSetImportMode
}
newUpdateDataSet :: Text -> Text -> Text -> DataSetImportMode -> UpdateDataSet
updateDataSet_fieldFolders :: Lens' UpdateDataSet (Maybe (HashMap Text FieldFolder))
updateDataSet_columnGroups :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnGroup))
updateDataSet_dataSetUsageConfiguration :: Lens' UpdateDataSet (Maybe DataSetUsageConfiguration)
updateDataSet_rowLevelPermissionTagConfiguration :: Lens' UpdateDataSet (Maybe RowLevelPermissionTagConfiguration)
updateDataSet_rowLevelPermissionDataSet :: Lens' UpdateDataSet (Maybe RowLevelPermissionDataSet)
updateDataSet_columnLevelPermissionRules :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule))
updateDataSet_logicalTableMap :: Lens' UpdateDataSet (Maybe (HashMap Text LogicalTable))
updateDataSet_awsAccountId :: Lens' UpdateDataSet Text
updateDataSet_dataSetId :: Lens' UpdateDataSet Text
updateDataSet_name :: Lens' UpdateDataSet Text
updateDataSet_physicalTableMap :: Lens' UpdateDataSet (HashMap Text PhysicalTable)
updateDataSet_importMode :: Lens' UpdateDataSet DataSetImportMode
data UpdateDataSetResponse = UpdateDataSetResponse' {
- requestId :: Maybe Text
- ingestionArn :: Maybe Text
- arn :: Maybe Text
- ingestionId :: Maybe Text
- dataSetId :: Maybe Text
- status :: Int
}
newUpdateDataSetResponse :: Int -> UpdateDataSetResponse
updateDataSetResponse_requestId :: Lens' UpdateDataSetResponse (Maybe Text)
updateDataSetResponse_ingestionArn :: Lens' UpdateDataSetResponse (Maybe Text)
updateDataSetResponse_arn :: Lens' UpdateDataSetResponse (Maybe Text)
updateDataSetResponse_ingestionId :: Lens' UpdateDataSetResponse (Maybe Text)
updateDataSetResponse_dataSetId :: Lens' UpdateDataSetResponse (Maybe Text)
updateDataSetResponse_status :: Lens' UpdateDataSetResponse Int

Creating a Request

data UpdateDataSet Source #

See: newUpdateDataSet smart constructor.

Constructors

UpdateDataSet'

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.
dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration
rowLevelPermissionTagConfiguration :: Maybe RowLevelPermissionTagConfiguration
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet
The row-level security configuration for the data you want to create.
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.
awsAccountId :: Text
The Amazon Web Services account ID.
dataSetId :: Text
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
name :: Text
The display name for the dataset.
physicalTableMap :: HashMap Text PhysicalTable
Declares the physical tables that are available in the underlying data sources.
importMode :: DataSetImportMode
Indicates whether you want to import the data into SPICE.

Instances

Instances details

Eq UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods (==) :: UpdateDataSet -> UpdateDataSet -> Bool # (/=) :: UpdateDataSet -> UpdateDataSet -> Bool #
Show UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods showsPrec :: Int -> UpdateDataSet -> ShowS # show :: UpdateDataSet -> String # showList :: [UpdateDataSet] -> ShowS #
Generic UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Associated Types type Rep UpdateDataSet :: Type -> Type # Methods from :: UpdateDataSet -> Rep UpdateDataSet x # to :: Rep UpdateDataSet x -> UpdateDataSet #
NFData UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods rnf :: UpdateDataSet -> () #
Hashable UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods hashWithSalt :: Int -> UpdateDataSet -> Int # hash :: UpdateDataSet -> Int #
ToJSON UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods toJSON :: UpdateDataSet -> Value # toEncoding :: UpdateDataSet -> Encoding # toJSONList :: [UpdateDataSet] -> Value # toEncodingList :: [UpdateDataSet] -> Encoding #
AWSRequest UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Associated Types type AWSResponse UpdateDataSet # Methods request :: UpdateDataSet -> Request UpdateDataSet # response :: MonadResource m => Logger -> Service -> Proxy UpdateDataSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDataSet))) #
ToHeaders UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods toHeaders :: UpdateDataSet -> [Header] #
ToPath UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods toPath :: UpdateDataSet -> ByteString #
ToQuery UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods toQuery :: UpdateDataSet -> QueryString #
type Rep UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet type Rep UpdateDataSet = D1 ('MetaData "UpdateDataSet" "Amazonka.QuickSight.UpdateDataSet" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "UpdateDataSet'" '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 "dataSetUsageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSetUsageConfiguration)))) :: (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))) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "physicalTableMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text PhysicalTable)) :*: S1 ('MetaSel ('Just "importMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataSetImportMode))))))
type AWSResponse UpdateDataSet Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet type AWSResponse UpdateDataSet = UpdateDataSetResponse

newUpdateDataSet Source #

Arguments

:: Text	`$sel:awsAccountId:UpdateDataSet'`
-> Text	`$sel:dataSetId:UpdateDataSet'`
-> Text	`$sel:name:UpdateDataSet'`
-> DataSetImportMode	`$sel:importMode:UpdateDataSet'`
-> UpdateDataSet

Create a value of UpdateDataSet 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:UpdateDataSet', updateDataSet_fieldFolders - The folder that contains fields and nested subfolders for your dataset.

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

$sel:dataSetUsageConfiguration:UpdateDataSet', updateDataSet_dataSetUsageConfiguration - Undocumented member.

$sel:rowLevelPermissionTagConfiguration:UpdateDataSet', updateDataSet_rowLevelPermissionTagConfiguration - The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

$sel:rowLevelPermissionDataSet:UpdateDataSet', updateDataSet_rowLevelPermissionDataSet - The row-level security configuration for the data you want to create.

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

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

$sel:awsAccountId:UpdateDataSet', updateDataSet_awsAccountId - The Amazon Web Services account ID.

$sel:dataSetId:UpdateDataSet', updateDataSet_dataSetId - The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

$sel:name:UpdateDataSet', updateDataSet_name - The display name for the dataset.

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

$sel:importMode:UpdateDataSet', updateDataSet_importMode - Indicates whether you want to import the data into SPICE.

Request Lenses

updateDataSet_fieldFolders :: Lens' UpdateDataSet (Maybe (HashMap Text FieldFolder)) Source #

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

updateDataSet_columnGroups :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnGroup)) Source #

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

updateDataSet_dataSetUsageConfiguration :: Lens' UpdateDataSet (Maybe DataSetUsageConfiguration) Source #

Undocumented member.

updateDataSet_rowLevelPermissionTagConfiguration :: Lens' UpdateDataSet (Maybe RowLevelPermissionTagConfiguration) Source #

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

updateDataSet_rowLevelPermissionDataSet :: Lens' UpdateDataSet (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the data you want to create.

updateDataSet_columnLevelPermissionRules :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

updateDataSet_logicalTableMap :: Lens' UpdateDataSet (Maybe (HashMap Text LogicalTable)) Source #

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

updateDataSet_awsAccountId :: Lens' UpdateDataSet Text Source #

The Amazon Web Services account ID.

updateDataSet_dataSetId :: Lens' UpdateDataSet Text Source #

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSet_name :: Lens' UpdateDataSet Text Source #

The display name for the dataset.

updateDataSet_physicalTableMap :: Lens' UpdateDataSet (HashMap Text PhysicalTable) Source #

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

updateDataSet_importMode :: Lens' UpdateDataSet DataSetImportMode Source #

Indicates whether you want to import the data into SPICE.

Destructuring the Response

data UpdateDataSetResponse Source #

See: newUpdateDataSetResponse smart constructor.

Constructors

UpdateDataSetResponse'

Fields

requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
ingestionArn :: Maybe Text
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the dataset.
ingestionId :: Maybe Text
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
dataSetId :: Maybe Text
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
status :: Int
The HTTP status of the request.

Instances

Instances details

Eq UpdateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods (==) :: UpdateDataSetResponse -> UpdateDataSetResponse -> Bool # (/=) :: UpdateDataSetResponse -> UpdateDataSetResponse -> Bool #
Read UpdateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods readsPrec :: Int -> ReadS UpdateDataSetResponse # readList :: ReadS [UpdateDataSetResponse] # readPrec :: ReadPrec UpdateDataSetResponse # readListPrec :: ReadPrec [UpdateDataSetResponse] #
Show UpdateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods showsPrec :: Int -> UpdateDataSetResponse -> ShowS # show :: UpdateDataSetResponse -> String # showList :: [UpdateDataSetResponse] -> ShowS #
Generic UpdateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Associated Types type Rep UpdateDataSetResponse :: Type -> Type # Methods from :: UpdateDataSetResponse -> Rep UpdateDataSetResponse x # to :: Rep UpdateDataSetResponse x -> UpdateDataSetResponse #
NFData UpdateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet Methods rnf :: UpdateDataSetResponse -> () #
type Rep UpdateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.UpdateDataSet type Rep UpdateDataSetResponse = D1 ('MetaData "UpdateDataSetResponse" "Amazonka.QuickSight.UpdateDataSet" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "UpdateDataSetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ingestionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "ingestionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateDataSetResponse Source #

Arguments

:: Int	`$sel:status:UpdateDataSetResponse'`
-> UpdateDataSetResponse

Create a value of UpdateDataSetResponse 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:requestId:UpdateDataSetResponse', updateDataSetResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:ingestionArn:UpdateDataSetResponse', updateDataSetResponse_ingestionArn - The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

$sel:arn:UpdateDataSetResponse', updateDataSetResponse_arn - The Amazon Resource Name (ARN) of the dataset.

$sel:ingestionId:UpdateDataSetResponse', updateDataSetResponse_ingestionId - The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

$sel:dataSetId:UpdateDataSet', updateDataSetResponse_dataSetId - The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

$sel:status:UpdateDataSetResponse', updateDataSetResponse_status - The HTTP status of the request.

Response Lenses

updateDataSetResponse_requestId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDataSetResponse_ingestionArn :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

updateDataSetResponse_arn :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

updateDataSetResponse_ingestionId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

updateDataSetResponse_dataSetId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSetResponse_status :: Lens' UpdateDataSetResponse Int Source #

The HTTP status of the request.