data_sets

Creates, updates, deletes, gets or lists a data_sets resource.

Overview

Name	data_sets
Type	Resource
Id	aws.quicksight.data_sets

Fields

The following fields are returned by SELECT queries:

describe_data_set

Name	Datatype	Description
data_set	object	Information on the dataset.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

search_data_sets

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the dataset.
column_level_permission_rules_applied	boolean	A value that indicates if the dataset has column level permission configured.
created_time	string (date-time)	The time that this dataset was created.
data_set_id	string	The ID of the dataset.
import_mode	string	A value that indicates whether you want to import the data into SPICE. (SPICE, DIRECT_QUERY)
last_updated_time	string (date-time)	The last time that this dataset was updated.
name	string	A display name for the dataset.
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 Quick Sight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
row_level_permission_data_set_map	object	The row-level security configuration for the dataset in the new data preparation experience.
row_level_permission_tag_configuration_applied	boolean	Whether or not the row level permission tags are applied.
use_as	string	The usage of the dataset. (RLS_RULES)

list_data_sets

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the dataset.
column_level_permission_rules_applied	boolean	A value that indicates if the dataset has column level permission configured.
created_time	string (date-time)	The time that this dataset was created.
data_set_id	string	The ID of the dataset.
import_mode	string	A value that indicates whether you want to import the data into SPICE. (SPICE, DIRECT_QUERY)
last_updated_time	string (date-time)	The last time that this dataset was updated.
name	string	A display name for the dataset.
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 Quick Sight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
row_level_permission_data_set_map	object	The row-level security configuration for the dataset in the new data preparation experience.
row_level_permission_tag_configuration_applied	boolean	Whether or not the row level permission tags are applied.
use_as	string	The usage of the dataset. (RLS_RULES)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_data_set	select	aws_account_id, data_set_id, region		Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
search_data_sets	select	aws_account_id, region		Use the SearchDataSets operation to search for datasets that belong to an account.
list_data_sets	select	aws_account_id, region	next-token, max-results	Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
create_data_set	insert	aws_account_id, region, DataSetId, PhysicalTableMap, ImportMode		Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
update_data_set	update	aws_account_id, data_set_id, region, PhysicalTableMap, ImportMode		Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
delete_data_set	delete	aws_account_id, data_set_id, region		Deletes a dataset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The Amazon Web Services account ID.
data_set_id	string	The ID for the dataset that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_data_set

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

SELECT
data_set,
request_id,
status
FROM aws.quicksight.data_sets
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND data_set_id = '{{ data_set_id }}' -- required
AND region = '{{ region }}' -- required
;

search_data_sets

Use the SearchDataSets operation to search for datasets that belong to an account.

SELECT
arn,
column_level_permission_rules_applied,
created_time,
data_set_id,
import_mode,
last_updated_time,
name,
row_level_permission_data_set,
row_level_permission_data_set_map,
row_level_permission_tag_configuration_applied,
use_as
FROM aws.quicksight.data_sets
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_data_sets

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

SELECT
arn,
column_level_permission_rules_applied,
created_time,
data_set_id,
import_mode,
last_updated_time,
name,
row_level_permission_data_set,
row_level_permission_data_set_map,
row_level_permission_tag_configuration_applied,
use_as
FROM aws.quicksight.data_sets
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_data_set

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

