CreateDataSetRequest ¶

class CreateDataSetRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The Amazon Web Services account ID.</p>"""
    data_set_id: "capo_quicksight.types.resource_id.ResourceId"
    """<p>An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"""
    name: "capo_quicksight.types.resource_name.ResourceName"
    """<p>The display name for the dataset.</p>"""
    physical_table_map: "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. This parameter is used with the legacy data preparation experience.</p>"""
    import_mode: "capo_quicksight.types.data_set_import_mode.DataSetImportMode"
    """<p>Indicates whether you want to import the data into SPICE.</p>"""
    column_groups: NotRequired[
        "capo_quicksight.types.column_group_list.ColumnGroupList"
    ]
    """<p>Groupings of columns that work together in certain Amazon 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>"""
    permissions: NotRequired[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ]
    """<p>A list of resource permissions on the 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 data that you want to create. This parameter is used with the legacy data preparation experience.</p>"""
    row_level_permission_tag_configuration: NotRequired[
        "capo_quicksight.types.row_level_permission_tag_configuration.RowLevelPermissionTagConfiguration"
    ]
    """<p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.</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>"""
    tags: NotRequired["capo_quicksight.types.tag_list.TagList"]
    """<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>"""
    data_set_usage_configuration: NotRequired[
        "capo_quicksight.types.data_set_usage_configuration.DataSetUsageConfiguration"
    ]
    dataset_parameters: NotRequired[
        "capo_quicksight.types.dataset_parameter_list.DatasetParameterList"
    ]
    """<p>The parameter declarations of the dataset.</p>"""
    folder_arns: NotRequired["capo_quicksight.types.folder_arn_list.FolderArnList"]
    """<p>When you create the dataset, Amazon Quick Sight adds the dataset to these folders.</p>"""
    performance_configuration: NotRequired[
        "capo_quicksight.types.performance_configuration.PerformanceConfiguration"
    ]
    """<p>The configuration for the performance optimization of the dataset that contains a <code>UniqueKey</code> configuration.</p>"""
    use_as: NotRequired["capo_quicksight.types.data_set_use_as.DataSetUseAs"]
    """<p>The usage of the dataset. <code>RLS_RULES</code> must be specified for RLS permission datasets.</p>"""
    data_prep_configuration: NotRequired[
        "capo_quicksight.types.data_prep_configuration.DataPrepConfiguration"
    ]
    """<p>The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.</p>"""
    semantic_model_configuration: NotRequired[
        "capo_quicksight.types.semantic_model_configuration.SemanticModelConfiguration"
    ]
    """<p>The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.</p>"""