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	The time that this dataset was created.
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.
▶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.
▶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.
▶permissions	array	A list of resource permissions on the dataset.
use_as	string
▶tags	array	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
physical_table_map	object
field_folders	object
last_updated_time	string	The last time that this dataset was updated.
data_set_id	string
▶performance_configuration	object
▶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.
▶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.
▶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.
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 = '{{ region }}' 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 = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.data_sets
WHERE
  Identifier = '{{ aws_account_id }}|{{ data_set_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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