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

get (all properties)

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 <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> 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.

list (identifiers only)

Name	Datatype	Description
data_set_id	string
aws_account_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	data_sets	INSERT	region
delete_resource	data_sets	DELETE	Identifier, region
update_resource	data_sets	UPDATE	Identifier, PatchDocument, region
list_resources	data_sets_list_only	SELECT	region
get_resource	data_sets	SELECT	Identifier, region

SELECT examples

get (all properties)

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
  Identifier = '{{ aws_account_id }}|{{ data_set_id }}';

list (identifiers only)

Lists all data_sets in a region.

SELECT
  region,
  aws_account_id,
  data_set_id
FROM awscc.quicksight.data_sets_list_only
WHERE
  region = 'us-east-1';

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
  '{{ folder_arns }}',
  '{{ row_level_permission_data_set }}',
  '{{ ingestion_wait_policy }}',
  '{{ column_level_permission_rules }}',
  '{{ name }}',
  '{{ permissions }}',
  '{{ use_as }}',
  '{{ tags }}',
  '{{ physical_table_map }}',
  '{{ field_folders }}',
  '{{ 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 }}',
  '{{ 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
  '{{ folder_arns }}',
  '{{ row_level_permission_data_set }}',
  '{{ ingestion_wait_policy }}',
  '{{ column_level_permission_rules }}',
  '{{ name }}',
  '{{ permissions }}',
  '{{ use_as }}',
  '{{ tags }}',
  '{{ physical_table_map }}',
  '{{ field_folders }}',
  '{{ 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 }}',
  '{{ 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: folder_arns
        value:
          - '{{ folder_arns[0] }}'
      - name: row_level_permission_data_set
        value:
          status: '{{ status }}'
          format_version: '{{ format_version }}'
          arn: '{{ arn }}'
          namespace: '{{ namespace }}'
          permission_policy: '{{ permission_policy }}'
      - name: ingestion_wait_policy
        value:
          wait_for_spice_ingestion: '{{ wait_for_spice_ingestion }}'
          ingestion_wait_time_in_hours: null
      - name: column_level_permission_rules
        value:
          - column_names:
              - '{{ column_names[0] }}'
            principals:
              - '{{ principals[0] }}'
      - name: name
        value: '{{ name }}'
      - name: permissions
        value:
          - principal: '{{ principal }}'
            actions:
              - '{{ actions[0] }}'
      - name: use_as
        value: '{{ use_as }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: physical_table_map
        value: {}
      - name: field_folders
        value: {}
      - name: data_set_id
        value: '{{ data_set_id }}'
      - name: performance_configuration
        value:
          unique_keys:
            - column_names:
                - '{{ column_names[0] }}'
      - name: data_set_refresh_properties
        value:
          refresh_configuration:
            incremental_refresh:
              lookback_window:
                column_name: '{{ column_name }}'
                size_unit: '{{ size_unit }}'
                size: null
          failure_configuration:
            email_alert:
              alert_status: '{{ alert_status }}'
      - name: row_level_permission_tag_configuration
        value:
          status: null
          tag_rules:
            - column_name: '{{ column_name }}'
              tag_key: '{{ tag_key }}'
              match_all_value: '{{ match_all_value }}'
              tag_multi_value_delimiter: '{{ tag_multi_value_delimiter }}'
          tag_rule_configurations:
            - - '{{ 0[0] }}'
      - name: column_groups
        value:
          - geo_spatial_column_group:
              columns:
                - '{{ columns[0] }}'
              country_code: '{{ country_code }}'
              name: '{{ name }}'
      - name: import_mode
        value: '{{ import_mode }}'
      - name: dataset_parameters
        value:
          - integer_dataset_parameter:
              value_type: '{{ value_type }}'
              default_values:
                static_values:
                  - null
              id: '{{ id }}'
              name: '{{ name }}'
            date_time_dataset_parameter:
              value_type: null
              time_granularity: '{{ time_granularity }}'
              default_values:
                static_values:
                  - '{{ static_values[0] }}'
              id: '{{ id }}'
              name: '{{ name }}'
            decimal_dataset_parameter:
              value_type: null
              default_values:
                static_values:
                  - null
              id: '{{ id }}'
              name: '{{ name }}'
            string_dataset_parameter:
              value_type: null
              default_values:
                static_values:
                  - '{{ static_values[0] }}'
              id: '{{ id }}'
              name: '{{ name }}'
      - name: logical_table_map
        value: {}
      - name: aws_account_id
        value: '{{ aws_account_id }}'
      - name: data_set_usage_configuration
        value:
          disable_use_as_imported_source: '{{ disable_use_as_imported_source }}'
          disable_use_as_direct_query_source: '{{ disable_use_as_direct_query_source }}'

UPDATE example

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

/*+ update */
UPDATE awscc.quicksight.data_sets
SET PatchDocument = string('{{ {
    "FolderArns": folder_arns,
    "RowLevelPermissionDataSet": row_level_permission_data_set,
    "IngestionWaitPolicy": ingestion_wait_policy,
    "ColumnLevelPermissionRules": column_level_permission_rules,
    "Name": name,
    "Permissions": permissions,
    "UseAs": use_as,
    "Tags": tags,
    "PhysicalTableMap": physical_table_map,
    "FieldFolders": field_folders,
    "PerformanceConfiguration": performance_configuration,
    "DataSetRefreshProperties": data_set_refresh_properties,
    "RowLevelPermissionTagConfiguration": row_level_permission_tag_configuration,
    "ColumnGroups": column_groups,
    "ImportMode": import_mode,
    "DatasetParameters": dataset_parameters,
    "LogicalTableMap": logical_table_map,
    "DataSetUsageConfiguration": data_set_usage_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aws_account_id }}|{{ data_set_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.data_sets
WHERE
  Identifier = '{{ aws_account_id }}|{{ data_set_id }}' 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