aws-sdk-quicksight 1.36.0 → 1.41.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/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +80 -19
- data/lib/aws-sdk-quicksight/client_api.rb +38 -1
- data/lib/aws-sdk-quicksight/errors.rb +21 -0
- data/lib/aws-sdk-quicksight/types.rb +207 -24
- 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: c21b0a0bf94adccd86fd947bcb0bb1ef2529c324224109ffbda70add8fd5001e
|
4
|
+
data.tar.gz: e36ad67aa64b72081e368c2f7ed97a34576ac19b2cab3cce10485b21015b1d61
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 606d17e35f47572d213686468bf09d2c0d24876403f75c4cc29db3584c31ee4293a86ef89174bd538d3a9f085623ac609f5d6689e082c3dac8cbb5dc349d3830
|
7
|
+
data.tar.gz: ce865a51a708aa4830dfb0d2bbd3780733cb7be92e84abc765557930339898f3b0c0f980e11e3d7f92e32c8bddd3eb87f3a4a22743e2ab49f8d59a14fcdc97ad
|
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
|
@@ -901,6 +906,12 @@ module Aws::QuickSight
|
|
901
906
|
# join_instruction: {
|
902
907
|
# left_operand: "LogicalTableId", # required
|
903
908
|
# right_operand: "LogicalTableId", # required
|
909
|
+
# left_join_key_properties: {
|
910
|
+
# unique_key: false,
|
911
|
+
# },
|
912
|
+
# right_join_key_properties: {
|
913
|
+
# unique_key: false,
|
914
|
+
# },
|
904
915
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
905
916
|
# on_clause: "OnClause", # required
|
906
917
|
# },
|
@@ -918,6 +929,12 @@ module Aws::QuickSight
|
|
918
929
|
# },
|
919
930
|
# },
|
920
931
|
# ],
|
932
|
+
# field_folders: {
|
933
|
+
# "FieldFolderPath" => {
|
934
|
+
# description: "FieldFolderDescription",
|
935
|
+
# columns: ["String"],
|
936
|
+
# },
|
937
|
+
# },
|
921
938
|
# permissions: [
|
922
939
|
# {
|
923
940
|
# principal: "Principal", # required
|
@@ -975,9 +992,12 @@ module Aws::QuickSight
|
|
975
992
|
#
|
976
993
|
# @option params [required, String] :type
|
977
994
|
# The type of the data source. Currently, the supported types for this
|
978
|
-
# operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
|
979
|
-
#
|
980
|
-
# 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.
|
981
1001
|
#
|
982
1002
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
983
1003
|
# The parameters that QuickSight uses to connect to your underlying
|
@@ -1439,7 +1459,7 @@ module Aws::QuickSight
|
|
1439
1459
|
#
|
1440
1460
|
#
|
1441
1461
|
#
|
1442
|
-
# [1]:
|
1462
|
+
# [1]: http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
|
1443
1463
|
#
|
1444
1464
|
# @option params [required, String] :data_set_id
|
1445
1465
|
# The ID of the dataset used in the ingestion.
|
@@ -2937,6 +2957,7 @@ module Aws::QuickSight
|
|
2937
2957
|
# resp.data_set.last_updated_time #=> Time
|
2938
2958
|
# resp.data_set.physical_table_map #=> Hash
|
2939
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
|
2940
2961
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.schema #=> String
|
2941
2962
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.name #=> String
|
2942
2963
|
# resp.data_set.physical_table_map["PhysicalTableId"].relational_table.input_columns #=> Array
|
@@ -2978,6 +2999,8 @@ module Aws::QuickSight
|
|
2978
2999
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
|
2979
3000
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
2980
3001
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
3002
|
+
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
|
3003
|
+
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_join_key_properties.unique_key #=> Boolean
|
2981
3004
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
|
2982
3005
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String
|
2983
3006
|
# resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
|
@@ -2992,6 +3015,10 @@ module Aws::QuickSight
|
|
2992
3015
|
# resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
|
2993
3016
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
|
2994
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
|
2995
3022
|
# resp.data_set.row_level_permission_data_set.namespace #=> String
|
2996
3023
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
2997
3024
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
@@ -3845,19 +3872,20 @@ module Aws::QuickSight
|
|
3845
3872
|
#
|
3846
3873
|
# * The resulting user session is valid for 10 hours.
|
3847
3874
|
#
|
3848
|
-
# For more information, see [
|
3849
|
-
#
|
3875
|
+
# For more information, see [Embedded Analytics][1] in the *Amazon
|
3876
|
+
# QuickSight User Guide*.
|
3850
3877
|
#
|
3851
3878
|
#
|
3852
3879
|
#
|
3853
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/
|
3880
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
3854
3881
|
#
|
3855
3882
|
# @option params [required, String] :aws_account_id
|
3856
3883
|
# The ID for the AWS account that contains the dashboard that you're
|
3857
3884
|
# embedding.
|
3858
3885
|
#
|
3859
3886
|
# @option params [required, String] :dashboard_id
|
3860
|
-
# 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.
|
3861
3889
|
#
|
3862
3890
|
# @option params [required, String] :identity_type
|
3863
3891
|
# The authentication method that the user uses to sign in.
|
@@ -3879,10 +3907,10 @@ module Aws::QuickSight
|
|
3879
3907
|
# dashboard. Persistence applies to the sheet and the parameter
|
3880
3908
|
# settings. These are control settings that the dashboard subscriber
|
3881
3909
|
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
3882
|
-
# set to `TRUE`, the settings are the same when the
|
3883
|
-
#
|
3884
|
-
#
|
3885
|
-
#
|
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`.
|
3886
3914
|
#
|
3887
3915
|
# @option params [String] :user_arn
|
3888
3916
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -3901,6 +3929,20 @@ module Aws::QuickSight
|
|
3901
3929
|
# Omit this parameter for users in the third group – IAM users and IAM
|
3902
3930
|
# role-based sessions.
|
3903
3931
|
#
|
3932
|
+
# @option params [String] :namespace
|
3933
|
+
# The QuickSight namespace that contains the dashboard IDs in this
|
3934
|
+
# request. If you're not using a custom namespace, set this to
|
3935
|
+
# "`default`".
|
3936
|
+
#
|
3937
|
+
# @option params [Array<String>] :additional_dashboard_ids
|
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.
|
3945
|
+
#
|
3904
3946
|
# @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3905
3947
|
#
|
3906
3948
|
# * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
|
@@ -3912,12 +3954,14 @@ module Aws::QuickSight
|
|
3912
3954
|
# resp = client.get_dashboard_embed_url({
|
3913
3955
|
# aws_account_id: "AwsAccountId", # required
|
3914
3956
|
# dashboard_id: "RestrictiveResourceId", # required
|
3915
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
3957
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
|
3916
3958
|
# session_lifetime_in_minutes: 1,
|
3917
3959
|
# undo_redo_disabled: false,
|
3918
3960
|
# reset_disabled: false,
|
3919
3961
|
# state_persistence_enabled: false,
|
3920
3962
|
# user_arn: "Arn",
|
3963
|
+
# namespace: "Namespace",
|
3964
|
+
# additional_dashboard_ids: ["RestrictiveResourceId"],
|
3921
3965
|
# })
|
3922
3966
|
#
|
3923
3967
|
# @example Response structure
|
@@ -3992,11 +4036,11 @@ module Aws::QuickSight
|
|
3992
4036
|
#
|
3993
4037
|
# 2. Invited nonfederated users
|
3994
4038
|
#
|
3995
|
-
# 3. IAM users and IAM role-based
|
3996
|
-
# Federated Single Sign-On using
|
3997
|
-
# 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
|
3998
4042
|
#
|
3999
|
-
# Omit this parameter for users in the third group
|
4043
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
4000
4044
|
# role-based sessions.
|
4001
4045
|
#
|
4002
4046
|
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5253,7 +5297,7 @@ module Aws::QuickSight
|
|
5253
5297
|
#
|
5254
5298
|
#
|
5255
5299
|
#
|
5256
|
-
# [1]: https://
|
5300
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
5257
5301
|
#
|
5258
5302
|
# @option params [required, String] :aws_account_id
|
5259
5303
|
# The ID for the AWS account that the user is in. Currently, you use the
|
@@ -6148,6 +6192,10 @@ module Aws::QuickSight
|
|
6148
6192
|
# Groupings of columns that work together in certain QuickSight
|
6149
6193
|
# features. Currently, only geospatial hierarchy is supported.
|
6150
6194
|
#
|
6195
|
+
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
6196
|
+
# The folder that contains fields and nested subfolders for your
|
6197
|
+
# dataset.
|
6198
|
+
#
|
6151
6199
|
# @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
|
6152
6200
|
# The row-level security configuration for the data you want to create.
|
6153
6201
|
#
|
@@ -6173,6 +6221,7 @@ module Aws::QuickSight
|
|
6173
6221
|
# "PhysicalTableId" => {
|
6174
6222
|
# relational_table: {
|
6175
6223
|
# data_source_arn: "Arn", # required
|
6224
|
+
# catalog: "RelationalTableCatalog",
|
6176
6225
|
# schema: "RelationalTableSchema",
|
6177
6226
|
# name: "RelationalTableName", # required
|
6178
6227
|
# input_columns: [ # required
|
@@ -6257,6 +6306,12 @@ module Aws::QuickSight
|
|
6257
6306
|
# join_instruction: {
|
6258
6307
|
# left_operand: "LogicalTableId", # required
|
6259
6308
|
# right_operand: "LogicalTableId", # required
|
6309
|
+
# left_join_key_properties: {
|
6310
|
+
# unique_key: false,
|
6311
|
+
# },
|
6312
|
+
# right_join_key_properties: {
|
6313
|
+
# unique_key: false,
|
6314
|
+
# },
|
6260
6315
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
6261
6316
|
# on_clause: "OnClause", # required
|
6262
6317
|
# },
|
@@ -6274,6 +6329,12 @@ module Aws::QuickSight
|
|
6274
6329
|
# },
|
6275
6330
|
# },
|
6276
6331
|
# ],
|
6332
|
+
# field_folders: {
|
6333
|
+
# "FieldFolderPath" => {
|
6334
|
+
# description: "FieldFolderDescription",
|
6335
|
+
# columns: ["String"],
|
6336
|
+
# },
|
6337
|
+
# },
|
6277
6338
|
# row_level_permission_data_set: {
|
6278
6339
|
# namespace: "Namespace",
|
6279
6340
|
# arn: "Arn", # required
|
@@ -7378,7 +7439,7 @@ module Aws::QuickSight
|
|
7378
7439
|
params: params,
|
7379
7440
|
config: config)
|
7380
7441
|
context[:gem_name] = 'aws-sdk-quicksight'
|
7381
|
-
context[:gem_version] = '1.
|
7442
|
+
context[:gem_version] = '1.41.0'
|
7382
7443
|
Seahorse::Client::Request.new(handlers, context)
|
7383
7444
|
end
|
7384
7445
|
|
@@ -20,6 +20,7 @@ module Aws::QuickSight
|
|
20
20
|
ActiveIAMPolicyAssignment = Shapes::StructureShape.new(name: 'ActiveIAMPolicyAssignment')
|
21
21
|
ActiveIAMPolicyAssignmentList = Shapes::ListShape.new(name: 'ActiveIAMPolicyAssignmentList')
|
22
22
|
AdHocFilteringOption = Shapes::StructureShape.new(name: 'AdHocFilteringOption')
|
23
|
+
AdditionalDashboardIdList = Shapes::ListShape.new(name: 'AdditionalDashboardIdList')
|
23
24
|
AliasName = Shapes::StringShape.new(name: 'AliasName')
|
24
25
|
AmazonElasticsearchParameters = Shapes::StructureShape.new(name: 'AmazonElasticsearchParameters')
|
25
26
|
Analysis = Shapes::StructureShape.new(name: 'Analysis')
|
@@ -228,15 +229,21 @@ module Aws::QuickSight
|
|
228
229
|
Double = Shapes::FloatShape.new(name: 'Double')
|
229
230
|
DoubleList = Shapes::ListShape.new(name: 'DoubleList')
|
230
231
|
Edition = Shapes::StringShape.new(name: 'Edition')
|
232
|
+
EmbeddingIdentityType = Shapes::StringShape.new(name: 'EmbeddingIdentityType')
|
231
233
|
EmbeddingUrl = Shapes::StringShape.new(name: 'EmbeddingUrl')
|
232
234
|
EntryPoint = Shapes::StringShape.new(name: 'EntryPoint')
|
233
235
|
ErrorInfo = Shapes::StructureShape.new(name: 'ErrorInfo')
|
234
236
|
ExceptionResourceType = Shapes::StringShape.new(name: 'ExceptionResourceType')
|
235
237
|
ExportToCSVOption = Shapes::StructureShape.new(name: 'ExportToCSVOption')
|
236
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')
|
237
243
|
FileFormat = Shapes::StringShape.new(name: 'FileFormat')
|
238
244
|
FilterOperation = Shapes::StructureShape.new(name: 'FilterOperation')
|
239
245
|
FilterOperator = Shapes::StringShape.new(name: 'FilterOperator')
|
246
|
+
FolderColumnList = Shapes::ListShape.new(name: 'FolderColumnList')
|
240
247
|
GeoSpatialColumnGroup = Shapes::StructureShape.new(name: 'GeoSpatialColumnGroup')
|
241
248
|
GeoSpatialCountryCode = Shapes::StringShape.new(name: 'GeoSpatialCountryCode')
|
242
249
|
GeoSpatialDataRole = Shapes::StringShape.new(name: 'GeoSpatialDataRole')
|
@@ -283,6 +290,7 @@ module Aws::QuickSight
|
|
283
290
|
InvalidParameterValueException = Shapes::StructureShape.new(name: 'InvalidParameterValueException')
|
284
291
|
JiraParameters = Shapes::StructureShape.new(name: 'JiraParameters')
|
285
292
|
JoinInstruction = Shapes::StructureShape.new(name: 'JoinInstruction')
|
293
|
+
JoinKeyProperties = Shapes::StructureShape.new(name: 'JoinKeyProperties')
|
286
294
|
JoinType = Shapes::StringShape.new(name: 'JoinType')
|
287
295
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
288
296
|
ListAnalysesRequest = Shapes::StructureShape.new(name: 'ListAnalysesRequest')
|
@@ -372,6 +380,7 @@ module Aws::QuickSight
|
|
372
380
|
RegisterUserRequest = Shapes::StructureShape.new(name: 'RegisterUserRequest')
|
373
381
|
RegisterUserResponse = Shapes::StructureShape.new(name: 'RegisterUserResponse')
|
374
382
|
RelationalTable = Shapes::StructureShape.new(name: 'RelationalTable')
|
383
|
+
RelationalTableCatalog = Shapes::StringShape.new(name: 'RelationalTableCatalog')
|
375
384
|
RelationalTableName = Shapes::StringShape.new(name: 'RelationalTableName')
|
376
385
|
RelationalTableSchema = Shapes::StringShape.new(name: 'RelationalTableSchema')
|
377
386
|
RenameColumnOperation = Shapes::StructureShape.new(name: 'RenameColumnOperation')
|
@@ -466,6 +475,7 @@ module Aws::QuickSight
|
|
466
475
|
TwitterParameters = Shapes::StructureShape.new(name: 'TwitterParameters')
|
467
476
|
TypeCastFormat = Shapes::StringShape.new(name: 'TypeCastFormat')
|
468
477
|
UIColorPalette = Shapes::StructureShape.new(name: 'UIColorPalette')
|
478
|
+
UnsupportedPricingPlanException = Shapes::StructureShape.new(name: 'UnsupportedPricingPlanException')
|
469
479
|
UnsupportedUserEditionException = Shapes::StructureShape.new(name: 'UnsupportedUserEditionException')
|
470
480
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
471
481
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
@@ -550,6 +560,8 @@ module Aws::QuickSight
|
|
550
560
|
AdHocFilteringOption.add_member(:availability_status, Shapes::ShapeRef.new(shape: DashboardBehavior, location_name: "AvailabilityStatus"))
|
551
561
|
AdHocFilteringOption.struct_class = Types::AdHocFilteringOption
|
552
562
|
|
563
|
+
AdditionalDashboardIdList.member = Shapes::ShapeRef.new(shape: RestrictiveResourceId)
|
564
|
+
|
553
565
|
AmazonElasticsearchParameters.add_member(:domain, Shapes::ShapeRef.new(shape: Domain, required: true, location_name: "Domain"))
|
554
566
|
AmazonElasticsearchParameters.struct_class = Types::AmazonElasticsearchParameters
|
555
567
|
|
@@ -750,6 +762,7 @@ module Aws::QuickSight
|
|
750
762
|
CreateDataSetRequest.add_member(:logical_table_map, Shapes::ShapeRef.new(shape: LogicalTableMap, location_name: "LogicalTableMap"))
|
751
763
|
CreateDataSetRequest.add_member(:import_mode, Shapes::ShapeRef.new(shape: DataSetImportMode, required: true, location_name: "ImportMode"))
|
752
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"))
|
753
766
|
CreateDataSetRequest.add_member(:permissions, Shapes::ShapeRef.new(shape: ResourcePermissionList, location_name: "Permissions"))
|
754
767
|
CreateDataSetRequest.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
755
768
|
CreateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
@@ -1000,6 +1013,7 @@ module Aws::QuickSight
|
|
1000
1013
|
DataSet.add_member(:import_mode, Shapes::ShapeRef.new(shape: DataSetImportMode, location_name: "ImportMode"))
|
1001
1014
|
DataSet.add_member(:consumed_spice_capacity_in_bytes, Shapes::ShapeRef.new(shape: Long, location_name: "ConsumedSpiceCapacityInBytes"))
|
1002
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"))
|
1003
1017
|
DataSet.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
1004
1018
|
DataSet.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
1005
1019
|
DataSet.struct_class = Types::DataSet
|
@@ -1476,9 +1490,18 @@ module Aws::QuickSight
|
|
1476
1490
|
ExportToCSVOption.add_member(:availability_status, Shapes::ShapeRef.new(shape: DashboardBehavior, location_name: "AvailabilityStatus"))
|
1477
1491
|
ExportToCSVOption.struct_class = Types::ExportToCSVOption
|
1478
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
|
+
|
1479
1500
|
FilterOperation.add_member(:condition_expression, Shapes::ShapeRef.new(shape: Expression, required: true, location_name: "ConditionExpression"))
|
1480
1501
|
FilterOperation.struct_class = Types::FilterOperation
|
1481
1502
|
|
1503
|
+
FolderColumnList.member = Shapes::ShapeRef.new(shape: String)
|
1504
|
+
|
1482
1505
|
GeoSpatialColumnGroup.add_member(:name, Shapes::ShapeRef.new(shape: ColumnGroupName, required: true, location_name: "Name"))
|
1483
1506
|
GeoSpatialColumnGroup.add_member(:country_code, Shapes::ShapeRef.new(shape: GeoSpatialCountryCode, required: true, location_name: "CountryCode"))
|
1484
1507
|
GeoSpatialColumnGroup.add_member(:columns, Shapes::ShapeRef.new(shape: ColumnList, required: true, location_name: "Columns"))
|
@@ -1486,12 +1509,14 @@ module Aws::QuickSight
|
|
1486
1509
|
|
1487
1510
|
GetDashboardEmbedUrlRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
1488
1511
|
GetDashboardEmbedUrlRequest.add_member(:dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location: "uri", location_name: "DashboardId"))
|
1489
|
-
GetDashboardEmbedUrlRequest.add_member(:identity_type, Shapes::ShapeRef.new(shape:
|
1512
|
+
GetDashboardEmbedUrlRequest.add_member(:identity_type, Shapes::ShapeRef.new(shape: EmbeddingIdentityType, required: true, location: "querystring", location_name: "creds-type"))
|
1490
1513
|
GetDashboardEmbedUrlRequest.add_member(:session_lifetime_in_minutes, Shapes::ShapeRef.new(shape: SessionLifetimeInMinutes, location: "querystring", location_name: "session-lifetime"))
|
1491
1514
|
GetDashboardEmbedUrlRequest.add_member(:undo_redo_disabled, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "undo-redo-disabled"))
|
1492
1515
|
GetDashboardEmbedUrlRequest.add_member(:reset_disabled, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "reset-disabled"))
|
1493
1516
|
GetDashboardEmbedUrlRequest.add_member(:state_persistence_enabled, Shapes::ShapeRef.new(shape: Boolean, location: "querystring", location_name: "state-persistence-enabled"))
|
1494
1517
|
GetDashboardEmbedUrlRequest.add_member(:user_arn, Shapes::ShapeRef.new(shape: Arn, location: "querystring", location_name: "user-arn"))
|
1518
|
+
GetDashboardEmbedUrlRequest.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location: "querystring", location_name: "namespace"))
|
1519
|
+
GetDashboardEmbedUrlRequest.add_member(:additional_dashboard_ids, Shapes::ShapeRef.new(shape: AdditionalDashboardIdList, location: "querystring", location_name: "additional-dashboard-ids"))
|
1495
1520
|
GetDashboardEmbedUrlRequest.struct_class = Types::GetDashboardEmbedUrlRequest
|
1496
1521
|
|
1497
1522
|
GetDashboardEmbedUrlResponse.add_member(:embed_url, Shapes::ShapeRef.new(shape: EmbeddingUrl, location_name: "EmbedUrl"))
|
@@ -1594,10 +1619,15 @@ module Aws::QuickSight
|
|
1594
1619
|
|
1595
1620
|
JoinInstruction.add_member(:left_operand, Shapes::ShapeRef.new(shape: LogicalTableId, required: true, location_name: "LeftOperand"))
|
1596
1621
|
JoinInstruction.add_member(:right_operand, Shapes::ShapeRef.new(shape: LogicalTableId, required: true, location_name: "RightOperand"))
|
1622
|
+
JoinInstruction.add_member(:left_join_key_properties, Shapes::ShapeRef.new(shape: JoinKeyProperties, location_name: "LeftJoinKeyProperties"))
|
1623
|
+
JoinInstruction.add_member(:right_join_key_properties, Shapes::ShapeRef.new(shape: JoinKeyProperties, location_name: "RightJoinKeyProperties"))
|
1597
1624
|
JoinInstruction.add_member(:type, Shapes::ShapeRef.new(shape: JoinType, required: true, location_name: "Type"))
|
1598
1625
|
JoinInstruction.add_member(:on_clause, Shapes::ShapeRef.new(shape: OnClause, required: true, location_name: "OnClause"))
|
1599
1626
|
JoinInstruction.struct_class = Types::JoinInstruction
|
1600
1627
|
|
1628
|
+
JoinKeyProperties.add_member(:unique_key, Shapes::ShapeRef.new(shape: Boolean, location_name: "UniqueKey", metadata: {"box"=>true}))
|
1629
|
+
JoinKeyProperties.struct_class = Types::JoinKeyProperties
|
1630
|
+
|
1601
1631
|
LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
1602
1632
|
LimitExceededException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ExceptionResourceType, location_name: "ResourceType"))
|
1603
1633
|
LimitExceededException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
@@ -1965,6 +1995,7 @@ module Aws::QuickSight
|
|
1965
1995
|
RegisterUserResponse.struct_class = Types::RegisterUserResponse
|
1966
1996
|
|
1967
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"))
|
1968
1999
|
RelationalTable.add_member(:schema, Shapes::ShapeRef.new(shape: RelationalTableSchema, location_name: "Schema"))
|
1969
2000
|
RelationalTable.add_member(:name, Shapes::ShapeRef.new(shape: RelationalTableName, required: true, location_name: "Name"))
|
1970
2001
|
RelationalTable.add_member(:input_columns, Shapes::ShapeRef.new(shape: InputColumnList, required: true, location_name: "InputColumns"))
|
@@ -2279,6 +2310,10 @@ module Aws::QuickSight
|
|
2279
2310
|
UIColorPalette.add_member(:measure_foreground, Shapes::ShapeRef.new(shape: HexColor, location_name: "MeasureForeground"))
|
2280
2311
|
UIColorPalette.struct_class = Types::UIColorPalette
|
2281
2312
|
|
2313
|
+
UnsupportedPricingPlanException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
2314
|
+
UnsupportedPricingPlanException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
2315
|
+
UnsupportedPricingPlanException.struct_class = Types::UnsupportedPricingPlanException
|
2316
|
+
|
2282
2317
|
UnsupportedUserEditionException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
2283
2318
|
UnsupportedUserEditionException.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
2284
2319
|
UnsupportedUserEditionException.struct_class = Types::UnsupportedUserEditionException
|
@@ -2402,6 +2437,7 @@ module Aws::QuickSight
|
|
2402
2437
|
UpdateDataSetRequest.add_member(:logical_table_map, Shapes::ShapeRef.new(shape: LogicalTableMap, location_name: "LogicalTableMap"))
|
2403
2438
|
UpdateDataSetRequest.add_member(:import_mode, Shapes::ShapeRef.new(shape: DataSetImportMode, required: true, location_name: "ImportMode"))
|
2404
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"))
|
2405
2441
|
UpdateDataSetRequest.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
2406
2442
|
UpdateDataSetRequest.add_member(:column_level_permission_rules, Shapes::ShapeRef.new(shape: ColumnLevelPermissionRuleList, location_name: "ColumnLevelPermissionRules"))
|
2407
2443
|
UpdateDataSetRequest.struct_class = Types::UpdateDataSetRequest
|
@@ -3363,6 +3399,7 @@ module Aws::QuickSight
|
|
3363
3399
|
o.errors << Shapes::ShapeRef.new(shape: IdentityTypeNotSupportedException)
|
3364
3400
|
o.errors << Shapes::ShapeRef.new(shape: SessionLifetimeInMinutesInvalidException)
|
3365
3401
|
o.errors << Shapes::ShapeRef.new(shape: UnsupportedUserEditionException)
|
3402
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedPricingPlanException)
|
3366
3403
|
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
3367
3404
|
end)
|
3368
3405
|
|
@@ -43,6 +43,7 @@ module Aws::QuickSight
|
|
43
43
|
# * {ResourceUnavailableException}
|
44
44
|
# * {SessionLifetimeInMinutesInvalidException}
|
45
45
|
# * {ThrottlingException}
|
46
|
+
# * {UnsupportedPricingPlanException}
|
46
47
|
# * {UnsupportedUserEditionException}
|
47
48
|
#
|
48
49
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
@@ -391,6 +392,26 @@ module Aws::QuickSight
|
|
391
392
|
end
|
392
393
|
end
|
393
394
|
|
395
|
+
class UnsupportedPricingPlanException < ServiceError
|
396
|
+
|
397
|
+
# @param [Seahorse::Client::RequestContext] context
|
398
|
+
# @param [String] message
|
399
|
+
# @param [Aws::QuickSight::Types::UnsupportedPricingPlanException] data
|
400
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
401
|
+
super(context, message, data)
|
402
|
+
end
|
403
|
+
|
404
|
+
# @return [String]
|
405
|
+
def message
|
406
|
+
@message || @data[:message]
|
407
|
+
end
|
408
|
+
|
409
|
+
# @return [String]
|
410
|
+
def request_id
|
411
|
+
@data[:request_id]
|
412
|
+
end
|
413
|
+
end
|
414
|
+
|
394
415
|
class UnsupportedUserEditionException < ServiceError
|
395
416
|
|
396
417
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -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
|
@@ -1404,6 +1405,12 @@ module Aws::QuickSight
|
|
1404
1405
|
# join_instruction: {
|
1405
1406
|
# left_operand: "LogicalTableId", # required
|
1406
1407
|
# right_operand: "LogicalTableId", # required
|
1408
|
+
# left_join_key_properties: {
|
1409
|
+
# unique_key: false,
|
1410
|
+
# },
|
1411
|
+
# right_join_key_properties: {
|
1412
|
+
# unique_key: false,
|
1413
|
+
# },
|
1407
1414
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
1408
1415
|
# on_clause: "OnClause", # required
|
1409
1416
|
# },
|
@@ -1421,6 +1428,12 @@ module Aws::QuickSight
|
|
1421
1428
|
# },
|
1422
1429
|
# },
|
1423
1430
|
# ],
|
1431
|
+
# field_folders: {
|
1432
|
+
# "FieldFolderPath" => {
|
1433
|
+
# description: "FieldFolderDescription",
|
1434
|
+
# columns: ["String"],
|
1435
|
+
# },
|
1436
|
+
# },
|
1424
1437
|
# permissions: [
|
1425
1438
|
# {
|
1426
1439
|
# principal: "Principal", # required
|
@@ -1478,6 +1491,11 @@ module Aws::QuickSight
|
|
1478
1491
|
# features. Currently, only geospatial hierarchy is supported.
|
1479
1492
|
# @return [Array<Types::ColumnGroup>]
|
1480
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
|
+
#
|
1481
1499
|
# @!attribute [rw] permissions
|
1482
1500
|
# A list of resource permissions on the dataset.
|
1483
1501
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1506,6 +1524,7 @@ module Aws::QuickSight
|
|
1506
1524
|
:logical_table_map,
|
1507
1525
|
:import_mode,
|
1508
1526
|
:column_groups,
|
1527
|
+
:field_folders,
|
1509
1528
|
:permissions,
|
1510
1529
|
:row_level_permission_data_set,
|
1511
1530
|
:column_level_permission_rules,
|
@@ -1788,10 +1807,12 @@ module Aws::QuickSight
|
|
1788
1807
|
#
|
1789
1808
|
# @!attribute [rw] type
|
1790
1809
|
# The type of the data source. Currently, the supported types for this
|
1791
|
-
# operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
|
1792
|
-
#
|
1793
|
-
# TERADATA`. Use `ListDataSources` to
|
1794
|
-
# 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.
|
1795
1816
|
# @return [String]
|
1796
1817
|
#
|
1797
1818
|
# @!attribute [rw] data_source_parameters
|
@@ -3290,7 +3311,8 @@ module Aws::QuickSight
|
|
3290
3311
|
# @return [Array<Types::OutputColumn>]
|
3291
3312
|
#
|
3292
3313
|
# @!attribute [rw] import_mode
|
3293
|
-
#
|
3314
|
+
# A value that indicates whether you want to import the data into
|
3315
|
+
# SPICE.
|
3294
3316
|
# @return [String]
|
3295
3317
|
#
|
3296
3318
|
# @!attribute [rw] consumed_spice_capacity_in_bytes
|
@@ -3303,6 +3325,11 @@ module Aws::QuickSight
|
|
3303
3325
|
# features. Currently, only geospatial hierarchy is supported.
|
3304
3326
|
# @return [Array<Types::ColumnGroup>]
|
3305
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
|
+
#
|
3306
3333
|
# @!attribute [rw] row_level_permission_data_set
|
3307
3334
|
# The row-level security configuration for the dataset.
|
3308
3335
|
# @return [Types::RowLevelPermissionDataSet]
|
@@ -3325,6 +3352,7 @@ module Aws::QuickSight
|
|
3325
3352
|
:import_mode,
|
3326
3353
|
:consumed_spice_capacity_in_bytes,
|
3327
3354
|
:column_groups,
|
3355
|
+
:field_folders,
|
3328
3356
|
:row_level_permission_data_set,
|
3329
3357
|
:column_level_permission_rules)
|
3330
3358
|
SENSITIVE = []
|
@@ -3419,7 +3447,8 @@ module Aws::QuickSight
|
|
3419
3447
|
# @return [Time]
|
3420
3448
|
#
|
3421
3449
|
# @!attribute [rw] import_mode
|
3422
|
-
#
|
3450
|
+
# A value that indicates whether you want to import the data into
|
3451
|
+
# SPICE.
|
3423
3452
|
# @return [String]
|
3424
3453
|
#
|
3425
3454
|
# @!attribute [rw] row_level_permission_data_set
|
@@ -3427,7 +3456,8 @@ module Aws::QuickSight
|
|
3427
3456
|
# @return [Types::RowLevelPermissionDataSet]
|
3428
3457
|
#
|
3429
3458
|
# @!attribute [rw] column_level_permission_rules_applied
|
3430
|
-
#
|
3459
|
+
# A value that indicates if the dataset has column level permission
|
3460
|
+
# configured.
|
3431
3461
|
# @return [Boolean]
|
3432
3462
|
#
|
3433
3463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
@@ -6044,6 +6074,34 @@ module Aws::QuickSight
|
|
6044
6074
|
include Aws::Structure
|
6045
6075
|
end
|
6046
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
|
+
|
6047
6105
|
# A transform operation that filters rows based on a condition.
|
6048
6106
|
#
|
6049
6107
|
# @note When making an API call, you may pass FilterOperation
|
@@ -6105,12 +6163,14 @@ module Aws::QuickSight
|
|
6105
6163
|
# {
|
6106
6164
|
# aws_account_id: "AwsAccountId", # required
|
6107
6165
|
# dashboard_id: "RestrictiveResourceId", # required
|
6108
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
6166
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
|
6109
6167
|
# session_lifetime_in_minutes: 1,
|
6110
6168
|
# undo_redo_disabled: false,
|
6111
6169
|
# reset_disabled: false,
|
6112
6170
|
# state_persistence_enabled: false,
|
6113
6171
|
# user_arn: "Arn",
|
6172
|
+
# namespace: "Namespace",
|
6173
|
+
# additional_dashboard_ids: ["RestrictiveResourceId"],
|
6114
6174
|
# }
|
6115
6175
|
#
|
6116
6176
|
# @!attribute [rw] aws_account_id
|
@@ -6119,7 +6179,8 @@ module Aws::QuickSight
|
|
6119
6179
|
# @return [String]
|
6120
6180
|
#
|
6121
6181
|
# @!attribute [rw] dashboard_id
|
6122
|
-
# 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.
|
6123
6184
|
# @return [String]
|
6124
6185
|
#
|
6125
6186
|
# @!attribute [rw] identity_type
|
@@ -6146,10 +6207,10 @@ module Aws::QuickSight
|
|
6146
6207
|
# dashboard. Persistence applies to the sheet and the parameter
|
6147
6208
|
# settings. These are control settings that the dashboard subscriber
|
6148
6209
|
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
6149
|
-
# set to `TRUE`, the settings are the same when the
|
6150
|
-
#
|
6151
|
-
#
|
6152
|
-
#
|
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`.
|
6153
6214
|
# @return [Boolean]
|
6154
6215
|
#
|
6155
6216
|
# @!attribute [rw] user_arn
|
@@ -6170,6 +6231,22 @@ module Aws::QuickSight
|
|
6170
6231
|
# role-based sessions.
|
6171
6232
|
# @return [String]
|
6172
6233
|
#
|
6234
|
+
# @!attribute [rw] namespace
|
6235
|
+
# The QuickSight namespace that contains the dashboard IDs in this
|
6236
|
+
# request. If you're not using a custom namespace, set this to
|
6237
|
+
# "`default`".
|
6238
|
+
# @return [String]
|
6239
|
+
#
|
6240
|
+
# @!attribute [rw] additional_dashboard_ids
|
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
|
6246
|
+
# identity-type ANONYMOUS`", the session can access all three
|
6247
|
+
# dashboards.
|
6248
|
+
# @return [Array<String>]
|
6249
|
+
#
|
6173
6250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
6174
6251
|
#
|
6175
6252
|
class GetDashboardEmbedUrlRequest < Struct.new(
|
@@ -6180,11 +6257,15 @@ module Aws::QuickSight
|
|
6180
6257
|
:undo_redo_disabled,
|
6181
6258
|
:reset_disabled,
|
6182
6259
|
:state_persistence_enabled,
|
6183
|
-
:user_arn
|
6260
|
+
:user_arn,
|
6261
|
+
:namespace,
|
6262
|
+
:additional_dashboard_ids)
|
6184
6263
|
SENSITIVE = []
|
6185
6264
|
include Aws::Structure
|
6186
6265
|
end
|
6187
6266
|
|
6267
|
+
# Output returned from the `GetDashboardEmbedUrl` operation.
|
6268
|
+
#
|
6188
6269
|
# @!attribute [rw] embed_url
|
6189
6270
|
# A single-use URL that you can put into your server-side webpage to
|
6190
6271
|
# embed your dashboard. This URL is valid for 5 minutes. The API
|
@@ -6260,11 +6341,11 @@ module Aws::QuickSight
|
|
6260
6341
|
#
|
6261
6342
|
# 2. Invited nonfederated users
|
6262
6343
|
#
|
6263
|
-
# 3.
|
6264
|
-
#
|
6265
|
-
# 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
|
6266
6347
|
#
|
6267
|
-
# Omit this parameter for users in the third group
|
6348
|
+
# Omit this parameter for users in the third group, IAM users and IAM
|
6268
6349
|
# role-based sessions.
|
6269
6350
|
# @return [String]
|
6270
6351
|
#
|
@@ -6648,7 +6729,7 @@ module Aws::QuickSight
|
|
6648
6729
|
include Aws::Structure
|
6649
6730
|
end
|
6650
6731
|
|
6651
|
-
#
|
6732
|
+
# The instructions associated with a join.
|
6652
6733
|
#
|
6653
6734
|
# @note When making an API call, you may pass JoinInstruction
|
6654
6735
|
# data as a hash:
|
@@ -6656,24 +6737,38 @@ module Aws::QuickSight
|
|
6656
6737
|
# {
|
6657
6738
|
# left_operand: "LogicalTableId", # required
|
6658
6739
|
# right_operand: "LogicalTableId", # required
|
6740
|
+
# left_join_key_properties: {
|
6741
|
+
# unique_key: false,
|
6742
|
+
# },
|
6743
|
+
# right_join_key_properties: {
|
6744
|
+
# unique_key: false,
|
6745
|
+
# },
|
6659
6746
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
6660
6747
|
# on_clause: "OnClause", # required
|
6661
6748
|
# }
|
6662
6749
|
#
|
6663
6750
|
# @!attribute [rw] left_operand
|
6664
|
-
#
|
6751
|
+
# The operand on the left side of a join.
|
6665
6752
|
# @return [String]
|
6666
6753
|
#
|
6667
6754
|
# @!attribute [rw] right_operand
|
6668
|
-
#
|
6755
|
+
# The operand on the right side of a join.
|
6669
6756
|
# @return [String]
|
6670
6757
|
#
|
6758
|
+
# @!attribute [rw] left_join_key_properties
|
6759
|
+
# Join key properties of the left operand.
|
6760
|
+
# @return [Types::JoinKeyProperties]
|
6761
|
+
#
|
6762
|
+
# @!attribute [rw] right_join_key_properties
|
6763
|
+
# Join key properties of the right operand.
|
6764
|
+
# @return [Types::JoinKeyProperties]
|
6765
|
+
#
|
6671
6766
|
# @!attribute [rw] type
|
6672
|
-
#
|
6767
|
+
# The type of join that it is.
|
6673
6768
|
# @return [String]
|
6674
6769
|
#
|
6675
6770
|
# @!attribute [rw] on_clause
|
6676
|
-
#
|
6771
|
+
# The join instructions provided in the `ON` clause of a join.
|
6677
6772
|
# @return [String]
|
6678
6773
|
#
|
6679
6774
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinInstruction AWS API Documentation
|
@@ -6681,12 +6776,37 @@ module Aws::QuickSight
|
|
6681
6776
|
class JoinInstruction < Struct.new(
|
6682
6777
|
:left_operand,
|
6683
6778
|
:right_operand,
|
6779
|
+
:left_join_key_properties,
|
6780
|
+
:right_join_key_properties,
|
6684
6781
|
:type,
|
6685
6782
|
:on_clause)
|
6686
6783
|
SENSITIVE = []
|
6687
6784
|
include Aws::Structure
|
6688
6785
|
end
|
6689
6786
|
|
6787
|
+
# Properties associated with the columns participating in a join.
|
6788
|
+
#
|
6789
|
+
# @note When making an API call, you may pass JoinKeyProperties
|
6790
|
+
# data as a hash:
|
6791
|
+
#
|
6792
|
+
# {
|
6793
|
+
# unique_key: false,
|
6794
|
+
# }
|
6795
|
+
#
|
6796
|
+
# @!attribute [rw] unique_key
|
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.
|
6800
|
+
# @return [Boolean]
|
6801
|
+
#
|
6802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
6803
|
+
#
|
6804
|
+
class JoinKeyProperties < Struct.new(
|
6805
|
+
:unique_key)
|
6806
|
+
SENSITIVE = []
|
6807
|
+
include Aws::Structure
|
6808
|
+
end
|
6809
|
+
|
6690
6810
|
# A limit is exceeded.
|
6691
6811
|
#
|
6692
6812
|
# @!attribute [rw] message
|
@@ -8070,6 +8190,12 @@ module Aws::QuickSight
|
|
8070
8190
|
# join_instruction: {
|
8071
8191
|
# left_operand: "LogicalTableId", # required
|
8072
8192
|
# right_operand: "LogicalTableId", # required
|
8193
|
+
# left_join_key_properties: {
|
8194
|
+
# unique_key: false,
|
8195
|
+
# },
|
8196
|
+
# right_join_key_properties: {
|
8197
|
+
# unique_key: false,
|
8198
|
+
# },
|
8073
8199
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
8074
8200
|
# on_clause: "OnClause", # required
|
8075
8201
|
# },
|
@@ -8110,6 +8236,12 @@ module Aws::QuickSight
|
|
8110
8236
|
# join_instruction: {
|
8111
8237
|
# left_operand: "LogicalTableId", # required
|
8112
8238
|
# right_operand: "LogicalTableId", # required
|
8239
|
+
# left_join_key_properties: {
|
8240
|
+
# unique_key: false,
|
8241
|
+
# },
|
8242
|
+
# right_join_key_properties: {
|
8243
|
+
# unique_key: false,
|
8244
|
+
# },
|
8113
8245
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
8114
8246
|
# on_clause: "OnClause", # required
|
8115
8247
|
# },
|
@@ -8433,6 +8565,7 @@ module Aws::QuickSight
|
|
8433
8565
|
# {
|
8434
8566
|
# relational_table: {
|
8435
8567
|
# data_source_arn: "Arn", # required
|
8568
|
+
# catalog: "RelationalTableCatalog",
|
8436
8569
|
# schema: "RelationalTableSchema",
|
8437
8570
|
# name: "RelationalTableName", # required
|
8438
8571
|
# input_columns: [ # required
|
@@ -8774,7 +8907,7 @@ module Aws::QuickSight
|
|
8774
8907
|
#
|
8775
8908
|
#
|
8776
8909
|
#
|
8777
|
-
# [1]: https://
|
8910
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
8778
8911
|
# @return [String]
|
8779
8912
|
#
|
8780
8913
|
# @!attribute [rw] aws_account_id
|
@@ -8877,6 +9010,7 @@ module Aws::QuickSight
|
|
8877
9010
|
#
|
8878
9011
|
# {
|
8879
9012
|
# data_source_arn: "Arn", # required
|
9013
|
+
# catalog: "RelationalTableCatalog",
|
8880
9014
|
# schema: "RelationalTableSchema",
|
8881
9015
|
# name: "RelationalTableName", # required
|
8882
9016
|
# input_columns: [ # required
|
@@ -8891,6 +9025,10 @@ module Aws::QuickSight
|
|
8891
9025
|
# The Amazon Resource Name (ARN) for the data source.
|
8892
9026
|
# @return [String]
|
8893
9027
|
#
|
9028
|
+
# @!attribute [rw] catalog
|
9029
|
+
# The catalog associated with a table.
|
9030
|
+
# @return [String]
|
9031
|
+
#
|
8894
9032
|
# @!attribute [rw] schema
|
8895
9033
|
# The schema name. This name applies to certain relational database
|
8896
9034
|
# engines.
|
@@ -8908,6 +9046,7 @@ module Aws::QuickSight
|
|
8908
9046
|
#
|
8909
9047
|
class RelationalTable < Struct.new(
|
8910
9048
|
:data_source_arn,
|
9049
|
+
:catalog,
|
8911
9050
|
:schema,
|
8912
9051
|
:name,
|
8913
9052
|
:input_columns)
|
@@ -10705,6 +10844,31 @@ module Aws::QuickSight
|
|
10705
10844
|
include Aws::Structure
|
10706
10845
|
end
|
10707
10846
|
|
10847
|
+
# This error indicates that you are calling an embedding operation in
|
10848
|
+
# Amazon QuickSight without the required pricing plan on your AWS
|
10849
|
+
# account. Before you can use embedding for anonymous users, a
|
10850
|
+
# QuickSight administrator needs to add capacity pricing to QuickSight.
|
10851
|
+
# You can do this on the **Manage QuickSight** page.
|
10852
|
+
#
|
10853
|
+
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
10854
|
+
# API operation with the `--identity-type ANONYMOUS` option.
|
10855
|
+
#
|
10856
|
+
# @!attribute [rw] message
|
10857
|
+
# @return [String]
|
10858
|
+
#
|
10859
|
+
# @!attribute [rw] request_id
|
10860
|
+
# The AWS request ID for this request.
|
10861
|
+
# @return [String]
|
10862
|
+
#
|
10863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedPricingPlanException AWS API Documentation
|
10864
|
+
#
|
10865
|
+
class UnsupportedPricingPlanException < Struct.new(
|
10866
|
+
:message,
|
10867
|
+
:request_id)
|
10868
|
+
SENSITIVE = []
|
10869
|
+
include Aws::Structure
|
10870
|
+
end
|
10871
|
+
|
10708
10872
|
# This error indicates that you are calling an operation on an Amazon
|
10709
10873
|
# QuickSight subscription where the edition doesn't include support for
|
10710
10874
|
# that operation. Amazon QuickSight currently has Standard Edition and
|
@@ -11512,6 +11676,7 @@ module Aws::QuickSight
|
|
11512
11676
|
# "PhysicalTableId" => {
|
11513
11677
|
# relational_table: {
|
11514
11678
|
# data_source_arn: "Arn", # required
|
11679
|
+
# catalog: "RelationalTableCatalog",
|
11515
11680
|
# schema: "RelationalTableSchema",
|
11516
11681
|
# name: "RelationalTableName", # required
|
11517
11682
|
# input_columns: [ # required
|
@@ -11596,6 +11761,12 @@ module Aws::QuickSight
|
|
11596
11761
|
# join_instruction: {
|
11597
11762
|
# left_operand: "LogicalTableId", # required
|
11598
11763
|
# right_operand: "LogicalTableId", # required
|
11764
|
+
# left_join_key_properties: {
|
11765
|
+
# unique_key: false,
|
11766
|
+
# },
|
11767
|
+
# right_join_key_properties: {
|
11768
|
+
# unique_key: false,
|
11769
|
+
# },
|
11599
11770
|
# type: "INNER", # required, accepts INNER, OUTER, LEFT, RIGHT
|
11600
11771
|
# on_clause: "OnClause", # required
|
11601
11772
|
# },
|
@@ -11613,6 +11784,12 @@ module Aws::QuickSight
|
|
11613
11784
|
# },
|
11614
11785
|
# },
|
11615
11786
|
# ],
|
11787
|
+
# field_folders: {
|
11788
|
+
# "FieldFolderPath" => {
|
11789
|
+
# description: "FieldFolderDescription",
|
11790
|
+
# columns: ["String"],
|
11791
|
+
# },
|
11792
|
+
# },
|
11616
11793
|
# row_level_permission_data_set: {
|
11617
11794
|
# namespace: "Namespace",
|
11618
11795
|
# arn: "Arn", # required
|
@@ -11658,6 +11835,11 @@ module Aws::QuickSight
|
|
11658
11835
|
# features. Currently, only geospatial hierarchy is supported.
|
11659
11836
|
# @return [Array<Types::ColumnGroup>]
|
11660
11837
|
#
|
11838
|
+
# @!attribute [rw] field_folders
|
11839
|
+
# The folder that contains fields and nested subfolders for your
|
11840
|
+
# dataset.
|
11841
|
+
# @return [Hash<String,Types::FieldFolder>]
|
11842
|
+
#
|
11661
11843
|
# @!attribute [rw] row_level_permission_data_set
|
11662
11844
|
# The row-level security configuration for the data you want to
|
11663
11845
|
# create.
|
@@ -11677,6 +11859,7 @@ module Aws::QuickSight
|
|
11677
11859
|
:logical_table_map,
|
11678
11860
|
:import_mode,
|
11679
11861
|
:column_groups,
|
11862
|
+
:field_folders,
|
11680
11863
|
:row_level_permission_data_set,
|
11681
11864
|
:column_level_permission_rules)
|
11682
11865
|
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.41.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-04 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
|