Skip to content

DataSet

Source code in docs_src/capo_quicksight/types/data_set.py
class DataSet(TypedDict, closed=True):
    arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the resource.</p>"""
    data_set_id: NotRequired["capo_quicksight.types.resource_id.ResourceId"]
    """<p>The ID of the dataset. Limited to 96 characters.</p>"""
    name: NotRequired["capo_quicksight.types.resource_name.ResourceName"]
    """<p>A display name for the dataset.</p>"""
    created_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p>The time that this dataset was created.</p>"""
    last_updated_time: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p>The last time that this dataset was updated.</p>"""
    physical_table_map: NotRequired[
        "capo_quicksight.types.physical_table_map.PhysicalTableMap"
    ]
    """<p>Declares the physical tables that are available in the underlying data sources.</p>"""
    logical_table_map: NotRequired[
        "capo_quicksight.types.logical_table_map.LogicalTableMap"
    ]
    """<p>Configures the combination and transformation of the data from the physical tables.</p>"""
    output_columns: NotRequired[
        "capo_quicksight.types.output_column_list.OutputColumnList"
    ]
    """<p>The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.</p>"""
    import_mode: NotRequired[
        "capo_quicksight.types.data_set_import_mode.DataSetImportMode"
    ]
    """<p>A value that indicates whether you want to import the data into SPICE.</p>"""
    consumed_spice_capacity_in_bytes: "capo_quicksight.types.long.Long"
    """<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.</p>"""
    column_groups: NotRequired[
        "capo_quicksight.types.column_group_list.ColumnGroupList"
    ]
    """<p>Groupings of columns that work together in certain Quick Sight features. Currently, only geospatial hierarchy is supported.</p>"""
    field_folders: NotRequired["capo_quicksight.types.field_folder_map.FieldFolderMap"]
    """<p>The folder that contains fields and nested subfolders for your dataset.</p>"""
    row_level_permission_data_set: NotRequired[
        "capo_quicksight.types.row_level_permission_data_set.RowLevelPermissionDataSet"
    ]
    """<p>The row-level security configuration for the dataset.</p>"""
    row_level_permission_tag_configuration: NotRequired[
        "capo_quicksight.types.row_level_permission_tag_configuration.RowLevelPermissionTagConfiguration"
    ]
    """<p>The element you can use to define tags for row-level security.</p>"""
    column_level_permission_rules: NotRequired[
        "capo_quicksight.types.column_level_permission_rule_list.ColumnLevelPermissionRuleList"
    ]
    """<p>A set of one or more definitions of a <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a> </code>.</p>"""
    data_set_usage_configuration: NotRequired[
        "capo_quicksight.types.data_set_usage_configuration.DataSetUsageConfiguration"
    ]
    """<p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>"""
    dataset_parameters: NotRequired[
        "capo_quicksight.types.dataset_parameter_list.DatasetParameterList"
    ]
    """<p>The parameters that are declared in a dataset.</p>"""
    performance_configuration: NotRequired[
        "capo_quicksight.types.performance_configuration.PerformanceConfiguration"
    ]
    """<p>The performance optimization configuration of a dataset.</p>"""
    use_as: NotRequired["capo_quicksight.types.data_set_use_as.DataSetUseAs"]
    """<p>The usage of the dataset.</p>"""
    data_prep_configuration: NotRequired[
        "capo_quicksight.types.data_prep_configuration.DataPrepConfiguration"
    ]
    """<p>The data preparation configuration associated with this dataset.</p>"""
    semantic_model_configuration: NotRequired[
        "capo_quicksight.types.semantic_model_configuration.SemanticModelConfiguration"
    ]
    """<p>The semantic model configuration associated with this dataset.</p>"""

arn instance-attribute

arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the resource.

column_groups instance-attribute

column_groups: NotRequired[ColumnGroupList]

Groupings of columns that work together in certain Quick Sight features. Currently, only geospatial hierarchy is supported.

column_level_permission_rules instance-attribute

column_level_permission_rules: NotRequired[ColumnLevelPermissionRuleList]

A set of one or more definitions of a ColumnLevelPermissionRule .

consumed_spice_capacity_in_bytes instance-attribute

consumed_spice_capacity_in_bytes: Long

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

created_time instance-attribute

created_time: NotRequired[Timestamp]

The time that this dataset was created.

data_prep_configuration instance-attribute

data_prep_configuration: NotRequired[DataPrepConfiguration]

The data preparation configuration associated with this dataset.

data_set_id instance-attribute

data_set_id: NotRequired[ResourceId]

The ID of the dataset. Limited to 96 characters.

data_set_usage_configuration instance-attribute

data_set_usage_configuration: NotRequired[DataSetUsageConfiguration]

The usage configuration to apply to child datasets that reference this dataset as a source.

dataset_parameters instance-attribute

dataset_parameters: NotRequired[DatasetParameterList]

The parameters that are declared in a dataset.

field_folders instance-attribute

field_folders: NotRequired[FieldFolderMap]

The folder that contains fields and nested subfolders for your dataset.

import_mode instance-attribute

import_mode: NotRequired[DataSetImportMode]

A value that indicates whether you want to import the data into SPICE.

last_updated_time instance-attribute

last_updated_time: NotRequired[Timestamp]

The last time that this dataset was updated.

logical_table_map instance-attribute

logical_table_map: NotRequired[LogicalTableMap]

Configures the combination and transformation of the data from the physical tables.

name instance-attribute

name: NotRequired[ResourceName]

A display name for the dataset.

output_columns instance-attribute

output_columns: NotRequired[OutputColumnList]

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

performance_configuration instance-attribute

performance_configuration: NotRequired[PerformanceConfiguration]

The performance optimization configuration of a dataset.

physical_table_map instance-attribute

physical_table_map: NotRequired[PhysicalTableMap]

Declares the physical tables that are available in the underlying data sources.

row_level_permission_data_set instance-attribute

row_level_permission_data_set: NotRequired[RowLevelPermissionDataSet]

The row-level security configuration for the dataset.

row_level_permission_tag_configuration instance-attribute

row_level_permission_tag_configuration: NotRequired[RowLevelPermissionTagConfiguration]

The element you can use to define tags for row-level security.

semantic_model_configuration instance-attribute

semantic_model_configuration: NotRequired[SemanticModelConfiguration]

The semantic model configuration associated with this dataset.

use_as instance-attribute

use_as: NotRequired[DataSetUseAs]

The usage of the dataset.