Class: Aws::QuickSight::Types::CreateDataSetRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CreateDataSetRequest

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ String

  The Amazon Web Services account ID.

• #column_groups ⇒ Array<Types::ColumnGroup>

  Groupings of columns that work together in certain Amazon Quick Sight features.

• #column_level_permission_rules ⇒ Array<Types::ColumnLevelPermissionRule>

  A set of one or more definitions of a ColumnLevelPermissionRule.

• #data_prep_configuration ⇒ Types::DataPrepConfiguration

  The data preparation configuration for the dataset.

• #data_set_id ⇒ String

  An ID for the dataset that you want to create.

• #data_set_usage_configuration ⇒ Types::DataSetUsageConfiguration

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

• #dataset_parameters ⇒ Array<Types::DatasetParameter>

  The parameter declarations of the dataset.

• #field_folders ⇒ Hash<String,Types::FieldFolder>

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

• #folder_arns ⇒ Array<String>

  When you create the dataset, Amazon Quick Sight adds the dataset to these folders.

• #import_mode ⇒ String

  Indicates whether you want to import the data into SPICE.

• #logical_table_map ⇒ Hash<String,Types::LogicalTable>

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

• #name ⇒ String

  The display name for the dataset.

• #performance_configuration ⇒ Types::PerformanceConfiguration

  The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.

• #permissions ⇒ Array<Types::ResourcePermission>

  A list of resource permissions on the dataset.

• #physical_table_map ⇒ Hash<String,Types::PhysicalTable>

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

• #row_level_permission_data_set ⇒ Types::RowLevelPermissionDataSet

  The row-level security configuration for the data that you want to create.

• #row_level_permission_tag_configuration ⇒ Types::RowLevelPermissionTagConfiguration

  The configuration of tags on a dataset to set row-level security.

• #semantic_model_configuration ⇒ Types::SemanticModelConfiguration

  The semantic model configuration for the dataset.

• #tags ⇒ Array<Types::Tag>

  Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

• #use_as ⇒ String

  The usage of the dataset.

Instance Attribute Details

#aws_account_id ⇒ String

The Amazon Web Services account ID.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#column_groups ⇒ Array<Types::ColumnGroup>

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

Returns:

• (Array<Types::ColumnGroup>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#column_level_permission_rules ⇒ Array<Types::ColumnLevelPermissionRule>

A set of one or more definitions of a ColumnLevelPermissionRule.

Returns:

• (Array<Types::ColumnLevelPermissionRule>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_prep_configuration ⇒ Types::DataPrepConfiguration

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.

Returns:

• (Types::DataPrepConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_set_id ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_set_usage_configuration ⇒ Types::DataSetUsageConfiguration

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

Returns:

• (Types::DataSetUsageConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_parameters ⇒ Array<Types::DatasetParameter>

The parameter declarations of the dataset.

Returns:

• (Array<Types::DatasetParameter>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#field_folders ⇒ Hash<String,Types::FieldFolder>

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

Returns:

• (Hash<String,Types::FieldFolder>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#folder_arns ⇒ Array<String>

When you create the dataset, Amazon Quick Sight adds the dataset to these folders.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#import_mode ⇒ String

Indicates whether you want to import the data into SPICE.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#logical_table_map ⇒ Hash<String,Types::LogicalTable>

Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.

Returns:

• (Hash<String,Types::LogicalTable>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The display name for the dataset.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#performance_configuration ⇒ Types::PerformanceConfiguration

The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.

Returns:

• (Types::PerformanceConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#permissions ⇒ Array<Types::ResourcePermission>

A list of resource permissions on the dataset.

Returns:

• (Array<Types::ResourcePermission>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#physical_table_map ⇒ Hash<String,Types::PhysicalTable>

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

Returns:

• (Hash<String,Types::PhysicalTable>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#row_level_permission_data_set ⇒ Types::RowLevelPermissionDataSet

The row-level security configuration for the data that you want to create. This parameter is used with the legacy data preparation experience.

Returns:

• (Types::RowLevelPermissionDataSet)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#row_level_permission_tag_configuration ⇒ Types::RowLevelPermissionTagConfiguration

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.

Returns:

• (Types::RowLevelPermissionTagConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#semantic_model_configuration ⇒ Types::SemanticModelConfiguration

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.

Returns:

• (Types::SemanticModelConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_as ⇒ String

The usage of the dataset. RLS_RULES must be specified for RLS permission datasets.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 8169

class CreateDataSetRequest < Struct.new(
  :aws_account_id,
  :data_set_id,
  :name,
  :physical_table_map,
  :logical_table_map,
  :import_mode,
  :column_groups,
  :field_folders,
  :permissions,
  :row_level_permission_data_set,
  :row_level_permission_tag_configuration,
  :column_level_permission_rules,
  :tags,
  :data_set_usage_configuration,
  :dataset_parameters,
  :folder_arns,
  :performance_configuration,
  :use_as,
  :data_prep_configuration,
  :semantic_model_configuration)
  SENSITIVE = []
  include Aws::Structure
end