Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.CreateDataSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Synopsis

data CreateDataSet = CreateDataSet' {
- columnGroups :: Maybe (NonEmpty ColumnGroup)
- columnLevelPermissionRules :: Maybe (NonEmpty ColumnLevelPermissionRule)
- dataSetUsageConfiguration :: Maybe DataSetUsageConfiguration
- fieldFolders :: Maybe (HashMap Text FieldFolder)
- logicalTableMap :: Maybe (HashMap Text LogicalTable)
- permissions :: Maybe (NonEmpty ResourcePermission)
- rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet
- rowLevelPermissionTagConfiguration :: Maybe RowLevelPermissionTagConfiguration
- tags :: Maybe (NonEmpty Tag)
- awsAccountId :: Text
- dataSetId :: Text
- name :: Text
- physicalTableMap :: HashMap Text PhysicalTable
- importMode :: DataSetImportMode
}
newCreateDataSet :: Text -> Text -> Text -> DataSetImportMode -> CreateDataSet
createDataSet_columnGroups :: Lens' CreateDataSet (Maybe (NonEmpty ColumnGroup))
createDataSet_columnLevelPermissionRules :: Lens' CreateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule))
createDataSet_dataSetUsageConfiguration :: Lens' CreateDataSet (Maybe DataSetUsageConfiguration)
createDataSet_fieldFolders :: Lens' CreateDataSet (Maybe (HashMap Text FieldFolder))
createDataSet_logicalTableMap :: Lens' CreateDataSet (Maybe (HashMap Text LogicalTable))
createDataSet_permissions :: Lens' CreateDataSet (Maybe (NonEmpty ResourcePermission))
createDataSet_rowLevelPermissionDataSet :: Lens' CreateDataSet (Maybe RowLevelPermissionDataSet)
createDataSet_rowLevelPermissionTagConfiguration :: Lens' CreateDataSet (Maybe RowLevelPermissionTagConfiguration)
createDataSet_tags :: Lens' CreateDataSet (Maybe (NonEmpty Tag))
createDataSet_awsAccountId :: Lens' CreateDataSet Text
createDataSet_dataSetId :: Lens' CreateDataSet Text
createDataSet_name :: Lens' CreateDataSet Text
createDataSet_physicalTableMap :: Lens' CreateDataSet (HashMap Text PhysicalTable)
createDataSet_importMode :: Lens' CreateDataSet DataSetImportMode
data CreateDataSetResponse = CreateDataSetResponse' {
- arn :: Maybe Text
- dataSetId :: Maybe Text
- ingestionArn :: Maybe Text
- ingestionId :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newCreateDataSetResponse :: Int -> CreateDataSetResponse
createDataSetResponse_arn :: Lens' CreateDataSetResponse (Maybe Text)
createDataSetResponse_dataSetId :: Lens' CreateDataSetResponse (Maybe Text)
createDataSetResponse_ingestionArn :: Lens' CreateDataSetResponse (Maybe Text)
createDataSetResponse_ingestionId :: Lens' CreateDataSetResponse (Maybe Text)
createDataSetResponse_requestId :: Lens' CreateDataSetResponse (Maybe Text)
createDataSetResponse_status :: Lens' CreateDataSetResponse Int

Creating a Request

data CreateDataSet Source #

See: newCreateDataSet smart constructor.

Constructors

CreateDataSet'

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.
permissions :: Maybe (NonEmpty ResourcePermission)
A list of resource permissions on the dataset.
rowLevelPermissionDataSet :: Maybe RowLevelPermissionDataSet
The row-level security configuration for the data that 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.
tags :: Maybe (NonEmpty Tag)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
awsAccountId :: Text
The Amazon Web Services account ID.
dataSetId :: Text
An ID for the dataset that you want to create. 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

ToJSON CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods toJSON :: CreateDataSet -> Value # toEncoding :: CreateDataSet -> Encoding # toJSONList :: [CreateDataSet] -> Value # toEncodingList :: [CreateDataSet] -> Encoding #
ToHeaders CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods toHeaders :: CreateDataSet -> [Header] #
ToPath CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods toPath :: CreateDataSet -> ByteString #
ToQuery CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods toQuery :: CreateDataSet -> QueryString #
AWSRequest CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Associated Types type AWSResponse CreateDataSet # Methods request :: (Service -> Service) -> CreateDataSet -> Request CreateDataSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataSet))) #
Generic CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Associated Types type Rep CreateDataSet :: Type -> Type # Methods from :: CreateDataSet -> Rep CreateDataSet x # to :: Rep CreateDataSet x -> CreateDataSet #
Show CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods showsPrec :: Int -> CreateDataSet -> ShowS # show :: CreateDataSet -> String # showList :: [CreateDataSet] -> ShowS #
NFData CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods rnf :: CreateDataSet -> () #
Eq CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods (==) :: CreateDataSet -> CreateDataSet -> Bool # (/=) :: CreateDataSet -> CreateDataSet -> Bool #
Hashable CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods hashWithSalt :: Int -> CreateDataSet -> Int # hash :: CreateDataSet -> Int #
type AWSResponse CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet type AWSResponse CreateDataSet = CreateDataSetResponse
type Rep CreateDataSet Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet type Rep CreateDataSet = D1 ('MetaData "CreateDataSet" "Amazonka.QuickSight.CreateDataSet" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateDataSet'" '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 "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourcePermission))) :: S1 ('MetaSel ('Just "rowLevelPermissionDataSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionDataSet))))) :: ((S1 ('MetaSel ('Just "rowLevelPermissionTagConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RowLevelPermissionTagConfiguration)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: 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))))))

