aws-sdk-quicksight 1.38.0 → 1.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +60 -24
- data/lib/aws-sdk-quicksight/client_api.rb +31 -0
- data/lib/aws-sdk-quicksight/types.rb +122 -38
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cd6245bd9e7887a69519566cd2f67da1048a1c05fc77e085e57531ac7a314189
|
4
|
+
data.tar.gz: eee313187fa5866c5ebc0b1739c70bd49314700773ac2a5476f374cd2cf36254
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cbd12bf79037993e1489f6c0bf2828e7a85400da81b0ba396b54f670ff609828cdd7c6504f7752588d3b717316e498f9febd4634689dd366a79db6c78e5673df
|
7
|
+
data.tar.gz: 0141e60fba61428f77758a7155982fb4ff439e37a67ed3d1b4251dca53e8c91779e67e73ea6ef9229566152a9e2ba87a1f5799c90be0fe6e225dc2248bb106c4
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -784,6 +784,10 @@ module Aws::QuickSight
|
|
784
784
|
# Groupings of columns that work together in certain QuickSight
|
785
785
|
# features. Currently, only geospatial hierarchy is supported.
|
786
786
|
#
|
787
|
+
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
788
|
+
# The folder that contains fields and nested subfolders for your
|
789
|
+
# dataset.
|
790
|
+
#
|
787
791
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
788
792
|
# A list of resource permissions on the dataset.
|
789
793
|
#
|
@@ -817,6 +821,7 @@ module Aws::QuickSight
|
|
817
821
|
# "PhysicalTableId" => {
|
818
822
|
# relational_table: {
|
819
823
|
# data_source_arn: "Arn", # required
|
824
|
+
# catalog: "RelationalTableCatalog",
|
820
825
|
# schema: "RelationalTableSchema",
|
821
826
|
# name: "RelationalTableName", # required
|
822
827
|
# input_columns: [ # required
|
@@ -924,6 +929,12 @@ module Aws::QuickSight
|
|
924
929
|
# },
|
925
930
|
# },
|
926
931
|
# ],
|
932
|
+
# field_folders: {
|
933
|
+
# "FieldFolderPath" => {
|
934
|
+
# description: "FieldFolderDescription",
|
935
|
+
# columns: ["String"],
|
936
|
+
# },
|
937
|
+
# },
|
927
938
|
# permissions: [
|
928
939
|
# {
|
929
940
|
# principal: "Principal", # required
|
@@ -981,9 +992,12 @@ module Aws::QuickSight
|
|
981
992
|
#
|
982
993
|
# @option params [required, String] :type
|
983
994
|
# The type of the data source. Currently, the supported types for this
|
984
|
-
# operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
|
985
|
-
#
|
986
|
-
# TERADATA`. Use `ListDataSources` to
|
995
|
+
# operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
|
996
|
+
# AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
|
997
|
+
# S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
|
998
|
+
# return a list of all data sources.
|
999
|
+
#
|
1000
|
+
# `AMAZON_ELASTICSEARCH` is for Amazon managed Elasticsearch Service.
|
987
1001
|
#
|
988
1002
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
989
1003
|
# The parameters that QuickSight uses to connect to your underlying
|
@@ -1445,7 +1459,7 @@ module Aws::QuickSight
|
|
1445
1459
|
#
|
1446
1460
|
#
|
1447
1461
|
#
|
1448
|
-
# [1]:
|
1462
|
+
# [1]: http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
|
1449
1463
|
#
|
1450
1464
|
# @option params [required, String] :data_set_id
|
1451
1465
|
# The ID of the dataset used in the ingestion.
|
@@ -2943,6 +2957,7 @@ module Aws::QuickSight
|
|
2943
2957
|
# resp.data_set.last_updated_time #=> Time
|
2944
2958
|
# resp.data_set.physical_table_map #=> Hash
|
2945
2959
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.data_source_arn #=> String
|
2960
|
+
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.catalog #=> String
|
2946
2961
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.schema #=> String
|
2947
2962
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.name #=> String
|
2948
2963
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns #=> Array
|
@@ -3000,6 +3015,10 @@ module Aws::QuickSight
|
|
3000
3015
|
# resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
|
3001
3016
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
|
3002
3017
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
|
3018
|
+
# resp.data_set.field_folders #=> Hash
|
3019
|
+
# resp.data_set.field_folders["FieldFolderPath"].description #=> String
|
3020
|
+
# resp.data_set.field_folders["FieldFolderPath"].columns #=> Array
|
3021
|
+
# resp.data_set.field_folders["FieldFolderPath"].columns[0] #=> String
|
3003
3022
|
# resp.data_set.row_level_permission_data_set.namespace #=> String
|
3004
3023
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
3005
3024
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
@@ -3853,19 +3872,20 @@ module Aws::QuickSight
|
|
3853
3872
|
#
|
3854
3873
|
# * The resulting user session is valid for 10 hours.
|
3855
3874
|
#
|
3856
|
-
# For more information, see [
|
3857
|
-
#
|
3875
|
+
# For more information, see [Embedded Analytics][1] in the *Amazon
|
3876
|
+
# QuickSight User Guide*.
|
3858
3877
|
#
|
3859
3878
|
#
|
3860
3879
|
#
|
3861
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/
|
3880
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
3862
3881
|
#
|
3863
3882
|
# @option params [required, String] :aws_account_id
|
3864
3883
|
# The ID for the AWS account that contains the dashboard that you're
|
3865
3884
|
# embedding.
|
3866
3885
|
#
|
3867
3886
|
# @option params [required, String] :dashboard_id
|
3868
|
-
# The ID for the dashboard, also added to the
|
3887
|
+
# The ID for the dashboard, also added to the AWS Identity and Access
|
3888
|
+
# Management (IAM) policy.
|
3869
3889
|
#
|
3870
3890
|
# @option params [required, String] :identity_type
|
3871
3891
|
# The authentication method that the user uses to sign in.
|
@@ -3887,10 +3907,10 @@ module Aws::QuickSight
|
|
3887
3907
|
# dashboard. Persistence applies to the sheet and the parameter
|
3888
3908
|
# settings. These are control settings that the dashboard subscriber
|
3889
3909
|
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
3890
|
-
# set to `TRUE`, the settings are the same when the
|
3891
|
-
#
|
3892
|
-
#
|
3893
|
-
#
|
3910
|
+
# set to `TRUE`, the settings are the same when the subscriber reopens
|
3911
|
+
# the same dashboard URL. The state is stored in QuickSight, not in a
|
3912
|
+
# browser cookie. If this is set to FALSE, the state of the user session
|
3913
|
+
# is not persisted. The default is `FALSE`.
|
3894
3914
|
#
|
3895
3915
|
# @option params [String] :user_arn
|
3896
3916
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -3915,12 +3935,13 @@ module Aws::QuickSight
|
|
3915
3935
|
# "`default`".
|
3916
3936
|
#
|
3917
3937
|
# @option params [Array<String>] :additional_dashboard_ids
|
3918
|
-
# A list of one or more dashboard
|
3919
|
-
# that includes anonymous
|
3920
|
-
# ANONYMOUS for this to work, because other identity types
|
3921
|
-
# as QuickSight users. For example, if you set
|
3922
|
-
# dash_id1 --dashboard-id dash_id2 dash_id3
|
3923
|
-
# the session can access all three
|
3938
|
+
# A list of one or more dashboard IDs that you want to add to a session
|
3939
|
+
# that includes anonymous users. The `IdentityType` parameter must be
|
3940
|
+
# set to `ANONYMOUS` for this to work, because other identity types
|
3941
|
+
# authenticate as QuickSight or IAM users. For example, if you set
|
3942
|
+
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
3943
|
+
# identity-type ANONYMOUS`", the session can access all three
|
3944
|
+
# dashboards.
|
3924
3945
|
#
|
3925
3946
|
# @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3926
3947
|
#
|
@@ -4015,11 +4036,11 @@ module Aws::QuickSight
|
|
4015
4036
|
#
|
4016
4037
|
# 2. Invited nonfederated users
|
4017
4038
|
#
|
4018
|
-
# 3. IAM users and IAM role-based
|
4019
|
-
# Federated Single Sign-On using
|
4020
|
-
# federation
|
4039
|
+
# 3. AWS Identity and Access Management (IAM) users and IAM role-based
|
4040
|
+
# sessions authenticated through Federated Single Sign-On using
|
4041
|
+
# SAML, OpenID Connect, or IAM federation
|
4021
4042
|
#
|
4022
|
-
# Omit this parameter for users in the third group
|
4043
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
4023
4044
|
# role-based sessions.
|
4024
4045
|
#
|
4025
4046
|
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5023,6 +5044,8 @@ module Aws::QuickSight
|
|
5023
5044
|
# * {Types::ListThemeVersionsResponse#status #status} => Integer
|
5024
5045
|
# * {Types::ListThemeVersionsResponse#request_id #request_id} => String
|
5025
5046
|
#
|
5047
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5048
|
+
#
|
5026
5049
|
# @example Request syntax with placeholder values
|
5027
5050
|
#
|
5028
5051
|
# resp = client.list_theme_versions({
|
@@ -5085,6 +5108,8 @@ module Aws::QuickSight
|
|
5085
5108
|
# * {Types::ListThemesResponse#status #status} => Integer
|
5086
5109
|
# * {Types::ListThemesResponse#request_id #request_id} => String
|
5087
5110
|
#
|
5111
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5112
|
+
#
|
5088
5113
|
# @example Request syntax with placeholder values
|
5089
5114
|
#
|
5090
5115
|
# resp = client.list_themes({
|
@@ -5276,7 +5301,7 @@ module Aws::QuickSight
|
|
5276
5301
|
#
|
5277
5302
|
#
|
5278
5303
|
#
|
5279
|
-
# [1]: https://
|
5304
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
5280
5305
|
#
|
5281
5306
|
# @option params [required, String] :aws_account_id
|
5282
5307
|
# The ID for the AWS account that the user is in. Currently, you use the
|
@@ -6171,6 +6196,10 @@ module Aws::QuickSight
|
|
6171
6196
|
# Groupings of columns that work together in certain QuickSight
|
6172
6197
|
# features. Currently, only geospatial hierarchy is supported.
|
6173
6198
|
#
|
6199
|
+
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
6200
|
+
# The folder that contains fields and nested subfolders for your
|
6201
|
+
# dataset.
|
6202
|
+
#
|
6174
6203
|
# @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
|
6175
6204
|
# The row-level security configuration for the data you want to create.
|
6176
6205
|
#
|
@@ -6196,6 +6225,7 @@ module Aws::QuickSight
|
|
6196
6225
|
# "PhysicalTableId" => {
|
6197
6226
|
# relational_table: {
|
6198
6227
|
# data_source_arn: "Arn", # required
|
6228
|
+
# catalog: "RelationalTableCatalog",
|
6199
6229
|
# schema: "RelationalTableSchema",
|
6200
6230
|
# name: "RelationalTableName", # required
|
6201
6231
|
# input_columns: [ # required
|
@@ -6303,6 +6333,12 @@ module Aws::QuickSight
|
|
6303
6333
|
# },
|
6304
6334
|
# },
|
6305
6335
|
# ],
|
6336
|
+
# field_folders: {
|
6337
|
+
# "FieldFolderPath" => {
|
6338
|
+
# description: "FieldFolderDescription",
|
6339
|
+
# columns: ["String"],
|
6340
|
+
# },
|
6341
|
+
# },
|
6306
6342
|
# row_level_permission_data_set: {
|
6307
6343
|
# namespace: "Namespace",
|
6308
6344
|
# arn: "Arn", # required
|
@@ -7407,7 +7443,7 @@ module Aws::QuickSight
|
|
7407
7443
|
params: params,
|
7408
7444
|
config: config)
|
7409
7445
|
context[:gem_name] = 'aws-sdk-quicksight'
|
7410
|
-
context[:gem_version] = '1.
|
7446
|
+
context[:gem_version] = '1.43.0'
|
7411
7447
|
Seahorse::Client::Request.new(handlers, context)
|
7412
7448
|
end
|
7413
7449
|
|
@@ -236,9 +236,14 @@ module Aws::QuickSight
|
|
236
236
|
ExceptionResourceType = Shapes::StringShape.new(name: 'ExceptionResourceType')
|
237
237
|
ExportToCSVOption = Shapes::StructureShape.new(name: 'ExportToCSVOption')
|
238
238
|
Expression = Shapes::StringShape.new(name: 'Expression')
|
239
|
+
FieldFolder = Shapes::StructureShape.new(name: 'FieldFolder')
|
240
|
+
FieldFolderDescription = Shapes::StringShape.new(name: 'FieldFolderDescription')
|
241
|
+
FieldFolderMap = Shapes::MapShape.new(name: 'FieldFolderMap')
|
242
|
+
FieldFolderPath = Shapes::StringShape.new(name: 'FieldFolderPath')
|
239
243
|
FileFormat = Shapes::StringShape.new(name: 'FileFormat')
|
240
244
|
FilterOperation = Shapes::StructureShape.new(name: 'FilterOperation')
|
241
245
|
FilterOperator = Shapes::StringShape.new(name: 'FilterOperator')
|
246
|
+
FolderColumnList = Shapes::ListShape.new(name: 'FolderColumnList')
|
242
247
|
GeoSpatialColumnGroup = Shapes::StructureShape.new(name: 'GeoSpatialColumnGroup')
|
243
248
|
GeoSpatialCountryCode = Shapes::StringShape.new(name: 'GeoSpatialCountryCode')
|
244
249
|
GeoSpatialDataRole = Shapes::StringShape.new(name: 'GeoSpatialDataRole')
|
@@ -375,6 +380,7 @@ module Aws::QuickSight
|
|
375
380
|
RegisterUserRequest = Shapes::StructureShape.new(name: 'RegisterUserRequest')
|
376
381
|
RegisterUserResponse = Shapes::StructureShape.new(name: 'RegisterUserResponse')
|
377
382
|
RelationalTable = Shapes::StructureShape.new(name: 'RelationalTable')
|
383
|
+
RelationalTableCatalog = Shapes::StringShape.new(name: 'RelationalTableCatalog')
|
378
384
|
RelationalTableName = Shapes::StringShape.new(name: 'RelationalTableName')
|
379
385
|
RelationalTableSchema = Shapes::StringShape.new(name: 'RelationalTableSchema')
|
380
386
|
RenameColumnOperation = Shapes::StructureShape.new(name: 'RenameColumnOperation')
|
@@ -756,6 +762,7 @@ module Aws::QuickSight
|
|
756
762
|
CreateDataSetRequest.add_member(:logical_table_map, Shapes::ShapeRef.new(shape: LogicalTableMap, location_name: "LogicalTableMap"))
|
757
763
|
CreateDataSetRequest.add_member(:import_mode, Shapes::ShapeRef.new(shape: DataSetImportMode, required: true, location_name: "ImportMode"))
|
758
764
|
CreateDataSetRequest.add_member(:column_groups, Shapes::ShapeRef.new(shape: ColumnGroupList, location_name: "ColumnGroups"))
|
765
|
+
CreateDataSetRequest.add_member(:field_folders, Shapes::ShapeRef.new(shape: FieldFolderMap, location_name: "FieldFolders"))
|
759
766
|
CreateDataSetRequest.add_member(:permissions, Shapes::ShapeRef.new(shape: ResourcePermissionList, location_name: "Permissions"))
|
760
767
|
CreateDataSetRequest.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
761
768
|
CreateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
@@ -1006,6 +1013,7 @@ module Aws::QuickSight
|
|
1006
1013
|
DataSet.add_member(:import_mode, Shapes::ShapeRef.new(shape: DataSetImportMode, location_name: "ImportMode"))
|
1007
1014
|
DataSet.add_member(:consumed_spice_capacity_in_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "ConsumedSpiceCapacityInBytes"))
|
1008
1015
|
DataSet.add_member(:column_groups, Shapes::ShapeRef.new(shape: ColumnGroupList, location_name: "ColumnGroups"))
|
1016
|
+
DataSet.add_member(:field_folders, Shapes::ShapeRef.new(shape: FieldFolderMap, location_name: "FieldFolders"))
|
1009
1017
|
DataSet.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
1010
1018
|
DataSet.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
1011
1019
|
DataSet.struct_class = Types::DataSet
|
@@ -1482,9 +1490,18 @@ module Aws::QuickSight
|
|
1482
1490
|
ExportToCSVOption.add_member(:availability_status, Shapes::ShapeRef.new(shape: DashboardBehavior, location_name: "AvailabilityStatus"))
|
1483
1491
|
ExportToCSVOption.struct_class = Types::ExportToCSVOption
|
1484
1492
|
|
1493
|
+
FieldFolder.add_member(:description, Shapes::ShapeRef.new(shape: FieldFolderDescription, location_name: "description"))
|
1494
|
+
FieldFolder.add_member(:columns, Shapes::ShapeRef.new(shape: FolderColumnList, location_name: "columns"))
|
1495
|
+
FieldFolder.struct_class = Types::FieldFolder
|
1496
|
+
|
1497
|
+
FieldFolderMap.key = Shapes::ShapeRef.new(shape: FieldFolderPath)
|
1498
|
+
FieldFolderMap.value = Shapes::ShapeRef.new(shape: FieldFolder)
|
1499
|
+
|
1485
1500
|
FilterOperation.add_member(:condition_expression, Shapes::ShapeRef.new(shape: Expression, required: true, location_name: "ConditionExpression"))
|
1486
1501
|
FilterOperation.struct_class = Types::FilterOperation
|
1487
1502
|
|
1503
|
+
FolderColumnList.member = Shapes::ShapeRef.new(shape: String)
|
1504
|
+
|
1488
1505
|
GeoSpatialColumnGroup.add_member(:name, Shapes::ShapeRef.new(shape: ColumnGroupName, required: true, location_name: "Name"))
|
1489
1506
|
GeoSpatialColumnGroup.add_member(:country_code, Shapes::ShapeRef.new(shape: GeoSpatialCountryCode, required: true, location_name: "CountryCode"))
|
1490
1507
|
GeoSpatialColumnGroup.add_member(:columns, Shapes::ShapeRef.new(shape: ColumnList, required: true, location_name: "Columns"))
|
@@ -1978,6 +1995,7 @@ module Aws::QuickSight
|
|
1978
1995
|
RegisterUserResponse.struct_class = Types::RegisterUserResponse
|
1979
1996
|
|
1980
1997
|
RelationalTable.add_member(:data_source_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DataSourceArn"))
|
1998
|
+
RelationalTable.add_member(:catalog, Shapes::ShapeRef.new(shape: RelationalTableCatalog, location_name: "Catalog"))
|
1981
1999
|
RelationalTable.add_member(:schema, Shapes::ShapeRef.new(shape: RelationalTableSchema, location_name: "Schema"))
|
1982
2000
|
RelationalTable.add_member(:name, Shapes::ShapeRef.new(shape: RelationalTableName, required: true, location_name: "Name"))
|
1983
2001
|
RelationalTable.add_member(:input_columns, Shapes::ShapeRef.new(shape: InputColumnList, required: true, location_name: "InputColumns"))
|
@@ -2419,6 +2437,7 @@ module Aws::QuickSight
|
|
2419
2437
|
UpdateDataSetRequest.add_member(:logical_table_map, Shapes::ShapeRef.new(shape: LogicalTableMap, location_name: "LogicalTableMap"))
|
2420
2438
|
UpdateDataSetRequest.add_member(:import_mode, Shapes::ShapeRef.new(shape: DataSetImportMode, required: true, location_name: "ImportMode"))
|
2421
2439
|
UpdateDataSetRequest.add_member(:column_groups, Shapes::ShapeRef.new(shape: ColumnGroupList, location_name: "ColumnGroups"))
|
2440
|
+
UpdateDataSetRequest.add_member(:field_folders, Shapes::ShapeRef.new(shape: FieldFolderMap, location_name: "FieldFolders"))
|
2422
2441
|
UpdateDataSetRequest.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
2423
2442
|
UpdateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
2424
2443
|
UpdateDataSetRequest.struct_class = Types::UpdateDataSetRequest
|
@@ -3699,6 +3718,12 @@ module Aws::QuickSight
|
|
3699
3718
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
3700
3719
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedUserEditionException)
|
3701
3720
|
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
3721
|
+
o[:pager] = Aws::Pager.new(
|
3722
|
+
limit_key: "max_results",
|
3723
|
+
tokens: {
|
3724
|
+
"next_token" => "next_token"
|
3725
|
+
}
|
3726
|
+
)
|
3702
3727
|
end)
|
3703
3728
|
|
3704
3729
|
api.add_operation(:list_themes, Seahorse::Model::Operation.new.tap do |o|
|
@@ -3714,6 +3739,12 @@ module Aws::QuickSight
|
|
3714
3739
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
3715
3740
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedUserEditionException)
|
3716
3741
|
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
3742
|
+
o[:pager] = Aws::Pager.new(
|
3743
|
+
limit_key: "max_results",
|
3744
|
+
tokens: {
|
3745
|
+
"next_token" => "next_token"
|
3746
|
+
}
|
3747
|
+
)
|
3717
3748
|
end)
|
3718
3749
|
|
3719
3750
|
api.add_operation(:list_user_groups, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1320,6 +1320,7 @@ module Aws::QuickSight
|
|
1320
1320
|
# "PhysicalTableId" => {
|
1321
1321
|
# relational_table: {
|
1322
1322
|
# data_source_arn: "Arn", # required
|
1323
|
+
# catalog: "RelationalTableCatalog",
|
1323
1324
|
# schema: "RelationalTableSchema",
|
1324
1325
|
# name: "RelationalTableName", # required
|
1325
1326
|
# input_columns: [ # required
|
@@ -1427,6 +1428,12 @@ module Aws::QuickSight
|
|
1427
1428
|
# },
|
1428
1429
|
# },
|
1429
1430
|
# ],
|
1431
|
+
# field_folders: {
|
1432
|
+
# "FieldFolderPath" => {
|
1433
|
+
# description: "FieldFolderDescription",
|
1434
|
+
# columns: ["String"],
|
1435
|
+
# },
|
1436
|
+
# },
|
1430
1437
|
# permissions: [
|
1431
1438
|
# {
|
1432
1439
|
# principal: "Principal", # required
|
@@ -1484,6 +1491,11 @@ module Aws::QuickSight
|
|
1484
1491
|
# features. Currently, only geospatial hierarchy is supported.
|
1485
1492
|
# @return [Array<Types::ColumnGroup>]
|
1486
1493
|
#
|
1494
|
+
# @!attribute [rw] field_folders
|
1495
|
+
# The folder that contains fields and nested subfolders for your
|
1496
|
+
# dataset.
|
1497
|
+
# @return [Hash<String,Types::FieldFolder>]
|
1498
|
+
#
|
1487
1499
|
# @!attribute [rw] permissions
|
1488
1500
|
# A list of resource permissions on the dataset.
|
1489
1501
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1512,6 +1524,7 @@ module Aws::QuickSight
|
|
1512
1524
|
:logical_table_map,
|
1513
1525
|
:import_mode,
|
1514
1526
|
:column_groups,
|
1527
|
+
:field_folders,
|
1515
1528
|
:permissions,
|
1516
1529
|
:row_level_permission_data_set,
|
1517
1530
|
:column_level_permission_rules,
|
@@ -1794,10 +1807,12 @@ module Aws::QuickSight
|
|
1794
1807
|
#
|
1795
1808
|
# @!attribute [rw] type
|
1796
1809
|
# The type of the data source. Currently, the supported types for this
|
1797
|
-
# operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
|
1798
|
-
#
|
1799
|
-
# TERADATA`. Use `ListDataSources` to
|
1800
|
-
# sources.
|
1810
|
+
# operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
|
1811
|
+
# AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
|
1812
|
+
# S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
|
1813
|
+
# return a list of all data sources.
|
1814
|
+
#
|
1815
|
+
# `AMAZON_ELASTICSEARCH` is for Amazon managed Elasticsearch Service.
|
1801
1816
|
# @return [String]
|
1802
1817
|
#
|
1803
1818
|
# @!attribute [rw] data_source_parameters
|
@@ -3296,7 +3311,8 @@ module Aws::QuickSight
|
|
3296
3311
|
# @return [Array<Types::OutputColumn>]
|
3297
3312
|
#
|
3298
3313
|
# @!attribute [rw] import_mode
|
3299
|
-
#
|
3314
|
+
# A value that indicates whether you want to import the data into
|
3315
|
+
# SPICE.
|
3300
3316
|
# @return [String]
|
3301
3317
|
#
|
3302
3318
|
# @!attribute [rw] consumed_spice_capacity_in_bytes
|
@@ -3309,6 +3325,11 @@ module Aws::QuickSight
|
|
3309
3325
|
# features. Currently, only geospatial hierarchy is supported.
|
3310
3326
|
# @return [Array<Types::ColumnGroup>]
|
3311
3327
|
#
|
3328
|
+
# @!attribute [rw] field_folders
|
3329
|
+
# The folder that contains fields and nested subfolders for your
|
3330
|
+
# dataset.
|
3331
|
+
# @return [Hash<String,Types::FieldFolder>]
|
3332
|
+
#
|
3312
3333
|
# @!attribute [rw] row_level_permission_data_set
|
3313
3334
|
# The row-level security configuration for the dataset.
|
3314
3335
|
# @return [Types::RowLevelPermissionDataSet]
|
@@ -3331,6 +3352,7 @@ module Aws::QuickSight
|
|
3331
3352
|
:import_mode,
|
3332
3353
|
:consumed_spice_capacity_in_bytes,
|
3333
3354
|
:column_groups,
|
3355
|
+
:field_folders,
|
3334
3356
|
:row_level_permission_data_set,
|
3335
3357
|
:column_level_permission_rules)
|
3336
3358
|
SENSITIVE = []
|
@@ -3425,7 +3447,8 @@ module Aws::QuickSight
|
|
3425
3447
|
# @return [Time]
|
3426
3448
|
#
|
3427
3449
|
# @!attribute [rw] import_mode
|
3428
|
-
#
|
3450
|
+
# A value that indicates whether you want to import the data into
|
3451
|
+
# SPICE.
|
3429
3452
|
# @return [String]
|
3430
3453
|
#
|
3431
3454
|
# @!attribute [rw] row_level_permission_data_set
|
@@ -3433,7 +3456,8 @@ module Aws::QuickSight
|
|
3433
3456
|
# @return [Types::RowLevelPermissionDataSet]
|
3434
3457
|
#
|
3435
3458
|
# @!attribute [rw] column_level_permission_rules_applied
|
3436
|
-
#
|
3459
|
+
# A value that indicates if the dataset has column level permission
|
3460
|
+
# configured.
|
3437
3461
|
# @return [Boolean]
|
3438
3462
|
#
|
3439
3463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
@@ -6050,6 +6074,34 @@ module Aws::QuickSight
|
|
6050
6074
|
include Aws::Structure
|
6051
6075
|
end
|
6052
6076
|
|
6077
|
+
# A FieldFolder element is a folder that contains fields and nested
|
6078
|
+
# subfolders.
|
6079
|
+
#
|
6080
|
+
# @note When making an API call, you may pass FieldFolder
|
6081
|
+
# data as a hash:
|
6082
|
+
#
|
6083
|
+
# {
|
6084
|
+
# description: "FieldFolderDescription",
|
6085
|
+
# columns: ["String"],
|
6086
|
+
# }
|
6087
|
+
#
|
6088
|
+
# @!attribute [rw] description
|
6089
|
+
# The description for a field folder.
|
6090
|
+
# @return [String]
|
6091
|
+
#
|
6092
|
+
# @!attribute [rw] columns
|
6093
|
+
# A folder has a list of columns. A column can only be in one folder.
|
6094
|
+
# @return [Array<String>]
|
6095
|
+
#
|
6096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FieldFolder AWS API Documentation
|
6097
|
+
#
|
6098
|
+
class FieldFolder < Struct.new(
|
6099
|
+
:description,
|
6100
|
+
:columns)
|
6101
|
+
SENSITIVE = []
|
6102
|
+
include Aws::Structure
|
6103
|
+
end
|
6104
|
+
|
6053
6105
|
# A transform operation that filters rows based on a condition.
|
6054
6106
|
#
|
6055
6107
|
# @note When making an API call, you may pass FilterOperation
|
@@ -6105,8 +6157,6 @@ module Aws::QuickSight
|
|
6105
6157
|
include Aws::Structure
|
6106
6158
|
end
|
6107
6159
|
|
6108
|
-
# Parameter input for the `GetDashboardEmbedUrl` operation.
|
6109
|
-
#
|
6110
6160
|
# @note When making an API call, you may pass GetDashboardEmbedUrlRequest
|
6111
6161
|
# data as a hash:
|
6112
6162
|
#
|
@@ -6129,7 +6179,8 @@ module Aws::QuickSight
|
|
6129
6179
|
# @return [String]
|
6130
6180
|
#
|
6131
6181
|
# @!attribute [rw] dashboard_id
|
6132
|
-
# The ID for the dashboard, also added to the
|
6182
|
+
# The ID for the dashboard, also added to the AWS Identity and Access
|
6183
|
+
# Management (IAM) policy.
|
6133
6184
|
# @return [String]
|
6134
6185
|
#
|
6135
6186
|
# @!attribute [rw] identity_type
|
@@ -6156,10 +6207,10 @@ module Aws::QuickSight
|
|
6156
6207
|
# dashboard. Persistence applies to the sheet and the parameter
|
6157
6208
|
# settings. These are control settings that the dashboard subscriber
|
6158
6209
|
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
6159
|
-
# set to `TRUE`, the settings are the same when the
|
6160
|
-
#
|
6161
|
-
#
|
6162
|
-
#
|
6210
|
+
# set to `TRUE`, the settings are the same when the subscriber reopens
|
6211
|
+
# the same dashboard URL. The state is stored in QuickSight, not in a
|
6212
|
+
# browser cookie. If this is set to FALSE, the state of the user
|
6213
|
+
# session is not persisted. The default is `FALSE`.
|
6163
6214
|
# @return [Boolean]
|
6164
6215
|
#
|
6165
6216
|
# @!attribute [rw] user_arn
|
@@ -6187,11 +6238,11 @@ module Aws::QuickSight
|
|
6187
6238
|
# @return [String]
|
6188
6239
|
#
|
6189
6240
|
# @!attribute [rw] additional_dashboard_ids
|
6190
|
-
# A list of one or more dashboard
|
6191
|
-
# session that includes anonymous
|
6192
|
-
# be set to ANONYMOUS for this to work, because other identity
|
6193
|
-
# authenticate as QuickSight users. For example, if you
|
6194
|
-
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
6241
|
+
# A list of one or more dashboard IDs that you want to add to a
|
6242
|
+
# session that includes anonymous users. The `IdentityType` parameter
|
6243
|
+
# must be set to `ANONYMOUS` for this to work, because other identity
|
6244
|
+
# types authenticate as QuickSight or IAM users. For example, if you
|
6245
|
+
# set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
6195
6246
|
# identity-type ANONYMOUS`", the session can access all three
|
6196
6247
|
# dashboards.
|
6197
6248
|
# @return [Array<String>]
|
@@ -6290,11 +6341,11 @@ module Aws::QuickSight
|
|
6290
6341
|
#
|
6291
6342
|
# 2. Invited nonfederated users
|
6292
6343
|
#
|
6293
|
-
# 3.
|
6294
|
-
#
|
6295
|
-
# federation
|
6344
|
+
# 3. AWS Identity and Access Management (IAM) users and IAM
|
6345
|
+
# role-based sessions authenticated through Federated Single
|
6346
|
+
# Sign-On using SAML, OpenID Connect, or IAM federation
|
6296
6347
|
#
|
6297
|
-
# Omit this parameter for users in the third group
|
6348
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
6298
6349
|
# role-based sessions.
|
6299
6350
|
# @return [String]
|
6300
6351
|
#
|
@@ -6743,9 +6794,9 @@ module Aws::QuickSight
|
|
6743
6794
|
# }
|
6744
6795
|
#
|
6745
6796
|
# @!attribute [rw] unique_key
|
6746
|
-
#
|
6747
|
-
# columns in a join key. This is used by QuickSight to optimize
|
6748
|
-
# performance.
|
6797
|
+
# A value that indicates that a row in a table is uniquely identified
|
6798
|
+
# by the columns in a join key. This is used by QuickSight to optimize
|
6799
|
+
# query performance.
|
6749
6800
|
# @return [Boolean]
|
6750
6801
|
#
|
6751
6802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
@@ -8514,6 +8565,7 @@ module Aws::QuickSight
|
|
8514
8565
|
# {
|
8515
8566
|
# relational_table: {
|
8516
8567
|
# data_source_arn: "Arn", # required
|
8568
|
+
# catalog: "RelationalTableCatalog",
|
8517
8569
|
# schema: "RelationalTableSchema",
|
8518
8570
|
# name: "RelationalTableName", # required
|
8519
8571
|
# input_columns: [ # required
|
@@ -8855,7 +8907,7 @@ module Aws::QuickSight
|
|
8855
8907
|
#
|
8856
8908
|
#
|
8857
8909
|
#
|
8858
|
-
# [1]: https://
|
8910
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
8859
8911
|
# @return [String]
|
8860
8912
|
#
|
8861
8913
|
# @!attribute [rw] aws_account_id
|
@@ -8958,6 +9010,7 @@ module Aws::QuickSight
|
|
8958
9010
|
#
|
8959
9011
|
# {
|
8960
9012
|
# data_source_arn: "Arn", # required
|
9013
|
+
# catalog: "RelationalTableCatalog",
|
8961
9014
|
# schema: "RelationalTableSchema",
|
8962
9015
|
# name: "RelationalTableName", # required
|
8963
9016
|
# input_columns: [ # required
|
@@ -8972,6 +9025,10 @@ module Aws::QuickSight
|
|
8972
9025
|
# The Amazon Resource Name (ARN) for the data source.
|
8973
9026
|
# @return [String]
|
8974
9027
|
#
|
9028
|
+
# @!attribute [rw] catalog
|
9029
|
+
# The catalog associated with a table.
|
9030
|
+
# @return [String]
|
9031
|
+
#
|
8975
9032
|
# @!attribute [rw] schema
|
8976
9033
|
# The schema name. This name applies to certain relational database
|
8977
9034
|
# engines.
|
@@ -8989,6 +9046,7 @@ module Aws::QuickSight
|
|
8989
9046
|
#
|
8990
9047
|
class RelationalTable < Struct.new(
|
8991
9048
|
:data_source_arn,
|
9049
|
+
:catalog,
|
8992
9050
|
:schema,
|
8993
9051
|
:name,
|
8994
9052
|
:input_columns)
|
@@ -9203,7 +9261,18 @@ module Aws::QuickSight
|
|
9203
9261
|
include Aws::Structure
|
9204
9262
|
end
|
9205
9263
|
|
9206
|
-
#
|
9264
|
+
# Information about a dataset that contains permissions for row-level
|
9265
|
+
# security (RLS). The permissions dataset maps fields to users or
|
9266
|
+
# groups. For more information, see [Using Row-Level Security (RLS) to
|
9267
|
+
# Restrict Access to a Dataset][1] in the *Amazon QuickSight User
|
9268
|
+
# Guide*.
|
9269
|
+
#
|
9270
|
+
# The option to deny permissions by setting `PermissionPolicy` to
|
9271
|
+
# `DENY_ACCESS` is not supported for new RLS datasets.
|
9272
|
+
#
|
9273
|
+
#
|
9274
|
+
#
|
9275
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html
|
9207
9276
|
#
|
9208
9277
|
# @note When making an API call, you may pass RowLevelPermissionDataSet
|
9209
9278
|
# data as a hash:
|
@@ -9215,15 +9284,18 @@ module Aws::QuickSight
|
|
9215
9284
|
# }
|
9216
9285
|
#
|
9217
9286
|
# @!attribute [rw] namespace
|
9218
|
-
# The namespace associated with the
|
9287
|
+
# The namespace associated with the dataset that contains permissions
|
9288
|
+
# for RLS.
|
9219
9289
|
# @return [String]
|
9220
9290
|
#
|
9221
9291
|
# @!attribute [rw] arn
|
9222
|
-
# The Amazon Resource Name (ARN) of the
|
9292
|
+
# The Amazon Resource Name (ARN) of the dataset that contains
|
9293
|
+
# permissions for RLS.
|
9223
9294
|
# @return [String]
|
9224
9295
|
#
|
9225
9296
|
# @!attribute [rw] permission_policy
|
9226
|
-
#
|
9297
|
+
# The type of permissions to use when interpretting the permissions
|
9298
|
+
# for RLS. `DENY_ACCESS` is included for backward compatibility only.
|
9227
9299
|
# @return [String]
|
9228
9300
|
#
|
9229
9301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionDataSet AWS API Documentation
|
@@ -9284,7 +9356,7 @@ module Aws::QuickSight
|
|
9284
9356
|
# }
|
9285
9357
|
#
|
9286
9358
|
# @!attribute [rw] data_source_arn
|
9287
|
-
# The
|
9359
|
+
# The Amazon Resource Name (ARN) for the data source.
|
9288
9360
|
# @return [String]
|
9289
9361
|
#
|
9290
9362
|
# @!attribute [rw] upload_settings
|
@@ -10788,13 +10860,12 @@ module Aws::QuickSight
|
|
10788
10860
|
|
10789
10861
|
# This error indicates that you are calling an embedding operation in
|
10790
10862
|
# Amazon QuickSight without the required pricing plan on your AWS
|
10791
|
-
# account. Before you can use anonymous
|
10792
|
-
# administrator needs to add capacity pricing to QuickSight.
|
10793
|
-
# this on the **Manage QuickSight** page.
|
10863
|
+
# account. Before you can use embedding for anonymous users, a
|
10864
|
+
# QuickSight administrator needs to add capacity pricing to QuickSight.
|
10865
|
+
# You can do this on the **Manage QuickSight** page.
|
10794
10866
|
#
|
10795
|
-
# After capacity pricing is added, you can
|
10796
|
-
#
|
10797
|
-
# `--identity-type ANONYMOUS` option.
|
10867
|
+
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
10868
|
+
# API operation with the `--identity-type ANONYMOUS` option.
|
10798
10869
|
#
|
10799
10870
|
# @!attribute [rw] message
|
10800
10871
|
# @return [String]
|
@@ -11619,6 +11690,7 @@ module Aws::QuickSight
|
|
11619
11690
|
# "PhysicalTableId" => {
|
11620
11691
|
# relational_table: {
|
11621
11692
|
# data_source_arn: "Arn", # required
|
11693
|
+
# catalog: "RelationalTableCatalog",
|
11622
11694
|
# schema: "RelationalTableSchema",
|
11623
11695
|
# name: "RelationalTableName", # required
|
11624
11696
|
# input_columns: [ # required
|
@@ -11726,6 +11798,12 @@ module Aws::QuickSight
|
|
11726
11798
|
# },
|
11727
11799
|
# },
|
11728
11800
|
# ],
|
11801
|
+
# field_folders: {
|
11802
|
+
# "FieldFolderPath" => {
|
11803
|
+
# description: "FieldFolderDescription",
|
11804
|
+
# columns: ["String"],
|
11805
|
+
# },
|
11806
|
+
# },
|
11729
11807
|
# row_level_permission_data_set: {
|
11730
11808
|
# namespace: "Namespace",
|
11731
11809
|
# arn: "Arn", # required
|
@@ -11771,6 +11849,11 @@ module Aws::QuickSight
|
|
11771
11849
|
# features. Currently, only geospatial hierarchy is supported.
|
11772
11850
|
# @return [Array<Types::ColumnGroup>]
|
11773
11851
|
#
|
11852
|
+
# @!attribute [rw] field_folders
|
11853
|
+
# The folder that contains fields and nested subfolders for your
|
11854
|
+
# dataset.
|
11855
|
+
# @return [Hash<String,Types::FieldFolder>]
|
11856
|
+
#
|
11774
11857
|
# @!attribute [rw] row_level_permission_data_set
|
11775
11858
|
# The row-level security configuration for the data you want to
|
11776
11859
|
# create.
|
@@ -11790,6 +11873,7 @@ module Aws::QuickSight
|
|
11790
11873
|
:logical_table_map,
|
11791
11874
|
:import_mode,
|
11792
11875
|
:column_groups,
|
11876
|
+
:field_folders,
|
11793
11877
|
:row_level_permission_data_set,
|
11794
11878
|
:column_level_permission_rules)
|
11795
11879
|
SENSITIVE = []
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-quicksight
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.43.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-02-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.112.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|