data_sets

Creates, updates, deletes or gets a data_set resource or lists data_sets in a region

Overview

Name	data_sets
Type	Resource
Description	Definition of the AWS::QuickSight::DataSet Resource Type.
Id	aws.quicksight.data_sets

Fields

Name	Datatype	Description
physical_table_map	object
created_time	string	The time that this dataset was created.
field_folders	object
last_updated_time	string	The last time that this dataset was updated.
data_set_id	string
folder_arns	array	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
consumed_spice_capacity_in_bytes	number	The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
performance_configuration	object
row_level_permission_data_set	object	Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
data_set_refresh_properties	object	The refresh properties of a dataset.
row_level_permission_tag_configuration	object	The configuration of tags on a dataset to set row-level security.
ingestion_wait_policy	object	Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.
column_level_permission_rules	array	A set of one or more definitions of a ColumnLevelPermissionRule .
name	string	The display name for the dataset.
column_groups	array	Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
import_mode	string
dataset_parameters	array	The parameter declarations of the dataset.
logical_table_map	object
aws_account_id	string
data_set_usage_configuration	object	The usage configuration to apply to child datasets that reference this dataset as a source.
permissions	array	A list of resource permissions on the dataset.
output_columns	array	The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
arn	string	The Amazon Resource Name (ARN) of the resource.
tags	array	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
region	string	AWS region.

For more information, see AWS::QuickSight::DataSet.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all data_sets in a region.

SELECT
region,
physical_table_map,
created_time,
field_folders,
last_updated_time,
data_set_id,
folder_arns,
consumed_spice_capacity_in_bytes,
performance_configuration,
row_level_permission_data_set,
data_set_refresh_properties,
row_level_permission_tag_configuration,
ingestion_wait_policy,
column_level_permission_rules,
name,
column_groups,
import_mode,
dataset_parameters,
logical_table_map,
aws_account_id,
data_set_usage_configuration,
permissions,
output_columns,
arn,
tags
FROM aws.quicksight.data_sets
WHERE region = 'us-east-1';

Gets all properties from an individual data_set.

SELECT
region,
physical_table_map,
created_time,
field_folders,
last_updated_time,
data_set_id,
folder_arns,
consumed_spice_capacity_in_bytes,
performance_configuration,
row_level_permission_data_set,
data_set_refresh_properties,
row_level_permission_tag_configuration,
ingestion_wait_policy,
column_level_permission_rules,
name,
column_groups,
import_mode,
dataset_parameters,
logical_table_map,
aws_account_id,
data_set_usage_configuration,
permissions,
output_columns,
arn,
tags
FROM aws.quicksight.data_sets
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<DataSetId>';

INSERT example

