aws-sdk-quicksight 1.162.0 → 1.163.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1233 -57
- data/lib/aws-sdk-quicksight/client_api.rb +383 -14
- data/lib/aws-sdk-quicksight/errors.rb +21 -0
- data/lib/aws-sdk-quicksight/types.rb +1358 -58
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +911 -5
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +341 -1
- metadata +1 -1
|
@@ -93,7 +93,7 @@ module Aws::QuickSight
|
|
|
93
93
|
# @!attribute [rw] account_name
|
|
94
94
|
# The account name that you provided for the Amazon Quick Sight
|
|
95
95
|
# subscription in your Amazon Web Services account. You create this
|
|
96
|
-
# name when you sign up for
|
|
96
|
+
# name when you sign up for Quick Suite. It's unique over all of
|
|
97
97
|
# Amazon Web Services, and it appears only when users sign in.
|
|
98
98
|
# @return [String]
|
|
99
99
|
#
|
|
@@ -158,7 +158,7 @@ module Aws::QuickSight
|
|
|
158
158
|
#
|
|
159
159
|
# @!attribute [rw] public_sharing_enabled
|
|
160
160
|
# A Boolean value that indicates whether public sharing is turned on
|
|
161
|
-
# for an
|
|
161
|
+
# for an Quick Suite account. For more information about turning on
|
|
162
162
|
# public sharing, see [UpdatePublicSharingSettings][1].
|
|
163
163
|
#
|
|
164
164
|
#
|
|
@@ -420,6 +420,67 @@ module Aws::QuickSight
|
|
|
420
420
|
include Aws::Structure
|
|
421
421
|
end
|
|
422
422
|
|
|
423
|
+
# A transform operation that groups rows by specified columns and
|
|
424
|
+
# applies aggregation functions to calculate summary values.
|
|
425
|
+
#
|
|
426
|
+
# @!attribute [rw] alias
|
|
427
|
+
# Alias for this operation.
|
|
428
|
+
# @return [String]
|
|
429
|
+
#
|
|
430
|
+
# @!attribute [rw] source
|
|
431
|
+
# The source transform operation that provides input data for the
|
|
432
|
+
# aggregation.
|
|
433
|
+
# @return [Types::TransformOperationSource]
|
|
434
|
+
#
|
|
435
|
+
# @!attribute [rw] group_by_column_names
|
|
436
|
+
# The list of column names to group by when performing the
|
|
437
|
+
# aggregation. Rows with the same values in these columns will be
|
|
438
|
+
# grouped together.
|
|
439
|
+
# @return [Array<String>]
|
|
440
|
+
#
|
|
441
|
+
# @!attribute [rw] aggregations
|
|
442
|
+
# The list of aggregation functions to apply to the grouped data, such
|
|
443
|
+
# as `SUM`, `COUNT`, or `AVERAGE`.
|
|
444
|
+
# @return [Array<Types::Aggregation>]
|
|
445
|
+
#
|
|
446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AggregateOperation AWS API Documentation
|
|
447
|
+
#
|
|
448
|
+
class AggregateOperation < Struct.new(
|
|
449
|
+
:alias,
|
|
450
|
+
:source,
|
|
451
|
+
:group_by_column_names,
|
|
452
|
+
:aggregations)
|
|
453
|
+
SENSITIVE = []
|
|
454
|
+
include Aws::Structure
|
|
455
|
+
end
|
|
456
|
+
|
|
457
|
+
# Defines an aggregation function to be applied to grouped data,
|
|
458
|
+
# creating a new column with the calculated result.
|
|
459
|
+
#
|
|
460
|
+
# @!attribute [rw] aggregation_function
|
|
461
|
+
# The aggregation function to apply, such as `SUM`, `COUNT`,
|
|
462
|
+
# `AVERAGE`, `MIN`, `MAX`
|
|
463
|
+
# @return [Types::DataPrepAggregationFunction]
|
|
464
|
+
#
|
|
465
|
+
# @!attribute [rw] new_column_name
|
|
466
|
+
# The name for the new column that will contain the aggregated values.
|
|
467
|
+
# @return [String]
|
|
468
|
+
#
|
|
469
|
+
# @!attribute [rw] new_column_id
|
|
470
|
+
# A unique identifier for the new column that will contain the
|
|
471
|
+
# aggregated values.
|
|
472
|
+
# @return [String]
|
|
473
|
+
#
|
|
474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Aggregation AWS API Documentation
|
|
475
|
+
#
|
|
476
|
+
class Aggregation < Struct.new(
|
|
477
|
+
:aggregation_function,
|
|
478
|
+
:new_column_name,
|
|
479
|
+
:new_column_id)
|
|
480
|
+
SENSITIVE = []
|
|
481
|
+
include Aws::Structure
|
|
482
|
+
end
|
|
483
|
+
|
|
423
484
|
# An aggregation function aggregates values from a dimension or measure.
|
|
424
485
|
#
|
|
425
486
|
# This is a union type structure. For this structure to be valid, only
|
|
@@ -1052,7 +1113,7 @@ module Aws::QuickSight
|
|
|
1052
1113
|
end
|
|
1053
1114
|
|
|
1054
1115
|
# The type of experience you want to embed. For anonymous users, you can
|
|
1055
|
-
# embed
|
|
1116
|
+
# embed Quick Suite dashboards.
|
|
1056
1117
|
#
|
|
1057
1118
|
# @!attribute [rw] dashboard
|
|
1058
1119
|
# The type of embedding experience. In this case, Amazon Quick Sight
|
|
@@ -1149,6 +1210,57 @@ module Aws::QuickSight
|
|
|
1149
1210
|
include Aws::Structure
|
|
1150
1211
|
end
|
|
1151
1212
|
|
|
1213
|
+
# A transform operation that combines rows from two data sources by
|
|
1214
|
+
# stacking them vertically (union operation).
|
|
1215
|
+
#
|
|
1216
|
+
# @!attribute [rw] alias
|
|
1217
|
+
# Alias for this operation.
|
|
1218
|
+
# @return [String]
|
|
1219
|
+
#
|
|
1220
|
+
# @!attribute [rw] first_source
|
|
1221
|
+
# The first data source to be included in the append operation.
|
|
1222
|
+
# @return [Types::TransformOperationSource]
|
|
1223
|
+
#
|
|
1224
|
+
# @!attribute [rw] second_source
|
|
1225
|
+
# The second data source to be appended to the first source.
|
|
1226
|
+
# @return [Types::TransformOperationSource]
|
|
1227
|
+
#
|
|
1228
|
+
# @!attribute [rw] appended_columns
|
|
1229
|
+
# The list of columns to include in the appended result, mapping
|
|
1230
|
+
# columns from both sources.
|
|
1231
|
+
# @return [Array<Types::AppendedColumn>]
|
|
1232
|
+
#
|
|
1233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AppendOperation AWS API Documentation
|
|
1234
|
+
#
|
|
1235
|
+
class AppendOperation < Struct.new(
|
|
1236
|
+
:alias,
|
|
1237
|
+
:first_source,
|
|
1238
|
+
:second_source,
|
|
1239
|
+
:appended_columns)
|
|
1240
|
+
SENSITIVE = []
|
|
1241
|
+
include Aws::Structure
|
|
1242
|
+
end
|
|
1243
|
+
|
|
1244
|
+
# Represents a column that will be included in the result of an append
|
|
1245
|
+
# operation, combining data from multiple sources.
|
|
1246
|
+
#
|
|
1247
|
+
# @!attribute [rw] column_name
|
|
1248
|
+
# The name of the column to include in the appended result.
|
|
1249
|
+
# @return [String]
|
|
1250
|
+
#
|
|
1251
|
+
# @!attribute [rw] new_column_id
|
|
1252
|
+
# A unique identifier for the column in the appended result.
|
|
1253
|
+
# @return [String]
|
|
1254
|
+
#
|
|
1255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AppendedColumn AWS API Documentation
|
|
1256
|
+
#
|
|
1257
|
+
class AppendedColumn < Struct.new(
|
|
1258
|
+
:column_name,
|
|
1259
|
+
:new_column_id)
|
|
1260
|
+
SENSITIVE = []
|
|
1261
|
+
include Aws::Structure
|
|
1262
|
+
end
|
|
1263
|
+
|
|
1152
1264
|
# The application theme.
|
|
1153
1265
|
#
|
|
1154
1266
|
# @!attribute [rw] brand_color_palette
|
|
@@ -4081,7 +4193,7 @@ module Aws::QuickSight
|
|
|
4081
4193
|
# The details of the brand.
|
|
4082
4194
|
#
|
|
4083
4195
|
# @!attribute [rw] brand_id
|
|
4084
|
-
# The ID of the
|
|
4196
|
+
# The ID of the Quick Suite brand.
|
|
4085
4197
|
# @return [String]
|
|
4086
4198
|
#
|
|
4087
4199
|
# @!attribute [rw] arn
|
|
@@ -4154,7 +4266,7 @@ module Aws::QuickSight
|
|
|
4154
4266
|
# @return [String]
|
|
4155
4267
|
#
|
|
4156
4268
|
# @!attribute [rw] brand_id
|
|
4157
|
-
# The ID of the
|
|
4269
|
+
# The ID of the Quick Suite brand.
|
|
4158
4270
|
# @return [String]
|
|
4159
4271
|
#
|
|
4160
4272
|
# @!attribute [rw] brand_name
|
|
@@ -4581,6 +4693,32 @@ module Aws::QuickSight
|
|
|
4581
4693
|
include Aws::Structure
|
|
4582
4694
|
end
|
|
4583
4695
|
|
|
4696
|
+
# A transform operation that changes the data types of one or more
|
|
4697
|
+
# columns in the dataset.
|
|
4698
|
+
#
|
|
4699
|
+
# @!attribute [rw] alias
|
|
4700
|
+
# Alias for this operation.
|
|
4701
|
+
# @return [String]
|
|
4702
|
+
#
|
|
4703
|
+
# @!attribute [rw] source
|
|
4704
|
+
# The source transform operation that provides input data for the type
|
|
4705
|
+
# casting.
|
|
4706
|
+
# @return [Types::TransformOperationSource]
|
|
4707
|
+
#
|
|
4708
|
+
# @!attribute [rw] cast_column_type_operations
|
|
4709
|
+
# The list of column type casting operations to perform.
|
|
4710
|
+
# @return [Array<Types::CastColumnTypeOperation>]
|
|
4711
|
+
#
|
|
4712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CastColumnTypesOperation AWS API Documentation
|
|
4713
|
+
#
|
|
4714
|
+
class CastColumnTypesOperation < Struct.new(
|
|
4715
|
+
:alias,
|
|
4716
|
+
:source,
|
|
4717
|
+
:cast_column_type_operations)
|
|
4718
|
+
SENSITIVE = []
|
|
4719
|
+
include Aws::Structure
|
|
4720
|
+
end
|
|
4721
|
+
|
|
4584
4722
|
# The dimension type field with categorical type columns..
|
|
4585
4723
|
#
|
|
4586
4724
|
# @!attribute [rw] field_id
|
|
@@ -5216,6 +5354,27 @@ module Aws::QuickSight
|
|
|
5216
5354
|
include Aws::Structure
|
|
5217
5355
|
end
|
|
5218
5356
|
|
|
5357
|
+
# Specifies a column to be unpivoted, transforming it from a column into
|
|
5358
|
+
# rows with associated values.
|
|
5359
|
+
#
|
|
5360
|
+
# @!attribute [rw] column_name
|
|
5361
|
+
# The name of the column to unpivot from the source data.
|
|
5362
|
+
# @return [String]
|
|
5363
|
+
#
|
|
5364
|
+
# @!attribute [rw] new_value
|
|
5365
|
+
# The value to assign to this column in the unpivoted result,
|
|
5366
|
+
# typically the column name or a descriptive label.
|
|
5367
|
+
# @return [String]
|
|
5368
|
+
#
|
|
5369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnToUnpivot AWS API Documentation
|
|
5370
|
+
#
|
|
5371
|
+
class ColumnToUnpivot < Struct.new(
|
|
5372
|
+
:column_name,
|
|
5373
|
+
:new_value)
|
|
5374
|
+
SENSITIVE = []
|
|
5375
|
+
include Aws::Structure
|
|
5376
|
+
end
|
|
5377
|
+
|
|
5219
5378
|
# The tooltip item for the columns that are not part of a field well.
|
|
5220
5379
|
#
|
|
5221
5380
|
# @!attribute [rw] column
|
|
@@ -6495,7 +6654,7 @@ module Aws::QuickSight
|
|
|
6495
6654
|
# @return [String]
|
|
6496
6655
|
#
|
|
6497
6656
|
# @!attribute [rw] brand_id
|
|
6498
|
-
# The ID of the
|
|
6657
|
+
# The ID of the Quick Suite brand.
|
|
6499
6658
|
# @return [String]
|
|
6500
6659
|
#
|
|
6501
6660
|
# @!attribute [rw] brand_definition
|
|
@@ -6542,6 +6701,15 @@ module Aws::QuickSight
|
|
|
6542
6701
|
# A transform operation that creates calculated columns. Columns created
|
|
6543
6702
|
# in one such operation form a lexical closure.
|
|
6544
6703
|
#
|
|
6704
|
+
# @!attribute [rw] alias
|
|
6705
|
+
# Alias for this operation.
|
|
6706
|
+
# @return [String]
|
|
6707
|
+
#
|
|
6708
|
+
# @!attribute [rw] source
|
|
6709
|
+
# The source transform operation that provides input data for creating
|
|
6710
|
+
# new calculated columns.
|
|
6711
|
+
# @return [Types::TransformOperationSource]
|
|
6712
|
+
#
|
|
6545
6713
|
# @!attribute [rw] columns
|
|
6546
6714
|
# Calculated columns to create.
|
|
6547
6715
|
# @return [Array<Types::CalculatedColumn>]
|
|
@@ -6549,6 +6717,8 @@ module Aws::QuickSight
|
|
|
6549
6717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateColumnsOperation AWS API Documentation
|
|
6550
6718
|
#
|
|
6551
6719
|
class CreateColumnsOperation < Struct.new(
|
|
6720
|
+
:alias,
|
|
6721
|
+
:source,
|
|
6552
6722
|
:columns)
|
|
6553
6723
|
SENSITIVE = []
|
|
6554
6724
|
include Aws::Structure
|
|
@@ -6811,7 +6981,8 @@ module Aws::QuickSight
|
|
|
6811
6981
|
#
|
|
6812
6982
|
# @!attribute [rw] logical_table_map
|
|
6813
6983
|
# Configures the combination and transformation of the data from the
|
|
6814
|
-
# physical tables.
|
|
6984
|
+
# physical tables. This parameter is used with the legacy data
|
|
6985
|
+
# preparation experience.
|
|
6815
6986
|
# @return [Hash<String,Types::LogicalTable>]
|
|
6816
6987
|
#
|
|
6817
6988
|
# @!attribute [rw] import_mode
|
|
@@ -6834,13 +7005,15 @@ module Aws::QuickSight
|
|
|
6834
7005
|
#
|
|
6835
7006
|
# @!attribute [rw] row_level_permission_data_set
|
|
6836
7007
|
# The row-level security configuration for the data that you want to
|
|
6837
|
-
# create.
|
|
7008
|
+
# create. This parameter is used with the legacy data preparation
|
|
7009
|
+
# experience.
|
|
6838
7010
|
# @return [Types::RowLevelPermissionDataSet]
|
|
6839
7011
|
#
|
|
6840
7012
|
# @!attribute [rw] row_level_permission_tag_configuration
|
|
6841
7013
|
# The configuration of tags on a dataset to set row-level security.
|
|
6842
7014
|
# Row-level security tags are currently supported for anonymous
|
|
6843
|
-
# embedding only.
|
|
7015
|
+
# embedding only. This parameter is used with the legacy data
|
|
7016
|
+
# preparation experience.
|
|
6844
7017
|
# @return [Types::RowLevelPermissionTagConfiguration]
|
|
6845
7018
|
#
|
|
6846
7019
|
# @!attribute [rw] column_level_permission_rules
|
|
@@ -6876,6 +7049,20 @@ module Aws::QuickSight
|
|
|
6876
7049
|
# permission datasets.
|
|
6877
7050
|
# @return [String]
|
|
6878
7051
|
#
|
|
7052
|
+
# @!attribute [rw] data_prep_configuration
|
|
7053
|
+
# The data preparation configuration for the dataset. This
|
|
7054
|
+
# configuration defines the source tables, transformation steps, and
|
|
7055
|
+
# destination tables used to prepare the data. Required when using the
|
|
7056
|
+
# new data preparation experience.
|
|
7057
|
+
# @return [Types::DataPrepConfiguration]
|
|
7058
|
+
#
|
|
7059
|
+
# @!attribute [rw] semantic_model_configuration
|
|
7060
|
+
# The semantic model configuration for the dataset. This configuration
|
|
7061
|
+
# defines how the prepared data is structured for an analysis,
|
|
7062
|
+
# including table mappings and row-level security configurations.
|
|
7063
|
+
# Required when using the new data preparation experience.
|
|
7064
|
+
# @return [Types::SemanticModelConfiguration]
|
|
7065
|
+
#
|
|
6879
7066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
|
6880
7067
|
#
|
|
6881
7068
|
class CreateDataSetRequest < Struct.new(
|
|
@@ -6896,7 +7083,9 @@ module Aws::QuickSight
|
|
|
6896
7083
|
:dataset_parameters,
|
|
6897
7084
|
:folder_arns,
|
|
6898
7085
|
:performance_configuration,
|
|
6899
|
-
:use_as
|
|
7086
|
+
:use_as,
|
|
7087
|
+
:data_prep_configuration,
|
|
7088
|
+
:semantic_model_configuration)
|
|
6900
7089
|
SENSITIVE = []
|
|
6901
7090
|
include Aws::Structure
|
|
6902
7091
|
end
|
|
@@ -8708,7 +8897,7 @@ module Aws::QuickSight
|
|
|
8708
8897
|
:name,
|
|
8709
8898
|
:sql_query,
|
|
8710
8899
|
:columns)
|
|
8711
|
-
SENSITIVE = []
|
|
8900
|
+
SENSITIVE = [:sql_query]
|
|
8712
8901
|
include Aws::Structure
|
|
8713
8902
|
end
|
|
8714
8903
|
|
|
@@ -9259,15 +9448,15 @@ module Aws::QuickSight
|
|
|
9259
9448
|
# The ID of the dashboard that has the visual that you want to embed.
|
|
9260
9449
|
# The `DashboardId` can be found in the `IDs for developers` section
|
|
9261
9450
|
# of the `Embed visual` pane of the visual's on-visual menu of the
|
|
9262
|
-
#
|
|
9451
|
+
# Quick Suite console. You can also get the `DashboardId` with a
|
|
9263
9452
|
# `ListDashboards` API operation.
|
|
9264
9453
|
# @return [String]
|
|
9265
9454
|
#
|
|
9266
9455
|
# @!attribute [rw] sheet_id
|
|
9267
9456
|
# The ID of the sheet that the has visual that you want to embed. The
|
|
9268
9457
|
# `SheetId` can be found in the `IDs for developers` section of the
|
|
9269
|
-
# `Embed visual` pane of the visual's on-visual menu of the
|
|
9270
|
-
#
|
|
9458
|
+
# `Embed visual` pane of the visual's on-visual menu of the Quick
|
|
9459
|
+
# Suite console.
|
|
9271
9460
|
# @return [String]
|
|
9272
9461
|
#
|
|
9273
9462
|
# @!attribute [rw] visual_id
|
|
@@ -9735,6 +9924,103 @@ module Aws::QuickSight
|
|
|
9735
9924
|
include Aws::Structure
|
|
9736
9925
|
end
|
|
9737
9926
|
|
|
9927
|
+
# Defines the type of aggregation function to apply to data during data
|
|
9928
|
+
# preparation, supporting simple and list aggregations.
|
|
9929
|
+
#
|
|
9930
|
+
# @!attribute [rw] simple_aggregation
|
|
9931
|
+
# A simple aggregation function such as `SUM`, `COUNT`, `AVERAGE`,
|
|
9932
|
+
# `MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or `STANDARD_DEVIATION`.
|
|
9933
|
+
# @return [Types::DataPrepSimpleAggregationFunction]
|
|
9934
|
+
#
|
|
9935
|
+
# @!attribute [rw] list_aggregation
|
|
9936
|
+
# A list aggregation function that concatenates values from multiple
|
|
9937
|
+
# rows into a single delimited string.
|
|
9938
|
+
# @return [Types::DataPrepListAggregationFunction]
|
|
9939
|
+
#
|
|
9940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepAggregationFunction AWS API Documentation
|
|
9941
|
+
#
|
|
9942
|
+
class DataPrepAggregationFunction < Struct.new(
|
|
9943
|
+
:simple_aggregation,
|
|
9944
|
+
:list_aggregation)
|
|
9945
|
+
SENSITIVE = []
|
|
9946
|
+
include Aws::Structure
|
|
9947
|
+
end
|
|
9948
|
+
|
|
9949
|
+
# Configuration for data preparation operations, defining the complete
|
|
9950
|
+
# pipeline from source tables through transformations to destination
|
|
9951
|
+
# tables.
|
|
9952
|
+
#
|
|
9953
|
+
# @!attribute [rw] source_table_map
|
|
9954
|
+
# A map of source tables that provide information about underlying
|
|
9955
|
+
# sources.
|
|
9956
|
+
# @return [Hash<String,Types::SourceTable>]
|
|
9957
|
+
#
|
|
9958
|
+
# @!attribute [rw] transform_step_map
|
|
9959
|
+
# A map of transformation steps that process the data.
|
|
9960
|
+
# @return [Hash<String,Types::TransformStep>]
|
|
9961
|
+
#
|
|
9962
|
+
# @!attribute [rw] destination_table_map
|
|
9963
|
+
# A map of destination tables that receive the final prepared data.
|
|
9964
|
+
# @return [Hash<String,Types::DestinationTable>]
|
|
9965
|
+
#
|
|
9966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepConfiguration AWS API Documentation
|
|
9967
|
+
#
|
|
9968
|
+
class DataPrepConfiguration < Struct.new(
|
|
9969
|
+
:source_table_map,
|
|
9970
|
+
:transform_step_map,
|
|
9971
|
+
:destination_table_map)
|
|
9972
|
+
SENSITIVE = []
|
|
9973
|
+
include Aws::Structure
|
|
9974
|
+
end
|
|
9975
|
+
|
|
9976
|
+
# An aggregation function that concatenates values from multiple rows
|
|
9977
|
+
# into a single string with a specified separator.
|
|
9978
|
+
#
|
|
9979
|
+
# @!attribute [rw] input_column_name
|
|
9980
|
+
# The name of the column containing values to be concatenated.
|
|
9981
|
+
# @return [String]
|
|
9982
|
+
#
|
|
9983
|
+
# @!attribute [rw] separator
|
|
9984
|
+
# The string used to separate values in the concatenated result.
|
|
9985
|
+
# @return [String]
|
|
9986
|
+
#
|
|
9987
|
+
# @!attribute [rw] distinct
|
|
9988
|
+
# Whether to include only distinct values in the concatenated result,
|
|
9989
|
+
# removing duplicates.
|
|
9990
|
+
# @return [Boolean]
|
|
9991
|
+
#
|
|
9992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepListAggregationFunction AWS API Documentation
|
|
9993
|
+
#
|
|
9994
|
+
class DataPrepListAggregationFunction < Struct.new(
|
|
9995
|
+
:input_column_name,
|
|
9996
|
+
:separator,
|
|
9997
|
+
:distinct)
|
|
9998
|
+
SENSITIVE = []
|
|
9999
|
+
include Aws::Structure
|
|
10000
|
+
end
|
|
10001
|
+
|
|
10002
|
+
# A simple aggregation function that performs standard statistical
|
|
10003
|
+
# operations on a column.
|
|
10004
|
+
#
|
|
10005
|
+
# @!attribute [rw] input_column_name
|
|
10006
|
+
# The name of the column on which to perform the aggregation function.
|
|
10007
|
+
# @return [String]
|
|
10008
|
+
#
|
|
10009
|
+
# @!attribute [rw] function_type
|
|
10010
|
+
# The type of aggregation function to perform, such as `COUNT`, `SUM`,
|
|
10011
|
+
# `AVERAGE`, `MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or
|
|
10012
|
+
# `STANDARD_DEVIATION`.
|
|
10013
|
+
# @return [String]
|
|
10014
|
+
#
|
|
10015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepSimpleAggregationFunction AWS API Documentation
|
|
10016
|
+
#
|
|
10017
|
+
class DataPrepSimpleAggregationFunction < Struct.new(
|
|
10018
|
+
:input_column_name,
|
|
10019
|
+
:function_type)
|
|
10020
|
+
SENSITIVE = []
|
|
10021
|
+
include Aws::Structure
|
|
10022
|
+
end
|
|
10023
|
+
|
|
9738
10024
|
# Adds Q&A capabilities to a dashboard. If no topic is linked,
|
|
9739
10025
|
# Dashboard Q&A uses the data values that are rendered on the
|
|
9740
10026
|
# dashboard. End users can use Dashboard Q&A to ask for different
|
|
@@ -9853,6 +10139,14 @@ module Aws::QuickSight
|
|
|
9853
10139
|
# The usage of the dataset.
|
|
9854
10140
|
# @return [String]
|
|
9855
10141
|
#
|
|
10142
|
+
# @!attribute [rw] data_prep_configuration
|
|
10143
|
+
# The data preparation configuration associated with this dataset.
|
|
10144
|
+
# @return [Types::DataPrepConfiguration]
|
|
10145
|
+
#
|
|
10146
|
+
# @!attribute [rw] semantic_model_configuration
|
|
10147
|
+
# The semantic model configuration associated with this dataset.
|
|
10148
|
+
# @return [Types::SemanticModelConfiguration]
|
|
10149
|
+
#
|
|
9856
10150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
|
9857
10151
|
#
|
|
9858
10152
|
class DataSet < Struct.new(
|
|
@@ -9874,7 +10168,29 @@ module Aws::QuickSight
|
|
|
9874
10168
|
:data_set_usage_configuration,
|
|
9875
10169
|
:dataset_parameters,
|
|
9876
10170
|
:performance_configuration,
|
|
9877
|
-
:use_as
|
|
10171
|
+
:use_as,
|
|
10172
|
+
:data_prep_configuration,
|
|
10173
|
+
:semantic_model_configuration)
|
|
10174
|
+
SENSITIVE = []
|
|
10175
|
+
include Aws::Structure
|
|
10176
|
+
end
|
|
10177
|
+
|
|
10178
|
+
# Maps a source column identifier to a target column identifier during
|
|
10179
|
+
# transform operations.
|
|
10180
|
+
#
|
|
10181
|
+
# @!attribute [rw] source_column_id
|
|
10182
|
+
# Source column ID.
|
|
10183
|
+
# @return [String]
|
|
10184
|
+
#
|
|
10185
|
+
# @!attribute [rw] target_column_id
|
|
10186
|
+
# Target column ID.
|
|
10187
|
+
# @return [String]
|
|
10188
|
+
#
|
|
10189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetColumnIdMapping AWS API Documentation
|
|
10190
|
+
#
|
|
10191
|
+
class DataSetColumnIdMapping < Struct.new(
|
|
10192
|
+
:source_column_id,
|
|
10193
|
+
:target_column_id)
|
|
9878
10194
|
SENSITIVE = []
|
|
9879
10195
|
include Aws::Structure
|
|
9880
10196
|
end
|
|
@@ -9903,6 +10219,96 @@ module Aws::QuickSight
|
|
|
9903
10219
|
include Aws::Structure
|
|
9904
10220
|
end
|
|
9905
10221
|
|
|
10222
|
+
# A filter condition that compares date values using operators like
|
|
10223
|
+
# `BEFORE`, `AFTER`, or their inclusive variants.
|
|
10224
|
+
#
|
|
10225
|
+
# @!attribute [rw] operator
|
|
10226
|
+
# The comparison operator to use, such as `BEFORE`,
|
|
10227
|
+
# `BEFORE_OR_EQUALS_TO`, `AFTER`, or `AFTER_OR_EQUALS_TO`.
|
|
10228
|
+
# @return [String]
|
|
10229
|
+
#
|
|
10230
|
+
# @!attribute [rw] value
|
|
10231
|
+
# The date value to compare against.
|
|
10232
|
+
# @return [Types::DataSetDateFilterValue]
|
|
10233
|
+
#
|
|
10234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateComparisonFilterCondition AWS API Documentation
|
|
10235
|
+
#
|
|
10236
|
+
class DataSetDateComparisonFilterCondition < Struct.new(
|
|
10237
|
+
:operator,
|
|
10238
|
+
:value)
|
|
10239
|
+
SENSITIVE = []
|
|
10240
|
+
include Aws::Structure
|
|
10241
|
+
end
|
|
10242
|
+
|
|
10243
|
+
# A filter condition for date columns, supporting both comparison and
|
|
10244
|
+
# range-based filtering.
|
|
10245
|
+
#
|
|
10246
|
+
# @!attribute [rw] column_name
|
|
10247
|
+
# The name of the date column to filter.
|
|
10248
|
+
# @return [String]
|
|
10249
|
+
#
|
|
10250
|
+
# @!attribute [rw] comparison_filter_condition
|
|
10251
|
+
# A comparison-based filter condition for the date column.
|
|
10252
|
+
# @return [Types::DataSetDateComparisonFilterCondition]
|
|
10253
|
+
#
|
|
10254
|
+
# @!attribute [rw] range_filter_condition
|
|
10255
|
+
# A range-based filter condition for the date column, filtering values
|
|
10256
|
+
# between minimum and maximum dates.
|
|
10257
|
+
# @return [Types::DataSetDateRangeFilterCondition]
|
|
10258
|
+
#
|
|
10259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateFilterCondition AWS API Documentation
|
|
10260
|
+
#
|
|
10261
|
+
class DataSetDateFilterCondition < Struct.new(
|
|
10262
|
+
:column_name,
|
|
10263
|
+
:comparison_filter_condition,
|
|
10264
|
+
:range_filter_condition)
|
|
10265
|
+
SENSITIVE = []
|
|
10266
|
+
include Aws::Structure
|
|
10267
|
+
end
|
|
10268
|
+
|
|
10269
|
+
# Represents a date value used in filter conditions.
|
|
10270
|
+
#
|
|
10271
|
+
# @!attribute [rw] static_value
|
|
10272
|
+
# A static date value used for filtering.
|
|
10273
|
+
# @return [Time]
|
|
10274
|
+
#
|
|
10275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateFilterValue AWS API Documentation
|
|
10276
|
+
#
|
|
10277
|
+
class DataSetDateFilterValue < Struct.new(
|
|
10278
|
+
:static_value)
|
|
10279
|
+
SENSITIVE = [:static_value]
|
|
10280
|
+
include Aws::Structure
|
|
10281
|
+
end
|
|
10282
|
+
|
|
10283
|
+
# A filter condition that filters date values within a specified range.
|
|
10284
|
+
#
|
|
10285
|
+
# @!attribute [rw] range_minimum
|
|
10286
|
+
# The minimum date value for the range filter.
|
|
10287
|
+
# @return [Types::DataSetDateFilterValue]
|
|
10288
|
+
#
|
|
10289
|
+
# @!attribute [rw] range_maximum
|
|
10290
|
+
# The maximum date value for the range filter.
|
|
10291
|
+
# @return [Types::DataSetDateFilterValue]
|
|
10292
|
+
#
|
|
10293
|
+
# @!attribute [rw] include_minimum
|
|
10294
|
+
# Whether to include the minimum value in the filter range.
|
|
10295
|
+
# @return [Boolean]
|
|
10296
|
+
#
|
|
10297
|
+
# @!attribute [rw] include_maximum
|
|
10298
|
+
# Whether to include the maximum value in the filter range.
|
|
10299
|
+
# @return [Boolean]
|
|
10300
|
+
#
|
|
10301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateRangeFilterCondition AWS API Documentation
|
|
10302
|
+
#
|
|
10303
|
+
class DataSetDateRangeFilterCondition < Struct.new(
|
|
10304
|
+
:range_minimum,
|
|
10305
|
+
:range_maximum,
|
|
10306
|
+
:include_minimum,
|
|
10307
|
+
:include_maximum)
|
|
10308
|
+
SENSITIVE = []
|
|
10309
|
+
include Aws::Structure
|
|
10310
|
+
end
|
|
10311
|
+
|
|
9906
10312
|
# A data set.
|
|
9907
10313
|
#
|
|
9908
10314
|
# @!attribute [rw] identifier
|
|
@@ -9922,6 +10328,97 @@ module Aws::QuickSight
|
|
|
9922
10328
|
include Aws::Structure
|
|
9923
10329
|
end
|
|
9924
10330
|
|
|
10331
|
+
# A filter condition that compares numeric values using operators like
|
|
10332
|
+
# `EQUALS`, `GREATER_THAN`, or `LESS_THAN`.
|
|
10333
|
+
#
|
|
10334
|
+
# @!attribute [rw] operator
|
|
10335
|
+
# The comparison operator to use, such as `EQUALS`, `GREATER_THAN`,
|
|
10336
|
+
# `LESS_THAN`, or their variants.
|
|
10337
|
+
# @return [String]
|
|
10338
|
+
#
|
|
10339
|
+
# @!attribute [rw] value
|
|
10340
|
+
# The numeric value to compare against.
|
|
10341
|
+
# @return [Types::DataSetNumericFilterValue]
|
|
10342
|
+
#
|
|
10343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericComparisonFilterCondition AWS API Documentation
|
|
10344
|
+
#
|
|
10345
|
+
class DataSetNumericComparisonFilterCondition < Struct.new(
|
|
10346
|
+
:operator,
|
|
10347
|
+
:value)
|
|
10348
|
+
SENSITIVE = []
|
|
10349
|
+
include Aws::Structure
|
|
10350
|
+
end
|
|
10351
|
+
|
|
10352
|
+
# A filter condition for numeric columns, supporting both comparison and
|
|
10353
|
+
# range-based filtering.
|
|
10354
|
+
#
|
|
10355
|
+
# @!attribute [rw] column_name
|
|
10356
|
+
# The name of the numeric column to filter.
|
|
10357
|
+
# @return [String]
|
|
10358
|
+
#
|
|
10359
|
+
# @!attribute [rw] comparison_filter_condition
|
|
10360
|
+
# A comparison-based filter condition for the numeric column.
|
|
10361
|
+
# @return [Types::DataSetNumericComparisonFilterCondition]
|
|
10362
|
+
#
|
|
10363
|
+
# @!attribute [rw] range_filter_condition
|
|
10364
|
+
# A range-based filter condition for the numeric column, filtering
|
|
10365
|
+
# values between minimum and maximum numbers.
|
|
10366
|
+
# @return [Types::DataSetNumericRangeFilterCondition]
|
|
10367
|
+
#
|
|
10368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericFilterCondition AWS API Documentation
|
|
10369
|
+
#
|
|
10370
|
+
class DataSetNumericFilterCondition < Struct.new(
|
|
10371
|
+
:column_name,
|
|
10372
|
+
:comparison_filter_condition,
|
|
10373
|
+
:range_filter_condition)
|
|
10374
|
+
SENSITIVE = []
|
|
10375
|
+
include Aws::Structure
|
|
10376
|
+
end
|
|
10377
|
+
|
|
10378
|
+
# Represents a numeric value used in filter conditions.
|
|
10379
|
+
#
|
|
10380
|
+
# @!attribute [rw] static_value
|
|
10381
|
+
# A static numeric value used for filtering.
|
|
10382
|
+
# @return [Float]
|
|
10383
|
+
#
|
|
10384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericFilterValue AWS API Documentation
|
|
10385
|
+
#
|
|
10386
|
+
class DataSetNumericFilterValue < Struct.new(
|
|
10387
|
+
:static_value)
|
|
10388
|
+
SENSITIVE = [:static_value]
|
|
10389
|
+
include Aws::Structure
|
|
10390
|
+
end
|
|
10391
|
+
|
|
10392
|
+
# A filter condition that filters numeric values within a specified
|
|
10393
|
+
# range.
|
|
10394
|
+
#
|
|
10395
|
+
# @!attribute [rw] range_minimum
|
|
10396
|
+
# The minimum numeric value for the range filter.
|
|
10397
|
+
# @return [Types::DataSetNumericFilterValue]
|
|
10398
|
+
#
|
|
10399
|
+
# @!attribute [rw] range_maximum
|
|
10400
|
+
# The maximum numeric value for the range filter.
|
|
10401
|
+
# @return [Types::DataSetNumericFilterValue]
|
|
10402
|
+
#
|
|
10403
|
+
# @!attribute [rw] include_minimum
|
|
10404
|
+
# Whether to include the minimum value in the filter range.
|
|
10405
|
+
# @return [Boolean]
|
|
10406
|
+
#
|
|
10407
|
+
# @!attribute [rw] include_maximum
|
|
10408
|
+
# Whether to include the maximum value in the filter range.
|
|
10409
|
+
# @return [Boolean]
|
|
10410
|
+
#
|
|
10411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericRangeFilterCondition AWS API Documentation
|
|
10412
|
+
#
|
|
10413
|
+
class DataSetNumericRangeFilterCondition < Struct.new(
|
|
10414
|
+
:range_minimum,
|
|
10415
|
+
:range_maximum,
|
|
10416
|
+
:include_minimum,
|
|
10417
|
+
:include_maximum)
|
|
10418
|
+
SENSITIVE = []
|
|
10419
|
+
include Aws::Structure
|
|
10420
|
+
end
|
|
10421
|
+
|
|
9925
10422
|
# Dataset reference.
|
|
9926
10423
|
#
|
|
9927
10424
|
# @!attribute [rw] data_set_placeholder
|
|
@@ -10046,6 +10543,102 @@ module Aws::QuickSight
|
|
|
10046
10543
|
include Aws::Structure
|
|
10047
10544
|
end
|
|
10048
10545
|
|
|
10546
|
+
# A filter condition that compares string values using operators like
|
|
10547
|
+
# `EQUALS`, `CONTAINS`, or `STARTS_WITH`.
|
|
10548
|
+
#
|
|
10549
|
+
# @!attribute [rw] operator
|
|
10550
|
+
# The comparison operator to use, such as `EQUALS`, `CONTAINS`,
|
|
10551
|
+
# `STARTS_WITH`, `ENDS_WITH`, or their negations.
|
|
10552
|
+
# @return [String]
|
|
10553
|
+
#
|
|
10554
|
+
# @!attribute [rw] value
|
|
10555
|
+
# The string value to compare against.
|
|
10556
|
+
# @return [Types::DataSetStringFilterValue]
|
|
10557
|
+
#
|
|
10558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringComparisonFilterCondition AWS API Documentation
|
|
10559
|
+
#
|
|
10560
|
+
class DataSetStringComparisonFilterCondition < Struct.new(
|
|
10561
|
+
:operator,
|
|
10562
|
+
:value)
|
|
10563
|
+
SENSITIVE = []
|
|
10564
|
+
include Aws::Structure
|
|
10565
|
+
end
|
|
10566
|
+
|
|
10567
|
+
# A filter condition for string columns, supporting both comparison and
|
|
10568
|
+
# list-based filtering.
|
|
10569
|
+
#
|
|
10570
|
+
# @!attribute [rw] column_name
|
|
10571
|
+
# The name of the string column to filter.
|
|
10572
|
+
# @return [String]
|
|
10573
|
+
#
|
|
10574
|
+
# @!attribute [rw] comparison_filter_condition
|
|
10575
|
+
# A comparison-based filter condition for the string column.
|
|
10576
|
+
# @return [Types::DataSetStringComparisonFilterCondition]
|
|
10577
|
+
#
|
|
10578
|
+
# @!attribute [rw] list_filter_condition
|
|
10579
|
+
# A list-based filter condition that includes or excludes values from
|
|
10580
|
+
# a specified list.
|
|
10581
|
+
# @return [Types::DataSetStringListFilterCondition]
|
|
10582
|
+
#
|
|
10583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringFilterCondition AWS API Documentation
|
|
10584
|
+
#
|
|
10585
|
+
class DataSetStringFilterCondition < Struct.new(
|
|
10586
|
+
:column_name,
|
|
10587
|
+
:comparison_filter_condition,
|
|
10588
|
+
:list_filter_condition)
|
|
10589
|
+
SENSITIVE = []
|
|
10590
|
+
include Aws::Structure
|
|
10591
|
+
end
|
|
10592
|
+
|
|
10593
|
+
# Represents a string value used in filter conditions.
|
|
10594
|
+
#
|
|
10595
|
+
# @!attribute [rw] static_value
|
|
10596
|
+
# A static string value used for filtering.
|
|
10597
|
+
# @return [String]
|
|
10598
|
+
#
|
|
10599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringFilterValue AWS API Documentation
|
|
10600
|
+
#
|
|
10601
|
+
class DataSetStringFilterValue < Struct.new(
|
|
10602
|
+
:static_value)
|
|
10603
|
+
SENSITIVE = [:static_value]
|
|
10604
|
+
include Aws::Structure
|
|
10605
|
+
end
|
|
10606
|
+
|
|
10607
|
+
# A filter condition that includes or excludes string values from a
|
|
10608
|
+
# specified list.
|
|
10609
|
+
#
|
|
10610
|
+
# @!attribute [rw] operator
|
|
10611
|
+
# The list operator to use, either `INCLUDE` to match values in the
|
|
10612
|
+
# list or `EXCLUDE` to filter out values in the list.
|
|
10613
|
+
# @return [String]
|
|
10614
|
+
#
|
|
10615
|
+
# @!attribute [rw] values
|
|
10616
|
+
# The list of string values to include or exclude in the filter.
|
|
10617
|
+
# @return [Types::DataSetStringListFilterValue]
|
|
10618
|
+
#
|
|
10619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringListFilterCondition AWS API Documentation
|
|
10620
|
+
#
|
|
10621
|
+
class DataSetStringListFilterCondition < Struct.new(
|
|
10622
|
+
:operator,
|
|
10623
|
+
:values)
|
|
10624
|
+
SENSITIVE = []
|
|
10625
|
+
include Aws::Structure
|
|
10626
|
+
end
|
|
10627
|
+
|
|
10628
|
+
# Represents a list of string values used in filter conditions.
|
|
10629
|
+
#
|
|
10630
|
+
# @!attribute [rw] static_values
|
|
10631
|
+
# A list of static string values used for filtering.
|
|
10632
|
+
# @return [Array<String>]
|
|
10633
|
+
#
|
|
10634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringListFilterValue AWS API Documentation
|
|
10635
|
+
#
|
|
10636
|
+
class DataSetStringListFilterValue < Struct.new(
|
|
10637
|
+
:static_values)
|
|
10638
|
+
SENSITIVE = [:static_values]
|
|
10639
|
+
include Aws::Structure
|
|
10640
|
+
end
|
|
10641
|
+
|
|
10049
10642
|
# Dataset summary.
|
|
10050
10643
|
#
|
|
10051
10644
|
# @!attribute [rw] arn
|
|
@@ -10074,9 +10667,15 @@ module Aws::QuickSight
|
|
|
10074
10667
|
# @return [String]
|
|
10075
10668
|
#
|
|
10076
10669
|
# @!attribute [rw] row_level_permission_data_set
|
|
10077
|
-
# The row-level security configuration for the dataset
|
|
10670
|
+
# The row-level security configuration for the dataset in the legacy
|
|
10671
|
+
# data preparation experience.
|
|
10078
10672
|
# @return [Types::RowLevelPermissionDataSet]
|
|
10079
10673
|
#
|
|
10674
|
+
# @!attribute [rw] row_level_permission_data_set_map
|
|
10675
|
+
# The row-level security configuration for the dataset in the new data
|
|
10676
|
+
# preparation experience.
|
|
10677
|
+
# @return [Hash<String,Types::RowLevelPermissionDataSet>]
|
|
10678
|
+
#
|
|
10080
10679
|
# @!attribute [rw] row_level_permission_tag_configuration_applied
|
|
10081
10680
|
# Whether or not the row level permission tags are applied.
|
|
10082
10681
|
# @return [Boolean]
|
|
@@ -10100,6 +10699,7 @@ module Aws::QuickSight
|
|
|
10100
10699
|
:last_updated_time,
|
|
10101
10700
|
:import_mode,
|
|
10102
10701
|
:row_level_permission_data_set,
|
|
10702
|
+
:row_level_permission_data_set_map,
|
|
10103
10703
|
:row_level_permission_tag_configuration_applied,
|
|
10104
10704
|
:column_level_permission_rules_applied,
|
|
10105
10705
|
:use_as)
|
|
@@ -11817,7 +12417,7 @@ module Aws::QuickSight
|
|
|
11817
12417
|
# @return [String]
|
|
11818
12418
|
#
|
|
11819
12419
|
# @!attribute [rw] brand_id
|
|
11820
|
-
# The ID of the
|
|
12420
|
+
# The ID of the Quick Suite brand.
|
|
11821
12421
|
# @return [String]
|
|
11822
12422
|
#
|
|
11823
12423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteBrandRequest AWS API Documentation
|
|
@@ -11972,7 +12572,7 @@ module Aws::QuickSight
|
|
|
11972
12572
|
# @return [String]
|
|
11973
12573
|
#
|
|
11974
12574
|
# @!attribute [rw] data_set_id
|
|
11975
|
-
# The ID for the dataset that you want to
|
|
12575
|
+
# The ID for the dataset that you want to delete. This ID is unique
|
|
11976
12576
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
11977
12577
|
# @return [String]
|
|
11978
12578
|
#
|
|
@@ -11990,7 +12590,7 @@ module Aws::QuickSight
|
|
|
11990
12590
|
# @return [String]
|
|
11991
12591
|
#
|
|
11992
12592
|
# @!attribute [rw] data_set_id
|
|
11993
|
-
# The ID for the dataset that you want to
|
|
12593
|
+
# The ID for the dataset that you want to delete. This ID is unique
|
|
11994
12594
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
11995
12595
|
# @return [String]
|
|
11996
12596
|
#
|
|
@@ -13156,7 +13756,7 @@ module Aws::QuickSight
|
|
|
13156
13756
|
# sometimes referred to as a Quick Sight "account" even though it's
|
|
13157
13757
|
# technically not an account by itself. Instead, it's a subscription
|
|
13158
13758
|
# to the Amazon Quick Sight service for your Amazon Web Services
|
|
13159
|
-
# account. The edition that you subscribe to applies to
|
|
13759
|
+
# account. The edition that you subscribe to applies to Quick Suite in
|
|
13160
13760
|
# every Amazon Web Services Region where you use it.
|
|
13161
13761
|
# @return [Types::AccountSettings]
|
|
13162
13762
|
#
|
|
@@ -13819,7 +14419,7 @@ module Aws::QuickSight
|
|
|
13819
14419
|
# @return [String]
|
|
13820
14420
|
#
|
|
13821
14421
|
# @!attribute [rw] brand_id
|
|
13822
|
-
# The ID of the
|
|
14422
|
+
# The ID of the Quick Suite brand.
|
|
13823
14423
|
# @return [String]
|
|
13824
14424
|
#
|
|
13825
14425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeBrandPublishedVersionRequest AWS API Documentation
|
|
@@ -13858,7 +14458,7 @@ module Aws::QuickSight
|
|
|
13858
14458
|
# @return [String]
|
|
13859
14459
|
#
|
|
13860
14460
|
# @!attribute [rw] brand_id
|
|
13861
|
-
# The ID of the
|
|
14461
|
+
# The ID of the Quick Suite brand.
|
|
13862
14462
|
# @return [String]
|
|
13863
14463
|
#
|
|
13864
14464
|
# @!attribute [rw] version_id
|
|
@@ -14399,7 +14999,7 @@ module Aws::QuickSight
|
|
|
14399
14999
|
# @return [String]
|
|
14400
15000
|
#
|
|
14401
15001
|
# @!attribute [rw] data_set_id
|
|
14402
|
-
# The ID for the dataset that you want to
|
|
15002
|
+
# The ID for the dataset that you want to describe. This ID is unique
|
|
14403
15003
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
14404
15004
|
# @return [String]
|
|
14405
15005
|
#
|
|
@@ -14417,7 +15017,7 @@ module Aws::QuickSight
|
|
|
14417
15017
|
# @return [String]
|
|
14418
15018
|
#
|
|
14419
15019
|
# @!attribute [rw] data_set_id
|
|
14420
|
-
# The ID for the dataset that you want to
|
|
15020
|
+
# The ID for the dataset that you want to describe. This ID is unique
|
|
14421
15021
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
14422
15022
|
# @return [String]
|
|
14423
15023
|
#
|
|
@@ -14489,7 +15089,7 @@ module Aws::QuickSight
|
|
|
14489
15089
|
# @return [String]
|
|
14490
15090
|
#
|
|
14491
15091
|
# @!attribute [rw] data_set_id
|
|
14492
|
-
# The ID for the dataset that you want to
|
|
15092
|
+
# The ID for the dataset that you want to describe. This ID is unique
|
|
14493
15093
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
14494
15094
|
# @return [String]
|
|
14495
15095
|
#
|
|
@@ -16093,6 +16693,43 @@ module Aws::QuickSight
|
|
|
16093
16693
|
include Aws::Structure
|
|
16094
16694
|
end
|
|
16095
16695
|
|
|
16696
|
+
# Defines a destination table in data preparation that receives the
|
|
16697
|
+
# final transformed data.
|
|
16698
|
+
#
|
|
16699
|
+
# @!attribute [rw] alias
|
|
16700
|
+
# Alias for the destination table.
|
|
16701
|
+
# @return [String]
|
|
16702
|
+
#
|
|
16703
|
+
# @!attribute [rw] source
|
|
16704
|
+
# The source configuration that specifies which transform operation
|
|
16705
|
+
# provides data to this destination table.
|
|
16706
|
+
# @return [Types::DestinationTableSource]
|
|
16707
|
+
#
|
|
16708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DestinationTable AWS API Documentation
|
|
16709
|
+
#
|
|
16710
|
+
class DestinationTable < Struct.new(
|
|
16711
|
+
:alias,
|
|
16712
|
+
:source)
|
|
16713
|
+
SENSITIVE = []
|
|
16714
|
+
include Aws::Structure
|
|
16715
|
+
end
|
|
16716
|
+
|
|
16717
|
+
# Specifies the source of data for a destination table, including the
|
|
16718
|
+
# transform operation and column mappings.
|
|
16719
|
+
#
|
|
16720
|
+
# @!attribute [rw] transform_operation_id
|
|
16721
|
+
# The identifier of the transform operation that provides data to the
|
|
16722
|
+
# destination table.
|
|
16723
|
+
# @return [String]
|
|
16724
|
+
#
|
|
16725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DestinationTableSource AWS API Documentation
|
|
16726
|
+
#
|
|
16727
|
+
class DestinationTableSource < Struct.new(
|
|
16728
|
+
:transform_operation_id)
|
|
16729
|
+
SENSITIVE = []
|
|
16730
|
+
include Aws::Structure
|
|
16731
|
+
end
|
|
16732
|
+
|
|
16096
16733
|
# The dimension type field.
|
|
16097
16734
|
#
|
|
16098
16735
|
# @!attribute [rw] numerical_dimension_field
|
|
@@ -17391,10 +18028,25 @@ module Aws::QuickSight
|
|
|
17391
18028
|
# the expression evaluates to true are kept in the dataset.
|
|
17392
18029
|
# @return [String]
|
|
17393
18030
|
#
|
|
18031
|
+
# @!attribute [rw] string_filter_condition
|
|
18032
|
+
# A string-based filter condition within a filter operation.
|
|
18033
|
+
# @return [Types::DataSetStringFilterCondition]
|
|
18034
|
+
#
|
|
18035
|
+
# @!attribute [rw] numeric_filter_condition
|
|
18036
|
+
# A numeric-based filter condition within a filter operation.
|
|
18037
|
+
# @return [Types::DataSetNumericFilterCondition]
|
|
18038
|
+
#
|
|
18039
|
+
# @!attribute [rw] date_filter_condition
|
|
18040
|
+
# A date-based filter condition within a filter operation.
|
|
18041
|
+
# @return [Types::DataSetDateFilterCondition]
|
|
18042
|
+
#
|
|
17394
18043
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperation AWS API Documentation
|
|
17395
18044
|
#
|
|
17396
18045
|
class FilterOperation < Struct.new(
|
|
17397
|
-
:condition_expression
|
|
18046
|
+
:condition_expression,
|
|
18047
|
+
:string_filter_condition,
|
|
18048
|
+
:numeric_filter_condition,
|
|
18049
|
+
:date_filter_condition)
|
|
17398
18050
|
SENSITIVE = [:condition_expression]
|
|
17399
18051
|
include Aws::Structure
|
|
17400
18052
|
end
|
|
@@ -17648,6 +18300,31 @@ module Aws::QuickSight
|
|
|
17648
18300
|
include Aws::Structure
|
|
17649
18301
|
end
|
|
17650
18302
|
|
|
18303
|
+
# A transform operation that applies one or more filter conditions.
|
|
18304
|
+
#
|
|
18305
|
+
# @!attribute [rw] alias
|
|
18306
|
+
# Alias for this operation.
|
|
18307
|
+
# @return [String]
|
|
18308
|
+
#
|
|
18309
|
+
# @!attribute [rw] source
|
|
18310
|
+
# The source transform operation that provides input data for
|
|
18311
|
+
# filtering.
|
|
18312
|
+
# @return [Types::TransformOperationSource]
|
|
18313
|
+
#
|
|
18314
|
+
# @!attribute [rw] filter_operations
|
|
18315
|
+
# The list of filter operations to apply.
|
|
18316
|
+
# @return [Array<Types::FilterOperation>]
|
|
18317
|
+
#
|
|
18318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FiltersOperation AWS API Documentation
|
|
18319
|
+
#
|
|
18320
|
+
class FiltersOperation < Struct.new(
|
|
18321
|
+
:alias,
|
|
18322
|
+
:source,
|
|
18323
|
+
:filter_operations)
|
|
18324
|
+
SENSITIVE = []
|
|
18325
|
+
include Aws::Structure
|
|
18326
|
+
end
|
|
18327
|
+
|
|
17651
18328
|
# The basic information of the flow exluding its definition specifying
|
|
17652
18329
|
# the steps.
|
|
17653
18330
|
#
|
|
@@ -18770,7 +19447,7 @@ module Aws::QuickSight
|
|
|
18770
19447
|
#
|
|
18771
19448
|
# @!attribute [rw] namespace
|
|
18772
19449
|
# The Amazon Quick Sight namespace that the anonymous user virtually
|
|
18773
|
-
# belongs to. If you are not using an Amazon
|
|
19450
|
+
# belongs to. If you are not using an Amazon Quick Suite custom
|
|
18774
19451
|
# namespace, set this to `default`.
|
|
18775
19452
|
# @return [String]
|
|
18776
19453
|
#
|
|
@@ -18847,8 +19524,8 @@ module Aws::QuickSight
|
|
|
18847
19524
|
# @return [String]
|
|
18848
19525
|
#
|
|
18849
19526
|
# @!attribute [rw] anonymous_user_arn
|
|
18850
|
-
# The Amazon Resource Name (ARN) to use for the anonymous Amazon
|
|
18851
|
-
#
|
|
19527
|
+
# The Amazon Resource Name (ARN) to use for the anonymous Amazon Quick
|
|
19528
|
+
# Suite user.
|
|
18852
19529
|
# @return [String]
|
|
18853
19530
|
#
|
|
18854
19531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserResponse AWS API Documentation
|
|
@@ -18878,7 +19555,7 @@ module Aws::QuickSight
|
|
|
18878
19555
|
#
|
|
18879
19556
|
# @!attribute [rw] experience_configuration
|
|
18880
19557
|
# The experience that you want to embed. For registered users, you can
|
|
18881
|
-
# embed
|
|
19558
|
+
# embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon
|
|
18882
19559
|
# Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A
|
|
18883
19560
|
# experience, or the entire Amazon Quick Sight console.
|
|
18884
19561
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
|
@@ -18941,7 +19618,7 @@ module Aws::QuickSight
|
|
|
18941
19618
|
#
|
|
18942
19619
|
# @!attribute [rw] experience_configuration
|
|
18943
19620
|
# The type of experience you want to embed. For registered users, you
|
|
18944
|
-
# can embed
|
|
19621
|
+
# can embed Quick Suite dashboards or the Amazon Quick Sight console.
|
|
18945
19622
|
#
|
|
18946
19623
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
|
18947
19624
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more
|
|
@@ -19983,9 +20660,9 @@ module Aws::QuickSight
|
|
|
19983
20660
|
# @return [Boolean]
|
|
19984
20661
|
#
|
|
19985
20662
|
# @!attribute [rw] user_arn
|
|
19986
|
-
# The Amazon
|
|
20663
|
+
# The Amazon Quick Suite user's Amazon Resource Name (ARN), for use
|
|
19987
20664
|
# with `QUICKSIGHT` identity type. You can use this for any Amazon
|
|
19988
|
-
#
|
|
20665
|
+
# Quick Suite users in your account (readers, authors, or admins)
|
|
19989
20666
|
# authenticated as one of the following:
|
|
19990
20667
|
#
|
|
19991
20668
|
# * Active Directory (AD) users or group members
|
|
@@ -20010,7 +20687,7 @@ module Aws::QuickSight
|
|
|
20010
20687
|
# A list of one or more dashboard IDs that you want anonymous users to
|
|
20011
20688
|
# have tempporary access to. Currently, the `IdentityType` parameter
|
|
20012
20689
|
# must be set to `ANONYMOUS` because other identity types authenticate
|
|
20013
|
-
# as
|
|
20690
|
+
# as Quick Suite or IAM users. For example, if you set
|
|
20014
20691
|
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
|
20015
20692
|
# identity-type ANONYMOUS`", the session can access all three
|
|
20016
20693
|
# dashboards.
|
|
@@ -20223,9 +20900,9 @@ module Aws::QuickSight
|
|
|
20223
20900
|
# @return [Integer]
|
|
20224
20901
|
#
|
|
20225
20902
|
# @!attribute [rw] user_arn
|
|
20226
|
-
# The Amazon
|
|
20903
|
+
# The Amazon Quick Suite user's Amazon Resource Name (ARN), for use
|
|
20227
20904
|
# with `QUICKSIGHT` identity type. You can use this for any type of
|
|
20228
|
-
# Amazon
|
|
20905
|
+
# Amazon Quick Suite users in your account (readers, authors, or
|
|
20229
20906
|
# admins). They need to be authenticated as one of the following:
|
|
20230
20907
|
#
|
|
20231
20908
|
# 1. Active Directory (AD) users or group members
|
|
@@ -20253,7 +20930,7 @@ module Aws::QuickSight
|
|
|
20253
20930
|
|
|
20254
20931
|
# @!attribute [rw] embed_url
|
|
20255
20932
|
# A single-use URL that you can put into your server-side web page to
|
|
20256
|
-
# embed your
|
|
20933
|
+
# embed your Quick Suite session. This URL is valid for 5 minutes. The
|
|
20257
20934
|
# API operation provides the URL with an `auth_code` value that
|
|
20258
20935
|
# enables one (and only one) sign-on to a user session that is valid
|
|
20259
20936
|
# for 10 hours.
|
|
@@ -21320,6 +21997,47 @@ module Aws::QuickSight
|
|
|
21320
21997
|
include Aws::Structure
|
|
21321
21998
|
end
|
|
21322
21999
|
|
|
22000
|
+
# A transform operation that imports data from a source table.
|
|
22001
|
+
#
|
|
22002
|
+
# @!attribute [rw] alias
|
|
22003
|
+
# Alias for this operation.
|
|
22004
|
+
# @return [String]
|
|
22005
|
+
#
|
|
22006
|
+
# @!attribute [rw] source
|
|
22007
|
+
# The source configuration that specifies which source table to import
|
|
22008
|
+
# and any column mappings.
|
|
22009
|
+
# @return [Types::ImportTableOperationSource]
|
|
22010
|
+
#
|
|
22011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ImportTableOperation AWS API Documentation
|
|
22012
|
+
#
|
|
22013
|
+
class ImportTableOperation < Struct.new(
|
|
22014
|
+
:alias,
|
|
22015
|
+
:source)
|
|
22016
|
+
SENSITIVE = []
|
|
22017
|
+
include Aws::Structure
|
|
22018
|
+
end
|
|
22019
|
+
|
|
22020
|
+
# Specifies the source table and column mappings for an import table
|
|
22021
|
+
# operation.
|
|
22022
|
+
#
|
|
22023
|
+
# @!attribute [rw] source_table_id
|
|
22024
|
+
# The identifier of the source table to import data from.
|
|
22025
|
+
# @return [String]
|
|
22026
|
+
#
|
|
22027
|
+
# @!attribute [rw] column_id_mappings
|
|
22028
|
+
# The mappings between source column identifiers and target column
|
|
22029
|
+
# identifiers during the import.
|
|
22030
|
+
# @return [Array<Types::DataSetColumnIdMapping>]
|
|
22031
|
+
#
|
|
22032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ImportTableOperationSource AWS API Documentation
|
|
22033
|
+
#
|
|
22034
|
+
class ImportTableOperationSource < Struct.new(
|
|
22035
|
+
:source_table_id,
|
|
22036
|
+
:column_id_mappings)
|
|
22037
|
+
SENSITIVE = []
|
|
22038
|
+
include Aws::Structure
|
|
22039
|
+
end
|
|
22040
|
+
|
|
21323
22041
|
# The incremental refresh configuration for a dataset.
|
|
21324
22042
|
#
|
|
21325
22043
|
# @!attribute [rw] lookback_window
|
|
@@ -21420,6 +22138,10 @@ module Aws::QuickSight
|
|
|
21420
22138
|
# The name of this column in the underlying data source.
|
|
21421
22139
|
# @return [String]
|
|
21422
22140
|
#
|
|
22141
|
+
# @!attribute [rw] id
|
|
22142
|
+
# A unique identifier for the input column.
|
|
22143
|
+
# @return [String]
|
|
22144
|
+
#
|
|
21423
22145
|
# @!attribute [rw] type
|
|
21424
22146
|
# The data type of the column.
|
|
21425
22147
|
# @return [String]
|
|
@@ -21433,6 +22155,7 @@ module Aws::QuickSight
|
|
|
21433
22155
|
#
|
|
21434
22156
|
class InputColumn < Struct.new(
|
|
21435
22157
|
:name,
|
|
22158
|
+
:id,
|
|
21436
22159
|
:type,
|
|
21437
22160
|
:sub_type)
|
|
21438
22161
|
SENSITIVE = []
|
|
@@ -21698,6 +22421,25 @@ module Aws::QuickSight
|
|
|
21698
22421
|
include Aws::Structure
|
|
21699
22422
|
end
|
|
21700
22423
|
|
|
22424
|
+
# An exception thrown when an invalid parameter value is provided for
|
|
22425
|
+
# dataset operations.
|
|
22426
|
+
#
|
|
22427
|
+
# @!attribute [rw] message
|
|
22428
|
+
# @return [String]
|
|
22429
|
+
#
|
|
22430
|
+
# @!attribute [rw] request_id
|
|
22431
|
+
# The Amazon Web Services request ID for this request.
|
|
22432
|
+
# @return [String]
|
|
22433
|
+
#
|
|
22434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidDataSetParameterValueException AWS API Documentation
|
|
22435
|
+
#
|
|
22436
|
+
class InvalidDataSetParameterValueException < Struct.new(
|
|
22437
|
+
:message,
|
|
22438
|
+
:request_id)
|
|
22439
|
+
SENSITIVE = []
|
|
22440
|
+
include Aws::Structure
|
|
22441
|
+
end
|
|
22442
|
+
|
|
21701
22443
|
# The `NextToken` value isn't valid.
|
|
21702
22444
|
#
|
|
21703
22445
|
# @!attribute [rw] message
|
|
@@ -21866,6 +22608,71 @@ module Aws::QuickSight
|
|
|
21866
22608
|
include Aws::Structure
|
|
21867
22609
|
end
|
|
21868
22610
|
|
|
22611
|
+
# Properties that control how columns are handled for a join operand,
|
|
22612
|
+
# including column name overrides.
|
|
22613
|
+
#
|
|
22614
|
+
# @!attribute [rw] output_column_name_overrides
|
|
22615
|
+
# A list of column name overrides to apply to the join operand's
|
|
22616
|
+
# output columns.
|
|
22617
|
+
# @return [Array<Types::OutputColumnNameOverride>]
|
|
22618
|
+
#
|
|
22619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinOperandProperties AWS API Documentation
|
|
22620
|
+
#
|
|
22621
|
+
class JoinOperandProperties < Struct.new(
|
|
22622
|
+
:output_column_name_overrides)
|
|
22623
|
+
SENSITIVE = []
|
|
22624
|
+
include Aws::Structure
|
|
22625
|
+
end
|
|
22626
|
+
|
|
22627
|
+
# A transform operation that combines data from two sources based on
|
|
22628
|
+
# specified join conditions.
|
|
22629
|
+
#
|
|
22630
|
+
# @!attribute [rw] alias
|
|
22631
|
+
# Alias for this operation.
|
|
22632
|
+
# @return [String]
|
|
22633
|
+
#
|
|
22634
|
+
# @!attribute [rw] left_operand
|
|
22635
|
+
# The left operand for the join operation.
|
|
22636
|
+
# @return [Types::TransformOperationSource]
|
|
22637
|
+
#
|
|
22638
|
+
# @!attribute [rw] right_operand
|
|
22639
|
+
# The right operand for the join operation.
|
|
22640
|
+
# @return [Types::TransformOperationSource]
|
|
22641
|
+
#
|
|
22642
|
+
# @!attribute [rw] type
|
|
22643
|
+
# The type of join to perform, such as `INNER`, `LEFT`, `RIGHT`, or
|
|
22644
|
+
# `OUTER`.
|
|
22645
|
+
# @return [String]
|
|
22646
|
+
#
|
|
22647
|
+
# @!attribute [rw] on_clause
|
|
22648
|
+
# The join condition that specifies how to match rows between the left
|
|
22649
|
+
# and right operands.
|
|
22650
|
+
# @return [String]
|
|
22651
|
+
#
|
|
22652
|
+
# @!attribute [rw] left_operand_properties
|
|
22653
|
+
# Properties that control how the left operand's columns are handled
|
|
22654
|
+
# in the join result.
|
|
22655
|
+
# @return [Types::JoinOperandProperties]
|
|
22656
|
+
#
|
|
22657
|
+
# @!attribute [rw] right_operand_properties
|
|
22658
|
+
# Properties that control how the right operand's columns are handled
|
|
22659
|
+
# in the join result.
|
|
22660
|
+
# @return [Types::JoinOperandProperties]
|
|
22661
|
+
#
|
|
22662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinOperation AWS API Documentation
|
|
22663
|
+
#
|
|
22664
|
+
class JoinOperation < Struct.new(
|
|
22665
|
+
:alias,
|
|
22666
|
+
:left_operand,
|
|
22667
|
+
:right_operand,
|
|
22668
|
+
:type,
|
|
22669
|
+
:on_clause,
|
|
22670
|
+
:left_operand_properties,
|
|
22671
|
+
:right_operand_properties)
|
|
22672
|
+
SENSITIVE = [:on_clause]
|
|
22673
|
+
include Aws::Structure
|
|
22674
|
+
end
|
|
22675
|
+
|
|
21869
22676
|
# The conditional formatting for the actual value of a KPI visual.
|
|
21870
22677
|
#
|
|
21871
22678
|
# @!attribute [rw] text_color
|
|
@@ -26225,6 +27032,10 @@ module Aws::QuickSight
|
|
|
26225
27032
|
# The display name of the column..
|
|
26226
27033
|
# @return [String]
|
|
26227
27034
|
#
|
|
27035
|
+
# @!attribute [rw] id
|
|
27036
|
+
# A unique identifier for the output column.
|
|
27037
|
+
# @return [String]
|
|
27038
|
+
#
|
|
26228
27039
|
# @!attribute [rw] description
|
|
26229
27040
|
# A description for a column.
|
|
26230
27041
|
# @return [String]
|
|
@@ -26241,6 +27052,7 @@ module Aws::QuickSight
|
|
|
26241
27052
|
#
|
|
26242
27053
|
class OutputColumn < Struct.new(
|
|
26243
27054
|
:name,
|
|
27055
|
+
:id,
|
|
26244
27056
|
:description,
|
|
26245
27057
|
:type,
|
|
26246
27058
|
:sub_type)
|
|
@@ -26248,6 +27060,26 @@ module Aws::QuickSight
|
|
|
26248
27060
|
include Aws::Structure
|
|
26249
27061
|
end
|
|
26250
27062
|
|
|
27063
|
+
# Specifies a mapping to override the name of an output column from a
|
|
27064
|
+
# transform operation.
|
|
27065
|
+
#
|
|
27066
|
+
# @!attribute [rw] source_column_name
|
|
27067
|
+
# The original name of the column from the source transform operation.
|
|
27068
|
+
# @return [String]
|
|
27069
|
+
#
|
|
27070
|
+
# @!attribute [rw] output_column_name
|
|
27071
|
+
# The new name to assign to the column in the output.
|
|
27072
|
+
# @return [String]
|
|
27073
|
+
#
|
|
27074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OutputColumnNameOverride AWS API Documentation
|
|
27075
|
+
#
|
|
27076
|
+
class OutputColumnNameOverride < Struct.new(
|
|
27077
|
+
:source_column_name,
|
|
27078
|
+
:output_column_name)
|
|
27079
|
+
SENSITIVE = []
|
|
27080
|
+
include Aws::Structure
|
|
27081
|
+
end
|
|
27082
|
+
|
|
26251
27083
|
# A transform operation that overrides the dataset parameter values that
|
|
26252
27084
|
# are defined in another dataset.
|
|
26253
27085
|
#
|
|
@@ -26767,6 +27599,26 @@ module Aws::QuickSight
|
|
|
26767
27599
|
include Aws::Structure
|
|
26768
27600
|
end
|
|
26769
27601
|
|
|
27602
|
+
# References a parent dataset that serves as a data source, including
|
|
27603
|
+
# its columns and metadata.
|
|
27604
|
+
#
|
|
27605
|
+
# @!attribute [rw] data_set_arn
|
|
27606
|
+
# The Amazon Resource Name (ARN) of the parent dataset.
|
|
27607
|
+
# @return [String]
|
|
27608
|
+
#
|
|
27609
|
+
# @!attribute [rw] input_columns
|
|
27610
|
+
# The list of input columns available from the parent dataset.
|
|
27611
|
+
# @return [Array<Types::InputColumn>]
|
|
27612
|
+
#
|
|
27613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ParentDataSet AWS API Documentation
|
|
27614
|
+
#
|
|
27615
|
+
class ParentDataSet < Struct.new(
|
|
27616
|
+
:data_set_arn,
|
|
27617
|
+
:input_columns)
|
|
27618
|
+
SENSITIVE = []
|
|
27619
|
+
include Aws::Structure
|
|
27620
|
+
end
|
|
27621
|
+
|
|
26770
27622
|
# The percent range in the visible range.
|
|
26771
27623
|
#
|
|
26772
27624
|
# @!attribute [rw] from
|
|
@@ -26980,8 +27832,8 @@ module Aws::QuickSight
|
|
|
26980
27832
|
#
|
|
26981
27833
|
# @!attribute [rw] principal
|
|
26982
27834
|
# The Amazon Resource Name (ARN) of the principal. This can be an
|
|
26983
|
-
# Amazon
|
|
26984
|
-
# Namespace principal can only be set as a viewer and will grant
|
|
27835
|
+
# Amazon Quick Suite user, group or namespace associated with the
|
|
27836
|
+
# flow. Namespace principal can only be set as a viewer and will grant
|
|
26985
27837
|
# everyone in the same namespace viewer permissions.
|
|
26986
27838
|
# @return [String]
|
|
26987
27839
|
#
|
|
@@ -27012,12 +27864,17 @@ module Aws::QuickSight
|
|
|
27012
27864
|
# A physical table type for as S3 data source.
|
|
27013
27865
|
# @return [Types::S3Source]
|
|
27014
27866
|
#
|
|
27867
|
+
# @!attribute [rw] saa_s_table
|
|
27868
|
+
# A physical table type for Software-as-a-Service (SaaS) sources.
|
|
27869
|
+
# @return [Types::SaaSTable]
|
|
27870
|
+
#
|
|
27015
27871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PhysicalTable AWS API Documentation
|
|
27016
27872
|
#
|
|
27017
27873
|
class PhysicalTable < Struct.new(
|
|
27018
27874
|
:relational_table,
|
|
27019
27875
|
:custom_sql,
|
|
27020
|
-
:s3_source
|
|
27876
|
+
:s3_source,
|
|
27877
|
+
:saa_s_table)
|
|
27021
27878
|
SENSITIVE = []
|
|
27022
27879
|
include Aws::Structure
|
|
27023
27880
|
end
|
|
@@ -27234,6 +28091,27 @@ module Aws::QuickSight
|
|
|
27234
28091
|
include Aws::Structure
|
|
27235
28092
|
end
|
|
27236
28093
|
|
|
28094
|
+
# Configuration for a pivot operation, specifying which column contains
|
|
28095
|
+
# labels and how to pivot them.
|
|
28096
|
+
#
|
|
28097
|
+
# @!attribute [rw] label_column_name
|
|
28098
|
+
# The name of the column that contains the labels to be pivoted into
|
|
28099
|
+
# separate columns.
|
|
28100
|
+
# @return [String]
|
|
28101
|
+
#
|
|
28102
|
+
# @!attribute [rw] pivoted_labels
|
|
28103
|
+
# The list of specific label values to pivot into separate columns.
|
|
28104
|
+
# @return [Array<Types::PivotedLabel>]
|
|
28105
|
+
#
|
|
28106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotConfiguration AWS API Documentation
|
|
28107
|
+
#
|
|
28108
|
+
class PivotConfiguration < Struct.new(
|
|
28109
|
+
:label_column_name,
|
|
28110
|
+
:pivoted_labels)
|
|
28111
|
+
SENSITIVE = []
|
|
28112
|
+
include Aws::Structure
|
|
28113
|
+
end
|
|
28114
|
+
|
|
27237
28115
|
# The field sort options for a pivot table sort configuration.
|
|
27238
28116
|
#
|
|
27239
28117
|
# @!attribute [rw] field_id
|
|
@@ -27253,6 +28131,45 @@ module Aws::QuickSight
|
|
|
27253
28131
|
include Aws::Structure
|
|
27254
28132
|
end
|
|
27255
28133
|
|
|
28134
|
+
# A transform operation that pivots data by converting row values into
|
|
28135
|
+
# columns.
|
|
28136
|
+
#
|
|
28137
|
+
# @!attribute [rw] alias
|
|
28138
|
+
# Alias for this operation.
|
|
28139
|
+
# @return [String]
|
|
28140
|
+
#
|
|
28141
|
+
# @!attribute [rw] source
|
|
28142
|
+
# The source transform operation that provides input data for
|
|
28143
|
+
# pivoting.
|
|
28144
|
+
# @return [Types::TransformOperationSource]
|
|
28145
|
+
#
|
|
28146
|
+
# @!attribute [rw] group_by_column_names
|
|
28147
|
+
# The list of column names to group by when performing the pivot
|
|
28148
|
+
# operation.
|
|
28149
|
+
# @return [Array<String>]
|
|
28150
|
+
#
|
|
28151
|
+
# @!attribute [rw] value_column_configuration
|
|
28152
|
+
# Configuration for how to aggregate values when multiple rows map to
|
|
28153
|
+
# the same pivoted column.
|
|
28154
|
+
# @return [Types::ValueColumnConfiguration]
|
|
28155
|
+
#
|
|
28156
|
+
# @!attribute [rw] pivot_configuration
|
|
28157
|
+
# Configuration that specifies which labels to pivot and how to
|
|
28158
|
+
# structure the resulting columns.
|
|
28159
|
+
# @return [Types::PivotConfiguration]
|
|
28160
|
+
#
|
|
28161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotOperation AWS API Documentation
|
|
28162
|
+
#
|
|
28163
|
+
class PivotOperation < Struct.new(
|
|
28164
|
+
:alias,
|
|
28165
|
+
:source,
|
|
28166
|
+
:group_by_column_names,
|
|
28167
|
+
:value_column_configuration,
|
|
28168
|
+
:pivot_configuration)
|
|
28169
|
+
SENSITIVE = []
|
|
28170
|
+
include Aws::Structure
|
|
28171
|
+
end
|
|
28172
|
+
|
|
27256
28173
|
# The aggregated field well for the pivot table.
|
|
27257
28174
|
#
|
|
27258
28175
|
# @!attribute [rw] rows
|
|
@@ -27839,6 +28756,32 @@ module Aws::QuickSight
|
|
|
27839
28756
|
include Aws::Structure
|
|
27840
28757
|
end
|
|
27841
28758
|
|
|
28759
|
+
# Specifies a label value to be pivoted into a separate column,
|
|
28760
|
+
# including the new column name and identifier.
|
|
28761
|
+
#
|
|
28762
|
+
# @!attribute [rw] label_name
|
|
28763
|
+
# The label value from the source data to be pivoted.
|
|
28764
|
+
# @return [String]
|
|
28765
|
+
#
|
|
28766
|
+
# @!attribute [rw] new_column_name
|
|
28767
|
+
# The name for the new column created from this pivoted label.
|
|
28768
|
+
# @return [String]
|
|
28769
|
+
#
|
|
28770
|
+
# @!attribute [rw] new_column_id
|
|
28771
|
+
# A unique identifier for the new column created from this pivoted
|
|
28772
|
+
# label.
|
|
28773
|
+
# @return [String]
|
|
28774
|
+
#
|
|
28775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotedLabel AWS API Documentation
|
|
28776
|
+
#
|
|
28777
|
+
class PivotedLabel < Struct.new(
|
|
28778
|
+
:label_name,
|
|
28779
|
+
:new_column_name,
|
|
28780
|
+
:new_column_id)
|
|
28781
|
+
SENSITIVE = []
|
|
28782
|
+
include Aws::Structure
|
|
28783
|
+
end
|
|
28784
|
+
|
|
27842
28785
|
# A flexible visualization type that allows engineers to create new
|
|
27843
28786
|
# custom charts in Quick Sight.
|
|
27844
28787
|
#
|
|
@@ -28190,6 +29133,15 @@ module Aws::QuickSight
|
|
|
28190
29133
|
# A transform operation that projects columns. Operations that come
|
|
28191
29134
|
# after a projection can only refer to projected columns.
|
|
28192
29135
|
#
|
|
29136
|
+
# @!attribute [rw] alias
|
|
29137
|
+
# Alias for this operation.
|
|
29138
|
+
# @return [String]
|
|
29139
|
+
#
|
|
29140
|
+
# @!attribute [rw] source
|
|
29141
|
+
# The source transform operation that provides input data for column
|
|
29142
|
+
# projection.
|
|
29143
|
+
# @return [Types::TransformOperationSource]
|
|
29144
|
+
#
|
|
28193
29145
|
# @!attribute [rw] projected_columns
|
|
28194
29146
|
# Projected columns.
|
|
28195
29147
|
# @return [Array<String>]
|
|
@@ -28197,6 +29149,8 @@ module Aws::QuickSight
|
|
|
28197
29149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ProjectOperation AWS API Documentation
|
|
28198
29150
|
#
|
|
28199
29151
|
class ProjectOperation < Struct.new(
|
|
29152
|
+
:alias,
|
|
29153
|
+
:source,
|
|
28200
29154
|
:projected_columns)
|
|
28201
29155
|
SENSITIVE = []
|
|
28202
29156
|
include Aws::Structure
|
|
@@ -29810,7 +30764,7 @@ module Aws::QuickSight
|
|
|
29810
30764
|
end
|
|
29811
30765
|
|
|
29812
30766
|
# The type of experience you want to embed. For registered users, you
|
|
29813
|
-
# can embed
|
|
30767
|
+
# can embed Quick Suite dashboards or the Amazon Quick Sight console.
|
|
29814
30768
|
#
|
|
29815
30769
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
|
29816
30770
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
|
@@ -29828,7 +30782,7 @@ module Aws::QuickSight
|
|
|
29828
30782
|
# console embedding experience. This can be used along with custom
|
|
29829
30783
|
# permissions to restrict access to certain features. For more
|
|
29830
30784
|
# information, see [Customizing Access to the Amazon Quick Sight
|
|
29831
|
-
# Console][1] in the *Amazon
|
|
30785
|
+
# Console][1] in the *Amazon Quick Suite User Guide*.
|
|
29832
30786
|
#
|
|
29833
30787
|
# Use ` GenerateEmbedUrlForRegisteredUser ` where you want to provide
|
|
29834
30788
|
# an authoring portal that allows users to create data sources,
|
|
@@ -29839,16 +30793,16 @@ module Aws::QuickSight
|
|
|
29839
30793
|
# the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
|
|
29840
30794
|
# operation to add a new user with a custom permission profile
|
|
29841
30795
|
# attached. For more information, see the following sections in the
|
|
29842
|
-
# *Amazon
|
|
30796
|
+
# *Amazon Quick Suite User Guide*:
|
|
29843
30797
|
#
|
|
29844
30798
|
# * [Embedding the Full Functionality of the Amazon Quick Sight
|
|
29845
30799
|
# Console for Authenticated Users][2]
|
|
29846
30800
|
#
|
|
29847
|
-
# * [Customizing Access to the Amazon
|
|
30801
|
+
# * [Customizing Access to the Amazon Quick Suite Console][1]
|
|
29848
30802
|
#
|
|
29849
30803
|
# For more information about the high-level steps for embedding and
|
|
29850
30804
|
# for an interactive demo of the ways you can customize embedding,
|
|
29851
|
-
# visit the [Amazon
|
|
30805
|
+
# visit the [Amazon Quick Suite Developer Portal][3].
|
|
29852
30806
|
#
|
|
29853
30807
|
#
|
|
29854
30808
|
#
|
|
@@ -29904,7 +30858,7 @@ module Aws::QuickSight
|
|
|
29904
30858
|
# @!attribute [rw] initial_topic_id
|
|
29905
30859
|
# The ID of the new Q reader experience topic that you want to make
|
|
29906
30860
|
# the starting topic in the Generative Q&A experience. You can
|
|
29907
|
-
# find a topic ID by navigating to the Topics pane in the
|
|
30861
|
+
# find a topic ID by navigating to the Topics pane in the Quick Suite
|
|
29908
30862
|
# application and opening a topic. The ID is in the URL for the topic
|
|
29909
30863
|
# that you open.
|
|
29910
30864
|
#
|
|
@@ -30153,6 +31107,32 @@ module Aws::QuickSight
|
|
|
30153
31107
|
include Aws::Structure
|
|
30154
31108
|
end
|
|
30155
31109
|
|
|
31110
|
+
# A transform operation that renames one or more columns in the dataset.
|
|
31111
|
+
#
|
|
31112
|
+
# @!attribute [rw] alias
|
|
31113
|
+
# Alias for this operation.
|
|
31114
|
+
# @return [String]
|
|
31115
|
+
#
|
|
31116
|
+
# @!attribute [rw] source
|
|
31117
|
+
# The source transform operation that provides input data for column
|
|
31118
|
+
# renaming.
|
|
31119
|
+
# @return [Types::TransformOperationSource]
|
|
31120
|
+
#
|
|
31121
|
+
# @!attribute [rw] rename_column_operations
|
|
31122
|
+
# The list of column rename operations to perform, specifying old and
|
|
31123
|
+
# new column names.
|
|
31124
|
+
# @return [Array<Types::RenameColumnOperation>]
|
|
31125
|
+
#
|
|
31126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RenameColumnsOperation AWS API Documentation
|
|
31127
|
+
#
|
|
31128
|
+
class RenameColumnsOperation < Struct.new(
|
|
31129
|
+
:alias,
|
|
31130
|
+
:source,
|
|
31131
|
+
:rename_column_operations)
|
|
31132
|
+
SENSITIVE = []
|
|
31133
|
+
include Aws::Structure
|
|
31134
|
+
end
|
|
31135
|
+
|
|
30156
31136
|
# The resource specified already exists.
|
|
30157
31137
|
#
|
|
30158
31138
|
# @!attribute [rw] message
|
|
@@ -30383,6 +31363,35 @@ module Aws::QuickSight
|
|
|
30383
31363
|
include Aws::Structure
|
|
30384
31364
|
end
|
|
30385
31365
|
|
|
31366
|
+
# Configuration for row level security.
|
|
31367
|
+
#
|
|
31368
|
+
# @!attribute [rw] tag_configuration
|
|
31369
|
+
# The configuration of tags on a dataset to set row-level security.
|
|
31370
|
+
# @return [Types::RowLevelPermissionTagConfiguration]
|
|
31371
|
+
#
|
|
31372
|
+
# @!attribute [rw] row_level_permission_data_set
|
|
31373
|
+
# Information about a dataset that contains permissions for row-level
|
|
31374
|
+
# security (RLS). The permissions dataset maps fields to users or
|
|
31375
|
+
# groups. For more information, see [Using Row-Level Security (RLS) to
|
|
31376
|
+
# Restrict Access to a Dataset][1] in the *Quick Sight User Guide*.
|
|
31377
|
+
#
|
|
31378
|
+
# The option to deny permissions by setting `PermissionPolicy` to
|
|
31379
|
+
# `DENY_ACCESS` is not supported for new RLS datasets.
|
|
31380
|
+
#
|
|
31381
|
+
#
|
|
31382
|
+
#
|
|
31383
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html
|
|
31384
|
+
# @return [Types::RowLevelPermissionDataSet]
|
|
31385
|
+
#
|
|
31386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionConfiguration AWS API Documentation
|
|
31387
|
+
#
|
|
31388
|
+
class RowLevelPermissionConfiguration < Struct.new(
|
|
31389
|
+
:tag_configuration,
|
|
31390
|
+
:row_level_permission_data_set)
|
|
31391
|
+
SENSITIVE = []
|
|
31392
|
+
include Aws::Structure
|
|
31393
|
+
end
|
|
31394
|
+
|
|
30386
31395
|
# Information about a dataset that contains permissions for row-level
|
|
30387
31396
|
# security (RLS). The permissions dataset maps fields to users or
|
|
30388
31397
|
# groups. For more information, see [Using Row-Level Security (RLS) to
|
|
@@ -30618,6 +31627,31 @@ module Aws::QuickSight
|
|
|
30618
31627
|
include Aws::Structure
|
|
30619
31628
|
end
|
|
30620
31629
|
|
|
31630
|
+
# A table from a Software-as-a-Service (SaaS) data source, including
|
|
31631
|
+
# connection details and column definitions.
|
|
31632
|
+
#
|
|
31633
|
+
# @!attribute [rw] data_source_arn
|
|
31634
|
+
# The Amazon Resource Name (ARN) of the SaaS data source.
|
|
31635
|
+
# @return [String]
|
|
31636
|
+
#
|
|
31637
|
+
# @!attribute [rw] table_path
|
|
31638
|
+
# The hierarchical path to the table within the SaaS data source.
|
|
31639
|
+
# @return [Array<Types::TablePathElement>]
|
|
31640
|
+
#
|
|
31641
|
+
# @!attribute [rw] input_columns
|
|
31642
|
+
# The list of input columns available from the SaaS table.
|
|
31643
|
+
# @return [Array<Types::InputColumn>]
|
|
31644
|
+
#
|
|
31645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SaaSTable AWS API Documentation
|
|
31646
|
+
#
|
|
31647
|
+
class SaaSTable < Struct.new(
|
|
31648
|
+
:data_source_arn,
|
|
31649
|
+
:table_path,
|
|
31650
|
+
:input_columns)
|
|
31651
|
+
SENSITIVE = []
|
|
31652
|
+
include Aws::Structure
|
|
31653
|
+
end
|
|
31654
|
+
|
|
30621
31655
|
# The configuration of the same-sheet target visuals that you want to be
|
|
30622
31656
|
# filtered.
|
|
30623
31657
|
#
|
|
@@ -31858,6 +32892,48 @@ module Aws::QuickSight
|
|
|
31858
32892
|
include Aws::Structure
|
|
31859
32893
|
end
|
|
31860
32894
|
|
|
32895
|
+
# Configuration for the semantic model that defines how prepared data is
|
|
32896
|
+
# structured for analysis and reporting.
|
|
32897
|
+
#
|
|
32898
|
+
# @!attribute [rw] table_map
|
|
32899
|
+
# A map of semantic tables that define the analytical structure.
|
|
32900
|
+
# @return [Hash<String,Types::SemanticTable>]
|
|
32901
|
+
#
|
|
32902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SemanticModelConfiguration AWS API Documentation
|
|
32903
|
+
#
|
|
32904
|
+
class SemanticModelConfiguration < Struct.new(
|
|
32905
|
+
:table_map)
|
|
32906
|
+
SENSITIVE = []
|
|
32907
|
+
include Aws::Structure
|
|
32908
|
+
end
|
|
32909
|
+
|
|
32910
|
+
# A semantic table that represents the final analytical structure of the
|
|
32911
|
+
# data.
|
|
32912
|
+
#
|
|
32913
|
+
# @!attribute [rw] alias
|
|
32914
|
+
# Alias for the semantic table.
|
|
32915
|
+
# @return [String]
|
|
32916
|
+
#
|
|
32917
|
+
# @!attribute [rw] destination_table_id
|
|
32918
|
+
# The identifier of the destination table from data preparation that
|
|
32919
|
+
# provides data to this semantic table.
|
|
32920
|
+
# @return [String]
|
|
32921
|
+
#
|
|
32922
|
+
# @!attribute [rw] row_level_permission_configuration
|
|
32923
|
+
# Configuration for row level security that control data access for
|
|
32924
|
+
# this semantic table.
|
|
32925
|
+
# @return [Types::RowLevelPermissionConfiguration]
|
|
32926
|
+
#
|
|
32927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SemanticTable AWS API Documentation
|
|
32928
|
+
#
|
|
32929
|
+
class SemanticTable < Struct.new(
|
|
32930
|
+
:alias,
|
|
32931
|
+
:destination_table_id,
|
|
32932
|
+
:row_level_permission_configuration)
|
|
32933
|
+
SENSITIVE = []
|
|
32934
|
+
include Aws::Structure
|
|
32935
|
+
end
|
|
32936
|
+
|
|
31861
32937
|
# A structure that represents a semantic type.
|
|
31862
32938
|
#
|
|
31863
32939
|
# @!attribute [rw] type_name
|
|
@@ -32140,7 +33216,7 @@ module Aws::QuickSight
|
|
|
32140
33216
|
#
|
|
32141
33217
|
# @!attribute [rw] name
|
|
32142
33218
|
# The name of the sheet. This name is displayed on the sheet's tab in
|
|
32143
|
-
# the
|
|
33219
|
+
# the Quick Suite console.
|
|
32144
33220
|
# @return [String]
|
|
32145
33221
|
#
|
|
32146
33222
|
# @!attribute [rw] parameter_controls
|
|
@@ -32687,7 +33763,7 @@ module Aws::QuickSight
|
|
|
32687
33763
|
# These are not the tags that are used for Amazon Web Services
|
|
32688
33764
|
# resource tagging. For more information on row level security in
|
|
32689
33765
|
# Amazon Quick Sight, see [Using Row-Level Security (RLS) with
|
|
32690
|
-
# Tags][1]in the *Amazon
|
|
33766
|
+
# Tags][1]in the *Amazon Quick Suite User Guide*.
|
|
32691
33767
|
#
|
|
32692
33768
|
#
|
|
32693
33769
|
#
|
|
@@ -33040,6 +34116,27 @@ module Aws::QuickSight
|
|
|
33040
34116
|
include Aws::Structure
|
|
33041
34117
|
end
|
|
33042
34118
|
|
|
34119
|
+
# A source table that provides initial data from either a physical table
|
|
34120
|
+
# or parent dataset.
|
|
34121
|
+
#
|
|
34122
|
+
# @!attribute [rw] physical_table_id
|
|
34123
|
+
# The identifier of the physical table that serves as the data source.
|
|
34124
|
+
# @return [String]
|
|
34125
|
+
#
|
|
34126
|
+
# @!attribute [rw] data_set
|
|
34127
|
+
# A parent dataset that serves as the data source instead of a
|
|
34128
|
+
# physical table.
|
|
34129
|
+
# @return [Types::ParentDataSet]
|
|
34130
|
+
#
|
|
34131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SourceTable AWS API Documentation
|
|
34132
|
+
#
|
|
34133
|
+
class SourceTable < Struct.new(
|
|
34134
|
+
:physical_table_id,
|
|
34135
|
+
:data_set)
|
|
34136
|
+
SENSITIVE = []
|
|
34137
|
+
include Aws::Structure
|
|
34138
|
+
end
|
|
34139
|
+
|
|
33043
34140
|
# The configuration of spacing (often a margin or padding).
|
|
33044
34141
|
#
|
|
33045
34142
|
# @!attribute [rw] top
|
|
@@ -34345,6 +35442,26 @@ module Aws::QuickSight
|
|
|
34345
35442
|
include Aws::Structure
|
|
34346
35443
|
end
|
|
34347
35444
|
|
|
35445
|
+
# An element in the hierarchical path to a table within a data source,
|
|
35446
|
+
# containing both name and identifier.
|
|
35447
|
+
#
|
|
35448
|
+
# @!attribute [rw] name
|
|
35449
|
+
# The name of the path element.
|
|
35450
|
+
# @return [String]
|
|
35451
|
+
#
|
|
35452
|
+
# @!attribute [rw] id
|
|
35453
|
+
# The unique identifier of the path element.
|
|
35454
|
+
# @return [String]
|
|
35455
|
+
#
|
|
35456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TablePathElement AWS API Documentation
|
|
35457
|
+
#
|
|
35458
|
+
class TablePathElement < Struct.new(
|
|
35459
|
+
:name,
|
|
35460
|
+
:id)
|
|
35461
|
+
SENSITIVE = []
|
|
35462
|
+
include Aws::Structure
|
|
35463
|
+
end
|
|
35464
|
+
|
|
34348
35465
|
# The settings for the pinned columns of a table visual.
|
|
34349
35466
|
#
|
|
34350
35467
|
# @!attribute [rw] pinned_left_fields
|
|
@@ -37218,6 +38335,99 @@ module Aws::QuickSight
|
|
|
37218
38335
|
include Aws::Structure
|
|
37219
38336
|
end
|
|
37220
38337
|
|
|
38338
|
+
# Specifies the source of data for a transform operation, including the
|
|
38339
|
+
# source operation and column mappings.
|
|
38340
|
+
#
|
|
38341
|
+
# @!attribute [rw] transform_operation_id
|
|
38342
|
+
# The identifier of the transform operation that provides input data.
|
|
38343
|
+
# @return [String]
|
|
38344
|
+
#
|
|
38345
|
+
# @!attribute [rw] column_id_mappings
|
|
38346
|
+
# The mappings between source column identifiers and target column
|
|
38347
|
+
# identifiers for this transformation.
|
|
38348
|
+
# @return [Array<Types::DataSetColumnIdMapping>]
|
|
38349
|
+
#
|
|
38350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperationSource AWS API Documentation
|
|
38351
|
+
#
|
|
38352
|
+
class TransformOperationSource < Struct.new(
|
|
38353
|
+
:transform_operation_id,
|
|
38354
|
+
:column_id_mappings)
|
|
38355
|
+
SENSITIVE = []
|
|
38356
|
+
include Aws::Structure
|
|
38357
|
+
end
|
|
38358
|
+
|
|
38359
|
+
# A step in data preparation that performs a specific operation on the
|
|
38360
|
+
# data.
|
|
38361
|
+
#
|
|
38362
|
+
# @!attribute [rw] import_table_step
|
|
38363
|
+
# A transform step that brings data from a source table.
|
|
38364
|
+
# @return [Types::ImportTableOperation]
|
|
38365
|
+
#
|
|
38366
|
+
# @!attribute [rw] project_step
|
|
38367
|
+
# A transform operation that projects columns. Operations that come
|
|
38368
|
+
# after a projection can only refer to projected columns.
|
|
38369
|
+
# @return [Types::ProjectOperation]
|
|
38370
|
+
#
|
|
38371
|
+
# @!attribute [rw] filters_step
|
|
38372
|
+
# A transform step that applies filter conditions.
|
|
38373
|
+
# @return [Types::FiltersOperation]
|
|
38374
|
+
#
|
|
38375
|
+
# @!attribute [rw] create_columns_step
|
|
38376
|
+
# A transform operation that creates calculated columns. Columns
|
|
38377
|
+
# created in one such operation form a lexical closure.
|
|
38378
|
+
# @return [Types::CreateColumnsOperation]
|
|
38379
|
+
#
|
|
38380
|
+
# @!attribute [rw] rename_columns_step
|
|
38381
|
+
# A transform step that changes the names of one or more columns.
|
|
38382
|
+
# @return [Types::RenameColumnsOperation]
|
|
38383
|
+
#
|
|
38384
|
+
# @!attribute [rw] cast_column_types_step
|
|
38385
|
+
# A transform step that changes the data types of one or more columns.
|
|
38386
|
+
# @return [Types::CastColumnTypesOperation]
|
|
38387
|
+
#
|
|
38388
|
+
# @!attribute [rw] join_step
|
|
38389
|
+
# A transform step that combines data from two sources based on
|
|
38390
|
+
# specified join conditions.
|
|
38391
|
+
# @return [Types::JoinOperation]
|
|
38392
|
+
#
|
|
38393
|
+
# @!attribute [rw] aggregate_step
|
|
38394
|
+
# A transform step that groups data and applies aggregation functions
|
|
38395
|
+
# to calculate summary values.
|
|
38396
|
+
# @return [Types::AggregateOperation]
|
|
38397
|
+
#
|
|
38398
|
+
# @!attribute [rw] pivot_step
|
|
38399
|
+
# A transform step that converts row values into columns to reshape
|
|
38400
|
+
# the data structure.
|
|
38401
|
+
# @return [Types::PivotOperation]
|
|
38402
|
+
#
|
|
38403
|
+
# @!attribute [rw] unpivot_step
|
|
38404
|
+
# A transform step that converts columns into rows to normalize the
|
|
38405
|
+
# data structure.
|
|
38406
|
+
# @return [Types::UnpivotOperation]
|
|
38407
|
+
#
|
|
38408
|
+
# @!attribute [rw] append_step
|
|
38409
|
+
# A transform step that combines rows from multiple sources by
|
|
38410
|
+
# stacking them vertically.
|
|
38411
|
+
# @return [Types::AppendOperation]
|
|
38412
|
+
#
|
|
38413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformStep AWS API Documentation
|
|
38414
|
+
#
|
|
38415
|
+
class TransformStep < Struct.new(
|
|
38416
|
+
:import_table_step,
|
|
38417
|
+
:project_step,
|
|
38418
|
+
:filters_step,
|
|
38419
|
+
:create_columns_step,
|
|
38420
|
+
:rename_columns_step,
|
|
38421
|
+
:cast_column_types_step,
|
|
38422
|
+
:join_step,
|
|
38423
|
+
:aggregate_step,
|
|
38424
|
+
:pivot_step,
|
|
38425
|
+
:unpivot_step,
|
|
38426
|
+
:append_step)
|
|
38427
|
+
SENSITIVE = []
|
|
38428
|
+
include Aws::Structure
|
|
38429
|
+
end
|
|
38430
|
+
|
|
37221
38431
|
# The column option of the transposed table.
|
|
37222
38432
|
#
|
|
37223
38433
|
# @!attribute [rw] column_index
|
|
@@ -37676,6 +38886,55 @@ module Aws::QuickSight
|
|
|
37676
38886
|
include Aws::Structure
|
|
37677
38887
|
end
|
|
37678
38888
|
|
|
38889
|
+
# A transform operation that converts columns into rows, normalizing the
|
|
38890
|
+
# data structure.
|
|
38891
|
+
#
|
|
38892
|
+
# @!attribute [rw] alias
|
|
38893
|
+
# Alias for this operation.
|
|
38894
|
+
# @return [String]
|
|
38895
|
+
#
|
|
38896
|
+
# @!attribute [rw] source
|
|
38897
|
+
# The source transform operation that provides input data for
|
|
38898
|
+
# unpivoting.
|
|
38899
|
+
# @return [Types::TransformOperationSource]
|
|
38900
|
+
#
|
|
38901
|
+
# @!attribute [rw] columns_to_unpivot
|
|
38902
|
+
# The list of columns to unpivot from the source data.
|
|
38903
|
+
# @return [Array<Types::ColumnToUnpivot>]
|
|
38904
|
+
#
|
|
38905
|
+
# @!attribute [rw] unpivoted_label_column_name
|
|
38906
|
+
# The name for the new column that will contain the unpivoted column
|
|
38907
|
+
# names.
|
|
38908
|
+
# @return [String]
|
|
38909
|
+
#
|
|
38910
|
+
# @!attribute [rw] unpivoted_label_column_id
|
|
38911
|
+
# A unique identifier for the new column that will contain the
|
|
38912
|
+
# unpivoted column names.
|
|
38913
|
+
# @return [String]
|
|
38914
|
+
#
|
|
38915
|
+
# @!attribute [rw] unpivoted_value_column_name
|
|
38916
|
+
# The name for the new column that will contain the unpivoted values.
|
|
38917
|
+
# @return [String]
|
|
38918
|
+
#
|
|
38919
|
+
# @!attribute [rw] unpivoted_value_column_id
|
|
38920
|
+
# A unique identifier for the new column that will contain the
|
|
38921
|
+
# unpivoted values.
|
|
38922
|
+
# @return [String]
|
|
38923
|
+
#
|
|
38924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnpivotOperation AWS API Documentation
|
|
38925
|
+
#
|
|
38926
|
+
class UnpivotOperation < Struct.new(
|
|
38927
|
+
:alias,
|
|
38928
|
+
:source,
|
|
38929
|
+
:columns_to_unpivot,
|
|
38930
|
+
:unpivoted_label_column_name,
|
|
38931
|
+
:unpivoted_label_column_id,
|
|
38932
|
+
:unpivoted_value_column_name,
|
|
38933
|
+
:unpivoted_value_column_id)
|
|
38934
|
+
SENSITIVE = []
|
|
38935
|
+
include Aws::Structure
|
|
38936
|
+
end
|
|
38937
|
+
|
|
37679
38938
|
# This error indicates that you are calling an embedding operation in
|
|
37680
38939
|
# Amazon Quick Sight without the required pricing plan on your Amazon
|
|
37681
38940
|
# Web Services account. Before you can use embedding for anonymous
|
|
@@ -38232,7 +39491,7 @@ module Aws::QuickSight
|
|
|
38232
39491
|
# @return [String]
|
|
38233
39492
|
#
|
|
38234
39493
|
# @!attribute [rw] namespace
|
|
38235
|
-
# The namespace of the
|
|
39494
|
+
# The namespace of the Quick Suite application.
|
|
38236
39495
|
# @return [String]
|
|
38237
39496
|
#
|
|
38238
39497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateApplicationWithTokenExchangeGrantRequest AWS API Documentation
|
|
@@ -38301,7 +39560,7 @@ module Aws::QuickSight
|
|
|
38301
39560
|
# @return [String]
|
|
38302
39561
|
#
|
|
38303
39562
|
# @!attribute [rw] brand_id
|
|
38304
|
-
# The ID of the
|
|
39563
|
+
# The ID of the Quick Suite brand.
|
|
38305
39564
|
# @return [String]
|
|
38306
39565
|
#
|
|
38307
39566
|
# @!attribute [rw] version_id
|
|
@@ -38340,7 +39599,7 @@ module Aws::QuickSight
|
|
|
38340
39599
|
# @return [String]
|
|
38341
39600
|
#
|
|
38342
39601
|
# @!attribute [rw] brand_id
|
|
38343
|
-
# The ID of the
|
|
39602
|
+
# The ID of the Quick Suite brand.
|
|
38344
39603
|
# @return [String]
|
|
38345
39604
|
#
|
|
38346
39605
|
# @!attribute [rw] brand_definition
|
|
@@ -38869,7 +40128,8 @@ module Aws::QuickSight
|
|
|
38869
40128
|
#
|
|
38870
40129
|
# @!attribute [rw] logical_table_map
|
|
38871
40130
|
# Configures the combination and transformation of the data from the
|
|
38872
|
-
# physical tables.
|
|
40131
|
+
# physical tables. This parameter is used with the legacy data
|
|
40132
|
+
# preparation experience.
|
|
38873
40133
|
# @return [Hash<String,Types::LogicalTable>]
|
|
38874
40134
|
#
|
|
38875
40135
|
# @!attribute [rw] import_mode
|
|
@@ -38888,13 +40148,15 @@ module Aws::QuickSight
|
|
|
38888
40148
|
#
|
|
38889
40149
|
# @!attribute [rw] row_level_permission_data_set
|
|
38890
40150
|
# The row-level security configuration for the data you want to
|
|
38891
|
-
# create.
|
|
40151
|
+
# create. This parameter is used with the legacy data preparation
|
|
40152
|
+
# experience.
|
|
38892
40153
|
# @return [Types::RowLevelPermissionDataSet]
|
|
38893
40154
|
#
|
|
38894
40155
|
# @!attribute [rw] row_level_permission_tag_configuration
|
|
38895
40156
|
# The configuration of tags on a dataset to set row-level security.
|
|
38896
40157
|
# Row-level security tags are currently supported for anonymous
|
|
38897
|
-
# embedding only.
|
|
40158
|
+
# embedding only. This parameter is used with the legacy data
|
|
40159
|
+
# preparation experience.
|
|
38898
40160
|
# @return [Types::RowLevelPermissionTagConfiguration]
|
|
38899
40161
|
#
|
|
38900
40162
|
# @!attribute [rw] column_level_permission_rules
|
|
@@ -38915,6 +40177,20 @@ module Aws::QuickSight
|
|
|
38915
40177
|
# that contains a `UniqueKey` configuration.
|
|
38916
40178
|
# @return [Types::PerformanceConfiguration]
|
|
38917
40179
|
#
|
|
40180
|
+
# @!attribute [rw] data_prep_configuration
|
|
40181
|
+
# The data preparation configuration for the dataset. This
|
|
40182
|
+
# configuration defines the source tables, transformation steps, and
|
|
40183
|
+
# destination tables used to prepare the data. Required when using the
|
|
40184
|
+
# new data preparation experience.
|
|
40185
|
+
# @return [Types::DataPrepConfiguration]
|
|
40186
|
+
#
|
|
40187
|
+
# @!attribute [rw] semantic_model_configuration
|
|
40188
|
+
# The semantic model configuration for the dataset. This configuration
|
|
40189
|
+
# defines how the prepared data is structured for an analysis,
|
|
40190
|
+
# including table mappings and row-level security configurations.
|
|
40191
|
+
# Required when using the new data preparation experience.
|
|
40192
|
+
# @return [Types::SemanticModelConfiguration]
|
|
40193
|
+
#
|
|
38918
40194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
|
38919
40195
|
#
|
|
38920
40196
|
class UpdateDataSetRequest < Struct.new(
|
|
@@ -38931,7 +40207,9 @@ module Aws::QuickSight
|
|
|
38931
40207
|
:column_level_permission_rules,
|
|
38932
40208
|
:data_set_usage_configuration,
|
|
38933
40209
|
:dataset_parameters,
|
|
38934
|
-
:performance_configuration
|
|
40210
|
+
:performance_configuration,
|
|
40211
|
+
:data_prep_configuration,
|
|
40212
|
+
:semantic_model_configuration)
|
|
38935
40213
|
SENSITIVE = []
|
|
38936
40214
|
include Aws::Structure
|
|
38937
40215
|
end
|
|
@@ -38941,7 +40219,7 @@ module Aws::QuickSight
|
|
|
38941
40219
|
# @return [String]
|
|
38942
40220
|
#
|
|
38943
40221
|
# @!attribute [rw] data_set_id
|
|
38944
|
-
# The ID for the dataset that you want to
|
|
40222
|
+
# The ID for the dataset that you want to update. This ID is unique
|
|
38945
40223
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
38946
40224
|
# @return [String]
|
|
38947
40225
|
#
|
|
@@ -39637,7 +40915,7 @@ module Aws::QuickSight
|
|
|
39637
40915
|
#
|
|
39638
40916
|
# @!attribute [rw] public_sharing_enabled
|
|
39639
40917
|
# A Boolean value that indicates whether public sharing is turned on
|
|
39640
|
-
# for an
|
|
40918
|
+
# for an Quick Suite account.
|
|
39641
40919
|
# @return [Boolean]
|
|
39642
40920
|
#
|
|
39643
40921
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation
|
|
@@ -40791,6 +42069,11 @@ module Aws::QuickSight
|
|
|
40791
42069
|
# The delimiter between values in the file.
|
|
40792
42070
|
# @return [String]
|
|
40793
42071
|
#
|
|
42072
|
+
# @!attribute [rw] custom_cell_address_range
|
|
42073
|
+
# A custom cell address range for Excel files, specifying which cells
|
|
42074
|
+
# to import from the spreadsheet.
|
|
42075
|
+
# @return [String]
|
|
42076
|
+
#
|
|
40794
42077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UploadSettings AWS API Documentation
|
|
40795
42078
|
#
|
|
40796
42079
|
class UploadSettings < Struct.new(
|
|
@@ -40798,7 +42081,8 @@ module Aws::QuickSight
|
|
|
40798
42081
|
:start_from_row,
|
|
40799
42082
|
:contains_header,
|
|
40800
42083
|
:text_qualifier,
|
|
40801
|
-
:delimiter
|
|
42084
|
+
:delimiter,
|
|
42085
|
+
:custom_cell_address_range)
|
|
40802
42086
|
SENSITIVE = []
|
|
40803
42087
|
include Aws::Structure
|
|
40804
42088
|
end
|
|
@@ -41072,6 +42356,22 @@ module Aws::QuickSight
|
|
|
41072
42356
|
include Aws::Structure
|
|
41073
42357
|
end
|
|
41074
42358
|
|
|
42359
|
+
# Configuration for how to handle value columns in pivot operations,
|
|
42360
|
+
# including aggregation settings.
|
|
42361
|
+
#
|
|
42362
|
+
# @!attribute [rw] aggregation_function
|
|
42363
|
+
# The aggregation function to apply when multiple values map to the
|
|
42364
|
+
# same pivoted cell.
|
|
42365
|
+
# @return [Types::DataPrepAggregationFunction]
|
|
42366
|
+
#
|
|
42367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ValueColumnConfiguration AWS API Documentation
|
|
42368
|
+
#
|
|
42369
|
+
class ValueColumnConfiguration < Struct.new(
|
|
42370
|
+
:aggregation_function)
|
|
42371
|
+
SENSITIVE = []
|
|
42372
|
+
include Aws::Structure
|
|
42373
|
+
end
|
|
42374
|
+
|
|
41075
42375
|
# The range options for the data zoom scroll bar.
|
|
41076
42376
|
#
|
|
41077
42377
|
# @!attribute [rw] percent_range
|