Amazonka.QuickSight.UpdateDataSet

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

Creating a Request

data UpdateDataSet

See: newUpdateDataSet smart constructor.

Constructors

UpdateDataSet'

Fields

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

• dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration
• fieldFolders :: Maybe (HashMap Text FieldFolder)

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

• logicalTableMap :: Maybe (HashMap Text LogicalTable)

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

• rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet

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

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

• 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

ToJSON UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

toJSON :: UpdateDataSet -> Value

toEncoding :: UpdateDataSet -> Encoding

toJSONList :: [UpdateDataSet] -> Value

toEncodingList :: [UpdateDataSet] -> Encoding

ToHeaders UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

toHeaders :: UpdateDataSet -> [Header]

ToPath UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

toPath :: UpdateDataSet -> ByteString

ToQuery UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

toQuery :: UpdateDataSet -> QueryString

AWSRequest UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Associated Types

type AWSResponse UpdateDataSet

Methods

request :: (Service -> Service) -> UpdateDataSet -> Request UpdateDataSet

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDataSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDataSet)))

Generic UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Associated Types

type Rep UpdateDataSet :: Type -> Type

Methods

from :: UpdateDataSet -> Rep UpdateDataSet x

to :: Rep UpdateDataSet x -> UpdateDataSet

Show UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

showsPrec :: Int -> UpdateDataSet -> ShowS

show :: UpdateDataSet -> String

showList :: [UpdateDataSet] -> ShowS

NFData UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

rnf :: UpdateDataSet -> ()

Eq UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

(==) :: UpdateDataSet -> UpdateDataSet -> Bool

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

Hashable UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

hashWithSalt :: Int -> UpdateDataSet -> Int

hash :: UpdateDataSet -> Int

type AWSResponse UpdateDataSet

Defined in Amazonka.QuickSight.UpdateDataSet

type AWSResponse UpdateDataSet = UpdateDataSetResponse

type Rep UpdateDataSet

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

Arguments

:: Text

UpdateDataSet

-> Text

UpdateDataSet

-> Text

UpdateDataSet

-> DataSetImportMode

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:

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

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

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

A set of one or more definitions of a ColumnLevelPermissionRule .

updateDataSet_dataSetUsageConfiguration :: Lens' UpdateDataSet (Maybe DataSetUsageConfiguration)

Undocumented member.

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

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

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

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

updateDataSet_rowLevelPermissionDataSet :: Lens' UpdateDataSet (Maybe RowLevelPermissionDataSet)

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

updateDataSet_rowLevelPermissionTagConfiguration :: Lens' UpdateDataSet (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.

updateDataSet_awsAccountId :: Lens' UpdateDataSet Text

The Amazon Web Services account ID.

updateDataSet_dataSetId :: Lens' UpdateDataSet 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.

updateDataSet_name :: Lens' UpdateDataSet Text

The display name for the dataset.

updateDataSet_physicalTableMap :: Lens' UpdateDataSet (HashMap Text PhysicalTable)

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

updateDataSet_importMode :: Lens' UpdateDataSet DataSetImportMode

Indicates whether you want to import the data into SPICE.

Destructuring the Response

data UpdateDataSetResponse

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

Generic UpdateDataSetResponse

Defined in Amazonka.QuickSight.UpdateDataSet

Associated Types

type Rep UpdateDataSetResponse :: Type -> Type

Methods

from :: UpdateDataSetResponse -> Rep UpdateDataSetResponse x

to :: Rep UpdateDataSetResponse x -> UpdateDataSetResponse

Read UpdateDataSetResponse

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

readsPrec :: Int -> ReadS UpdateDataSetResponse

readList :: ReadS [UpdateDataSetResponse]

readPrec :: ReadPrec UpdateDataSetResponse

readListPrec :: ReadPrec [UpdateDataSetResponse]

Show UpdateDataSetResponse

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

showsPrec :: Int -> UpdateDataSetResponse -> ShowS

show :: UpdateDataSetResponse -> String

showList :: [UpdateDataSetResponse] -> ShowS

NFData UpdateDataSetResponse

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

rnf :: UpdateDataSetResponse -> ()

Eq UpdateDataSetResponse

Defined in Amazonka.QuickSight.UpdateDataSet

Methods

(==) :: UpdateDataSetResponse -> UpdateDataSetResponse -> Bool

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

type Rep UpdateDataSetResponse

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

Arguments

:: Int

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:

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)

The Amazon Resource Name (ARN) of the dataset.

updateDataSetResponse_dataSetId :: Lens' UpdateDataSetResponse (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.

updateDataSetResponse_ingestionArn :: Lens' UpdateDataSetResponse (Maybe Text)

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)

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)

The Amazon Web Services request ID for this operation.

updateDataSetResponse_status :: Lens' UpdateDataSetResponse Int

The HTTP status of the request.