aws-sdk-quicksight 1.162.0 → 1.164.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1509 -57
- data/lib/aws-sdk-quicksight/client_api.rb +438 -14
- data/lib/aws-sdk-quicksight/errors.rb +21 -0
- data/lib/aws-sdk-quicksight/types.rb +1586 -65
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +1541 -95
- data/sig/errors.rbs +4 -0
- data/sig/types.rbs +396 -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
|
|
@@ -3761,14 +3873,24 @@ module Aws::QuickSight
|
|
|
3761
3873
|
|
|
3762
3874
|
# The display options for tile borders for visuals.
|
|
3763
3875
|
#
|
|
3876
|
+
# @!attribute [rw] color
|
|
3877
|
+
# The option to add color for tile borders for visuals.
|
|
3878
|
+
# @return [String]
|
|
3879
|
+
#
|
|
3764
3880
|
# @!attribute [rw] show
|
|
3765
3881
|
# The option to enable display of borders for visuals.
|
|
3766
3882
|
# @return [Boolean]
|
|
3767
3883
|
#
|
|
3884
|
+
# @!attribute [rw] width
|
|
3885
|
+
# The option to set the width of tile borders for visuals.
|
|
3886
|
+
# @return [String]
|
|
3887
|
+
#
|
|
3768
3888
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BorderStyle AWS API Documentation
|
|
3769
3889
|
#
|
|
3770
3890
|
class BorderStyle < Struct.new(
|
|
3771
|
-
:
|
|
3891
|
+
:color,
|
|
3892
|
+
:show,
|
|
3893
|
+
:width)
|
|
3772
3894
|
SENSITIVE = []
|
|
3773
3895
|
include Aws::Structure
|
|
3774
3896
|
end
|
|
@@ -4081,7 +4203,7 @@ module Aws::QuickSight
|
|
|
4081
4203
|
# The details of the brand.
|
|
4082
4204
|
#
|
|
4083
4205
|
# @!attribute [rw] brand_id
|
|
4084
|
-
# The ID of the
|
|
4206
|
+
# The ID of the Quick Suite brand.
|
|
4085
4207
|
# @return [String]
|
|
4086
4208
|
#
|
|
4087
4209
|
# @!attribute [rw] arn
|
|
@@ -4154,7 +4276,7 @@ module Aws::QuickSight
|
|
|
4154
4276
|
# @return [String]
|
|
4155
4277
|
#
|
|
4156
4278
|
# @!attribute [rw] brand_id
|
|
4157
|
-
# The ID of the
|
|
4279
|
+
# The ID of the Quick Suite brand.
|
|
4158
4280
|
# @return [String]
|
|
4159
4281
|
#
|
|
4160
4282
|
# @!attribute [rw] brand_name
|
|
@@ -4581,6 +4703,32 @@ module Aws::QuickSight
|
|
|
4581
4703
|
include Aws::Structure
|
|
4582
4704
|
end
|
|
4583
4705
|
|
|
4706
|
+
# A transform operation that changes the data types of one or more
|
|
4707
|
+
# columns in the dataset.
|
|
4708
|
+
#
|
|
4709
|
+
# @!attribute [rw] alias
|
|
4710
|
+
# Alias for this operation.
|
|
4711
|
+
# @return [String]
|
|
4712
|
+
#
|
|
4713
|
+
# @!attribute [rw] source
|
|
4714
|
+
# The source transform operation that provides input data for the type
|
|
4715
|
+
# casting.
|
|
4716
|
+
# @return [Types::TransformOperationSource]
|
|
4717
|
+
#
|
|
4718
|
+
# @!attribute [rw] cast_column_type_operations
|
|
4719
|
+
# The list of column type casting operations to perform.
|
|
4720
|
+
# @return [Array<Types::CastColumnTypeOperation>]
|
|
4721
|
+
#
|
|
4722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CastColumnTypesOperation AWS API Documentation
|
|
4723
|
+
#
|
|
4724
|
+
class CastColumnTypesOperation < Struct.new(
|
|
4725
|
+
:alias,
|
|
4726
|
+
:source,
|
|
4727
|
+
:cast_column_type_operations)
|
|
4728
|
+
SENSITIVE = []
|
|
4729
|
+
include Aws::Structure
|
|
4730
|
+
end
|
|
4731
|
+
|
|
4584
4732
|
# The dimension type field with categorical type columns..
|
|
4585
4733
|
#
|
|
4586
4734
|
# @!attribute [rw] field_id
|
|
@@ -5216,6 +5364,27 @@ module Aws::QuickSight
|
|
|
5216
5364
|
include Aws::Structure
|
|
5217
5365
|
end
|
|
5218
5366
|
|
|
5367
|
+
# Specifies a column to be unpivoted, transforming it from a column into
|
|
5368
|
+
# rows with associated values.
|
|
5369
|
+
#
|
|
5370
|
+
# @!attribute [rw] column_name
|
|
5371
|
+
# The name of the column to unpivot from the source data.
|
|
5372
|
+
# @return [String]
|
|
5373
|
+
#
|
|
5374
|
+
# @!attribute [rw] new_value
|
|
5375
|
+
# The value to assign to this column in the unpivoted result,
|
|
5376
|
+
# typically the column name or a descriptive label.
|
|
5377
|
+
# @return [String]
|
|
5378
|
+
#
|
|
5379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnToUnpivot AWS API Documentation
|
|
5380
|
+
#
|
|
5381
|
+
class ColumnToUnpivot < Struct.new(
|
|
5382
|
+
:column_name,
|
|
5383
|
+
:new_value)
|
|
5384
|
+
SENSITIVE = []
|
|
5385
|
+
include Aws::Structure
|
|
5386
|
+
end
|
|
5387
|
+
|
|
5219
5388
|
# The tooltip item for the columns that are not part of a field well.
|
|
5220
5389
|
#
|
|
5221
5390
|
# @!attribute [rw] column
|
|
@@ -6495,7 +6664,7 @@ module Aws::QuickSight
|
|
|
6495
6664
|
# @return [String]
|
|
6496
6665
|
#
|
|
6497
6666
|
# @!attribute [rw] brand_id
|
|
6498
|
-
# The ID of the
|
|
6667
|
+
# The ID of the Quick Suite brand.
|
|
6499
6668
|
# @return [String]
|
|
6500
6669
|
#
|
|
6501
6670
|
# @!attribute [rw] brand_definition
|
|
@@ -6542,6 +6711,15 @@ module Aws::QuickSight
|
|
|
6542
6711
|
# A transform operation that creates calculated columns. Columns created
|
|
6543
6712
|
# in one such operation form a lexical closure.
|
|
6544
6713
|
#
|
|
6714
|
+
# @!attribute [rw] alias
|
|
6715
|
+
# Alias for this operation.
|
|
6716
|
+
# @return [String]
|
|
6717
|
+
#
|
|
6718
|
+
# @!attribute [rw] source
|
|
6719
|
+
# The source transform operation that provides input data for creating
|
|
6720
|
+
# new calculated columns.
|
|
6721
|
+
# @return [Types::TransformOperationSource]
|
|
6722
|
+
#
|
|
6545
6723
|
# @!attribute [rw] columns
|
|
6546
6724
|
# Calculated columns to create.
|
|
6547
6725
|
# @return [Array<Types::CalculatedColumn>]
|
|
@@ -6549,6 +6727,8 @@ module Aws::QuickSight
|
|
|
6549
6727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateColumnsOperation AWS API Documentation
|
|
6550
6728
|
#
|
|
6551
6729
|
class CreateColumnsOperation < Struct.new(
|
|
6730
|
+
:alias,
|
|
6731
|
+
:source,
|
|
6552
6732
|
:columns)
|
|
6553
6733
|
SENSITIVE = []
|
|
6554
6734
|
include Aws::Structure
|
|
@@ -6811,7 +6991,8 @@ module Aws::QuickSight
|
|
|
6811
6991
|
#
|
|
6812
6992
|
# @!attribute [rw] logical_table_map
|
|
6813
6993
|
# Configures the combination and transformation of the data from the
|
|
6814
|
-
# physical tables.
|
|
6994
|
+
# physical tables. This parameter is used with the legacy data
|
|
6995
|
+
# preparation experience.
|
|
6815
6996
|
# @return [Hash<String,Types::LogicalTable>]
|
|
6816
6997
|
#
|
|
6817
6998
|
# @!attribute [rw] import_mode
|
|
@@ -6834,13 +7015,15 @@ module Aws::QuickSight
|
|
|
6834
7015
|
#
|
|
6835
7016
|
# @!attribute [rw] row_level_permission_data_set
|
|
6836
7017
|
# The row-level security configuration for the data that you want to
|
|
6837
|
-
# create.
|
|
7018
|
+
# create. This parameter is used with the legacy data preparation
|
|
7019
|
+
# experience.
|
|
6838
7020
|
# @return [Types::RowLevelPermissionDataSet]
|
|
6839
7021
|
#
|
|
6840
7022
|
# @!attribute [rw] row_level_permission_tag_configuration
|
|
6841
7023
|
# The configuration of tags on a dataset to set row-level security.
|
|
6842
7024
|
# Row-level security tags are currently supported for anonymous
|
|
6843
|
-
# embedding only.
|
|
7025
|
+
# embedding only. This parameter is used with the legacy data
|
|
7026
|
+
# preparation experience.
|
|
6844
7027
|
# @return [Types::RowLevelPermissionTagConfiguration]
|
|
6845
7028
|
#
|
|
6846
7029
|
# @!attribute [rw] column_level_permission_rules
|
|
@@ -6876,6 +7059,20 @@ module Aws::QuickSight
|
|
|
6876
7059
|
# permission datasets.
|
|
6877
7060
|
# @return [String]
|
|
6878
7061
|
#
|
|
7062
|
+
# @!attribute [rw] data_prep_configuration
|
|
7063
|
+
# The data preparation configuration for the dataset. This
|
|
7064
|
+
# configuration defines the source tables, transformation steps, and
|
|
7065
|
+
# destination tables used to prepare the data. Required when using the
|
|
7066
|
+
# new data preparation experience.
|
|
7067
|
+
# @return [Types::DataPrepConfiguration]
|
|
7068
|
+
#
|
|
7069
|
+
# @!attribute [rw] semantic_model_configuration
|
|
7070
|
+
# The semantic model configuration for the dataset. This configuration
|
|
7071
|
+
# defines how the prepared data is structured for an analysis,
|
|
7072
|
+
# including table mappings and row-level security configurations.
|
|
7073
|
+
# Required when using the new data preparation experience.
|
|
7074
|
+
# @return [Types::SemanticModelConfiguration]
|
|
7075
|
+
#
|
|
6879
7076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
|
6880
7077
|
#
|
|
6881
7078
|
class CreateDataSetRequest < Struct.new(
|
|
@@ -6896,7 +7093,9 @@ module Aws::QuickSight
|
|
|
6896
7093
|
:dataset_parameters,
|
|
6897
7094
|
:folder_arns,
|
|
6898
7095
|
:performance_configuration,
|
|
6899
|
-
:use_as
|
|
7096
|
+
:use_as,
|
|
7097
|
+
:data_prep_configuration,
|
|
7098
|
+
:semantic_model_configuration)
|
|
6900
7099
|
SENSITIVE = []
|
|
6901
7100
|
include Aws::Structure
|
|
6902
7101
|
end
|
|
@@ -8708,7 +8907,7 @@ module Aws::QuickSight
|
|
|
8708
8907
|
:name,
|
|
8709
8908
|
:sql_query,
|
|
8710
8909
|
:columns)
|
|
8711
|
-
SENSITIVE = []
|
|
8910
|
+
SENSITIVE = [:sql_query]
|
|
8712
8911
|
include Aws::Structure
|
|
8713
8912
|
end
|
|
8714
8913
|
|
|
@@ -9259,15 +9458,15 @@ module Aws::QuickSight
|
|
|
9259
9458
|
# The ID of the dashboard that has the visual that you want to embed.
|
|
9260
9459
|
# The `DashboardId` can be found in the `IDs for developers` section
|
|
9261
9460
|
# of the `Embed visual` pane of the visual's on-visual menu of the
|
|
9262
|
-
#
|
|
9461
|
+
# Quick Suite console. You can also get the `DashboardId` with a
|
|
9263
9462
|
# `ListDashboards` API operation.
|
|
9264
9463
|
# @return [String]
|
|
9265
9464
|
#
|
|
9266
9465
|
# @!attribute [rw] sheet_id
|
|
9267
9466
|
# The ID of the sheet that the has visual that you want to embed. The
|
|
9268
9467
|
# `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
|
-
#
|
|
9468
|
+
# `Embed visual` pane of the visual's on-visual menu of the Quick
|
|
9469
|
+
# Suite console.
|
|
9271
9470
|
# @return [String]
|
|
9272
9471
|
#
|
|
9273
9472
|
# @!attribute [rw] visual_id
|
|
@@ -9735,6 +9934,103 @@ module Aws::QuickSight
|
|
|
9735
9934
|
include Aws::Structure
|
|
9736
9935
|
end
|
|
9737
9936
|
|
|
9937
|
+
# Defines the type of aggregation function to apply to data during data
|
|
9938
|
+
# preparation, supporting simple and list aggregations.
|
|
9939
|
+
#
|
|
9940
|
+
# @!attribute [rw] simple_aggregation
|
|
9941
|
+
# A simple aggregation function such as `SUM`, `COUNT`, `AVERAGE`,
|
|
9942
|
+
# `MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or `STANDARD_DEVIATION`.
|
|
9943
|
+
# @return [Types::DataPrepSimpleAggregationFunction]
|
|
9944
|
+
#
|
|
9945
|
+
# @!attribute [rw] list_aggregation
|
|
9946
|
+
# A list aggregation function that concatenates values from multiple
|
|
9947
|
+
# rows into a single delimited string.
|
|
9948
|
+
# @return [Types::DataPrepListAggregationFunction]
|
|
9949
|
+
#
|
|
9950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepAggregationFunction AWS API Documentation
|
|
9951
|
+
#
|
|
9952
|
+
class DataPrepAggregationFunction < Struct.new(
|
|
9953
|
+
:simple_aggregation,
|
|
9954
|
+
:list_aggregation)
|
|
9955
|
+
SENSITIVE = []
|
|
9956
|
+
include Aws::Structure
|
|
9957
|
+
end
|
|
9958
|
+
|
|
9959
|
+
# Configuration for data preparation operations, defining the complete
|
|
9960
|
+
# pipeline from source tables through transformations to destination
|
|
9961
|
+
# tables.
|
|
9962
|
+
#
|
|
9963
|
+
# @!attribute [rw] source_table_map
|
|
9964
|
+
# A map of source tables that provide information about underlying
|
|
9965
|
+
# sources.
|
|
9966
|
+
# @return [Hash<String,Types::SourceTable>]
|
|
9967
|
+
#
|
|
9968
|
+
# @!attribute [rw] transform_step_map
|
|
9969
|
+
# A map of transformation steps that process the data.
|
|
9970
|
+
# @return [Hash<String,Types::TransformStep>]
|
|
9971
|
+
#
|
|
9972
|
+
# @!attribute [rw] destination_table_map
|
|
9973
|
+
# A map of destination tables that receive the final prepared data.
|
|
9974
|
+
# @return [Hash<String,Types::DestinationTable>]
|
|
9975
|
+
#
|
|
9976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepConfiguration AWS API Documentation
|
|
9977
|
+
#
|
|
9978
|
+
class DataPrepConfiguration < Struct.new(
|
|
9979
|
+
:source_table_map,
|
|
9980
|
+
:transform_step_map,
|
|
9981
|
+
:destination_table_map)
|
|
9982
|
+
SENSITIVE = []
|
|
9983
|
+
include Aws::Structure
|
|
9984
|
+
end
|
|
9985
|
+
|
|
9986
|
+
# An aggregation function that concatenates values from multiple rows
|
|
9987
|
+
# into a single string with a specified separator.
|
|
9988
|
+
#
|
|
9989
|
+
# @!attribute [rw] input_column_name
|
|
9990
|
+
# The name of the column containing values to be concatenated.
|
|
9991
|
+
# @return [String]
|
|
9992
|
+
#
|
|
9993
|
+
# @!attribute [rw] separator
|
|
9994
|
+
# The string used to separate values in the concatenated result.
|
|
9995
|
+
# @return [String]
|
|
9996
|
+
#
|
|
9997
|
+
# @!attribute [rw] distinct
|
|
9998
|
+
# Whether to include only distinct values in the concatenated result,
|
|
9999
|
+
# removing duplicates.
|
|
10000
|
+
# @return [Boolean]
|
|
10001
|
+
#
|
|
10002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepListAggregationFunction AWS API Documentation
|
|
10003
|
+
#
|
|
10004
|
+
class DataPrepListAggregationFunction < Struct.new(
|
|
10005
|
+
:input_column_name,
|
|
10006
|
+
:separator,
|
|
10007
|
+
:distinct)
|
|
10008
|
+
SENSITIVE = []
|
|
10009
|
+
include Aws::Structure
|
|
10010
|
+
end
|
|
10011
|
+
|
|
10012
|
+
# A simple aggregation function that performs standard statistical
|
|
10013
|
+
# operations on a column.
|
|
10014
|
+
#
|
|
10015
|
+
# @!attribute [rw] input_column_name
|
|
10016
|
+
# The name of the column on which to perform the aggregation function.
|
|
10017
|
+
# @return [String]
|
|
10018
|
+
#
|
|
10019
|
+
# @!attribute [rw] function_type
|
|
10020
|
+
# The type of aggregation function to perform, such as `COUNT`, `SUM`,
|
|
10021
|
+
# `AVERAGE`, `MIN`, `MAX`, `MEDIAN`, `VARIANCE`, or
|
|
10022
|
+
# `STANDARD_DEVIATION`.
|
|
10023
|
+
# @return [String]
|
|
10024
|
+
#
|
|
10025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataPrepSimpleAggregationFunction AWS API Documentation
|
|
10026
|
+
#
|
|
10027
|
+
class DataPrepSimpleAggregationFunction < Struct.new(
|
|
10028
|
+
:input_column_name,
|
|
10029
|
+
:function_type)
|
|
10030
|
+
SENSITIVE = []
|
|
10031
|
+
include Aws::Structure
|
|
10032
|
+
end
|
|
10033
|
+
|
|
9738
10034
|
# Adds Q&A capabilities to a dashboard. If no topic is linked,
|
|
9739
10035
|
# Dashboard Q&A uses the data values that are rendered on the
|
|
9740
10036
|
# dashboard. End users can use Dashboard Q&A to ask for different
|
|
@@ -9853,6 +10149,14 @@ module Aws::QuickSight
|
|
|
9853
10149
|
# The usage of the dataset.
|
|
9854
10150
|
# @return [String]
|
|
9855
10151
|
#
|
|
10152
|
+
# @!attribute [rw] data_prep_configuration
|
|
10153
|
+
# The data preparation configuration associated with this dataset.
|
|
10154
|
+
# @return [Types::DataPrepConfiguration]
|
|
10155
|
+
#
|
|
10156
|
+
# @!attribute [rw] semantic_model_configuration
|
|
10157
|
+
# The semantic model configuration associated with this dataset.
|
|
10158
|
+
# @return [Types::SemanticModelConfiguration]
|
|
10159
|
+
#
|
|
9856
10160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
|
9857
10161
|
#
|
|
9858
10162
|
class DataSet < Struct.new(
|
|
@@ -9874,7 +10178,29 @@ module Aws::QuickSight
|
|
|
9874
10178
|
:data_set_usage_configuration,
|
|
9875
10179
|
:dataset_parameters,
|
|
9876
10180
|
:performance_configuration,
|
|
9877
|
-
:use_as
|
|
10181
|
+
:use_as,
|
|
10182
|
+
:data_prep_configuration,
|
|
10183
|
+
:semantic_model_configuration)
|
|
10184
|
+
SENSITIVE = []
|
|
10185
|
+
include Aws::Structure
|
|
10186
|
+
end
|
|
10187
|
+
|
|
10188
|
+
# Maps a source column identifier to a target column identifier during
|
|
10189
|
+
# transform operations.
|
|
10190
|
+
#
|
|
10191
|
+
# @!attribute [rw] source_column_id
|
|
10192
|
+
# Source column ID.
|
|
10193
|
+
# @return [String]
|
|
10194
|
+
#
|
|
10195
|
+
# @!attribute [rw] target_column_id
|
|
10196
|
+
# Target column ID.
|
|
10197
|
+
# @return [String]
|
|
10198
|
+
#
|
|
10199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetColumnIdMapping AWS API Documentation
|
|
10200
|
+
#
|
|
10201
|
+
class DataSetColumnIdMapping < Struct.new(
|
|
10202
|
+
:source_column_id,
|
|
10203
|
+
:target_column_id)
|
|
9878
10204
|
SENSITIVE = []
|
|
9879
10205
|
include Aws::Structure
|
|
9880
10206
|
end
|
|
@@ -9903,6 +10229,96 @@ module Aws::QuickSight
|
|
|
9903
10229
|
include Aws::Structure
|
|
9904
10230
|
end
|
|
9905
10231
|
|
|
10232
|
+
# A filter condition that compares date values using operators like
|
|
10233
|
+
# `BEFORE`, `AFTER`, or their inclusive variants.
|
|
10234
|
+
#
|
|
10235
|
+
# @!attribute [rw] operator
|
|
10236
|
+
# The comparison operator to use, such as `BEFORE`,
|
|
10237
|
+
# `BEFORE_OR_EQUALS_TO`, `AFTER`, or `AFTER_OR_EQUALS_TO`.
|
|
10238
|
+
# @return [String]
|
|
10239
|
+
#
|
|
10240
|
+
# @!attribute [rw] value
|
|
10241
|
+
# The date value to compare against.
|
|
10242
|
+
# @return [Types::DataSetDateFilterValue]
|
|
10243
|
+
#
|
|
10244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateComparisonFilterCondition AWS API Documentation
|
|
10245
|
+
#
|
|
10246
|
+
class DataSetDateComparisonFilterCondition < Struct.new(
|
|
10247
|
+
:operator,
|
|
10248
|
+
:value)
|
|
10249
|
+
SENSITIVE = []
|
|
10250
|
+
include Aws::Structure
|
|
10251
|
+
end
|
|
10252
|
+
|
|
10253
|
+
# A filter condition for date columns, supporting both comparison and
|
|
10254
|
+
# range-based filtering.
|
|
10255
|
+
#
|
|
10256
|
+
# @!attribute [rw] column_name
|
|
10257
|
+
# The name of the date column to filter.
|
|
10258
|
+
# @return [String]
|
|
10259
|
+
#
|
|
10260
|
+
# @!attribute [rw] comparison_filter_condition
|
|
10261
|
+
# A comparison-based filter condition for the date column.
|
|
10262
|
+
# @return [Types::DataSetDateComparisonFilterCondition]
|
|
10263
|
+
#
|
|
10264
|
+
# @!attribute [rw] range_filter_condition
|
|
10265
|
+
# A range-based filter condition for the date column, filtering values
|
|
10266
|
+
# between minimum and maximum dates.
|
|
10267
|
+
# @return [Types::DataSetDateRangeFilterCondition]
|
|
10268
|
+
#
|
|
10269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateFilterCondition AWS API Documentation
|
|
10270
|
+
#
|
|
10271
|
+
class DataSetDateFilterCondition < Struct.new(
|
|
10272
|
+
:column_name,
|
|
10273
|
+
:comparison_filter_condition,
|
|
10274
|
+
:range_filter_condition)
|
|
10275
|
+
SENSITIVE = []
|
|
10276
|
+
include Aws::Structure
|
|
10277
|
+
end
|
|
10278
|
+
|
|
10279
|
+
# Represents a date value used in filter conditions.
|
|
10280
|
+
#
|
|
10281
|
+
# @!attribute [rw] static_value
|
|
10282
|
+
# A static date value used for filtering.
|
|
10283
|
+
# @return [Time]
|
|
10284
|
+
#
|
|
10285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateFilterValue AWS API Documentation
|
|
10286
|
+
#
|
|
10287
|
+
class DataSetDateFilterValue < Struct.new(
|
|
10288
|
+
:static_value)
|
|
10289
|
+
SENSITIVE = [:static_value]
|
|
10290
|
+
include Aws::Structure
|
|
10291
|
+
end
|
|
10292
|
+
|
|
10293
|
+
# A filter condition that filters date values within a specified range.
|
|
10294
|
+
#
|
|
10295
|
+
# @!attribute [rw] range_minimum
|
|
10296
|
+
# The minimum date value for the range filter.
|
|
10297
|
+
# @return [Types::DataSetDateFilterValue]
|
|
10298
|
+
#
|
|
10299
|
+
# @!attribute [rw] range_maximum
|
|
10300
|
+
# The maximum date value for the range filter.
|
|
10301
|
+
# @return [Types::DataSetDateFilterValue]
|
|
10302
|
+
#
|
|
10303
|
+
# @!attribute [rw] include_minimum
|
|
10304
|
+
# Whether to include the minimum value in the filter range.
|
|
10305
|
+
# @return [Boolean]
|
|
10306
|
+
#
|
|
10307
|
+
# @!attribute [rw] include_maximum
|
|
10308
|
+
# Whether to include the maximum value in the filter range.
|
|
10309
|
+
# @return [Boolean]
|
|
10310
|
+
#
|
|
10311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetDateRangeFilterCondition AWS API Documentation
|
|
10312
|
+
#
|
|
10313
|
+
class DataSetDateRangeFilterCondition < Struct.new(
|
|
10314
|
+
:range_minimum,
|
|
10315
|
+
:range_maximum,
|
|
10316
|
+
:include_minimum,
|
|
10317
|
+
:include_maximum)
|
|
10318
|
+
SENSITIVE = []
|
|
10319
|
+
include Aws::Structure
|
|
10320
|
+
end
|
|
10321
|
+
|
|
9906
10322
|
# A data set.
|
|
9907
10323
|
#
|
|
9908
10324
|
# @!attribute [rw] identifier
|
|
@@ -9922,6 +10338,97 @@ module Aws::QuickSight
|
|
|
9922
10338
|
include Aws::Structure
|
|
9923
10339
|
end
|
|
9924
10340
|
|
|
10341
|
+
# A filter condition that compares numeric values using operators like
|
|
10342
|
+
# `EQUALS`, `GREATER_THAN`, or `LESS_THAN`.
|
|
10343
|
+
#
|
|
10344
|
+
# @!attribute [rw] operator
|
|
10345
|
+
# The comparison operator to use, such as `EQUALS`, `GREATER_THAN`,
|
|
10346
|
+
# `LESS_THAN`, or their variants.
|
|
10347
|
+
# @return [String]
|
|
10348
|
+
#
|
|
10349
|
+
# @!attribute [rw] value
|
|
10350
|
+
# The numeric value to compare against.
|
|
10351
|
+
# @return [Types::DataSetNumericFilterValue]
|
|
10352
|
+
#
|
|
10353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericComparisonFilterCondition AWS API Documentation
|
|
10354
|
+
#
|
|
10355
|
+
class DataSetNumericComparisonFilterCondition < Struct.new(
|
|
10356
|
+
:operator,
|
|
10357
|
+
:value)
|
|
10358
|
+
SENSITIVE = []
|
|
10359
|
+
include Aws::Structure
|
|
10360
|
+
end
|
|
10361
|
+
|
|
10362
|
+
# A filter condition for numeric columns, supporting both comparison and
|
|
10363
|
+
# range-based filtering.
|
|
10364
|
+
#
|
|
10365
|
+
# @!attribute [rw] column_name
|
|
10366
|
+
# The name of the numeric column to filter.
|
|
10367
|
+
# @return [String]
|
|
10368
|
+
#
|
|
10369
|
+
# @!attribute [rw] comparison_filter_condition
|
|
10370
|
+
# A comparison-based filter condition for the numeric column.
|
|
10371
|
+
# @return [Types::DataSetNumericComparisonFilterCondition]
|
|
10372
|
+
#
|
|
10373
|
+
# @!attribute [rw] range_filter_condition
|
|
10374
|
+
# A range-based filter condition for the numeric column, filtering
|
|
10375
|
+
# values between minimum and maximum numbers.
|
|
10376
|
+
# @return [Types::DataSetNumericRangeFilterCondition]
|
|
10377
|
+
#
|
|
10378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericFilterCondition AWS API Documentation
|
|
10379
|
+
#
|
|
10380
|
+
class DataSetNumericFilterCondition < Struct.new(
|
|
10381
|
+
:column_name,
|
|
10382
|
+
:comparison_filter_condition,
|
|
10383
|
+
:range_filter_condition)
|
|
10384
|
+
SENSITIVE = []
|
|
10385
|
+
include Aws::Structure
|
|
10386
|
+
end
|
|
10387
|
+
|
|
10388
|
+
# Represents a numeric value used in filter conditions.
|
|
10389
|
+
#
|
|
10390
|
+
# @!attribute [rw] static_value
|
|
10391
|
+
# A static numeric value used for filtering.
|
|
10392
|
+
# @return [Float]
|
|
10393
|
+
#
|
|
10394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericFilterValue AWS API Documentation
|
|
10395
|
+
#
|
|
10396
|
+
class DataSetNumericFilterValue < Struct.new(
|
|
10397
|
+
:static_value)
|
|
10398
|
+
SENSITIVE = [:static_value]
|
|
10399
|
+
include Aws::Structure
|
|
10400
|
+
end
|
|
10401
|
+
|
|
10402
|
+
# A filter condition that filters numeric values within a specified
|
|
10403
|
+
# range.
|
|
10404
|
+
#
|
|
10405
|
+
# @!attribute [rw] range_minimum
|
|
10406
|
+
# The minimum numeric value for the range filter.
|
|
10407
|
+
# @return [Types::DataSetNumericFilterValue]
|
|
10408
|
+
#
|
|
10409
|
+
# @!attribute [rw] range_maximum
|
|
10410
|
+
# The maximum numeric value for the range filter.
|
|
10411
|
+
# @return [Types::DataSetNumericFilterValue]
|
|
10412
|
+
#
|
|
10413
|
+
# @!attribute [rw] include_minimum
|
|
10414
|
+
# Whether to include the minimum value in the filter range.
|
|
10415
|
+
# @return [Boolean]
|
|
10416
|
+
#
|
|
10417
|
+
# @!attribute [rw] include_maximum
|
|
10418
|
+
# Whether to include the maximum value in the filter range.
|
|
10419
|
+
# @return [Boolean]
|
|
10420
|
+
#
|
|
10421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetNumericRangeFilterCondition AWS API Documentation
|
|
10422
|
+
#
|
|
10423
|
+
class DataSetNumericRangeFilterCondition < Struct.new(
|
|
10424
|
+
:range_minimum,
|
|
10425
|
+
:range_maximum,
|
|
10426
|
+
:include_minimum,
|
|
10427
|
+
:include_maximum)
|
|
10428
|
+
SENSITIVE = []
|
|
10429
|
+
include Aws::Structure
|
|
10430
|
+
end
|
|
10431
|
+
|
|
9925
10432
|
# Dataset reference.
|
|
9926
10433
|
#
|
|
9927
10434
|
# @!attribute [rw] data_set_placeholder
|
|
@@ -10046,6 +10553,102 @@ module Aws::QuickSight
|
|
|
10046
10553
|
include Aws::Structure
|
|
10047
10554
|
end
|
|
10048
10555
|
|
|
10556
|
+
# A filter condition that compares string values using operators like
|
|
10557
|
+
# `EQUALS`, `CONTAINS`, or `STARTS_WITH`.
|
|
10558
|
+
#
|
|
10559
|
+
# @!attribute [rw] operator
|
|
10560
|
+
# The comparison operator to use, such as `EQUALS`, `CONTAINS`,
|
|
10561
|
+
# `STARTS_WITH`, `ENDS_WITH`, or their negations.
|
|
10562
|
+
# @return [String]
|
|
10563
|
+
#
|
|
10564
|
+
# @!attribute [rw] value
|
|
10565
|
+
# The string value to compare against.
|
|
10566
|
+
# @return [Types::DataSetStringFilterValue]
|
|
10567
|
+
#
|
|
10568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringComparisonFilterCondition AWS API Documentation
|
|
10569
|
+
#
|
|
10570
|
+
class DataSetStringComparisonFilterCondition < Struct.new(
|
|
10571
|
+
:operator,
|
|
10572
|
+
:value)
|
|
10573
|
+
SENSITIVE = []
|
|
10574
|
+
include Aws::Structure
|
|
10575
|
+
end
|
|
10576
|
+
|
|
10577
|
+
# A filter condition for string columns, supporting both comparison and
|
|
10578
|
+
# list-based filtering.
|
|
10579
|
+
#
|
|
10580
|
+
# @!attribute [rw] column_name
|
|
10581
|
+
# The name of the string column to filter.
|
|
10582
|
+
# @return [String]
|
|
10583
|
+
#
|
|
10584
|
+
# @!attribute [rw] comparison_filter_condition
|
|
10585
|
+
# A comparison-based filter condition for the string column.
|
|
10586
|
+
# @return [Types::DataSetStringComparisonFilterCondition]
|
|
10587
|
+
#
|
|
10588
|
+
# @!attribute [rw] list_filter_condition
|
|
10589
|
+
# A list-based filter condition that includes or excludes values from
|
|
10590
|
+
# a specified list.
|
|
10591
|
+
# @return [Types::DataSetStringListFilterCondition]
|
|
10592
|
+
#
|
|
10593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringFilterCondition AWS API Documentation
|
|
10594
|
+
#
|
|
10595
|
+
class DataSetStringFilterCondition < Struct.new(
|
|
10596
|
+
:column_name,
|
|
10597
|
+
:comparison_filter_condition,
|
|
10598
|
+
:list_filter_condition)
|
|
10599
|
+
SENSITIVE = []
|
|
10600
|
+
include Aws::Structure
|
|
10601
|
+
end
|
|
10602
|
+
|
|
10603
|
+
# Represents a string value used in filter conditions.
|
|
10604
|
+
#
|
|
10605
|
+
# @!attribute [rw] static_value
|
|
10606
|
+
# A static string value used for filtering.
|
|
10607
|
+
# @return [String]
|
|
10608
|
+
#
|
|
10609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringFilterValue AWS API Documentation
|
|
10610
|
+
#
|
|
10611
|
+
class DataSetStringFilterValue < Struct.new(
|
|
10612
|
+
:static_value)
|
|
10613
|
+
SENSITIVE = [:static_value]
|
|
10614
|
+
include Aws::Structure
|
|
10615
|
+
end
|
|
10616
|
+
|
|
10617
|
+
# A filter condition that includes or excludes string values from a
|
|
10618
|
+
# specified list.
|
|
10619
|
+
#
|
|
10620
|
+
# @!attribute [rw] operator
|
|
10621
|
+
# The list operator to use, either `INCLUDE` to match values in the
|
|
10622
|
+
# list or `EXCLUDE` to filter out values in the list.
|
|
10623
|
+
# @return [String]
|
|
10624
|
+
#
|
|
10625
|
+
# @!attribute [rw] values
|
|
10626
|
+
# The list of string values to include or exclude in the filter.
|
|
10627
|
+
# @return [Types::DataSetStringListFilterValue]
|
|
10628
|
+
#
|
|
10629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringListFilterCondition AWS API Documentation
|
|
10630
|
+
#
|
|
10631
|
+
class DataSetStringListFilterCondition < Struct.new(
|
|
10632
|
+
:operator,
|
|
10633
|
+
:values)
|
|
10634
|
+
SENSITIVE = []
|
|
10635
|
+
include Aws::Structure
|
|
10636
|
+
end
|
|
10637
|
+
|
|
10638
|
+
# Represents a list of string values used in filter conditions.
|
|
10639
|
+
#
|
|
10640
|
+
# @!attribute [rw] static_values
|
|
10641
|
+
# A list of static string values used for filtering.
|
|
10642
|
+
# @return [Array<String>]
|
|
10643
|
+
#
|
|
10644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetStringListFilterValue AWS API Documentation
|
|
10645
|
+
#
|
|
10646
|
+
class DataSetStringListFilterValue < Struct.new(
|
|
10647
|
+
:static_values)
|
|
10648
|
+
SENSITIVE = [:static_values]
|
|
10649
|
+
include Aws::Structure
|
|
10650
|
+
end
|
|
10651
|
+
|
|
10049
10652
|
# Dataset summary.
|
|
10050
10653
|
#
|
|
10051
10654
|
# @!attribute [rw] arn
|
|
@@ -10074,9 +10677,15 @@ module Aws::QuickSight
|
|
|
10074
10677
|
# @return [String]
|
|
10075
10678
|
#
|
|
10076
10679
|
# @!attribute [rw] row_level_permission_data_set
|
|
10077
|
-
# The row-level security configuration for the dataset
|
|
10680
|
+
# The row-level security configuration for the dataset in the legacy
|
|
10681
|
+
# data preparation experience.
|
|
10078
10682
|
# @return [Types::RowLevelPermissionDataSet]
|
|
10079
10683
|
#
|
|
10684
|
+
# @!attribute [rw] row_level_permission_data_set_map
|
|
10685
|
+
# The row-level security configuration for the dataset in the new data
|
|
10686
|
+
# preparation experience.
|
|
10687
|
+
# @return [Hash<String,Types::RowLevelPermissionDataSet>]
|
|
10688
|
+
#
|
|
10080
10689
|
# @!attribute [rw] row_level_permission_tag_configuration_applied
|
|
10081
10690
|
# Whether or not the row level permission tags are applied.
|
|
10082
10691
|
# @return [Boolean]
|
|
@@ -10100,6 +10709,7 @@ module Aws::QuickSight
|
|
|
10100
10709
|
:last_updated_time,
|
|
10101
10710
|
:import_mode,
|
|
10102
10711
|
:row_level_permission_data_set,
|
|
10712
|
+
:row_level_permission_data_set_map,
|
|
10103
10713
|
:row_level_permission_tag_configuration_applied,
|
|
10104
10714
|
:column_level_permission_rules_applied,
|
|
10105
10715
|
:use_as)
|
|
@@ -11817,7 +12427,7 @@ module Aws::QuickSight
|
|
|
11817
12427
|
# @return [String]
|
|
11818
12428
|
#
|
|
11819
12429
|
# @!attribute [rw] brand_id
|
|
11820
|
-
# The ID of the
|
|
12430
|
+
# The ID of the Quick Suite brand.
|
|
11821
12431
|
# @return [String]
|
|
11822
12432
|
#
|
|
11823
12433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteBrandRequest AWS API Documentation
|
|
@@ -11972,7 +12582,7 @@ module Aws::QuickSight
|
|
|
11972
12582
|
# @return [String]
|
|
11973
12583
|
#
|
|
11974
12584
|
# @!attribute [rw] data_set_id
|
|
11975
|
-
# The ID for the dataset that you want to
|
|
12585
|
+
# The ID for the dataset that you want to delete. This ID is unique
|
|
11976
12586
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
11977
12587
|
# @return [String]
|
|
11978
12588
|
#
|
|
@@ -11990,7 +12600,7 @@ module Aws::QuickSight
|
|
|
11990
12600
|
# @return [String]
|
|
11991
12601
|
#
|
|
11992
12602
|
# @!attribute [rw] data_set_id
|
|
11993
|
-
# The ID for the dataset that you want to
|
|
12603
|
+
# The ID for the dataset that you want to delete. This ID is unique
|
|
11994
12604
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
11995
12605
|
# @return [String]
|
|
11996
12606
|
#
|
|
@@ -13156,7 +13766,7 @@ module Aws::QuickSight
|
|
|
13156
13766
|
# sometimes referred to as a Quick Sight "account" even though it's
|
|
13157
13767
|
# technically not an account by itself. Instead, it's a subscription
|
|
13158
13768
|
# to the Amazon Quick Sight service for your Amazon Web Services
|
|
13159
|
-
# account. The edition that you subscribe to applies to
|
|
13769
|
+
# account. The edition that you subscribe to applies to Quick Suite in
|
|
13160
13770
|
# every Amazon Web Services Region where you use it.
|
|
13161
13771
|
# @return [Types::AccountSettings]
|
|
13162
13772
|
#
|
|
@@ -13819,7 +14429,7 @@ module Aws::QuickSight
|
|
|
13819
14429
|
# @return [String]
|
|
13820
14430
|
#
|
|
13821
14431
|
# @!attribute [rw] brand_id
|
|
13822
|
-
# The ID of the
|
|
14432
|
+
# The ID of the Quick Suite brand.
|
|
13823
14433
|
# @return [String]
|
|
13824
14434
|
#
|
|
13825
14435
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeBrandPublishedVersionRequest AWS API Documentation
|
|
@@ -13858,7 +14468,7 @@ module Aws::QuickSight
|
|
|
13858
14468
|
# @return [String]
|
|
13859
14469
|
#
|
|
13860
14470
|
# @!attribute [rw] brand_id
|
|
13861
|
-
# The ID of the
|
|
14471
|
+
# The ID of the Quick Suite brand.
|
|
13862
14472
|
# @return [String]
|
|
13863
14473
|
#
|
|
13864
14474
|
# @!attribute [rw] version_id
|
|
@@ -14399,7 +15009,7 @@ module Aws::QuickSight
|
|
|
14399
15009
|
# @return [String]
|
|
14400
15010
|
#
|
|
14401
15011
|
# @!attribute [rw] data_set_id
|
|
14402
|
-
# The ID for the dataset that you want to
|
|
15012
|
+
# The ID for the dataset that you want to describe. This ID is unique
|
|
14403
15013
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
14404
15014
|
# @return [String]
|
|
14405
15015
|
#
|
|
@@ -14417,7 +15027,7 @@ module Aws::QuickSight
|
|
|
14417
15027
|
# @return [String]
|
|
14418
15028
|
#
|
|
14419
15029
|
# @!attribute [rw] data_set_id
|
|
14420
|
-
# The ID for the dataset that you want to
|
|
15030
|
+
# The ID for the dataset that you want to describe. This ID is unique
|
|
14421
15031
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
14422
15032
|
# @return [String]
|
|
14423
15033
|
#
|
|
@@ -14489,7 +15099,7 @@ module Aws::QuickSight
|
|
|
14489
15099
|
# @return [String]
|
|
14490
15100
|
#
|
|
14491
15101
|
# @!attribute [rw] data_set_id
|
|
14492
|
-
# The ID for the dataset that you want to
|
|
15102
|
+
# The ID for the dataset that you want to describe. This ID is unique
|
|
14493
15103
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
14494
15104
|
# @return [String]
|
|
14495
15105
|
#
|
|
@@ -16093,6 +16703,43 @@ module Aws::QuickSight
|
|
|
16093
16703
|
include Aws::Structure
|
|
16094
16704
|
end
|
|
16095
16705
|
|
|
16706
|
+
# Defines a destination table in data preparation that receives the
|
|
16707
|
+
# final transformed data.
|
|
16708
|
+
#
|
|
16709
|
+
# @!attribute [rw] alias
|
|
16710
|
+
# Alias for the destination table.
|
|
16711
|
+
# @return [String]
|
|
16712
|
+
#
|
|
16713
|
+
# @!attribute [rw] source
|
|
16714
|
+
# The source configuration that specifies which transform operation
|
|
16715
|
+
# provides data to this destination table.
|
|
16716
|
+
# @return [Types::DestinationTableSource]
|
|
16717
|
+
#
|
|
16718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DestinationTable AWS API Documentation
|
|
16719
|
+
#
|
|
16720
|
+
class DestinationTable < Struct.new(
|
|
16721
|
+
:alias,
|
|
16722
|
+
:source)
|
|
16723
|
+
SENSITIVE = []
|
|
16724
|
+
include Aws::Structure
|
|
16725
|
+
end
|
|
16726
|
+
|
|
16727
|
+
# Specifies the source of data for a destination table, including the
|
|
16728
|
+
# transform operation and column mappings.
|
|
16729
|
+
#
|
|
16730
|
+
# @!attribute [rw] transform_operation_id
|
|
16731
|
+
# The identifier of the transform operation that provides data to the
|
|
16732
|
+
# destination table.
|
|
16733
|
+
# @return [String]
|
|
16734
|
+
#
|
|
16735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DestinationTableSource AWS API Documentation
|
|
16736
|
+
#
|
|
16737
|
+
class DestinationTableSource < Struct.new(
|
|
16738
|
+
:transform_operation_id)
|
|
16739
|
+
SENSITIVE = []
|
|
16740
|
+
include Aws::Structure
|
|
16741
|
+
end
|
|
16742
|
+
|
|
16096
16743
|
# The dimension type field.
|
|
16097
16744
|
#
|
|
16098
16745
|
# @!attribute [rw] numerical_dimension_field
|
|
@@ -17391,10 +18038,25 @@ module Aws::QuickSight
|
|
|
17391
18038
|
# the expression evaluates to true are kept in the dataset.
|
|
17392
18039
|
# @return [String]
|
|
17393
18040
|
#
|
|
18041
|
+
# @!attribute [rw] string_filter_condition
|
|
18042
|
+
# A string-based filter condition within a filter operation.
|
|
18043
|
+
# @return [Types::DataSetStringFilterCondition]
|
|
18044
|
+
#
|
|
18045
|
+
# @!attribute [rw] numeric_filter_condition
|
|
18046
|
+
# A numeric-based filter condition within a filter operation.
|
|
18047
|
+
# @return [Types::DataSetNumericFilterCondition]
|
|
18048
|
+
#
|
|
18049
|
+
# @!attribute [rw] date_filter_condition
|
|
18050
|
+
# A date-based filter condition within a filter operation.
|
|
18051
|
+
# @return [Types::DataSetDateFilterCondition]
|
|
18052
|
+
#
|
|
17394
18053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperation AWS API Documentation
|
|
17395
18054
|
#
|
|
17396
18055
|
class FilterOperation < Struct.new(
|
|
17397
|
-
:condition_expression
|
|
18056
|
+
:condition_expression,
|
|
18057
|
+
:string_filter_condition,
|
|
18058
|
+
:numeric_filter_condition,
|
|
18059
|
+
:date_filter_condition)
|
|
17398
18060
|
SENSITIVE = [:condition_expression]
|
|
17399
18061
|
include Aws::Structure
|
|
17400
18062
|
end
|
|
@@ -17648,6 +18310,31 @@ module Aws::QuickSight
|
|
|
17648
18310
|
include Aws::Structure
|
|
17649
18311
|
end
|
|
17650
18312
|
|
|
18313
|
+
# A transform operation that applies one or more filter conditions.
|
|
18314
|
+
#
|
|
18315
|
+
# @!attribute [rw] alias
|
|
18316
|
+
# Alias for this operation.
|
|
18317
|
+
# @return [String]
|
|
18318
|
+
#
|
|
18319
|
+
# @!attribute [rw] source
|
|
18320
|
+
# The source transform operation that provides input data for
|
|
18321
|
+
# filtering.
|
|
18322
|
+
# @return [Types::TransformOperationSource]
|
|
18323
|
+
#
|
|
18324
|
+
# @!attribute [rw] filter_operations
|
|
18325
|
+
# The list of filter operations to apply.
|
|
18326
|
+
# @return [Array<Types::FilterOperation>]
|
|
18327
|
+
#
|
|
18328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FiltersOperation AWS API Documentation
|
|
18329
|
+
#
|
|
18330
|
+
class FiltersOperation < Struct.new(
|
|
18331
|
+
:alias,
|
|
18332
|
+
:source,
|
|
18333
|
+
:filter_operations)
|
|
18334
|
+
SENSITIVE = []
|
|
18335
|
+
include Aws::Structure
|
|
18336
|
+
end
|
|
18337
|
+
|
|
17651
18338
|
# The basic information of the flow exluding its definition specifying
|
|
17652
18339
|
# the steps.
|
|
17653
18340
|
#
|
|
@@ -18220,6 +18907,14 @@ module Aws::QuickSight
|
|
|
18220
18907
|
# The loading animation configuration of a free-form layout element.
|
|
18221
18908
|
# @return [Types::LoadingAnimation]
|
|
18222
18909
|
#
|
|
18910
|
+
# @!attribute [rw] border_radius
|
|
18911
|
+
# The border radius of a free-form layout element.
|
|
18912
|
+
# @return [String]
|
|
18913
|
+
#
|
|
18914
|
+
# @!attribute [rw] padding
|
|
18915
|
+
# The padding of a free-form layout element.
|
|
18916
|
+
# @return [String]
|
|
18917
|
+
#
|
|
18223
18918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FreeFormLayoutElement AWS API Documentation
|
|
18224
18919
|
#
|
|
18225
18920
|
class FreeFormLayoutElement < Struct.new(
|
|
@@ -18234,7 +18929,9 @@ module Aws::QuickSight
|
|
|
18234
18929
|
:border_style,
|
|
18235
18930
|
:selected_border_style,
|
|
18236
18931
|
:background_style,
|
|
18237
|
-
:loading_animation
|
|
18932
|
+
:loading_animation,
|
|
18933
|
+
:border_radius,
|
|
18934
|
+
:padding)
|
|
18238
18935
|
SENSITIVE = []
|
|
18239
18936
|
include Aws::Structure
|
|
18240
18937
|
end
|
|
@@ -18268,11 +18965,16 @@ module Aws::QuickSight
|
|
|
18268
18965
|
# The border color of a free-form layout element.
|
|
18269
18966
|
# @return [String]
|
|
18270
18967
|
#
|
|
18968
|
+
# @!attribute [rw] width
|
|
18969
|
+
# The border width of a free-form layout element.
|
|
18970
|
+
# @return [String]
|
|
18971
|
+
#
|
|
18271
18972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FreeFormLayoutElementBorderStyle AWS API Documentation
|
|
18272
18973
|
#
|
|
18273
18974
|
class FreeFormLayoutElementBorderStyle < Struct.new(
|
|
18274
18975
|
:visibility,
|
|
18275
|
-
:color
|
|
18976
|
+
:color,
|
|
18977
|
+
:width)
|
|
18276
18978
|
SENSITIVE = []
|
|
18277
18979
|
include Aws::Structure
|
|
18278
18980
|
end
|
|
@@ -18770,7 +19472,7 @@ module Aws::QuickSight
|
|
|
18770
19472
|
#
|
|
18771
19473
|
# @!attribute [rw] namespace
|
|
18772
19474
|
# The Amazon Quick Sight namespace that the anonymous user virtually
|
|
18773
|
-
# belongs to. If you are not using an Amazon
|
|
19475
|
+
# belongs to. If you are not using an Amazon Quick Suite custom
|
|
18774
19476
|
# namespace, set this to `default`.
|
|
18775
19477
|
# @return [String]
|
|
18776
19478
|
#
|
|
@@ -18847,8 +19549,8 @@ module Aws::QuickSight
|
|
|
18847
19549
|
# @return [String]
|
|
18848
19550
|
#
|
|
18849
19551
|
# @!attribute [rw] anonymous_user_arn
|
|
18850
|
-
# The Amazon Resource Name (ARN) to use for the anonymous Amazon
|
|
18851
|
-
#
|
|
19552
|
+
# The Amazon Resource Name (ARN) to use for the anonymous Amazon Quick
|
|
19553
|
+
# Suite user.
|
|
18852
19554
|
# @return [String]
|
|
18853
19555
|
#
|
|
18854
19556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserResponse AWS API Documentation
|
|
@@ -18878,7 +19580,7 @@ module Aws::QuickSight
|
|
|
18878
19580
|
#
|
|
18879
19581
|
# @!attribute [rw] experience_configuration
|
|
18880
19582
|
# The experience that you want to embed. For registered users, you can
|
|
18881
|
-
# embed
|
|
19583
|
+
# embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon
|
|
18882
19584
|
# Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A
|
|
18883
19585
|
# experience, or the entire Amazon Quick Sight console.
|
|
18884
19586
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
|
@@ -18941,7 +19643,7 @@ module Aws::QuickSight
|
|
|
18941
19643
|
#
|
|
18942
19644
|
# @!attribute [rw] experience_configuration
|
|
18943
19645
|
# The type of experience you want to embed. For registered users, you
|
|
18944
|
-
# can embed
|
|
19646
|
+
# can embed Quick Suite dashboards or the Amazon Quick Sight console.
|
|
18945
19647
|
#
|
|
18946
19648
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
|
18947
19649
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more
|
|
@@ -19983,9 +20685,9 @@ module Aws::QuickSight
|
|
|
19983
20685
|
# @return [Boolean]
|
|
19984
20686
|
#
|
|
19985
20687
|
# @!attribute [rw] user_arn
|
|
19986
|
-
# The Amazon
|
|
20688
|
+
# The Amazon Quick Suite user's Amazon Resource Name (ARN), for use
|
|
19987
20689
|
# with `QUICKSIGHT` identity type. You can use this for any Amazon
|
|
19988
|
-
#
|
|
20690
|
+
# Quick Suite users in your account (readers, authors, or admins)
|
|
19989
20691
|
# authenticated as one of the following:
|
|
19990
20692
|
#
|
|
19991
20693
|
# * Active Directory (AD) users or group members
|
|
@@ -20010,7 +20712,7 @@ module Aws::QuickSight
|
|
|
20010
20712
|
# A list of one or more dashboard IDs that you want anonymous users to
|
|
20011
20713
|
# have tempporary access to. Currently, the `IdentityType` parameter
|
|
20012
20714
|
# must be set to `ANONYMOUS` because other identity types authenticate
|
|
20013
|
-
# as
|
|
20715
|
+
# as Quick Suite or IAM users. For example, if you set
|
|
20014
20716
|
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
|
20015
20717
|
# identity-type ANONYMOUS`", the session can access all three
|
|
20016
20718
|
# dashboards.
|
|
@@ -20223,9 +20925,9 @@ module Aws::QuickSight
|
|
|
20223
20925
|
# @return [Integer]
|
|
20224
20926
|
#
|
|
20225
20927
|
# @!attribute [rw] user_arn
|
|
20226
|
-
# The Amazon
|
|
20928
|
+
# The Amazon Quick Suite user's Amazon Resource Name (ARN), for use
|
|
20227
20929
|
# with `QUICKSIGHT` identity type. You can use this for any type of
|
|
20228
|
-
# Amazon
|
|
20930
|
+
# Amazon Quick Suite users in your account (readers, authors, or
|
|
20229
20931
|
# admins). They need to be authenticated as one of the following:
|
|
20230
20932
|
#
|
|
20231
20933
|
# 1. Active Directory (AD) users or group members
|
|
@@ -20253,7 +20955,7 @@ module Aws::QuickSight
|
|
|
20253
20955
|
|
|
20254
20956
|
# @!attribute [rw] embed_url
|
|
20255
20957
|
# A single-use URL that you can put into your server-side web page to
|
|
20256
|
-
# embed your
|
|
20958
|
+
# embed your Quick Suite session. This URL is valid for 5 minutes. The
|
|
20257
20959
|
# API operation provides the URL with an `auth_code` value that
|
|
20258
20960
|
# enables one (and only one) sign-on to a user session that is valid
|
|
20259
20961
|
# for 10 hours.
|
|
@@ -20398,6 +21100,31 @@ module Aws::QuickSight
|
|
|
20398
21100
|
# The height of a grid element expressed as a number of grid rows.
|
|
20399
21101
|
# @return [Integer]
|
|
20400
21102
|
#
|
|
21103
|
+
# @!attribute [rw] border_style
|
|
21104
|
+
# The border style configuration of a grid layout element.
|
|
21105
|
+
# @return [Types::GridLayoutElementBorderStyle]
|
|
21106
|
+
#
|
|
21107
|
+
# @!attribute [rw] selected_border_style
|
|
21108
|
+
# The border style configuration of a grid layout element. This border
|
|
21109
|
+
# style is used when the element is selected.
|
|
21110
|
+
# @return [Types::GridLayoutElementBorderStyle]
|
|
21111
|
+
#
|
|
21112
|
+
# @!attribute [rw] background_style
|
|
21113
|
+
# The background style configuration of a grid layout element.
|
|
21114
|
+
# @return [Types::GridLayoutElementBackgroundStyle]
|
|
21115
|
+
#
|
|
21116
|
+
# @!attribute [rw] loading_animation
|
|
21117
|
+
# The configuration of loading animation in free-form layout.
|
|
21118
|
+
# @return [Types::LoadingAnimation]
|
|
21119
|
+
#
|
|
21120
|
+
# @!attribute [rw] border_radius
|
|
21121
|
+
# The border radius of a grid layout element.
|
|
21122
|
+
# @return [String]
|
|
21123
|
+
#
|
|
21124
|
+
# @!attribute [rw] padding
|
|
21125
|
+
# The padding of a grid layout element.
|
|
21126
|
+
# @return [String]
|
|
21127
|
+
#
|
|
20401
21128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GridLayoutElement AWS API Documentation
|
|
20402
21129
|
#
|
|
20403
21130
|
class GridLayoutElement < Struct.new(
|
|
@@ -20406,7 +21133,56 @@ module Aws::QuickSight
|
|
|
20406
21133
|
:column_index,
|
|
20407
21134
|
:column_span,
|
|
20408
21135
|
:row_index,
|
|
20409
|
-
:row_span
|
|
21136
|
+
:row_span,
|
|
21137
|
+
:border_style,
|
|
21138
|
+
:selected_border_style,
|
|
21139
|
+
:background_style,
|
|
21140
|
+
:loading_animation,
|
|
21141
|
+
:border_radius,
|
|
21142
|
+
:padding)
|
|
21143
|
+
SENSITIVE = []
|
|
21144
|
+
include Aws::Structure
|
|
21145
|
+
end
|
|
21146
|
+
|
|
21147
|
+
# The background style configuration of a grid layout element.
|
|
21148
|
+
#
|
|
21149
|
+
# @!attribute [rw] visibility
|
|
21150
|
+
# The background visibility of a grid layout element.
|
|
21151
|
+
# @return [String]
|
|
21152
|
+
#
|
|
21153
|
+
# @!attribute [rw] color
|
|
21154
|
+
# The background color of a grid layout element.
|
|
21155
|
+
# @return [String]
|
|
21156
|
+
#
|
|
21157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GridLayoutElementBackgroundStyle AWS API Documentation
|
|
21158
|
+
#
|
|
21159
|
+
class GridLayoutElementBackgroundStyle < Struct.new(
|
|
21160
|
+
:visibility,
|
|
21161
|
+
:color)
|
|
21162
|
+
SENSITIVE = []
|
|
21163
|
+
include Aws::Structure
|
|
21164
|
+
end
|
|
21165
|
+
|
|
21166
|
+
# The border style configuration of a grid layout element.
|
|
21167
|
+
#
|
|
21168
|
+
# @!attribute [rw] visibility
|
|
21169
|
+
# The border visibility of a grid layout element.
|
|
21170
|
+
# @return [String]
|
|
21171
|
+
#
|
|
21172
|
+
# @!attribute [rw] color
|
|
21173
|
+
# The border color of a grid layout element.
|
|
21174
|
+
# @return [String]
|
|
21175
|
+
#
|
|
21176
|
+
# @!attribute [rw] width
|
|
21177
|
+
# The border width of a grid layout element.
|
|
21178
|
+
# @return [String]
|
|
21179
|
+
#
|
|
21180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GridLayoutElementBorderStyle AWS API Documentation
|
|
21181
|
+
#
|
|
21182
|
+
class GridLayoutElementBorderStyle < Struct.new(
|
|
21183
|
+
:visibility,
|
|
21184
|
+
:color,
|
|
21185
|
+
:width)
|
|
20410
21186
|
SENSITIVE = []
|
|
20411
21187
|
include Aws::Structure
|
|
20412
21188
|
end
|
|
@@ -21320,6 +22096,47 @@ module Aws::QuickSight
|
|
|
21320
22096
|
include Aws::Structure
|
|
21321
22097
|
end
|
|
21322
22098
|
|
|
22099
|
+
# A transform operation that imports data from a source table.
|
|
22100
|
+
#
|
|
22101
|
+
# @!attribute [rw] alias
|
|
22102
|
+
# Alias for this operation.
|
|
22103
|
+
# @return [String]
|
|
22104
|
+
#
|
|
22105
|
+
# @!attribute [rw] source
|
|
22106
|
+
# The source configuration that specifies which source table to import
|
|
22107
|
+
# and any column mappings.
|
|
22108
|
+
# @return [Types::ImportTableOperationSource]
|
|
22109
|
+
#
|
|
22110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ImportTableOperation AWS API Documentation
|
|
22111
|
+
#
|
|
22112
|
+
class ImportTableOperation < Struct.new(
|
|
22113
|
+
:alias,
|
|
22114
|
+
:source)
|
|
22115
|
+
SENSITIVE = []
|
|
22116
|
+
include Aws::Structure
|
|
22117
|
+
end
|
|
22118
|
+
|
|
22119
|
+
# Specifies the source table and column mappings for an import table
|
|
22120
|
+
# operation.
|
|
22121
|
+
#
|
|
22122
|
+
# @!attribute [rw] source_table_id
|
|
22123
|
+
# The identifier of the source table to import data from.
|
|
22124
|
+
# @return [String]
|
|
22125
|
+
#
|
|
22126
|
+
# @!attribute [rw] column_id_mappings
|
|
22127
|
+
# The mappings between source column identifiers and target column
|
|
22128
|
+
# identifiers during the import.
|
|
22129
|
+
# @return [Array<Types::DataSetColumnIdMapping>]
|
|
22130
|
+
#
|
|
22131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ImportTableOperationSource AWS API Documentation
|
|
22132
|
+
#
|
|
22133
|
+
class ImportTableOperationSource < Struct.new(
|
|
22134
|
+
:source_table_id,
|
|
22135
|
+
:column_id_mappings)
|
|
22136
|
+
SENSITIVE = []
|
|
22137
|
+
include Aws::Structure
|
|
22138
|
+
end
|
|
22139
|
+
|
|
21323
22140
|
# The incremental refresh configuration for a dataset.
|
|
21324
22141
|
#
|
|
21325
22142
|
# @!attribute [rw] lookback_window
|
|
@@ -21420,6 +22237,10 @@ module Aws::QuickSight
|
|
|
21420
22237
|
# The name of this column in the underlying data source.
|
|
21421
22238
|
# @return [String]
|
|
21422
22239
|
#
|
|
22240
|
+
# @!attribute [rw] id
|
|
22241
|
+
# A unique identifier for the input column.
|
|
22242
|
+
# @return [String]
|
|
22243
|
+
#
|
|
21423
22244
|
# @!attribute [rw] type
|
|
21424
22245
|
# The data type of the column.
|
|
21425
22246
|
# @return [String]
|
|
@@ -21433,6 +22254,7 @@ module Aws::QuickSight
|
|
|
21433
22254
|
#
|
|
21434
22255
|
class InputColumn < Struct.new(
|
|
21435
22256
|
:name,
|
|
22257
|
+
:id,
|
|
21436
22258
|
:type,
|
|
21437
22259
|
:sub_type)
|
|
21438
22260
|
SENSITIVE = []
|
|
@@ -21698,6 +22520,25 @@ module Aws::QuickSight
|
|
|
21698
22520
|
include Aws::Structure
|
|
21699
22521
|
end
|
|
21700
22522
|
|
|
22523
|
+
# An exception thrown when an invalid parameter value is provided for
|
|
22524
|
+
# dataset operations.
|
|
22525
|
+
#
|
|
22526
|
+
# @!attribute [rw] message
|
|
22527
|
+
# @return [String]
|
|
22528
|
+
#
|
|
22529
|
+
# @!attribute [rw] request_id
|
|
22530
|
+
# The Amazon Web Services request ID for this request.
|
|
22531
|
+
# @return [String]
|
|
22532
|
+
#
|
|
22533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidDataSetParameterValueException AWS API Documentation
|
|
22534
|
+
#
|
|
22535
|
+
class InvalidDataSetParameterValueException < Struct.new(
|
|
22536
|
+
:message,
|
|
22537
|
+
:request_id)
|
|
22538
|
+
SENSITIVE = []
|
|
22539
|
+
include Aws::Structure
|
|
22540
|
+
end
|
|
22541
|
+
|
|
21701
22542
|
# The `NextToken` value isn't valid.
|
|
21702
22543
|
#
|
|
21703
22544
|
# @!attribute [rw] message
|
|
@@ -21866,6 +22707,71 @@ module Aws::QuickSight
|
|
|
21866
22707
|
include Aws::Structure
|
|
21867
22708
|
end
|
|
21868
22709
|
|
|
22710
|
+
# Properties that control how columns are handled for a join operand,
|
|
22711
|
+
# including column name overrides.
|
|
22712
|
+
#
|
|
22713
|
+
# @!attribute [rw] output_column_name_overrides
|
|
22714
|
+
# A list of column name overrides to apply to the join operand's
|
|
22715
|
+
# output columns.
|
|
22716
|
+
# @return [Array<Types::OutputColumnNameOverride>]
|
|
22717
|
+
#
|
|
22718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinOperandProperties AWS API Documentation
|
|
22719
|
+
#
|
|
22720
|
+
class JoinOperandProperties < Struct.new(
|
|
22721
|
+
:output_column_name_overrides)
|
|
22722
|
+
SENSITIVE = []
|
|
22723
|
+
include Aws::Structure
|
|
22724
|
+
end
|
|
22725
|
+
|
|
22726
|
+
# A transform operation that combines data from two sources based on
|
|
22727
|
+
# specified join conditions.
|
|
22728
|
+
#
|
|
22729
|
+
# @!attribute [rw] alias
|
|
22730
|
+
# Alias for this operation.
|
|
22731
|
+
# @return [String]
|
|
22732
|
+
#
|
|
22733
|
+
# @!attribute [rw] left_operand
|
|
22734
|
+
# The left operand for the join operation.
|
|
22735
|
+
# @return [Types::TransformOperationSource]
|
|
22736
|
+
#
|
|
22737
|
+
# @!attribute [rw] right_operand
|
|
22738
|
+
# The right operand for the join operation.
|
|
22739
|
+
# @return [Types::TransformOperationSource]
|
|
22740
|
+
#
|
|
22741
|
+
# @!attribute [rw] type
|
|
22742
|
+
# The type of join to perform, such as `INNER`, `LEFT`, `RIGHT`, or
|
|
22743
|
+
# `OUTER`.
|
|
22744
|
+
# @return [String]
|
|
22745
|
+
#
|
|
22746
|
+
# @!attribute [rw] on_clause
|
|
22747
|
+
# The join condition that specifies how to match rows between the left
|
|
22748
|
+
# and right operands.
|
|
22749
|
+
# @return [String]
|
|
22750
|
+
#
|
|
22751
|
+
# @!attribute [rw] left_operand_properties
|
|
22752
|
+
# Properties that control how the left operand's columns are handled
|
|
22753
|
+
# in the join result.
|
|
22754
|
+
# @return [Types::JoinOperandProperties]
|
|
22755
|
+
#
|
|
22756
|
+
# @!attribute [rw] right_operand_properties
|
|
22757
|
+
# Properties that control how the right operand's columns are handled
|
|
22758
|
+
# in the join result.
|
|
22759
|
+
# @return [Types::JoinOperandProperties]
|
|
22760
|
+
#
|
|
22761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinOperation AWS API Documentation
|
|
22762
|
+
#
|
|
22763
|
+
class JoinOperation < Struct.new(
|
|
22764
|
+
:alias,
|
|
22765
|
+
:left_operand,
|
|
22766
|
+
:right_operand,
|
|
22767
|
+
:type,
|
|
22768
|
+
:on_clause,
|
|
22769
|
+
:left_operand_properties,
|
|
22770
|
+
:right_operand_properties)
|
|
22771
|
+
SENSITIVE = [:on_clause]
|
|
22772
|
+
include Aws::Structure
|
|
22773
|
+
end
|
|
22774
|
+
|
|
21869
22775
|
# The conditional formatting for the actual value of a KPI visual.
|
|
21870
22776
|
#
|
|
21871
22777
|
# @!attribute [rw] text_color
|
|
@@ -26225,6 +27131,10 @@ module Aws::QuickSight
|
|
|
26225
27131
|
# The display name of the column..
|
|
26226
27132
|
# @return [String]
|
|
26227
27133
|
#
|
|
27134
|
+
# @!attribute [rw] id
|
|
27135
|
+
# A unique identifier for the output column.
|
|
27136
|
+
# @return [String]
|
|
27137
|
+
#
|
|
26228
27138
|
# @!attribute [rw] description
|
|
26229
27139
|
# A description for a column.
|
|
26230
27140
|
# @return [String]
|
|
@@ -26241,6 +27151,7 @@ module Aws::QuickSight
|
|
|
26241
27151
|
#
|
|
26242
27152
|
class OutputColumn < Struct.new(
|
|
26243
27153
|
:name,
|
|
27154
|
+
:id,
|
|
26244
27155
|
:description,
|
|
26245
27156
|
:type,
|
|
26246
27157
|
:sub_type)
|
|
@@ -26248,6 +27159,26 @@ module Aws::QuickSight
|
|
|
26248
27159
|
include Aws::Structure
|
|
26249
27160
|
end
|
|
26250
27161
|
|
|
27162
|
+
# Specifies a mapping to override the name of an output column from a
|
|
27163
|
+
# transform operation.
|
|
27164
|
+
#
|
|
27165
|
+
# @!attribute [rw] source_column_name
|
|
27166
|
+
# The original name of the column from the source transform operation.
|
|
27167
|
+
# @return [String]
|
|
27168
|
+
#
|
|
27169
|
+
# @!attribute [rw] output_column_name
|
|
27170
|
+
# The new name to assign to the column in the output.
|
|
27171
|
+
# @return [String]
|
|
27172
|
+
#
|
|
27173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OutputColumnNameOverride AWS API Documentation
|
|
27174
|
+
#
|
|
27175
|
+
class OutputColumnNameOverride < Struct.new(
|
|
27176
|
+
:source_column_name,
|
|
27177
|
+
:output_column_name)
|
|
27178
|
+
SENSITIVE = []
|
|
27179
|
+
include Aws::Structure
|
|
27180
|
+
end
|
|
27181
|
+
|
|
26251
27182
|
# A transform operation that overrides the dataset parameter values that
|
|
26252
27183
|
# are defined in another dataset.
|
|
26253
27184
|
#
|
|
@@ -26767,6 +27698,26 @@ module Aws::QuickSight
|
|
|
26767
27698
|
include Aws::Structure
|
|
26768
27699
|
end
|
|
26769
27700
|
|
|
27701
|
+
# References a parent dataset that serves as a data source, including
|
|
27702
|
+
# its columns and metadata.
|
|
27703
|
+
#
|
|
27704
|
+
# @!attribute [rw] data_set_arn
|
|
27705
|
+
# The Amazon Resource Name (ARN) of the parent dataset.
|
|
27706
|
+
# @return [String]
|
|
27707
|
+
#
|
|
27708
|
+
# @!attribute [rw] input_columns
|
|
27709
|
+
# The list of input columns available from the parent dataset.
|
|
27710
|
+
# @return [Array<Types::InputColumn>]
|
|
27711
|
+
#
|
|
27712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ParentDataSet AWS API Documentation
|
|
27713
|
+
#
|
|
27714
|
+
class ParentDataSet < Struct.new(
|
|
27715
|
+
:data_set_arn,
|
|
27716
|
+
:input_columns)
|
|
27717
|
+
SENSITIVE = []
|
|
27718
|
+
include Aws::Structure
|
|
27719
|
+
end
|
|
27720
|
+
|
|
26770
27721
|
# The percent range in the visible range.
|
|
26771
27722
|
#
|
|
26772
27723
|
# @!attribute [rw] from
|
|
@@ -26980,8 +27931,8 @@ module Aws::QuickSight
|
|
|
26980
27931
|
#
|
|
26981
27932
|
# @!attribute [rw] principal
|
|
26982
27933
|
# 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
|
|
27934
|
+
# Amazon Quick Suite user, group or namespace associated with the
|
|
27935
|
+
# flow. Namespace principal can only be set as a viewer and will grant
|
|
26985
27936
|
# everyone in the same namespace viewer permissions.
|
|
26986
27937
|
# @return [String]
|
|
26987
27938
|
#
|
|
@@ -27012,12 +27963,17 @@ module Aws::QuickSight
|
|
|
27012
27963
|
# A physical table type for as S3 data source.
|
|
27013
27964
|
# @return [Types::S3Source]
|
|
27014
27965
|
#
|
|
27966
|
+
# @!attribute [rw] saa_s_table
|
|
27967
|
+
# A physical table type for Software-as-a-Service (SaaS) sources.
|
|
27968
|
+
# @return [Types::SaaSTable]
|
|
27969
|
+
#
|
|
27015
27970
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PhysicalTable AWS API Documentation
|
|
27016
27971
|
#
|
|
27017
27972
|
class PhysicalTable < Struct.new(
|
|
27018
27973
|
:relational_table,
|
|
27019
27974
|
:custom_sql,
|
|
27020
|
-
:s3_source
|
|
27975
|
+
:s3_source,
|
|
27976
|
+
:saa_s_table)
|
|
27021
27977
|
SENSITIVE = []
|
|
27022
27978
|
include Aws::Structure
|
|
27023
27979
|
end
|
|
@@ -27234,6 +28190,27 @@ module Aws::QuickSight
|
|
|
27234
28190
|
include Aws::Structure
|
|
27235
28191
|
end
|
|
27236
28192
|
|
|
28193
|
+
# Configuration for a pivot operation, specifying which column contains
|
|
28194
|
+
# labels and how to pivot them.
|
|
28195
|
+
#
|
|
28196
|
+
# @!attribute [rw] label_column_name
|
|
28197
|
+
# The name of the column that contains the labels to be pivoted into
|
|
28198
|
+
# separate columns.
|
|
28199
|
+
# @return [String]
|
|
28200
|
+
#
|
|
28201
|
+
# @!attribute [rw] pivoted_labels
|
|
28202
|
+
# The list of specific label values to pivot into separate columns.
|
|
28203
|
+
# @return [Array<Types::PivotedLabel>]
|
|
28204
|
+
#
|
|
28205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotConfiguration AWS API Documentation
|
|
28206
|
+
#
|
|
28207
|
+
class PivotConfiguration < Struct.new(
|
|
28208
|
+
:label_column_name,
|
|
28209
|
+
:pivoted_labels)
|
|
28210
|
+
SENSITIVE = []
|
|
28211
|
+
include Aws::Structure
|
|
28212
|
+
end
|
|
28213
|
+
|
|
27237
28214
|
# The field sort options for a pivot table sort configuration.
|
|
27238
28215
|
#
|
|
27239
28216
|
# @!attribute [rw] field_id
|
|
@@ -27253,6 +28230,45 @@ module Aws::QuickSight
|
|
|
27253
28230
|
include Aws::Structure
|
|
27254
28231
|
end
|
|
27255
28232
|
|
|
28233
|
+
# A transform operation that pivots data by converting row values into
|
|
28234
|
+
# columns.
|
|
28235
|
+
#
|
|
28236
|
+
# @!attribute [rw] alias
|
|
28237
|
+
# Alias for this operation.
|
|
28238
|
+
# @return [String]
|
|
28239
|
+
#
|
|
28240
|
+
# @!attribute [rw] source
|
|
28241
|
+
# The source transform operation that provides input data for
|
|
28242
|
+
# pivoting.
|
|
28243
|
+
# @return [Types::TransformOperationSource]
|
|
28244
|
+
#
|
|
28245
|
+
# @!attribute [rw] group_by_column_names
|
|
28246
|
+
# The list of column names to group by when performing the pivot
|
|
28247
|
+
# operation.
|
|
28248
|
+
# @return [Array<String>]
|
|
28249
|
+
#
|
|
28250
|
+
# @!attribute [rw] value_column_configuration
|
|
28251
|
+
# Configuration for how to aggregate values when multiple rows map to
|
|
28252
|
+
# the same pivoted column.
|
|
28253
|
+
# @return [Types::ValueColumnConfiguration]
|
|
28254
|
+
#
|
|
28255
|
+
# @!attribute [rw] pivot_configuration
|
|
28256
|
+
# Configuration that specifies which labels to pivot and how to
|
|
28257
|
+
# structure the resulting columns.
|
|
28258
|
+
# @return [Types::PivotConfiguration]
|
|
28259
|
+
#
|
|
28260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotOperation AWS API Documentation
|
|
28261
|
+
#
|
|
28262
|
+
class PivotOperation < Struct.new(
|
|
28263
|
+
:alias,
|
|
28264
|
+
:source,
|
|
28265
|
+
:group_by_column_names,
|
|
28266
|
+
:value_column_configuration,
|
|
28267
|
+
:pivot_configuration)
|
|
28268
|
+
SENSITIVE = []
|
|
28269
|
+
include Aws::Structure
|
|
28270
|
+
end
|
|
28271
|
+
|
|
27256
28272
|
# The aggregated field well for the pivot table.
|
|
27257
28273
|
#
|
|
27258
28274
|
# @!attribute [rw] rows
|
|
@@ -27839,6 +28855,32 @@ module Aws::QuickSight
|
|
|
27839
28855
|
include Aws::Structure
|
|
27840
28856
|
end
|
|
27841
28857
|
|
|
28858
|
+
# Specifies a label value to be pivoted into a separate column,
|
|
28859
|
+
# including the new column name and identifier.
|
|
28860
|
+
#
|
|
28861
|
+
# @!attribute [rw] label_name
|
|
28862
|
+
# The label value from the source data to be pivoted.
|
|
28863
|
+
# @return [String]
|
|
28864
|
+
#
|
|
28865
|
+
# @!attribute [rw] new_column_name
|
|
28866
|
+
# The name for the new column created from this pivoted label.
|
|
28867
|
+
# @return [String]
|
|
28868
|
+
#
|
|
28869
|
+
# @!attribute [rw] new_column_id
|
|
28870
|
+
# A unique identifier for the new column created from this pivoted
|
|
28871
|
+
# label.
|
|
28872
|
+
# @return [String]
|
|
28873
|
+
#
|
|
28874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotedLabel AWS API Documentation
|
|
28875
|
+
#
|
|
28876
|
+
class PivotedLabel < Struct.new(
|
|
28877
|
+
:label_name,
|
|
28878
|
+
:new_column_name,
|
|
28879
|
+
:new_column_id)
|
|
28880
|
+
SENSITIVE = []
|
|
28881
|
+
include Aws::Structure
|
|
28882
|
+
end
|
|
28883
|
+
|
|
27842
28884
|
# A flexible visualization type that allows engineers to create new
|
|
27843
28885
|
# custom charts in Quick Sight.
|
|
27844
28886
|
#
|
|
@@ -28190,6 +29232,15 @@ module Aws::QuickSight
|
|
|
28190
29232
|
# A transform operation that projects columns. Operations that come
|
|
28191
29233
|
# after a projection can only refer to projected columns.
|
|
28192
29234
|
#
|
|
29235
|
+
# @!attribute [rw] alias
|
|
29236
|
+
# Alias for this operation.
|
|
29237
|
+
# @return [String]
|
|
29238
|
+
#
|
|
29239
|
+
# @!attribute [rw] source
|
|
29240
|
+
# The source transform operation that provides input data for column
|
|
29241
|
+
# projection.
|
|
29242
|
+
# @return [Types::TransformOperationSource]
|
|
29243
|
+
#
|
|
28193
29244
|
# @!attribute [rw] projected_columns
|
|
28194
29245
|
# Projected columns.
|
|
28195
29246
|
# @return [Array<String>]
|
|
@@ -28197,6 +29248,8 @@ module Aws::QuickSight
|
|
|
28197
29248
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ProjectOperation AWS API Documentation
|
|
28198
29249
|
#
|
|
28199
29250
|
class ProjectOperation < Struct.new(
|
|
29251
|
+
:alias,
|
|
29252
|
+
:source,
|
|
28200
29253
|
:projected_columns)
|
|
28201
29254
|
SENSITIVE = []
|
|
28202
29255
|
include Aws::Structure
|
|
@@ -29810,7 +30863,7 @@ module Aws::QuickSight
|
|
|
29810
30863
|
end
|
|
29811
30864
|
|
|
29812
30865
|
# The type of experience you want to embed. For registered users, you
|
|
29813
|
-
# can embed
|
|
30866
|
+
# can embed Quick Suite dashboards or the Amazon Quick Sight console.
|
|
29814
30867
|
#
|
|
29815
30868
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
|
29816
30869
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
|
@@ -29828,7 +30881,7 @@ module Aws::QuickSight
|
|
|
29828
30881
|
# console embedding experience. This can be used along with custom
|
|
29829
30882
|
# permissions to restrict access to certain features. For more
|
|
29830
30883
|
# information, see [Customizing Access to the Amazon Quick Sight
|
|
29831
|
-
# Console][1] in the *Amazon
|
|
30884
|
+
# Console][1] in the *Amazon Quick Suite User Guide*.
|
|
29832
30885
|
#
|
|
29833
30886
|
# Use ` GenerateEmbedUrlForRegisteredUser ` where you want to provide
|
|
29834
30887
|
# an authoring portal that allows users to create data sources,
|
|
@@ -29839,16 +30892,16 @@ module Aws::QuickSight
|
|
|
29839
30892
|
# the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
|
|
29840
30893
|
# operation to add a new user with a custom permission profile
|
|
29841
30894
|
# attached. For more information, see the following sections in the
|
|
29842
|
-
# *Amazon
|
|
30895
|
+
# *Amazon Quick Suite User Guide*:
|
|
29843
30896
|
#
|
|
29844
30897
|
# * [Embedding the Full Functionality of the Amazon Quick Sight
|
|
29845
30898
|
# Console for Authenticated Users][2]
|
|
29846
30899
|
#
|
|
29847
|
-
# * [Customizing Access to the Amazon
|
|
30900
|
+
# * [Customizing Access to the Amazon Quick Suite Console][1]
|
|
29848
30901
|
#
|
|
29849
30902
|
# For more information about the high-level steps for embedding and
|
|
29850
30903
|
# for an interactive demo of the ways you can customize embedding,
|
|
29851
|
-
# visit the [Amazon
|
|
30904
|
+
# visit the [Amazon Quick Suite Developer Portal][3].
|
|
29852
30905
|
#
|
|
29853
30906
|
#
|
|
29854
30907
|
#
|
|
@@ -29904,7 +30957,7 @@ module Aws::QuickSight
|
|
|
29904
30957
|
# @!attribute [rw] initial_topic_id
|
|
29905
30958
|
# The ID of the new Q reader experience topic that you want to make
|
|
29906
30959
|
# the starting topic in the Generative Q&A experience. You can
|
|
29907
|
-
# find a topic ID by navigating to the Topics pane in the
|
|
30960
|
+
# find a topic ID by navigating to the Topics pane in the Quick Suite
|
|
29908
30961
|
# application and opening a topic. The ID is in the URL for the topic
|
|
29909
30962
|
# that you open.
|
|
29910
30963
|
#
|
|
@@ -30153,6 +31206,32 @@ module Aws::QuickSight
|
|
|
30153
31206
|
include Aws::Structure
|
|
30154
31207
|
end
|
|
30155
31208
|
|
|
31209
|
+
# A transform operation that renames one or more columns in the dataset.
|
|
31210
|
+
#
|
|
31211
|
+
# @!attribute [rw] alias
|
|
31212
|
+
# Alias for this operation.
|
|
31213
|
+
# @return [String]
|
|
31214
|
+
#
|
|
31215
|
+
# @!attribute [rw] source
|
|
31216
|
+
# The source transform operation that provides input data for column
|
|
31217
|
+
# renaming.
|
|
31218
|
+
# @return [Types::TransformOperationSource]
|
|
31219
|
+
#
|
|
31220
|
+
# @!attribute [rw] rename_column_operations
|
|
31221
|
+
# The list of column rename operations to perform, specifying old and
|
|
31222
|
+
# new column names.
|
|
31223
|
+
# @return [Array<Types::RenameColumnOperation>]
|
|
31224
|
+
#
|
|
31225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RenameColumnsOperation AWS API Documentation
|
|
31226
|
+
#
|
|
31227
|
+
class RenameColumnsOperation < Struct.new(
|
|
31228
|
+
:alias,
|
|
31229
|
+
:source,
|
|
31230
|
+
:rename_column_operations)
|
|
31231
|
+
SENSITIVE = []
|
|
31232
|
+
include Aws::Structure
|
|
31233
|
+
end
|
|
31234
|
+
|
|
30156
31235
|
# The resource specified already exists.
|
|
30157
31236
|
#
|
|
30158
31237
|
# @!attribute [rw] message
|
|
@@ -30383,6 +31462,35 @@ module Aws::QuickSight
|
|
|
30383
31462
|
include Aws::Structure
|
|
30384
31463
|
end
|
|
30385
31464
|
|
|
31465
|
+
# Configuration for row level security.
|
|
31466
|
+
#
|
|
31467
|
+
# @!attribute [rw] tag_configuration
|
|
31468
|
+
# The configuration of tags on a dataset to set row-level security.
|
|
31469
|
+
# @return [Types::RowLevelPermissionTagConfiguration]
|
|
31470
|
+
#
|
|
31471
|
+
# @!attribute [rw] row_level_permission_data_set
|
|
31472
|
+
# Information about a dataset that contains permissions for row-level
|
|
31473
|
+
# security (RLS). The permissions dataset maps fields to users or
|
|
31474
|
+
# groups. For more information, see [Using Row-Level Security (RLS) to
|
|
31475
|
+
# Restrict Access to a Dataset][1] in the *Quick Sight User Guide*.
|
|
31476
|
+
#
|
|
31477
|
+
# The option to deny permissions by setting `PermissionPolicy` to
|
|
31478
|
+
# `DENY_ACCESS` is not supported for new RLS datasets.
|
|
31479
|
+
#
|
|
31480
|
+
#
|
|
31481
|
+
#
|
|
31482
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html
|
|
31483
|
+
# @return [Types::RowLevelPermissionDataSet]
|
|
31484
|
+
#
|
|
31485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionConfiguration AWS API Documentation
|
|
31486
|
+
#
|
|
31487
|
+
class RowLevelPermissionConfiguration < Struct.new(
|
|
31488
|
+
:tag_configuration,
|
|
31489
|
+
:row_level_permission_data_set)
|
|
31490
|
+
SENSITIVE = []
|
|
31491
|
+
include Aws::Structure
|
|
31492
|
+
end
|
|
31493
|
+
|
|
30386
31494
|
# Information about a dataset that contains permissions for row-level
|
|
30387
31495
|
# security (RLS). The permissions dataset maps fields to users or
|
|
30388
31496
|
# groups. For more information, see [Using Row-Level Security (RLS) to
|
|
@@ -30618,6 +31726,31 @@ module Aws::QuickSight
|
|
|
30618
31726
|
include Aws::Structure
|
|
30619
31727
|
end
|
|
30620
31728
|
|
|
31729
|
+
# A table from a Software-as-a-Service (SaaS) data source, including
|
|
31730
|
+
# connection details and column definitions.
|
|
31731
|
+
#
|
|
31732
|
+
# @!attribute [rw] data_source_arn
|
|
31733
|
+
# The Amazon Resource Name (ARN) of the SaaS data source.
|
|
31734
|
+
# @return [String]
|
|
31735
|
+
#
|
|
31736
|
+
# @!attribute [rw] table_path
|
|
31737
|
+
# The hierarchical path to the table within the SaaS data source.
|
|
31738
|
+
# @return [Array<Types::TablePathElement>]
|
|
31739
|
+
#
|
|
31740
|
+
# @!attribute [rw] input_columns
|
|
31741
|
+
# The list of input columns available from the SaaS table.
|
|
31742
|
+
# @return [Array<Types::InputColumn>]
|
|
31743
|
+
#
|
|
31744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SaaSTable AWS API Documentation
|
|
31745
|
+
#
|
|
31746
|
+
class SaaSTable < Struct.new(
|
|
31747
|
+
:data_source_arn,
|
|
31748
|
+
:table_path,
|
|
31749
|
+
:input_columns)
|
|
31750
|
+
SENSITIVE = []
|
|
31751
|
+
include Aws::Structure
|
|
31752
|
+
end
|
|
31753
|
+
|
|
30621
31754
|
# The configuration of the same-sheet target visuals that you want to be
|
|
30622
31755
|
# filtered.
|
|
30623
31756
|
#
|
|
@@ -31858,6 +32991,48 @@ module Aws::QuickSight
|
|
|
31858
32991
|
include Aws::Structure
|
|
31859
32992
|
end
|
|
31860
32993
|
|
|
32994
|
+
# Configuration for the semantic model that defines how prepared data is
|
|
32995
|
+
# structured for analysis and reporting.
|
|
32996
|
+
#
|
|
32997
|
+
# @!attribute [rw] table_map
|
|
32998
|
+
# A map of semantic tables that define the analytical structure.
|
|
32999
|
+
# @return [Hash<String,Types::SemanticTable>]
|
|
33000
|
+
#
|
|
33001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SemanticModelConfiguration AWS API Documentation
|
|
33002
|
+
#
|
|
33003
|
+
class SemanticModelConfiguration < Struct.new(
|
|
33004
|
+
:table_map)
|
|
33005
|
+
SENSITIVE = []
|
|
33006
|
+
include Aws::Structure
|
|
33007
|
+
end
|
|
33008
|
+
|
|
33009
|
+
# A semantic table that represents the final analytical structure of the
|
|
33010
|
+
# data.
|
|
33011
|
+
#
|
|
33012
|
+
# @!attribute [rw] alias
|
|
33013
|
+
# Alias for the semantic table.
|
|
33014
|
+
# @return [String]
|
|
33015
|
+
#
|
|
33016
|
+
# @!attribute [rw] destination_table_id
|
|
33017
|
+
# The identifier of the destination table from data preparation that
|
|
33018
|
+
# provides data to this semantic table.
|
|
33019
|
+
# @return [String]
|
|
33020
|
+
#
|
|
33021
|
+
# @!attribute [rw] row_level_permission_configuration
|
|
33022
|
+
# Configuration for row level security that control data access for
|
|
33023
|
+
# this semantic table.
|
|
33024
|
+
# @return [Types::RowLevelPermissionConfiguration]
|
|
33025
|
+
#
|
|
33026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SemanticTable AWS API Documentation
|
|
33027
|
+
#
|
|
33028
|
+
class SemanticTable < Struct.new(
|
|
33029
|
+
:alias,
|
|
33030
|
+
:destination_table_id,
|
|
33031
|
+
:row_level_permission_configuration)
|
|
33032
|
+
SENSITIVE = []
|
|
33033
|
+
include Aws::Structure
|
|
33034
|
+
end
|
|
33035
|
+
|
|
31861
33036
|
# A structure that represents a semantic type.
|
|
31862
33037
|
#
|
|
31863
33038
|
# @!attribute [rw] type_name
|
|
@@ -32058,6 +33233,25 @@ module Aws::QuickSight
|
|
|
32058
33233
|
include Aws::Structure
|
|
32059
33234
|
end
|
|
32060
33235
|
|
|
33236
|
+
# The background configuration for sheets.
|
|
33237
|
+
#
|
|
33238
|
+
# @!attribute [rw] color
|
|
33239
|
+
# The solid color background option for sheets.
|
|
33240
|
+
# @return [String]
|
|
33241
|
+
#
|
|
33242
|
+
# @!attribute [rw] gradient
|
|
33243
|
+
# The gradient background option for sheets.
|
|
33244
|
+
# @return [String]
|
|
33245
|
+
#
|
|
33246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetBackgroundStyle AWS API Documentation
|
|
33247
|
+
#
|
|
33248
|
+
class SheetBackgroundStyle < Struct.new(
|
|
33249
|
+
:color,
|
|
33250
|
+
:gradient)
|
|
33251
|
+
SENSITIVE = []
|
|
33252
|
+
include Aws::Structure
|
|
33253
|
+
end
|
|
33254
|
+
|
|
32061
33255
|
# A control to display info icons for filters and parameters.
|
|
32062
33256
|
#
|
|
32063
33257
|
# @!attribute [rw] visibility
|
|
@@ -32140,7 +33334,7 @@ module Aws::QuickSight
|
|
|
32140
33334
|
#
|
|
32141
33335
|
# @!attribute [rw] name
|
|
32142
33336
|
# The name of the sheet. This name is displayed on the sheet's tab in
|
|
32143
|
-
# the
|
|
33337
|
+
# the Quick Suite console.
|
|
32144
33338
|
# @return [String]
|
|
32145
33339
|
#
|
|
32146
33340
|
# @!attribute [rw] parameter_controls
|
|
@@ -32422,11 +33616,16 @@ module Aws::QuickSight
|
|
|
32422
33616
|
# The layout options for tiles.
|
|
32423
33617
|
# @return [Types::TileLayoutStyle]
|
|
32424
33618
|
#
|
|
33619
|
+
# @!attribute [rw] background
|
|
33620
|
+
# The background for sheets.
|
|
33621
|
+
# @return [Types::SheetBackgroundStyle]
|
|
33622
|
+
#
|
|
32425
33623
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetStyle AWS API Documentation
|
|
32426
33624
|
#
|
|
32427
33625
|
class SheetStyle < Struct.new(
|
|
32428
33626
|
:tile,
|
|
32429
|
-
:tile_layout
|
|
33627
|
+
:tile_layout,
|
|
33628
|
+
:background)
|
|
32430
33629
|
SENSITIVE = []
|
|
32431
33630
|
include Aws::Structure
|
|
32432
33631
|
end
|
|
@@ -32687,7 +33886,7 @@ module Aws::QuickSight
|
|
|
32687
33886
|
# These are not the tags that are used for Amazon Web Services
|
|
32688
33887
|
# resource tagging. For more information on row level security in
|
|
32689
33888
|
# Amazon Quick Sight, see [Using Row-Level Security (RLS) with
|
|
32690
|
-
# Tags][1]in the *Amazon
|
|
33889
|
+
# Tags][1]in the *Amazon Quick Suite User Guide*.
|
|
32691
33890
|
#
|
|
32692
33891
|
#
|
|
32693
33892
|
#
|
|
@@ -33040,6 +34239,27 @@ module Aws::QuickSight
|
|
|
33040
34239
|
include Aws::Structure
|
|
33041
34240
|
end
|
|
33042
34241
|
|
|
34242
|
+
# A source table that provides initial data from either a physical table
|
|
34243
|
+
# or parent dataset.
|
|
34244
|
+
#
|
|
34245
|
+
# @!attribute [rw] physical_table_id
|
|
34246
|
+
# The identifier of the physical table that serves as the data source.
|
|
34247
|
+
# @return [String]
|
|
34248
|
+
#
|
|
34249
|
+
# @!attribute [rw] data_set
|
|
34250
|
+
# A parent dataset that serves as the data source instead of a
|
|
34251
|
+
# physical table.
|
|
34252
|
+
# @return [Types::ParentDataSet]
|
|
34253
|
+
#
|
|
34254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SourceTable AWS API Documentation
|
|
34255
|
+
#
|
|
34256
|
+
class SourceTable < Struct.new(
|
|
34257
|
+
:physical_table_id,
|
|
34258
|
+
:data_set)
|
|
34259
|
+
SENSITIVE = []
|
|
34260
|
+
include Aws::Structure
|
|
34261
|
+
end
|
|
34262
|
+
|
|
33043
34263
|
# The configuration of spacing (often a margin or padding).
|
|
33044
34264
|
#
|
|
33045
34265
|
# @!attribute [rw] top
|
|
@@ -34345,6 +35565,26 @@ module Aws::QuickSight
|
|
|
34345
35565
|
include Aws::Structure
|
|
34346
35566
|
end
|
|
34347
35567
|
|
|
35568
|
+
# An element in the hierarchical path to a table within a data source,
|
|
35569
|
+
# containing both name and identifier.
|
|
35570
|
+
#
|
|
35571
|
+
# @!attribute [rw] name
|
|
35572
|
+
# The name of the path element.
|
|
35573
|
+
# @return [String]
|
|
35574
|
+
#
|
|
35575
|
+
# @!attribute [rw] id
|
|
35576
|
+
# The unique identifier of the path element.
|
|
35577
|
+
# @return [String]
|
|
35578
|
+
#
|
|
35579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TablePathElement AWS API Documentation
|
|
35580
|
+
#
|
|
35581
|
+
class TablePathElement < Struct.new(
|
|
35582
|
+
:name,
|
|
35583
|
+
:id)
|
|
35584
|
+
SENSITIVE = []
|
|
35585
|
+
include Aws::Structure
|
|
35586
|
+
end
|
|
35587
|
+
|
|
34348
35588
|
# The settings for the pinned columns of a table visual.
|
|
34349
35589
|
#
|
|
34350
35590
|
# @!attribute [rw] pinned_left_fields
|
|
@@ -35447,14 +36687,29 @@ module Aws::QuickSight
|
|
|
35447
36687
|
|
|
35448
36688
|
# Display options related to tiles on a sheet.
|
|
35449
36689
|
#
|
|
36690
|
+
# @!attribute [rw] background_color
|
|
36691
|
+
# The background color of a tile.
|
|
36692
|
+
# @return [String]
|
|
36693
|
+
#
|
|
35450
36694
|
# @!attribute [rw] border
|
|
35451
36695
|
# The border around a tile.
|
|
35452
36696
|
# @return [Types::BorderStyle]
|
|
35453
36697
|
#
|
|
36698
|
+
# @!attribute [rw] border_radius
|
|
36699
|
+
# The border radius of a tile.
|
|
36700
|
+
# @return [String]
|
|
36701
|
+
#
|
|
36702
|
+
# @!attribute [rw] padding
|
|
36703
|
+
# The padding of a tile.
|
|
36704
|
+
# @return [String]
|
|
36705
|
+
#
|
|
35454
36706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TileStyle AWS API Documentation
|
|
35455
36707
|
#
|
|
35456
36708
|
class TileStyle < Struct.new(
|
|
35457
|
-
:
|
|
36709
|
+
:background_color,
|
|
36710
|
+
:border,
|
|
36711
|
+
:border_radius,
|
|
36712
|
+
:padding)
|
|
35458
36713
|
SENSITIVE = []
|
|
35459
36714
|
include Aws::Structure
|
|
35460
36715
|
end
|
|
@@ -37218,6 +38473,99 @@ module Aws::QuickSight
|
|
|
37218
38473
|
include Aws::Structure
|
|
37219
38474
|
end
|
|
37220
38475
|
|
|
38476
|
+
# Specifies the source of data for a transform operation, including the
|
|
38477
|
+
# source operation and column mappings.
|
|
38478
|
+
#
|
|
38479
|
+
# @!attribute [rw] transform_operation_id
|
|
38480
|
+
# The identifier of the transform operation that provides input data.
|
|
38481
|
+
# @return [String]
|
|
38482
|
+
#
|
|
38483
|
+
# @!attribute [rw] column_id_mappings
|
|
38484
|
+
# The mappings between source column identifiers and target column
|
|
38485
|
+
# identifiers for this transformation.
|
|
38486
|
+
# @return [Array<Types::DataSetColumnIdMapping>]
|
|
38487
|
+
#
|
|
38488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperationSource AWS API Documentation
|
|
38489
|
+
#
|
|
38490
|
+
class TransformOperationSource < Struct.new(
|
|
38491
|
+
:transform_operation_id,
|
|
38492
|
+
:column_id_mappings)
|
|
38493
|
+
SENSITIVE = []
|
|
38494
|
+
include Aws::Structure
|
|
38495
|
+
end
|
|
38496
|
+
|
|
38497
|
+
# A step in data preparation that performs a specific operation on the
|
|
38498
|
+
# data.
|
|
38499
|
+
#
|
|
38500
|
+
# @!attribute [rw] import_table_step
|
|
38501
|
+
# A transform step that brings data from a source table.
|
|
38502
|
+
# @return [Types::ImportTableOperation]
|
|
38503
|
+
#
|
|
38504
|
+
# @!attribute [rw] project_step
|
|
38505
|
+
# A transform operation that projects columns. Operations that come
|
|
38506
|
+
# after a projection can only refer to projected columns.
|
|
38507
|
+
# @return [Types::ProjectOperation]
|
|
38508
|
+
#
|
|
38509
|
+
# @!attribute [rw] filters_step
|
|
38510
|
+
# A transform step that applies filter conditions.
|
|
38511
|
+
# @return [Types::FiltersOperation]
|
|
38512
|
+
#
|
|
38513
|
+
# @!attribute [rw] create_columns_step
|
|
38514
|
+
# A transform operation that creates calculated columns. Columns
|
|
38515
|
+
# created in one such operation form a lexical closure.
|
|
38516
|
+
# @return [Types::CreateColumnsOperation]
|
|
38517
|
+
#
|
|
38518
|
+
# @!attribute [rw] rename_columns_step
|
|
38519
|
+
# A transform step that changes the names of one or more columns.
|
|
38520
|
+
# @return [Types::RenameColumnsOperation]
|
|
38521
|
+
#
|
|
38522
|
+
# @!attribute [rw] cast_column_types_step
|
|
38523
|
+
# A transform step that changes the data types of one or more columns.
|
|
38524
|
+
# @return [Types::CastColumnTypesOperation]
|
|
38525
|
+
#
|
|
38526
|
+
# @!attribute [rw] join_step
|
|
38527
|
+
# A transform step that combines data from two sources based on
|
|
38528
|
+
# specified join conditions.
|
|
38529
|
+
# @return [Types::JoinOperation]
|
|
38530
|
+
#
|
|
38531
|
+
# @!attribute [rw] aggregate_step
|
|
38532
|
+
# A transform step that groups data and applies aggregation functions
|
|
38533
|
+
# to calculate summary values.
|
|
38534
|
+
# @return [Types::AggregateOperation]
|
|
38535
|
+
#
|
|
38536
|
+
# @!attribute [rw] pivot_step
|
|
38537
|
+
# A transform step that converts row values into columns to reshape
|
|
38538
|
+
# the data structure.
|
|
38539
|
+
# @return [Types::PivotOperation]
|
|
38540
|
+
#
|
|
38541
|
+
# @!attribute [rw] unpivot_step
|
|
38542
|
+
# A transform step that converts columns into rows to normalize the
|
|
38543
|
+
# data structure.
|
|
38544
|
+
# @return [Types::UnpivotOperation]
|
|
38545
|
+
#
|
|
38546
|
+
# @!attribute [rw] append_step
|
|
38547
|
+
# A transform step that combines rows from multiple sources by
|
|
38548
|
+
# stacking them vertically.
|
|
38549
|
+
# @return [Types::AppendOperation]
|
|
38550
|
+
#
|
|
38551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformStep AWS API Documentation
|
|
38552
|
+
#
|
|
38553
|
+
class TransformStep < Struct.new(
|
|
38554
|
+
:import_table_step,
|
|
38555
|
+
:project_step,
|
|
38556
|
+
:filters_step,
|
|
38557
|
+
:create_columns_step,
|
|
38558
|
+
:rename_columns_step,
|
|
38559
|
+
:cast_column_types_step,
|
|
38560
|
+
:join_step,
|
|
38561
|
+
:aggregate_step,
|
|
38562
|
+
:pivot_step,
|
|
38563
|
+
:unpivot_step,
|
|
38564
|
+
:append_step)
|
|
38565
|
+
SENSITIVE = []
|
|
38566
|
+
include Aws::Structure
|
|
38567
|
+
end
|
|
38568
|
+
|
|
37221
38569
|
# The column option of the transposed table.
|
|
37222
38570
|
#
|
|
37223
38571
|
# @!attribute [rw] column_index
|
|
@@ -37494,10 +38842,45 @@ module Aws::QuickSight
|
|
|
37494
38842
|
# Determines the list of font families.
|
|
37495
38843
|
# @return [Array<Types::Font>]
|
|
37496
38844
|
#
|
|
38845
|
+
# @!attribute [rw] axis_title_font_configuration
|
|
38846
|
+
# Configures the display properties of the given text.
|
|
38847
|
+
# @return [Types::FontConfiguration]
|
|
38848
|
+
#
|
|
38849
|
+
# @!attribute [rw] axis_label_font_configuration
|
|
38850
|
+
# Configures the display properties of the given text.
|
|
38851
|
+
# @return [Types::FontConfiguration]
|
|
38852
|
+
#
|
|
38853
|
+
# @!attribute [rw] legend_title_font_configuration
|
|
38854
|
+
# Configures the display properties of the given text.
|
|
38855
|
+
# @return [Types::FontConfiguration]
|
|
38856
|
+
#
|
|
38857
|
+
# @!attribute [rw] legend_value_font_configuration
|
|
38858
|
+
# Configures the display properties of the given text.
|
|
38859
|
+
# @return [Types::FontConfiguration]
|
|
38860
|
+
#
|
|
38861
|
+
# @!attribute [rw] data_label_font_configuration
|
|
38862
|
+
# Configures the display properties of the given text.
|
|
38863
|
+
# @return [Types::FontConfiguration]
|
|
38864
|
+
#
|
|
38865
|
+
# @!attribute [rw] visual_title_font_configuration
|
|
38866
|
+
# Configures the display properties of the visual title.
|
|
38867
|
+
# @return [Types::VisualTitleFontConfiguration]
|
|
38868
|
+
#
|
|
38869
|
+
# @!attribute [rw] visual_subtitle_font_configuration
|
|
38870
|
+
# Configures the display properties of the visual sub-title.
|
|
38871
|
+
# @return [Types::VisualSubtitleFontConfiguration]
|
|
38872
|
+
#
|
|
37497
38873
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Typography AWS API Documentation
|
|
37498
38874
|
#
|
|
37499
38875
|
class Typography < Struct.new(
|
|
37500
|
-
:font_families
|
|
38876
|
+
:font_families,
|
|
38877
|
+
:axis_title_font_configuration,
|
|
38878
|
+
:axis_label_font_configuration,
|
|
38879
|
+
:legend_title_font_configuration,
|
|
38880
|
+
:legend_value_font_configuration,
|
|
38881
|
+
:data_label_font_configuration,
|
|
38882
|
+
:visual_title_font_configuration,
|
|
38883
|
+
:visual_subtitle_font_configuration)
|
|
37501
38884
|
SENSITIVE = []
|
|
37502
38885
|
include Aws::Structure
|
|
37503
38886
|
end
|
|
@@ -37676,6 +39059,55 @@ module Aws::QuickSight
|
|
|
37676
39059
|
include Aws::Structure
|
|
37677
39060
|
end
|
|
37678
39061
|
|
|
39062
|
+
# A transform operation that converts columns into rows, normalizing the
|
|
39063
|
+
# data structure.
|
|
39064
|
+
#
|
|
39065
|
+
# @!attribute [rw] alias
|
|
39066
|
+
# Alias for this operation.
|
|
39067
|
+
# @return [String]
|
|
39068
|
+
#
|
|
39069
|
+
# @!attribute [rw] source
|
|
39070
|
+
# The source transform operation that provides input data for
|
|
39071
|
+
# unpivoting.
|
|
39072
|
+
# @return [Types::TransformOperationSource]
|
|
39073
|
+
#
|
|
39074
|
+
# @!attribute [rw] columns_to_unpivot
|
|
39075
|
+
# The list of columns to unpivot from the source data.
|
|
39076
|
+
# @return [Array<Types::ColumnToUnpivot>]
|
|
39077
|
+
#
|
|
39078
|
+
# @!attribute [rw] unpivoted_label_column_name
|
|
39079
|
+
# The name for the new column that will contain the unpivoted column
|
|
39080
|
+
# names.
|
|
39081
|
+
# @return [String]
|
|
39082
|
+
#
|
|
39083
|
+
# @!attribute [rw] unpivoted_label_column_id
|
|
39084
|
+
# A unique identifier for the new column that will contain the
|
|
39085
|
+
# unpivoted column names.
|
|
39086
|
+
# @return [String]
|
|
39087
|
+
#
|
|
39088
|
+
# @!attribute [rw] unpivoted_value_column_name
|
|
39089
|
+
# The name for the new column that will contain the unpivoted values.
|
|
39090
|
+
# @return [String]
|
|
39091
|
+
#
|
|
39092
|
+
# @!attribute [rw] unpivoted_value_column_id
|
|
39093
|
+
# A unique identifier for the new column that will contain the
|
|
39094
|
+
# unpivoted values.
|
|
39095
|
+
# @return [String]
|
|
39096
|
+
#
|
|
39097
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnpivotOperation AWS API Documentation
|
|
39098
|
+
#
|
|
39099
|
+
class UnpivotOperation < Struct.new(
|
|
39100
|
+
:alias,
|
|
39101
|
+
:source,
|
|
39102
|
+
:columns_to_unpivot,
|
|
39103
|
+
:unpivoted_label_column_name,
|
|
39104
|
+
:unpivoted_label_column_id,
|
|
39105
|
+
:unpivoted_value_column_name,
|
|
39106
|
+
:unpivoted_value_column_id)
|
|
39107
|
+
SENSITIVE = []
|
|
39108
|
+
include Aws::Structure
|
|
39109
|
+
end
|
|
39110
|
+
|
|
37679
39111
|
# This error indicates that you are calling an embedding operation in
|
|
37680
39112
|
# Amazon Quick Sight without the required pricing plan on your Amazon
|
|
37681
39113
|
# Web Services account. Before you can use embedding for anonymous
|
|
@@ -38232,7 +39664,7 @@ module Aws::QuickSight
|
|
|
38232
39664
|
# @return [String]
|
|
38233
39665
|
#
|
|
38234
39666
|
# @!attribute [rw] namespace
|
|
38235
|
-
# The namespace of the
|
|
39667
|
+
# The namespace of the Quick Suite application.
|
|
38236
39668
|
# @return [String]
|
|
38237
39669
|
#
|
|
38238
39670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateApplicationWithTokenExchangeGrantRequest AWS API Documentation
|
|
@@ -38301,7 +39733,7 @@ module Aws::QuickSight
|
|
|
38301
39733
|
# @return [String]
|
|
38302
39734
|
#
|
|
38303
39735
|
# @!attribute [rw] brand_id
|
|
38304
|
-
# The ID of the
|
|
39736
|
+
# The ID of the Quick Suite brand.
|
|
38305
39737
|
# @return [String]
|
|
38306
39738
|
#
|
|
38307
39739
|
# @!attribute [rw] version_id
|
|
@@ -38340,7 +39772,7 @@ module Aws::QuickSight
|
|
|
38340
39772
|
# @return [String]
|
|
38341
39773
|
#
|
|
38342
39774
|
# @!attribute [rw] brand_id
|
|
38343
|
-
# The ID of the
|
|
39775
|
+
# The ID of the Quick Suite brand.
|
|
38344
39776
|
# @return [String]
|
|
38345
39777
|
#
|
|
38346
39778
|
# @!attribute [rw] brand_definition
|
|
@@ -38869,7 +40301,8 @@ module Aws::QuickSight
|
|
|
38869
40301
|
#
|
|
38870
40302
|
# @!attribute [rw] logical_table_map
|
|
38871
40303
|
# Configures the combination and transformation of the data from the
|
|
38872
|
-
# physical tables.
|
|
40304
|
+
# physical tables. This parameter is used with the legacy data
|
|
40305
|
+
# preparation experience.
|
|
38873
40306
|
# @return [Hash<String,Types::LogicalTable>]
|
|
38874
40307
|
#
|
|
38875
40308
|
# @!attribute [rw] import_mode
|
|
@@ -38888,13 +40321,15 @@ module Aws::QuickSight
|
|
|
38888
40321
|
#
|
|
38889
40322
|
# @!attribute [rw] row_level_permission_data_set
|
|
38890
40323
|
# The row-level security configuration for the data you want to
|
|
38891
|
-
# create.
|
|
40324
|
+
# create. This parameter is used with the legacy data preparation
|
|
40325
|
+
# experience.
|
|
38892
40326
|
# @return [Types::RowLevelPermissionDataSet]
|
|
38893
40327
|
#
|
|
38894
40328
|
# @!attribute [rw] row_level_permission_tag_configuration
|
|
38895
40329
|
# The configuration of tags on a dataset to set row-level security.
|
|
38896
40330
|
# Row-level security tags are currently supported for anonymous
|
|
38897
|
-
# embedding only.
|
|
40331
|
+
# embedding only. This parameter is used with the legacy data
|
|
40332
|
+
# preparation experience.
|
|
38898
40333
|
# @return [Types::RowLevelPermissionTagConfiguration]
|
|
38899
40334
|
#
|
|
38900
40335
|
# @!attribute [rw] column_level_permission_rules
|
|
@@ -38915,6 +40350,20 @@ module Aws::QuickSight
|
|
|
38915
40350
|
# that contains a `UniqueKey` configuration.
|
|
38916
40351
|
# @return [Types::PerformanceConfiguration]
|
|
38917
40352
|
#
|
|
40353
|
+
# @!attribute [rw] data_prep_configuration
|
|
40354
|
+
# The data preparation configuration for the dataset. This
|
|
40355
|
+
# configuration defines the source tables, transformation steps, and
|
|
40356
|
+
# destination tables used to prepare the data. Required when using the
|
|
40357
|
+
# new data preparation experience.
|
|
40358
|
+
# @return [Types::DataPrepConfiguration]
|
|
40359
|
+
#
|
|
40360
|
+
# @!attribute [rw] semantic_model_configuration
|
|
40361
|
+
# The semantic model configuration for the dataset. This configuration
|
|
40362
|
+
# defines how the prepared data is structured for an analysis,
|
|
40363
|
+
# including table mappings and row-level security configurations.
|
|
40364
|
+
# Required when using the new data preparation experience.
|
|
40365
|
+
# @return [Types::SemanticModelConfiguration]
|
|
40366
|
+
#
|
|
38918
40367
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
|
38919
40368
|
#
|
|
38920
40369
|
class UpdateDataSetRequest < Struct.new(
|
|
@@ -38931,7 +40380,9 @@ module Aws::QuickSight
|
|
|
38931
40380
|
:column_level_permission_rules,
|
|
38932
40381
|
:data_set_usage_configuration,
|
|
38933
40382
|
:dataset_parameters,
|
|
38934
|
-
:performance_configuration
|
|
40383
|
+
:performance_configuration,
|
|
40384
|
+
:data_prep_configuration,
|
|
40385
|
+
:semantic_model_configuration)
|
|
38935
40386
|
SENSITIVE = []
|
|
38936
40387
|
include Aws::Structure
|
|
38937
40388
|
end
|
|
@@ -38941,7 +40392,7 @@ module Aws::QuickSight
|
|
|
38941
40392
|
# @return [String]
|
|
38942
40393
|
#
|
|
38943
40394
|
# @!attribute [rw] data_set_id
|
|
38944
|
-
# The ID for the dataset that you want to
|
|
40395
|
+
# The ID for the dataset that you want to update. This ID is unique
|
|
38945
40396
|
# per Amazon Web Services Region for each Amazon Web Services account.
|
|
38946
40397
|
# @return [String]
|
|
38947
40398
|
#
|
|
@@ -39637,7 +41088,7 @@ module Aws::QuickSight
|
|
|
39637
41088
|
#
|
|
39638
41089
|
# @!attribute [rw] public_sharing_enabled
|
|
39639
41090
|
# A Boolean value that indicates whether public sharing is turned on
|
|
39640
|
-
# for an
|
|
41091
|
+
# for an Quick Suite account.
|
|
39641
41092
|
# @return [Boolean]
|
|
39642
41093
|
#
|
|
39643
41094
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation
|
|
@@ -40791,6 +42242,11 @@ module Aws::QuickSight
|
|
|
40791
42242
|
# The delimiter between values in the file.
|
|
40792
42243
|
# @return [String]
|
|
40793
42244
|
#
|
|
42245
|
+
# @!attribute [rw] custom_cell_address_range
|
|
42246
|
+
# A custom cell address range for Excel files, specifying which cells
|
|
42247
|
+
# to import from the spreadsheet.
|
|
42248
|
+
# @return [String]
|
|
42249
|
+
#
|
|
40794
42250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UploadSettings AWS API Documentation
|
|
40795
42251
|
#
|
|
40796
42252
|
class UploadSettings < Struct.new(
|
|
@@ -40798,7 +42254,8 @@ module Aws::QuickSight
|
|
|
40798
42254
|
:start_from_row,
|
|
40799
42255
|
:contains_header,
|
|
40800
42256
|
:text_qualifier,
|
|
40801
|
-
:delimiter
|
|
42257
|
+
:delimiter,
|
|
42258
|
+
:custom_cell_address_range)
|
|
40802
42259
|
SENSITIVE = []
|
|
40803
42260
|
include Aws::Structure
|
|
40804
42261
|
end
|
|
@@ -41072,6 +42529,22 @@ module Aws::QuickSight
|
|
|
41072
42529
|
include Aws::Structure
|
|
41073
42530
|
end
|
|
41074
42531
|
|
|
42532
|
+
# Configuration for how to handle value columns in pivot operations,
|
|
42533
|
+
# including aggregation settings.
|
|
42534
|
+
#
|
|
42535
|
+
# @!attribute [rw] aggregation_function
|
|
42536
|
+
# The aggregation function to apply when multiple values map to the
|
|
42537
|
+
# same pivoted cell.
|
|
42538
|
+
# @return [Types::DataPrepAggregationFunction]
|
|
42539
|
+
#
|
|
42540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ValueColumnConfiguration AWS API Documentation
|
|
42541
|
+
#
|
|
42542
|
+
class ValueColumnConfiguration < Struct.new(
|
|
42543
|
+
:aggregation_function)
|
|
42544
|
+
SENSITIVE = []
|
|
42545
|
+
include Aws::Structure
|
|
42546
|
+
end
|
|
42547
|
+
|
|
41075
42548
|
# The range options for the data zoom scroll bar.
|
|
41076
42549
|
#
|
|
41077
42550
|
# @!attribute [rw] percent_range
|
|
@@ -41567,6 +43040,30 @@ module Aws::QuickSight
|
|
|
41567
43040
|
include Aws::Structure
|
|
41568
43041
|
end
|
|
41569
43042
|
|
|
43043
|
+
# Configures the display properties of the visual sub-title.
|
|
43044
|
+
#
|
|
43045
|
+
# @!attribute [rw] font_configuration
|
|
43046
|
+
# Configures the display properties of the given text.
|
|
43047
|
+
# @return [Types::FontConfiguration]
|
|
43048
|
+
#
|
|
43049
|
+
# @!attribute [rw] text_alignment
|
|
43050
|
+
# Determines the alignment of visual sub-title.
|
|
43051
|
+
# @return [String]
|
|
43052
|
+
#
|
|
43053
|
+
# @!attribute [rw] text_transform
|
|
43054
|
+
# Determines the text transformation of visual sub-title.
|
|
43055
|
+
# @return [String]
|
|
43056
|
+
#
|
|
43057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/VisualSubtitleFontConfiguration AWS API Documentation
|
|
43058
|
+
#
|
|
43059
|
+
class VisualSubtitleFontConfiguration < Struct.new(
|
|
43060
|
+
:font_configuration,
|
|
43061
|
+
:text_alignment,
|
|
43062
|
+
:text_transform)
|
|
43063
|
+
SENSITIVE = []
|
|
43064
|
+
include Aws::Structure
|
|
43065
|
+
end
|
|
43066
|
+
|
|
41570
43067
|
# The subtitle label options for a visual.
|
|
41571
43068
|
#
|
|
41572
43069
|
# @!attribute [rw] visibility
|
|
@@ -41587,6 +43084,30 @@ module Aws::QuickSight
|
|
|
41587
43084
|
include Aws::Structure
|
|
41588
43085
|
end
|
|
41589
43086
|
|
|
43087
|
+
# Configures the display properties of the visual title.
|
|
43088
|
+
#
|
|
43089
|
+
# @!attribute [rw] font_configuration
|
|
43090
|
+
# Configures the display properties of the given text.
|
|
43091
|
+
# @return [Types::FontConfiguration]
|
|
43092
|
+
#
|
|
43093
|
+
# @!attribute [rw] text_alignment
|
|
43094
|
+
# Determines the alignment of visual title.
|
|
43095
|
+
# @return [String]
|
|
43096
|
+
#
|
|
43097
|
+
# @!attribute [rw] text_transform
|
|
43098
|
+
# Determines the text transformation of visual title.
|
|
43099
|
+
# @return [String]
|
|
43100
|
+
#
|
|
43101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/VisualTitleFontConfiguration AWS API Documentation
|
|
43102
|
+
#
|
|
43103
|
+
class VisualTitleFontConfiguration < Struct.new(
|
|
43104
|
+
:font_configuration,
|
|
43105
|
+
:text_alignment,
|
|
43106
|
+
:text_transform)
|
|
43107
|
+
SENSITIVE = []
|
|
43108
|
+
include Aws::Structure
|
|
43109
|
+
end
|
|
43110
|
+
|
|
41590
43111
|
# The title label options for a visual.
|
|
41591
43112
|
#
|
|
41592
43113
|
# @!attribute [rw] visibility
|