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	awscc.quicksight.data_sets

Fields

Name	Datatype	Description
created_time	string	<p>The time that this dataset was created.</p>
folder_arns	array	<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>
consumed_spice_capacity_in_bytes	number	<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't<br />imported into SPICE.</p>
▶row_level_permission_data_set	object	<p>Information about a dataset that contains permissions for row-level security (RLS).<br />The permissions dataset maps fields to users or groups. For more information, see<br /><a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User<br />Guide</i>.</p><br /><p>The option to deny permissions by setting &#95;&#95;CODE&#95;BLOCK&#95;0&#95;&#95; to &#95;&#95;CODE&#95;BLOCK&#95;1&#95;&#95; is<br />not supported for new RLS datasets.</p>
▶ingestion_wait_policy	object	<p>Wait policy to use when creating/updating dataset. Default is to wait for SPICE ingestion to finish with timeout of 36 hours.</p>
▶column_level_permission_rules	array	<p>A set of one or more definitions of a <code><br /><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API&#95;ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a><br /></code>.</p>
name	string	<p>The display name for the dataset.</p>
▶permissions	array	<p>A list of resource permissions on the dataset.</p>
use_as	string
▶tags	array	<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
physical_table_map	object
field_folders	object
last_updated_time	string	<p>The last time that this dataset was updated.</p>
data_set_id	string
▶performance_configuration	object
▶data_set_refresh_properties	object	<p>The refresh properties of a dataset.</p>
▶row_level_permission_tag_configuration	object	<p>The configuration of tags on a dataset to set row-level security. </p>
▶column_groups	array	<p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
import_mode	string
▶dataset_parameters	array	<p>The parameter declarations of the dataset.</p>
logical_table_map	object
aws_account_id	string
▶data_set_usage_configuration	object	<p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
▶output_columns	array	<p>The list of columns after all transforms. These columns are available in templates,<br />analyses, and dashboards.</p>
arn	string	<p>The Amazon Resource Name (ARN) of the resource.</p>
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 properties from an individual data_set.

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

All Properties

/*+ create */
INSERT INTO awscc.quicksight.data_sets (
 FolderArns,
 RowLevelPermissionDataSet,
 IngestionWaitPolicy,
 ColumnLevelPermissionRules,
 Name,
 Permissions,
 UseAs,
 Tags,
 PhysicalTableMap,
 FieldFolders,
 DataSetId,
 PerformanceConfiguration,
 DataSetRefreshProperties,
 RowLevelPermissionTagConfiguration,
 ColumnGroups,
 ImportMode,
 DatasetParameters,
 LogicalTableMap,
 AwsAccountId,
 DataSetUsageConfiguration,
 region
)
SELECT 
 '{{ FolderArns }}',
 '{{ RowLevelPermissionDataSet }}',
 '{{ IngestionWaitPolicy }}',
 '{{ ColumnLevelPermissionRules }}',
 '{{ Name }}',
 '{{ Permissions }}',
 '{{ UseAs }}',
 '{{ Tags }}',
 '{{ PhysicalTableMap }}',
 '{{ FieldFolders }}',
 '{{ DataSetId }}',
 '{{ PerformanceConfiguration }}',
 '{{ DataSetRefreshProperties }}',
 '{{ RowLevelPermissionTagConfiguration }}',
 '{{ ColumnGroups }}',
 '{{ ImportMode }}',
 '{{ DatasetParameters }}',
 '{{ LogicalTableMap }}',
 '{{ AwsAccountId }}',
 '{{ DataSetUsageConfiguration }}',
 '{{ 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: FolderArns
        value:
          - '{{ FolderArns[0] }}'
      - name: RowLevelPermissionDataSet
        value:
          Status: '{{ Status }}'
          FormatVersion: '{{ FormatVersion }}'
          Arn: '{{ Arn }}'
          Namespace: '{{ Namespace }}'
          PermissionPolicy: '{{ PermissionPolicy }}'
      - name: IngestionWaitPolicy
        value:
          WaitForSpiceIngestion: '{{ WaitForSpiceIngestion }}'
          IngestionWaitTimeInHours: null
      - name: ColumnLevelPermissionRules
        value:
          - ColumnNames:
              - '{{ ColumnNames[0] }}'
            Principals:
              - '{{ Principals[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: UseAs
        value: '{{ UseAs }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: PhysicalTableMap
        value: {}
      - name: FieldFolders
        value: {}
      - name: DataSetId
        value: '{{ DataSetId }}'
      - name: PerformanceConfiguration
        value:
          UniqueKeys:
            - ColumnNames:
                - '{{ ColumnNames[0] }}'
      - name: DataSetRefreshProperties
        value:
          RefreshConfiguration:
            IncrementalRefresh:
              LookbackWindow:
                ColumnName: '{{ ColumnName }}'
                SizeUnit: '{{ SizeUnit }}'
                Size: null
          FailureConfiguration:
            EmailAlert:
              AlertStatus: '{{ AlertStatus }}'
      - name: RowLevelPermissionTagConfiguration
        value:
          Status: null
          TagRules:
            - ColumnName: '{{ ColumnName }}'
              TagKey: '{{ TagKey }}'
              MatchAllValue: '{{ MatchAllValue }}'
              TagMultiValueDelimiter: '{{ TagMultiValueDelimiter }}'
          TagRuleConfigurations:
            - - '{{ 0[0] }}'
      - 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 }}'

DELETE example

/*+ delete */
DELETE FROM awscc.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