newCreateDataSet Source #

Arguments

:: Text	`CreateDataSet`
-> Text	`CreateDataSet`
-> Text	`CreateDataSet`
-> DataSetImportMode	`CreateDataSet`
-> CreateDataSet

Create a value of CreateDataSet 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:

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

CreateDataSet, createDataSet_columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

CreateDataSet, createDataSet_dataSetUsageConfiguration - Undocumented member.

CreateDataSet, createDataSet_fieldFolders - The folder that contains fields and nested subfolders for your dataset.

CreateDataSet, createDataSet_logicalTableMap - Configures the combination and transformation of the data from the physical tables.

CreateDataSet, createDataSet_permissions - A list of resource permissions on the dataset.

CreateDataSet, createDataSet_rowLevelPermissionDataSet - The row-level security configuration for the data that you want to create.

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

CreateDataSet, createDataSet_tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

CreateDataSet, createDataSet_awsAccountId - The Amazon Web Services account ID.

CreateDataSet, createDataSet_dataSetId - An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

CreateDataSet, createDataSet_name - The display name for the dataset.

CreateDataSet, createDataSet_physicalTableMap - Declares the physical tables that are available in the underlying data sources.

CreateDataSet, createDataSet_importMode - Indicates whether you want to import the data into SPICE.

Request Lenses

createDataSet_columnGroups :: Lens' CreateDataSet (Maybe (NonEmpty ColumnGroup)) Source #

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

createDataSet_columnLevelPermissionRules :: Lens' CreateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

createDataSet_dataSetUsageConfiguration :: Lens' CreateDataSet (Maybe DataSetUsageConfiguration) Source #

Undocumented member.

createDataSet_fieldFolders :: Lens' CreateDataSet (Maybe (HashMap Text FieldFolder)) Source #

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

createDataSet_logicalTableMap :: Lens' CreateDataSet (Maybe (HashMap Text LogicalTable)) Source #

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

createDataSet_permissions :: Lens' CreateDataSet (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the dataset.

createDataSet_rowLevelPermissionDataSet :: Lens' CreateDataSet (Maybe RowLevelPermissionDataSet) Source #

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

createDataSet_rowLevelPermissionTagConfiguration :: Lens' CreateDataSet (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.

createDataSet_tags :: Lens' CreateDataSet (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

createDataSet_awsAccountId :: Lens' CreateDataSet Text Source #

The Amazon Web Services account ID.

createDataSet_dataSetId :: Lens' CreateDataSet Text Source #

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

createDataSet_name :: Lens' CreateDataSet Text Source #

The display name for the dataset.

createDataSet_physicalTableMap :: Lens' CreateDataSet (HashMap Text PhysicalTable) Source #

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

createDataSet_importMode :: Lens' CreateDataSet DataSetImportMode Source #

Indicates whether you want to import the data into SPICE.

Destructuring the Response

data CreateDataSetResponse Source #

See: newCreateDataSetResponse smart constructor.

Constructors

CreateDataSetResponse'

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 CreateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Associated Types type Rep CreateDataSetResponse :: Type -> Type # Methods from :: CreateDataSetResponse -> Rep CreateDataSetResponse x # to :: Rep CreateDataSetResponse x -> CreateDataSetResponse #
Read CreateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods readsPrec :: Int -> ReadS CreateDataSetResponse # readList :: ReadS [CreateDataSetResponse] # readPrec :: ReadPrec CreateDataSetResponse # readListPrec :: ReadPrec [CreateDataSetResponse] #
Show CreateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods showsPrec :: Int -> CreateDataSetResponse -> ShowS # show :: CreateDataSetResponse -> String # showList :: [CreateDataSetResponse] -> ShowS #
NFData CreateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods rnf :: CreateDataSetResponse -> () #
Eq CreateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet Methods (==) :: CreateDataSetResponse -> CreateDataSetResponse -> Bool # (/=) :: CreateDataSetResponse -> CreateDataSetResponse -> Bool #
type Rep CreateDataSetResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSet type Rep CreateDataSetResponse = D1 ('MetaData "CreateDataSetResponse" "Amazonka.QuickSight.CreateDataSet" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateDataSetResponse'" '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)))))

newCreateDataSetResponse Source #

Arguments

:: Int	`CreateDataSetResponse`
-> CreateDataSetResponse

Create a value of CreateDataSetResponse 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:

CreateDataSetResponse, createDataSetResponse_arn - The Amazon Resource Name (ARN) of the dataset.

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

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

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

CreateDataSetResponse, createDataSetResponse_status - The HTTP status of the request.

Response Lenses

createDataSetResponse_arn :: Lens' CreateDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

createDataSetResponse_dataSetId :: Lens' CreateDataSetResponse (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.

createDataSetResponse_ingestionArn :: Lens' CreateDataSetResponse (Maybe Text) Source #

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

createDataSetResponse_ingestionId :: Lens' CreateDataSetResponse (Maybe Text) Source #

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

createDataSetResponse_requestId :: Lens' CreateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createDataSetResponse_status :: Lens' CreateDataSetResponse Int Source #

The HTTP status of the request.