amazonka-quicksight-2.0: Amazon QuickSight SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.QuickSight.UpdateDataSet

Description

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

Synopsis

Creating a Request

data UpdateDataSet Source #

See: newUpdateDataSet smart constructor.

Constructors

UpdateDataSet' 

Fields

Instances

Instances details
ToJSON UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

ToHeaders UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

ToPath UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

ToQuery UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

AWSRequest UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Associated Types

type AWSResponse UpdateDataSet #

Generic UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Associated Types

type Rep UpdateDataSet :: Type -> Type #

Show UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

NFData UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

rnf :: UpdateDataSet -> () #

Eq UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Hashable UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

type AWSResponse UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

type Rep UpdateDataSet Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

type Rep UpdateDataSet = D1 ('MetaData "UpdateDataSet" "Amazonka.QuickSight.UpdateDataSet" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateDataSet'" 'PrefixI 'True) (((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 "dataSetUsageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSetUsageConfiguration)))) :*: (S1 ('MetaSel ('Just "fieldFolders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text FieldFolder))) :*: (S1 ('MetaSel ('Just "logicalTableMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text LogicalTable))) :*: S1 ('MetaSel ('Just "rowLevelPermissionDataSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionDataSet))))) :*: ((S1 ('MetaSel ('Just "rowLevelPermissionTagConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionTagConfiguration)) :*: (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))))))

newUpdateDataSet Source #

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:

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

UpdateDataSet, updateDataSet_columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

UpdateDataSet, updateDataSet_dataSetUsageConfiguration - Undocumented member.

UpdateDataSet, updateDataSet_fieldFolders - The folder that contains fields and nested subfolders for your dataset.

UpdateDataSet, updateDataSet_logicalTableMap - Configures the combination and transformation of the data from the physical tables.

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

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.

UpdateDataSet, updateDataSet_awsAccountId - The Amazon Web Services account ID.

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.

UpdateDataSet, updateDataSet_name - The display name for the dataset.

UpdateDataSet, updateDataSet_physicalTableMap - Declares the physical tables that are available in the underlying data sources.

UpdateDataSet, updateDataSet_importMode - Indicates whether you want to import the data into SPICE.

Request Lenses

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_fieldFolders :: Lens' UpdateDataSet (Maybe (HashMap Text FieldFolder)) Source #

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

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

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

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

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

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_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

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the dataset.

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

  • ingestionArn :: Maybe Text

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

  • ingestionId :: Maybe Text

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

  • requestId :: Maybe Text

    The Amazon Web Services request ID for this operation.

  • status :: Int

    The HTTP status of the request.

Instances

Instances details
Generic UpdateDataSetResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Associated Types

type Rep UpdateDataSetResponse :: Type -> Type #

Read UpdateDataSetResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Show UpdateDataSetResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

NFData UpdateDataSetResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

rnf :: UpdateDataSetResponse -> () #

Eq UpdateDataSetResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

type Rep UpdateDataSetResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateDataSet

type Rep UpdateDataSetResponse = D1 ('MetaData "UpdateDataSetResponse" "Amazonka.QuickSight.UpdateDataSet" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateDataSetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ingestionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "ingestionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateDataSetResponse Source #

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:

UpdateDataSetResponse, updateDataSetResponse_arn - The Amazon Resource Name (ARN) of the dataset.

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:ingestionArn:UpdateDataSetResponse', updateDataSetResponse_ingestionArn - The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

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

$sel:requestId:UpdateDataSetResponse', updateDataSetResponse_requestId - The Amazon Web Services request ID for this operation.

UpdateDataSetResponse, updateDataSetResponse_status - The HTTP status of the request.

Response Lenses

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

The Amazon Resource Name (ARN) of the dataset.

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_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_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_requestId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.