INSERT INTO aws.quicksight.data_sets (
DataSetId,
Name,
PhysicalTableMap,
LogicalTableMap,
ImportMode,
ColumnGroups,
FieldFolders,
Permissions,
RowLevelPermissionDataSet,
RowLevelPermissionTagConfiguration,
ColumnLevelPermissionRules,
Tags,
DataSetUsageConfiguration,
DatasetParameters,
FolderArns,
PerformanceConfiguration,
UseAs,
DataPrepConfiguration,
SemanticModelConfiguration,
aws_account_id,
region
)
SELECT 
'{{ DataSetId }}' /* required */,
'{{ Name }}',
'{{ PhysicalTableMap }}' /* required */,
'{{ LogicalTableMap }}',
'{{ ImportMode }}' /* required */,
'{{ ColumnGroups }}',
'{{ FieldFolders }}',
'{{ Permissions }}',
'{{ RowLevelPermissionDataSet }}',
'{{ RowLevelPermissionTagConfiguration }}',
'{{ ColumnLevelPermissionRules }}',
'{{ Tags }}',
'{{ DataSetUsageConfiguration }}',
'{{ DatasetParameters }}',
'{{ FolderArns }}',
'{{ PerformanceConfiguration }}',
'{{ UseAs }}',
'{{ DataPrepConfiguration }}',
'{{ SemanticModelConfiguration }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
data_set_id,
ingestion_arn,
ingestion_id,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: data_sets
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the data_sets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_sets resource.
  - name: DataSetId
    value: "{{ DataSetId }}"
  - name: Name
    value: "{{ Name }}"
  - name: PhysicalTableMap
    value: "{{ PhysicalTableMap }}"
  - name: LogicalTableMap
    value: "{{ LogicalTableMap }}"
  - name: ImportMode
    value: "{{ ImportMode }}"
    valid_values: ['SPICE', 'DIRECT_QUERY']
  - name: ColumnGroups
    value:
      - GeoSpatialColumnGroup:
          Name: "{{ Name }}"
          CountryCode: "{{ CountryCode }}"
          Columns:
            - "{{ Columns }}"
  - name: FieldFolders
    value: "{{ FieldFolders }}"
  - name: Permissions
    value:
      - Principal: "{{ Principal }}"
        Actions: "{{ Actions }}"
  - name: RowLevelPermissionDataSet
    description: |
      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 Quick Sight User Guide. The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
    value:
      Namespace: "{{ Namespace }}"
      Arn: "{{ Arn }}"
      PermissionPolicy: "{{ PermissionPolicy }}"
      FormatVersion: "{{ FormatVersion }}"
      Status: "{{ Status }}"
  - name: RowLevelPermissionTagConfiguration
    description: |
      The configuration of tags on a dataset to set row-level security.
    value:
      Status: "{{ Status }}"
      TagRules:
        - TagKey: "{{ TagKey }}"
          ColumnName: "{{ ColumnName }}"
          TagMultiValueDelimiter: "{{ TagMultiValueDelimiter }}"
          MatchAllValue: "{{ MatchAllValue }}"
      TagRuleConfigurations:
        - "{{ TagRuleConfigurations }}"
  - name: ColumnLevelPermissionRules
    value:
      - Principals: "{{ Principals }}"
        ColumnNames: "{{ ColumnNames }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: DataSetUsageConfiguration
    description: |
      The usage configuration to apply to child datasets that reference this dataset as a source.
    value:
      DisableUseAsDirectQuerySource: {{ DisableUseAsDirectQuerySource }}
      DisableUseAsImportedSource: {{ DisableUseAsImportedSource }}
  - name: DatasetParameters
    value:
      - StringDatasetParameter:
          Id: "{{ Id }}"
          Name: "{{ Name }}"
          ValueType: "{{ ValueType }}"
          DefaultValues:
            StaticValues:
              - "{{ StaticValues }}"
        DecimalDatasetParameter:
          Id: "{{ Id }}"
          Name: "{{ Name }}"
          ValueType: "{{ ValueType }}"
          DefaultValues:
            StaticValues:
              - {{ StaticValues }}
        IntegerDatasetParameter:
          Id: "{{ Id }}"
          Name: "{{ Name }}"
          ValueType: "{{ ValueType }}"
          DefaultValues:
            StaticValues:
              - {{ StaticValues }}
        DateTimeDatasetParameter:
          Id: "{{ Id }}"
          Name: "{{ Name }}"
          ValueType: "{{ ValueType }}"
          TimeGranularity: "{{ TimeGranularity }}"
          DefaultValues:
            StaticValues:
              - "{{ StaticValues }}"
  - name: FolderArns
    value:
      - "{{ FolderArns }}"
  - name: PerformanceConfiguration
    description: |
      The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
    value:
      UniqueKeys:
        - ColumnNames: "{{ ColumnNames }}"
  - name: UseAs
    value: "{{ UseAs }}"
    valid_values: ['RLS_RULES']
  - name: DataPrepConfiguration
    description: |
      Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables.
    value:
      SourceTableMap: "{{ SourceTableMap }}"
      TransformStepMap: "{{ TransformStepMap }}"
      DestinationTableMap: "{{ DestinationTableMap }}"
  - name: SemanticModelConfiguration
    description: |
      Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.
    value:
      TableMap: "{{ TableMap }}"
      SemanticMetadata:
        - Description:
            Text: "{{ Text }}"
          CustomInstructions: "{{ CustomInstructions }}"

UPDATE examples

update_data_set

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

UPDATE aws.quicksight.data_sets
SET 
Name = '{{ Name }}',
PhysicalTableMap = '{{ PhysicalTableMap }}',
LogicalTableMap = '{{ LogicalTableMap }}',
ImportMode = '{{ ImportMode }}',
ColumnGroups = '{{ ColumnGroups }}',
FieldFolders = '{{ FieldFolders }}',
RowLevelPermissionDataSet = '{{ RowLevelPermissionDataSet }}',
RowLevelPermissionTagConfiguration = '{{ RowLevelPermissionTagConfiguration }}',
ColumnLevelPermissionRules = '{{ ColumnLevelPermissionRules }}',
DataSetUsageConfiguration = '{{ DataSetUsageConfiguration }}',
DatasetParameters = '{{ DatasetParameters }}',
PerformanceConfiguration = '{{ PerformanceConfiguration }}',
DataPrepConfiguration = '{{ DataPrepConfiguration }}',
SemanticModelConfiguration = '{{ SemanticModelConfiguration }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND data_set_id = '{{ data_set_id }}' --required
AND region = '{{ region }}' --required
AND PhysicalTableMap = '{{ PhysicalTableMap }}' --required
AND ImportMode = '{{ ImportMode }}' --required
RETURNING
arn,
data_set_id,
ingestion_arn,
ingestion_id,
request_id,
status;

DELETE examples

delete_data_set

Deletes a dataset.

DELETE FROM aws.quicksight.data_sets
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND data_set_id = '{{ data_set_id }}' --required
AND region = '{{ region }}' --required
;