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
arn	string	The Amazon Resource Name (ARN) of the resource.
aws_account_id	string
column_groups	array	Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
column_level_permission_rules	array	A set of one or more definitions of a ColumnLevelPermissionRule .
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.
created_time	string	The time that this dataset was created.
data_set_id	string
data_set_refresh_properties	object	The refresh properties of a dataset.
data_set_usage_configuration	object	The usage configuration to apply to child datasets that reference this dataset as a source.
dataset_parameters	array	The parameter declarations of the dataset.
field_folders	object
import_mode	string
last_updated_time	string	The last time that this dataset was updated.
logical_table_map	object
name	string	The display name for the dataset.
output_columns	array	The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
permissions	array	A list of resource permissions on the dataset.
physical_table_map	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.
row_level_permission_tag_configuration	object	The configuration of tags on a dataset to set row-level security.
tags	array	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
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.
region	string	AWS region.

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,
arn,
aws_account_id,
column_groups,
column_level_permission_rules,
consumed_spice_capacity_in_bytes,
created_time,
data_set_id,
data_set_refresh_properties,
data_set_usage_configuration,
dataset_parameters,
field_folders,
import_mode,
last_updated_time,
logical_table_map,
name,
output_columns,
permissions,
physical_table_map,
row_level_permission_data_set,
row_level_permission_tag_configuration,
tags,
ingestion_wait_policy
FROM aws.quicksight.data_sets
WHERE region = 'us-east-1';

Gets all properties from an individual data_set.

SELECT
region,
arn,
aws_account_id,
column_groups,
column_level_permission_rules,
consumed_spice_capacity_in_bytes,
created_time,
data_set_id,
data_set_refresh_properties,
data_set_usage_configuration,
dataset_parameters,
field_folders,
import_mode,
last_updated_time,
logical_table_map,
name,
output_columns,
permissions,
physical_table_map,
row_level_permission_data_set,
row_level_permission_tag_configuration,
tags,
ingestion_wait_policy
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 (
 AwsAccountId,
 ColumnGroups,
 ColumnLevelPermissionRules,
 DataSetId,
 DataSetRefreshProperties,
 DataSetUsageConfiguration,
 DatasetParameters,
 FieldFolders,
 ImportMode,
 LogicalTableMap,
 Name,
 Permissions,
 PhysicalTableMap,
 RowLevelPermissionDataSet,
 RowLevelPermissionTagConfiguration,
 Tags,
 IngestionWaitPolicy,
 region
)
SELECT 
'{{ AwsAccountId }}',
 '{{ ColumnGroups }}',
 '{{ ColumnLevelPermissionRules }}',
 '{{ DataSetId }}',
 '{{ DataSetRefreshProperties }}',
 '{{ DataSetUsageConfiguration }}',
 '{{ DatasetParameters }}',
 '{{ FieldFolders }}',
 '{{ ImportMode }}',
 '{{ LogicalTableMap }}',
 '{{ Name }}',
 '{{ Permissions }}',
 '{{ PhysicalTableMap }}',
 '{{ RowLevelPermissionDataSet }}',
 '{{ RowLevelPermissionTagConfiguration }}',
 '{{ Tags }}',
 '{{ IngestionWaitPolicy }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.data_sets (
 AwsAccountId,
 ColumnGroups,
 ColumnLevelPermissionRules,
 DataSetId,
 DataSetRefreshProperties,
 DataSetUsageConfiguration,
 DatasetParameters,
 FieldFolders,
 ImportMode,
 LogicalTableMap,
 Name,
 Permissions,
 PhysicalTableMap,
 RowLevelPermissionDataSet,
 RowLevelPermissionTagConfiguration,
 Tags,
 IngestionWaitPolicy,
 region
)
SELECT 
 '{{ AwsAccountId }}',
 '{{ ColumnGroups }}',
 '{{ ColumnLevelPermissionRules }}',
 '{{ DataSetId }}',
 '{{ DataSetRefreshProperties }}',
 '{{ DataSetUsageConfiguration }}',
 '{{ DatasetParameters }}',
 '{{ FieldFolders }}',
 '{{ ImportMode }}',
 '{{ LogicalTableMap }}',
 '{{ Name }}',
 '{{ Permissions }}',
 '{{ PhysicalTableMap }}',
 '{{ RowLevelPermissionDataSet }}',
 '{{ RowLevelPermissionTagConfiguration }}',
 '{{ Tags }}',
 '{{ IngestionWaitPolicy }}',
 '{{ 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: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: ColumnGroups
        value:
          - GeoSpatialColumnGroup:
              Name: '{{ Name }}'
              CountryCode: '{{ CountryCode }}'
              Columns:
                - '{{ Columns[0] }}'
      - name: ColumnLevelPermissionRules
        value:
          - Principals:
              - '{{ Principals[0] }}'
            ColumnNames:
              - '{{ ColumnNames[0] }}'
      - name: DataSetId
        value: '{{ DataSetId }}'
      - name: DataSetRefreshProperties
        value:
          RefreshConfiguration:
            IncrementalRefresh:
              LookbackWindow:
                ColumnName: '{{ ColumnName }}'
                Size: null
                SizeUnit: '{{ SizeUnit }}'
      - name: DataSetUsageConfiguration
        value:
          DisableUseAsDirectQuerySource: '{{ DisableUseAsDirectQuerySource }}'
          DisableUseAsImportedSource: '{{ DisableUseAsImportedSource }}'
      - name: DatasetParameters
        value:
          - StringDatasetParameter:
              Id: '{{ Id }}'
              Name: '{{ Name }}'
              ValueType: '{{ ValueType }}'
              DefaultValues:
                StaticValues:
                  - '{{ StaticValues[0] }}'
            DecimalDatasetParameter:
              Id: '{{ Id }}'
              Name: '{{ Name }}'
              ValueType: null
              DefaultValues:
                StaticValues:
                  - null
            IntegerDatasetParameter:
              Id: '{{ Id }}'
              Name: '{{ Name }}'
              ValueType: null
              DefaultValues:
                StaticValues:
                  - null
            DateTimeDatasetParameter:
              Id: '{{ Id }}'
              Name: '{{ Name }}'
              ValueType: null
              TimeGranularity: '{{ TimeGranularity }}'
              DefaultValues:
                StaticValues:
                  - '{{ StaticValues[0] }}'
      - name: FieldFolders
        value: {}
      - name: ImportMode
        value: '{{ ImportMode }}'
      - name: LogicalTableMap
        value: {}
      - name: Name
        value: '{{ Name }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: PhysicalTableMap
        value: {}
      - name: RowLevelPermissionDataSet
        value:
          Namespace: '{{ Namespace }}'
          Arn: '{{ Arn }}'
          PermissionPolicy: '{{ PermissionPolicy }}'
          FormatVersion: '{{ FormatVersion }}'
          Status: '{{ Status }}'
      - name: RowLevelPermissionTagConfiguration
        value:
          Status: null
          TagRules:
            - TagKey: '{{ TagKey }}'
              ColumnName: '{{ ColumnName }}'
              TagMultiValueDelimiter: '{{ TagMultiValueDelimiter }}'
              MatchAllValue: '{{ MatchAllValue }}'
          TagRuleConfigurations:
            - - '{{ 0[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: IngestionWaitPolicy
        value:
          WaitForSpiceIngestion: '{{ WaitForSpiceIngestion }}'
          IngestionWaitTimeInHours: null

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:

Create

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

Read

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

Update

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

Delete

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

List

quicksight:DescribeDataSet,
quicksight:ListDataSets