Use the following StackQL query and manifest file to create a new data_set resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.quicksight.data_sets (
 PhysicalTableMap,
 FieldFolders,
 DataSetId,
 FolderArns,
 PerformanceConfiguration,
 RowLevelPermissionDataSet,
 DataSetRefreshProperties,
 RowLevelPermissionTagConfiguration,
 IngestionWaitPolicy,
 ColumnLevelPermissionRules,
 Name,
 ColumnGroups,
 ImportMode,
 DatasetParameters,
 LogicalTableMap,
 AwsAccountId,
 DataSetUsageConfiguration,
 Permissions,
 Tags,
 region
)
SELECT 
'{{ PhysicalTableMap }}',
 '{{ FieldFolders }}',
 '{{ DataSetId }}',
 '{{ FolderArns }}',
 '{{ PerformanceConfiguration }}',
 '{{ RowLevelPermissionDataSet }}',
 '{{ DataSetRefreshProperties }}',
 '{{ RowLevelPermissionTagConfiguration }}',
 '{{ IngestionWaitPolicy }}',
 '{{ ColumnLevelPermissionRules }}',
 '{{ Name }}',
 '{{ ColumnGroups }}',
 '{{ ImportMode }}',
 '{{ DatasetParameters }}',
 '{{ LogicalTableMap }}',
 '{{ AwsAccountId }}',
 '{{ DataSetUsageConfiguration }}',
 '{{ Permissions }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.data_sets (
 PhysicalTableMap,
 FieldFolders,
 DataSetId,
 FolderArns,
 PerformanceConfiguration,
 RowLevelPermissionDataSet,
 DataSetRefreshProperties,
 RowLevelPermissionTagConfiguration,
 IngestionWaitPolicy,
 ColumnLevelPermissionRules,
 Name,
 ColumnGroups,
 ImportMode,
 DatasetParameters,
 LogicalTableMap,
 AwsAccountId,
 DataSetUsageConfiguration,
 Permissions,
 Tags,
 region
)
SELECT 
 '{{ PhysicalTableMap }}',
 '{{ FieldFolders }}',
 '{{ DataSetId }}',
 '{{ FolderArns }}',
 '{{ PerformanceConfiguration }}',
 '{{ RowLevelPermissionDataSet }}',
 '{{ DataSetRefreshProperties }}',
 '{{ RowLevelPermissionTagConfiguration }}',
 '{{ IngestionWaitPolicy }}',
 '{{ ColumnLevelPermissionRules }}',
 '{{ Name }}',
 '{{ ColumnGroups }}',
 '{{ ImportMode }}',
 '{{ DatasetParameters }}',
 '{{ LogicalTableMap }}',
 '{{ AwsAccountId }}',
 '{{ DataSetUsageConfiguration }}',
 '{{ Permissions }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: data_set
    props:
      - name: PhysicalTableMap
        value: {}
      - name: FieldFolders
        value: {}
      - name: DataSetId
        value: '{{ DataSetId }}'
      - name: FolderArns
        value:
          - '{{ FolderArns[0] }}'
      - name: PerformanceConfiguration
        value:
          UniqueKeys:
            - ColumnNames:
                - '{{ ColumnNames[0] }}'
      - name: RowLevelPermissionDataSet
        value:
          Status: '{{ Status }}'
          FormatVersion: '{{ FormatVersion }}'
          Arn: '{{ Arn }}'
          Namespace: '{{ Namespace }}'
          PermissionPolicy: '{{ PermissionPolicy }}'
      - name: DataSetRefreshProperties
        value:
          RefreshConfiguration:
            IncrementalRefresh:
              LookbackWindow:
                ColumnName: '{{ ColumnName }}'
                SizeUnit: '{{ SizeUnit }}'
                Size: null
      - name: RowLevelPermissionTagConfiguration
        value:
          Status: null
          TagRules:
            - ColumnName: '{{ ColumnName }}'
              TagKey: '{{ TagKey }}'
              MatchAllValue: '{{ MatchAllValue }}'
              TagMultiValueDelimiter: '{{ TagMultiValueDelimiter }}'
          TagRuleConfigurations:
            - - '{{ 0[0] }}'
      - name: IngestionWaitPolicy
        value:
          WaitForSpiceIngestion: '{{ WaitForSpiceIngestion }}'
          IngestionWaitTimeInHours: null
      - name: ColumnLevelPermissionRules
        value:
          - ColumnNames:
              - '{{ ColumnNames[0] }}'
            Principals:
              - '{{ Principals[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: ColumnGroups
        value:
          - GeoSpatialColumnGroup:
              Columns:
                - '{{ Columns[0] }}'
              CountryCode: '{{ CountryCode }}'
              Name: '{{ Name }}'
      - name: ImportMode
        value: '{{ ImportMode }}'
      - name: DatasetParameters
        value:
          - IntegerDatasetParameter:
              ValueType: '{{ ValueType }}'
              DefaultValues:
                StaticValues:
                  - null
              Id: '{{ Id }}'
              Name: '{{ Name }}'
            DateTimeDatasetParameter:
              ValueType: null
              TimeGranularity: '{{ TimeGranularity }}'
              DefaultValues:
                StaticValues:
                  - '{{ StaticValues[0] }}'
              Id: '{{ Id }}'
              Name: '{{ Name }}'
            DecimalDatasetParameter:
              ValueType: null
              DefaultValues:
                StaticValues:
                  - null
              Id: '{{ Id }}'
              Name: '{{ Name }}'
            StringDatasetParameter:
              ValueType: null
              DefaultValues:
                StaticValues:
                  - '{{ StaticValues[0] }}'
              Id: '{{ Id }}'
              Name: '{{ Name }}'
      - name: LogicalTableMap
        value: {}
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: DataSetUsageConfiguration
        value:
          DisableUseAsImportedSource: '{{ DisableUseAsImportedSource }}'
          DisableUseAsDirectQuerySource: '{{ DisableUseAsDirectQuerySource }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.data_sets
WHERE data__Identifier = '<AwsAccountId|DataSetId>'
AND region = 'us-east-1';

Permissions

To operate on the data_sets resource, the following permissions are required:

Read

quicksight:DescribeDataSet,
quicksight:DescribeDataSetPermissions,
quicksight:ListTagsForResource,
quicksight:DescribeDataSetRefreshProperties

Create

quicksight:DescribeDataSet,
quicksight:DescribeDataSetPermissions,
quicksight:DescribeIngestion,
quicksight:ListIngestions,
quicksight:CreateDataSet,
quicksight:PassDataSource,
quicksight:PassDataSet,
quicksight:TagResource,
quicksight:ListTagsForResource,
quicksight:DescribeDataSetRefreshProperties,
quicksight:PutDataSetRefreshProperties,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource

Update

quicksight:DescribeDataSet,
quicksight:DescribeDataSetPermissions,
quicksight:PassDataSource,
quicksight:UpdateDataSet,
quicksight:UpdateDataSetPermissions,
quicksight:PassDataSet,
quicksight:DescribeIngestion,
quicksight:ListIngestions,
quicksight:CancelIngestion,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource,
quicksight:PutDataSetRefreshProperties,
quicksight:DescribeDataSetRefreshProperties,
quicksight:DeleteDataSetRefreshProperties

List

quicksight:DescribeDataSet,
quicksight:ListDataSets

Delete

quicksight:DescribeDataSet,
quicksight:DeleteDataSet,
quicksight:ListTagsForResource,
quicksight:DescribeIngestion,
quicksight:DeleteDataSetRefreshProperties,
quicksight:DescribeDataSetRefreshProperties