aws_sdk_quicksight/client/
create_data_set.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateDataSet`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID.</p><br>
7    ///   - [`data_set_id(impl Into<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::data_set_id) / [`set_data_set_id(Option<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_data_set_id):<br>required: **true**<br><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><br>
8    ///   - [`name(impl Into<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_name):<br>required: **true**<br><p>The display name for the dataset.</p><br>
9    ///   - [`physical_table_map(impl Into<String>, PhysicalTable)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::physical_table_map) / [`set_physical_table_map(Option<HashMap::<String, PhysicalTable>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_physical_table_map):<br>required: **true**<br><p>Declares the physical tables that are available in the underlying data sources.</p><br>
10    ///   - [`logical_table_map(impl Into<String>, LogicalTable)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::logical_table_map) / [`set_logical_table_map(Option<HashMap::<String, LogicalTable>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_logical_table_map):<br>required: **false**<br><p>Configures the combination and transformation of the data from the physical tables.</p><br>
11    ///   - [`import_mode(DataSetImportMode)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::import_mode) / [`set_import_mode(Option<DataSetImportMode>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_import_mode):<br>required: **true**<br><p>Indicates whether you want to import the data into SPICE.</p><br>
12    ///   - [`column_groups(ColumnGroup)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::column_groups) / [`set_column_groups(Option<Vec::<ColumnGroup>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_column_groups):<br>required: **false**<br><p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p><br>
13    ///   - [`field_folders(impl Into<String>, FieldFolder)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::field_folders) / [`set_field_folders(Option<HashMap::<String, FieldFolder>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_field_folders):<br>required: **false**<br><p>The folder that contains fields and nested subfolders for your dataset.</p><br>
14    ///   - [`permissions(ResourcePermission)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::permissions) / [`set_permissions(Option<Vec::<ResourcePermission>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_permissions):<br>required: **false**<br><p>A list of resource permissions on the dataset.</p><br>
15    ///   - [`row_level_permission_data_set(RowLevelPermissionDataSet)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::row_level_permission_data_set) / [`set_row_level_permission_data_set(Option<RowLevelPermissionDataSet>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_row_level_permission_data_set):<br>required: **false**<br><p>The row-level security configuration for the data that you want to create.</p><br>
16    ///   - [`row_level_permission_tag_configuration(RowLevelPermissionTagConfiguration)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::row_level_permission_tag_configuration) / [`set_row_level_permission_tag_configuration(Option<RowLevelPermissionTagConfiguration>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_row_level_permission_tag_configuration):<br>required: **false**<br><p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p><br>
17    ///   - [`column_level_permission_rules(ColumnLevelPermissionRule)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::column_level_permission_rules) / [`set_column_level_permission_rules(Option<Vec::<ColumnLevelPermissionRule>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_column_level_permission_rules):<br>required: **false**<br><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><br>
18    ///   - [`tags(Tag)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_tags):<br>required: **false**<br><p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p><br>
19    ///   - [`data_set_usage_configuration(DataSetUsageConfiguration)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::data_set_usage_configuration) / [`set_data_set_usage_configuration(Option<DataSetUsageConfiguration>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_data_set_usage_configuration):<br>required: **false**<br><p>The usage configuration to apply to child datasets that reference this dataset as a source.</p><br>
20    ///   - [`dataset_parameters(DatasetParameter)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::dataset_parameters) / [`set_dataset_parameters(Option<Vec::<DatasetParameter>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_dataset_parameters):<br>required: **false**<br><p>The parameter declarations of the dataset.</p><br>
21    ///   - [`folder_arns(impl Into<String>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::folder_arns) / [`set_folder_arns(Option<Vec::<String>>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_folder_arns):<br>required: **false**<br><p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p><br>
22    ///   - [`performance_configuration(PerformanceConfiguration)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::performance_configuration) / [`set_performance_configuration(Option<PerformanceConfiguration>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_performance_configuration):<br>required: **false**<br><p>The configuration for the performance optimization of the dataset that contains a <code>UniqueKey</code> configuration.</p><br>
23    ///   - [`use_as(DataSetUseAs)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::use_as) / [`set_use_as(Option<DataSetUseAs>)`](crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::set_use_as):<br>required: **false**<br><p>The usage of the dataset. <code>RLS_RULES</code> must be specified for RLS permission datasets.</p><br>
24    /// - On success, responds with [`CreateDataSetOutput`](crate::operation::create_data_set::CreateDataSetOutput) with field(s):
25    ///   - [`arn(Option<String>)`](crate::operation::create_data_set::CreateDataSetOutput::arn): <p>The Amazon Resource Name (ARN) of the dataset.</p>
26    ///   - [`data_set_id(Option<String>)`](crate::operation::create_data_set::CreateDataSetOutput::data_set_id): <p>The 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>
27    ///   - [`ingestion_arn(Option<String>)`](crate::operation::create_data_set::CreateDataSetOutput::ingestion_arn): <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.</p>
28    ///   - [`ingestion_id(Option<String>)`](crate::operation::create_data_set::CreateDataSetOutput::ingestion_id): <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.</p>
29    ///   - [`request_id(Option<String>)`](crate::operation::create_data_set::CreateDataSetOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
30    ///   - [`status(i32)`](crate::operation::create_data_set::CreateDataSetOutput::status): <p>The HTTP status of the request.</p>
31    /// - On failure, responds with [`SdkError<CreateDataSetError>`](crate::operation::create_data_set::CreateDataSetError)
32    pub fn create_data_set(&self) -> crate::operation::create_data_set::builders::CreateDataSetFluentBuilder {
33        crate::operation::create_data_set::builders::CreateDataSetFluentBuilder::new(self.handle.clone())
34    }
35}