aws-sdk-quicksight 1.157.0 → 1.158.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +601 -460
- data/lib/aws-sdk-quicksight/client_api.rb +100 -0
- data/lib/aws-sdk-quicksight/types.rb +778 -561
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +88 -5
- data/sig/types.rbs +74 -4
- metadata +1 -1
@@ -37,7 +37,7 @@ module Aws::QuickSight
|
|
37
37
|
# Services Region.
|
38
38
|
#
|
39
39
|
# @!attribute [rw] default_theme
|
40
|
-
# The default theme for this
|
40
|
+
# The default theme for this QuickSight subscription.
|
41
41
|
# @return [String]
|
42
42
|
#
|
43
43
|
# @!attribute [rw] default_email_customization_template
|
@@ -55,36 +55,36 @@ module Aws::QuickSight
|
|
55
55
|
|
56
56
|
# A structure that contains the following account information elements:
|
57
57
|
#
|
58
|
-
# * Your
|
58
|
+
# * Your QuickSight account name.
|
59
59
|
#
|
60
|
-
# * The edition of
|
60
|
+
# * The edition of QuickSight that your account is using.
|
61
61
|
#
|
62
|
-
# * The notification email address that is associated with the
|
62
|
+
# * The notification email address that is associated with the
|
63
63
|
# QuickSight account.
|
64
64
|
#
|
65
|
-
# * The authentication type of the
|
65
|
+
# * The authentication type of the QuickSight account.
|
66
66
|
#
|
67
|
-
# * The status of the
|
67
|
+
# * The status of the QuickSight account's subscription.
|
68
68
|
#
|
69
69
|
# @!attribute [rw] account_name
|
70
|
-
# The account name that you provided for the
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
70
|
+
# The account name that you provided for the QuickSight subscription
|
71
|
+
# in your Amazon Web Services account. You create this name when you
|
72
|
+
# sign up for QuickSight. It's unique over all of Amazon Web
|
73
|
+
# Services, and it appears only when users sign in.
|
74
74
|
# @return [String]
|
75
75
|
#
|
76
76
|
# @!attribute [rw] edition
|
77
|
-
# The edition of your
|
77
|
+
# The edition of your QuickSight account.
|
78
78
|
# @return [String]
|
79
79
|
#
|
80
80
|
# @!attribute [rw] notification_email
|
81
|
-
# The email address that will be used for
|
82
|
-
# notifications regarding your Amazon Web Services account or
|
81
|
+
# The email address that will be used for QuickSight to send
|
82
|
+
# notifications regarding your Amazon Web Services account or
|
83
83
|
# QuickSight subscription.
|
84
84
|
# @return [String]
|
85
85
|
#
|
86
86
|
# @!attribute [rw] authentication_type
|
87
|
-
# The way that your
|
87
|
+
# The way that your QuickSight account is authenticated.
|
88
88
|
# @return [String]
|
89
89
|
#
|
90
90
|
# @!attribute [rw] account_subscription_status
|
@@ -108,34 +108,34 @@ module Aws::QuickSight
|
|
108
108
|
include Aws::Structure
|
109
109
|
end
|
110
110
|
|
111
|
-
# The
|
112
|
-
#
|
111
|
+
# The QuickSight settings associated with your Amazon Web Services
|
112
|
+
# account.
|
113
113
|
#
|
114
114
|
# @!attribute [rw] account_name
|
115
|
-
# The "account name" you provided for the
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
115
|
+
# The "account name" you provided for the QuickSight subscription in
|
116
|
+
# your Amazon Web Services account. You create this name when you sign
|
117
|
+
# up for QuickSight. It is unique in all of Amazon Web Services and it
|
118
|
+
# appears only when users sign in.
|
119
119
|
# @return [String]
|
120
120
|
#
|
121
121
|
# @!attribute [rw] edition
|
122
|
-
# The edition of
|
123
|
-
#
|
122
|
+
# The edition of QuickSight that you're currently subscribed to:
|
123
|
+
# Enterprise edition or Standard edition.
|
124
124
|
# @return [String]
|
125
125
|
#
|
126
126
|
# @!attribute [rw] default_namespace
|
127
|
-
# The default
|
127
|
+
# The default QuickSight namespace for your Amazon Web Services
|
128
128
|
# account.
|
129
129
|
# @return [String]
|
130
130
|
#
|
131
131
|
# @!attribute [rw] notification_email
|
132
|
-
# The main notification email for your
|
132
|
+
# The main notification email for your QuickSight subscription.
|
133
133
|
# @return [String]
|
134
134
|
#
|
135
135
|
# @!attribute [rw] public_sharing_enabled
|
136
136
|
# A Boolean value that indicates whether public sharing is turned on
|
137
|
-
# for an
|
138
|
-
#
|
137
|
+
# for an QuickSight account. For more information about turning on
|
138
|
+
# public sharing, see [UpdatePublicSharingSettings][1].
|
139
139
|
#
|
140
140
|
#
|
141
141
|
#
|
@@ -143,9 +143,9 @@ module Aws::QuickSight
|
|
143
143
|
# @return [Boolean]
|
144
144
|
#
|
145
145
|
# @!attribute [rw] termination_protection_enabled
|
146
|
-
# A boolean value that determines whether or not an
|
147
|
-
#
|
148
|
-
#
|
146
|
+
# A boolean value that determines whether or not an QuickSight account
|
147
|
+
# can be deleted. A `True` value doesn't allow the account to be
|
148
|
+
# deleted and results in an error message if a user tries to make a
|
149
149
|
# `DeleteAccountSubsctiption` request. A `False` value will allow the
|
150
150
|
# ccount to be deleted.
|
151
151
|
# @return [Boolean]
|
@@ -362,27 +362,26 @@ module Aws::QuickSight
|
|
362
362
|
include Aws::Structure
|
363
363
|
end
|
364
364
|
|
365
|
-
# A collection of Amazon Q feature configurations in an embedded
|
365
|
+
# A collection of Amazon Q feature configurations in an embedded
|
366
366
|
# QuickSight console.
|
367
367
|
#
|
368
368
|
# @!attribute [rw] data_qn_a
|
369
|
-
# Adds generative Q&A capabilitiees to an embedded
|
370
|
-
#
|
369
|
+
# Adds generative Q&A capabilitiees to an embedded QuickSight
|
370
|
+
# console.
|
371
371
|
# @return [Types::DataQnAConfigurations]
|
372
372
|
#
|
373
373
|
# @!attribute [rw] generative_authoring
|
374
|
-
# Adds the generative BI authoring experience to an embedded
|
374
|
+
# Adds the generative BI authoring experience to an embedded
|
375
375
|
# QuickSight console.
|
376
376
|
# @return [Types::GenerativeAuthoringConfigurations]
|
377
377
|
#
|
378
378
|
# @!attribute [rw] executive_summary
|
379
|
-
# Adds the executive summaries feature to an embedded
|
380
|
-
#
|
379
|
+
# Adds the executive summaries feature to an embedded QuickSight
|
380
|
+
# console.
|
381
381
|
# @return [Types::ExecutiveSummaryConfigurations]
|
382
382
|
#
|
383
383
|
# @!attribute [rw] data_stories
|
384
|
-
# Adds the data stories feature to an embedded
|
385
|
-
# console.
|
384
|
+
# Adds the data stories feature to an embedded QuickSight console.
|
386
385
|
# @return [Types::DataStoriesConfigurations]
|
387
386
|
#
|
388
387
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonQInQuickSightConsoleConfigurations AWS API Documentation
|
@@ -396,12 +395,11 @@ module Aws::QuickSight
|
|
396
395
|
include Aws::Structure
|
397
396
|
end
|
398
397
|
|
399
|
-
# A collection of Amazon Q feature configurations in an embedded
|
398
|
+
# A collection of Amazon Q feature configurations in an embedded
|
400
399
|
# QuickSight dashboard.
|
401
400
|
#
|
402
401
|
# @!attribute [rw] executive_summary
|
403
|
-
# A generated executive summary of an embedded
|
404
|
-
# dashboard.
|
402
|
+
# A generated executive summary of an embedded QuickSight dashboard.
|
405
403
|
# @return [Types::ExecutiveSummaryConfigurations]
|
406
404
|
#
|
407
405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonQInQuickSightDashboardConfigurations AWS API Documentation
|
@@ -709,8 +707,8 @@ module Aws::QuickSight
|
|
709
707
|
# @return [String]
|
710
708
|
#
|
711
709
|
# @!attribute [rw] name
|
712
|
-
# The name of the analysis. This name is displayed in the
|
713
|
-
#
|
710
|
+
# The name of the analysis. This name is displayed in the QuickSight
|
711
|
+
# console.
|
714
712
|
# @return [String]
|
715
713
|
#
|
716
714
|
# @!attribute [rw] status
|
@@ -792,7 +790,7 @@ module Aws::QuickSight
|
|
792
790
|
# @!attribute [rw] initial_dashboard_id
|
793
791
|
# The dashboard ID for the dashboard that you want the user to see
|
794
792
|
# first. This ID is included in the output URL. When the URL in
|
795
|
-
# response is accessed,
|
793
|
+
# response is accessed, QuickSight renders this dashboard.
|
796
794
|
#
|
797
795
|
# The Amazon Resource Name (ARN) of this dashboard must be included in
|
798
796
|
# the `AuthorizedResourceArns` parameter. Otherwise, the request will
|
@@ -842,7 +840,7 @@ module Aws::QuickSight
|
|
842
840
|
# @!attribute [rw] initial_dashboard_visual_id
|
843
841
|
# The visual ID for the visual that you want the user to see. This ID
|
844
842
|
# is included in the output URL. When the URL in response is accessed,
|
845
|
-
#
|
843
|
+
# QuickSight renders this visual.
|
846
844
|
#
|
847
845
|
# The Amazon Resource Name (ARN) of the dashboard that the visual
|
848
846
|
# belongs to must be included in the `AuthorizedResourceArns`
|
@@ -859,16 +857,15 @@ module Aws::QuickSight
|
|
859
857
|
end
|
860
858
|
|
861
859
|
# The type of experience you want to embed. For anonymous users, you can
|
862
|
-
# embed
|
860
|
+
# embed QuickSight dashboards.
|
863
861
|
#
|
864
862
|
# @!attribute [rw] dashboard
|
865
|
-
# The type of embedding experience. In this case,
|
863
|
+
# The type of embedding experience. In this case, QuickSight
|
866
864
|
# dashboards.
|
867
865
|
# @return [Types::AnonymousUserDashboardEmbeddingConfiguration]
|
868
866
|
#
|
869
867
|
# @!attribute [rw] dashboard_visual
|
870
|
-
# The type of embedding experience. In this case,
|
871
|
-
# visuals.
|
868
|
+
# The type of embedding experience. In this case, QuickSight visuals.
|
872
869
|
# @return [Types::AnonymousUserDashboardVisualEmbeddingConfiguration]
|
873
870
|
#
|
874
871
|
# @!attribute [rw] q_search_bar
|
@@ -895,11 +892,11 @@ module Aws::QuickSight
|
|
895
892
|
# experience.
|
896
893
|
#
|
897
894
|
# @!attribute [rw] initial_topic_id
|
898
|
-
# The
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
895
|
+
# The QuickSight Q topic ID of the new reader experience topic that
|
896
|
+
# you want the anonymous user to see first. This ID is included in the
|
897
|
+
# output URL. When the URL in response is accessed, QuickSight renders
|
898
|
+
# the Generative Q&A experience with this new reader experience
|
899
|
+
# topic pre selected.
|
903
900
|
#
|
904
901
|
# The Amazon Resource Name (ARN) of this Q new reader experience topic
|
905
902
|
# must be included in the `AuthorizedResourceArns` parameter.
|
@@ -918,10 +915,10 @@ module Aws::QuickSight
|
|
918
915
|
# The settings that you want to use with the Q search bar.
|
919
916
|
#
|
920
917
|
# @!attribute [rw] initial_topic_id
|
921
|
-
# The
|
922
|
-
#
|
923
|
-
#
|
924
|
-
#
|
918
|
+
# The QuickSight Q topic ID of the legacy topic that you want the
|
919
|
+
# anonymous user to see first. This ID is included in the output URL.
|
920
|
+
# When the URL in response is accessed, QuickSight renders the Q
|
921
|
+
# search bar with this legacy topic pre-selected.
|
925
922
|
#
|
926
923
|
# The Amazon Resource Name (ARN) of this Q legacy topic must be
|
927
924
|
# included in the `AuthorizedResourceArns` parameter. Otherwise, the
|
@@ -1680,8 +1677,8 @@ module Aws::QuickSight
|
|
1680
1677
|
# @return [Types::VpcConnectionProperties]
|
1681
1678
|
#
|
1682
1679
|
# @!attribute [rw] ssl_properties
|
1683
|
-
# Secure Socket Layer (SSL) properties that apply when
|
1684
|
-
#
|
1680
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
1681
|
+
# connects to your underlying data source.
|
1685
1682
|
# @return [Types::SslProperties]
|
1686
1683
|
#
|
1687
1684
|
# @!attribute [rw] credentials
|
@@ -2310,7 +2307,7 @@ module Aws::QuickSight
|
|
2310
2307
|
end
|
2311
2308
|
|
2312
2309
|
# A structure that contains the configuration of a shared link to an
|
2313
|
-
#
|
2310
|
+
# QuickSight dashboard.
|
2314
2311
|
#
|
2315
2312
|
# @!attribute [rw] permissions
|
2316
2313
|
# A list of link sharing permissions for the dashboards that you want
|
@@ -2398,10 +2395,10 @@ module Aws::QuickSight
|
|
2398
2395
|
#
|
2399
2396
|
# @!attribute [rw] identity_center_configuration
|
2400
2397
|
# An optional parameter that configures IAM Identity Center
|
2401
|
-
# authentication to grant
|
2398
|
+
# authentication to grant QuickSight access to your workgroup.
|
2402
2399
|
#
|
2403
|
-
# This parameter can only be specified if your
|
2404
|
-
#
|
2400
|
+
# This parameter can only be specified if your QuickSight account is
|
2401
|
+
# configured with IAM Identity Center.
|
2405
2402
|
# @return [Types::IdentityCenterConfiguration]
|
2406
2403
|
#
|
2407
2404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AthenaParameters AWS API Documentation
|
@@ -3706,7 +3703,7 @@ module Aws::QuickSight
|
|
3706
3703
|
# The details of the brand.
|
3707
3704
|
#
|
3708
3705
|
# @!attribute [rw] brand_id
|
3709
|
-
# The ID of the
|
3706
|
+
# The ID of the QuickSight brand.
|
3710
3707
|
# @return [String]
|
3711
3708
|
#
|
3712
3709
|
# @!attribute [rw] arn
|
@@ -3779,7 +3776,7 @@ module Aws::QuickSight
|
|
3779
3776
|
# @return [String]
|
3780
3777
|
#
|
3781
3778
|
# @!attribute [rw] brand_id
|
3782
|
-
# The ID of the
|
3779
|
+
# The ID of the QuickSight brand.
|
3783
3780
|
# @return [String]
|
3784
3781
|
#
|
3785
3782
|
# @!attribute [rw] brand_name
|
@@ -3935,7 +3932,7 @@ module Aws::QuickSight
|
|
3935
3932
|
include Aws::Structure
|
3936
3933
|
end
|
3937
3934
|
|
3938
|
-
# A set of actions that correspond to
|
3935
|
+
# A set of actions that correspond to QuickSight permissions.
|
3939
3936
|
#
|
3940
3937
|
# @!attribute [rw] export_to_csv
|
3941
3938
|
# The ability to export to CSV files from the UI.
|
@@ -4029,6 +4026,14 @@ module Aws::QuickSight
|
|
4029
4026
|
# The ability to include content in scheduled email reports.
|
4030
4027
|
# @return [String]
|
4031
4028
|
#
|
4029
|
+
# @!attribute [rw] dashboard
|
4030
|
+
# The ability to perform dashboard-related actions.
|
4031
|
+
# @return [String]
|
4032
|
+
#
|
4033
|
+
# @!attribute [rw] analysis
|
4034
|
+
# The ability to perform analysis-related actions.
|
4035
|
+
# @return [String]
|
4036
|
+
#
|
4032
4037
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Capabilities AWS API Documentation
|
4033
4038
|
#
|
4034
4039
|
class Capabilities < Struct.new(
|
@@ -4054,7 +4059,9 @@ module Aws::QuickSight
|
|
4054
4059
|
:export_to_pdf_in_scheduled_reports,
|
4055
4060
|
:export_to_csv_in_scheduled_reports,
|
4056
4061
|
:export_to_excel_in_scheduled_reports,
|
4057
|
-
:include_content_in_scheduled_reports_email
|
4062
|
+
:include_content_in_scheduled_reports_email,
|
4063
|
+
:dashboard,
|
4064
|
+
:analysis)
|
4058
4065
|
SENSITIVE = []
|
4059
4066
|
include Aws::Structure
|
4060
4067
|
end
|
@@ -4251,13 +4258,13 @@ module Aws::QuickSight
|
|
4251
4258
|
# one of the attributes can be defined.
|
4252
4259
|
#
|
4253
4260
|
# @!attribute [rw] filter_list_configuration
|
4254
|
-
# A list of filter configurations. In the
|
4255
|
-
#
|
4261
|
+
# A list of filter configurations. In the QuickSight console, this
|
4262
|
+
# filter type is called a filter list.
|
4256
4263
|
# @return [Types::FilterListConfiguration]
|
4257
4264
|
#
|
4258
4265
|
# @!attribute [rw] custom_filter_list_configuration
|
4259
|
-
# A list of custom filter values. In the
|
4260
|
-
#
|
4266
|
+
# A list of custom filter values. In the QuickSight console, this
|
4267
|
+
# filter type is called a custom filter list.
|
4261
4268
|
# @return [Types::CustomFilterListConfiguration]
|
4262
4269
|
#
|
4263
4270
|
# @!attribute [rw] custom_filter_configuration
|
@@ -4600,8 +4607,8 @@ module Aws::QuickSight
|
|
4600
4607
|
# column, a user or group needs to be added to a rule for that column.
|
4601
4608
|
#
|
4602
4609
|
# @!attribute [rw] principals
|
4603
|
-
# An array of Amazon Resource Names (ARNs) for
|
4604
|
-
#
|
4610
|
+
# An array of Amazon Resource Names (ARNs) for QuickSight users or
|
4611
|
+
# groups.
|
4605
4612
|
# @return [Array<String>]
|
4606
4613
|
#
|
4607
4614
|
# @!attribute [rw] column_names
|
@@ -5377,18 +5384,17 @@ module Aws::QuickSight
|
|
5377
5384
|
|
5378
5385
|
# @!attribute [rw] aws_account_id
|
5379
5386
|
# The ID for the Amazon Web Services account that you want to
|
5380
|
-
# customize
|
5387
|
+
# customize QuickSight for.
|
5381
5388
|
# @return [String]
|
5382
5389
|
#
|
5383
5390
|
# @!attribute [rw] namespace
|
5384
|
-
# The
|
5385
|
-
# to.
|
5391
|
+
# The QuickSight namespace that you want to add customizations to.
|
5386
5392
|
# @return [String]
|
5387
5393
|
#
|
5388
5394
|
# @!attribute [rw] account_customization
|
5389
|
-
# The
|
5390
|
-
#
|
5391
|
-
#
|
5395
|
+
# The QuickSight customizations you're adding in the current Amazon
|
5396
|
+
# Web Services Region. You can add these to an Amazon Web Services
|
5397
|
+
# account and a QuickSight namespace.
|
5392
5398
|
#
|
5393
5399
|
# For example, you can add a default theme by setting
|
5394
5400
|
# `AccountCustomization` to the midnight theme:
|
@@ -5422,7 +5428,7 @@ module Aws::QuickSight
|
|
5422
5428
|
#
|
5423
5429
|
# @!attribute [rw] aws_account_id
|
5424
5430
|
# The ID for the Amazon Web Services account that you want to
|
5425
|
-
# customize
|
5431
|
+
# customize QuickSight for.
|
5426
5432
|
# @return [String]
|
5427
5433
|
#
|
5428
5434
|
# @!attribute [rw] namespace
|
@@ -5430,8 +5436,8 @@ module Aws::QuickSight
|
|
5430
5436
|
# @return [String]
|
5431
5437
|
#
|
5432
5438
|
# @!attribute [rw] account_customization
|
5433
|
-
# The
|
5434
|
-
#
|
5439
|
+
# The QuickSight customizations you're adding in the current Amazon
|
5440
|
+
# Web Services Region.
|
5435
5441
|
# @return [Types::AccountCustomization]
|
5436
5442
|
#
|
5437
5443
|
# @!attribute [rw] request_id
|
@@ -5456,7 +5462,7 @@ module Aws::QuickSight
|
|
5456
5462
|
end
|
5457
5463
|
|
5458
5464
|
# @!attribute [rw] edition
|
5459
|
-
# The edition of
|
5465
|
+
# The edition of QuickSight that you want your account to have.
|
5460
5466
|
# Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
|
5461
5467
|
#
|
5462
5468
|
# If you choose `ENTERPRISE_AND_Q`, the following parameters are
|
@@ -5472,8 +5478,8 @@ module Aws::QuickSight
|
|
5472
5478
|
# @return [String]
|
5473
5479
|
#
|
5474
5480
|
# @!attribute [rw] authentication_method
|
5475
|
-
# The method that you want to use to authenticate your
|
5476
|
-
#
|
5481
|
+
# The method that you want to use to authenticate your QuickSight
|
5482
|
+
# account.
|
5477
5483
|
#
|
5478
5484
|
# If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName`
|
5479
5485
|
# and an `AdminGroup` associated with your Active Directory.
|
@@ -5484,37 +5490,35 @@ module Aws::QuickSight
|
|
5484
5490
|
#
|
5485
5491
|
# @!attribute [rw] aws_account_id
|
5486
5492
|
# The Amazon Web Services account ID of the account that you're using
|
5487
|
-
# to create your
|
5493
|
+
# to create your QuickSight account.
|
5488
5494
|
# @return [String]
|
5489
5495
|
#
|
5490
5496
|
# @!attribute [rw] account_name
|
5491
|
-
# The name of your
|
5492
|
-
#
|
5493
|
-
#
|
5494
|
-
#
|
5497
|
+
# The name of your QuickSight account. This name is unique over all of
|
5498
|
+
# Amazon Web Services, and it appears only when users sign in. You
|
5499
|
+
# can't change `AccountName` value after the QuickSight account is
|
5500
|
+
# created.
|
5495
5501
|
# @return [String]
|
5496
5502
|
#
|
5497
5503
|
# @!attribute [rw] notification_email
|
5498
|
-
# The email address that you want
|
5499
|
-
#
|
5500
|
-
# QuickSight subscription.
|
5504
|
+
# The email address that you want QuickSight to send notifications to
|
5505
|
+
# regarding your QuickSight account or QuickSight subscription.
|
5501
5506
|
# @return [String]
|
5502
5507
|
#
|
5503
5508
|
# @!attribute [rw] active_directory_name
|
5504
5509
|
# The name of your Active Directory. This field is required if
|
5505
5510
|
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
5506
|
-
#
|
5511
|
+
# QuickSight account.
|
5507
5512
|
# @return [String]
|
5508
5513
|
#
|
5509
5514
|
# @!attribute [rw] realm
|
5510
5515
|
# The realm of the Active Directory that is associated with your
|
5511
|
-
#
|
5512
|
-
#
|
5513
|
-
# Amazon QuickSight account.
|
5516
|
+
# QuickSight account. This field is required if `ACTIVE_DIRECTORY` is
|
5517
|
+
# the selected authentication method of the new QuickSight account.
|
5514
5518
|
# @return [String]
|
5515
5519
|
#
|
5516
5520
|
# @!attribute [rw] directory_id
|
5517
|
-
# The ID of the Active Directory that is associated with your
|
5521
|
+
# The ID of the Active Directory that is associated with your
|
5518
5522
|
# QuickSight account.
|
5519
5523
|
# @return [String]
|
5520
5524
|
#
|
@@ -5522,15 +5526,13 @@ module Aws::QuickSight
|
|
5522
5526
|
# The admin group associated with your Active Directory or IAM
|
5523
5527
|
# Identity Center account. Either this field or the `AdminProGroup`
|
5524
5528
|
# field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is
|
5525
|
-
# the selected authentication method of the new
|
5526
|
-
# account.
|
5529
|
+
# the selected authentication method of the new QuickSight account.
|
5527
5530
|
#
|
5528
|
-
# For more information about using IAM Identity Center in
|
5529
|
-
#
|
5530
|
-
#
|
5531
|
-
#
|
5532
|
-
#
|
5533
|
-
# Edition][2] in the Amazon QuickSight User Guide.
|
5531
|
+
# For more information about using IAM Identity Center in QuickSight,
|
5532
|
+
# see [Using IAM Identity Center with QuickSight Enterprise
|
5533
|
+
# Edition][1] in the QuickSight User Guide. For more information about
|
5534
|
+
# using Active Directory in QuickSight, see [Using Active Directory
|
5535
|
+
# with QuickSight Enterprise Edition][2] in the QuickSight User Guide.
|
5534
5536
|
#
|
5535
5537
|
#
|
5536
5538
|
#
|
@@ -5542,12 +5544,11 @@ module Aws::QuickSight
|
|
5542
5544
|
# The author group associated with your Active Directory or IAM
|
5543
5545
|
# Identity Center account.
|
5544
5546
|
#
|
5545
|
-
# For more information about using IAM Identity Center in
|
5546
|
-
#
|
5547
|
-
#
|
5548
|
-
#
|
5549
|
-
#
|
5550
|
-
# Edition][2] in the Amazon QuickSight User Guide.
|
5547
|
+
# For more information about using IAM Identity Center in QuickSight,
|
5548
|
+
# see [Using IAM Identity Center with QuickSight Enterprise
|
5549
|
+
# Edition][1] in the QuickSight User Guide. For more information about
|
5550
|
+
# using Active Directory in QuickSight, see [Using Active Directory
|
5551
|
+
# with QuickSight Enterprise Edition][2] in the QuickSight User Guide.
|
5551
5552
|
#
|
5552
5553
|
#
|
5553
5554
|
#
|
@@ -5559,12 +5560,11 @@ module Aws::QuickSight
|
|
5559
5560
|
# The reader group associated with your Active Directory or IAM
|
5560
5561
|
# Identity Center account.
|
5561
5562
|
#
|
5562
|
-
# For more information about using IAM Identity Center in
|
5563
|
-
#
|
5564
|
-
#
|
5565
|
-
#
|
5566
|
-
#
|
5567
|
-
# Edition][2] in the Amazon QuickSight User Guide.
|
5563
|
+
# For more information about using IAM Identity Center in QuickSight,
|
5564
|
+
# see [Using IAM Identity Center with QuickSight Enterprise
|
5565
|
+
# Edition][1] in the QuickSight User Guide. For more information about
|
5566
|
+
# using Active Directory in QuickSight, see [Using Active Directory
|
5567
|
+
# with QuickSight Enterprise Edition][2] in the QuickSight User Guide.
|
5568
5568
|
#
|
5569
5569
|
#
|
5570
5570
|
#
|
@@ -5576,14 +5576,13 @@ module Aws::QuickSight
|
|
5576
5576
|
# The admin pro group associated with your Active Directory or IAM
|
5577
5577
|
# Identity Center account. Either this field or the `AdminGroup` field
|
5578
5578
|
# is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
5579
|
-
# selected authentication method of the new
|
5579
|
+
# selected authentication method of the new QuickSight account.
|
5580
5580
|
#
|
5581
|
-
# For more information about using IAM Identity Center in
|
5582
|
-
#
|
5583
|
-
#
|
5584
|
-
#
|
5585
|
-
#
|
5586
|
-
# Edition][2] in the Amazon QuickSight User Guide.
|
5581
|
+
# For more information about using IAM Identity Center in QuickSight,
|
5582
|
+
# see [Using IAM Identity Center with QuickSight Enterprise
|
5583
|
+
# Edition][1] in the QuickSight User Guide. For more information about
|
5584
|
+
# using Active Directory in QuickSight, see [Using Active Directory
|
5585
|
+
# with QuickSight Enterprise Edition][2] in the QuickSight User Guide.
|
5587
5586
|
#
|
5588
5587
|
#
|
5589
5588
|
#
|
@@ -5595,12 +5594,11 @@ module Aws::QuickSight
|
|
5595
5594
|
# The author pro group associated with your Active Directory or IAM
|
5596
5595
|
# Identity Center account.
|
5597
5596
|
#
|
5598
|
-
# For more information about using IAM Identity Center in
|
5599
|
-
#
|
5600
|
-
#
|
5601
|
-
#
|
5602
|
-
#
|
5603
|
-
# Edition][2] in the Amazon QuickSight User Guide.
|
5597
|
+
# For more information about using IAM Identity Center in QuickSight,
|
5598
|
+
# see [Using IAM Identity Center with QuickSight Enterprise
|
5599
|
+
# Edition][1] in the QuickSight User Guide. For more information about
|
5600
|
+
# using Active Directory in QuickSight, see [Using Active Directory
|
5601
|
+
# with QuickSight Enterprise Edition][2] in the QuickSight User Guide.
|
5604
5602
|
#
|
5605
5603
|
#
|
5606
5604
|
#
|
@@ -5612,12 +5610,11 @@ module Aws::QuickSight
|
|
5612
5610
|
# The reader pro group associated with your Active Directory or IAM
|
5613
5611
|
# Identity Center account.
|
5614
5612
|
#
|
5615
|
-
# For more information about using IAM Identity Center in
|
5616
|
-
#
|
5617
|
-
#
|
5618
|
-
#
|
5619
|
-
#
|
5620
|
-
# Edition][2] in the Amazon QuickSight User Guide.
|
5613
|
+
# For more information about using IAM Identity Center in QuickSight,
|
5614
|
+
# see [Using IAM Identity Center with QuickSight Enterprise
|
5615
|
+
# Edition][1] in the QuickSight User Guide. For more information about
|
5616
|
+
# using Active Directory in QuickSight, see [Using Active Directory
|
5617
|
+
# with QuickSight Enterprise Edition][2] in the QuickSight User Guide.
|
5621
5618
|
#
|
5622
5619
|
#
|
5623
5620
|
#
|
@@ -5626,31 +5623,28 @@ module Aws::QuickSight
|
|
5626
5623
|
# @return [Array<String>]
|
5627
5624
|
#
|
5628
5625
|
# @!attribute [rw] first_name
|
5629
|
-
# The first name of the author of the
|
5630
|
-
#
|
5631
|
-
#
|
5632
|
-
# QuickSight account.
|
5626
|
+
# The first name of the author of the QuickSight account to use for
|
5627
|
+
# future communications. This field is required if `ENTERPPRISE_AND_Q`
|
5628
|
+
# is the selected edition of the new QuickSight account.
|
5633
5629
|
# @return [String]
|
5634
5630
|
#
|
5635
5631
|
# @!attribute [rw] last_name
|
5636
|
-
# The last name of the author of the
|
5637
|
-
#
|
5638
|
-
#
|
5639
|
-
# QuickSight account.
|
5632
|
+
# The last name of the author of the QuickSight account to use for
|
5633
|
+
# future communications. This field is required if `ENTERPPRISE_AND_Q`
|
5634
|
+
# is the selected edition of the new QuickSight account.
|
5640
5635
|
# @return [String]
|
5641
5636
|
#
|
5642
5637
|
# @!attribute [rw] email_address
|
5643
|
-
# The email address of the author of the
|
5644
|
-
#
|
5645
|
-
#
|
5646
|
-
# QuickSight account.
|
5638
|
+
# The email address of the author of the QuickSight account to use for
|
5639
|
+
# future communications. This field is required if `ENTERPPRISE_AND_Q`
|
5640
|
+
# is the selected edition of the new QuickSight account.
|
5647
5641
|
# @return [String]
|
5648
5642
|
#
|
5649
5643
|
# @!attribute [rw] contact_number
|
5650
|
-
# A 10-digit phone number for the author of the
|
5651
|
-
#
|
5652
|
-
# `ENTERPPRISE_AND_Q` is the selected edition of the new
|
5653
|
-
#
|
5644
|
+
# A 10-digit phone number for the author of the QuickSight account to
|
5645
|
+
# use for future communications. This field is required if
|
5646
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new QuickSight
|
5647
|
+
# account.
|
5654
5648
|
# @return [String]
|
5655
5649
|
#
|
5656
5650
|
# @!attribute [rw] iam_identity_center_instance_arn
|
@@ -5685,7 +5679,7 @@ module Aws::QuickSight
|
|
5685
5679
|
|
5686
5680
|
# @!attribute [rw] signup_response
|
5687
5681
|
# A `SignupResponse` object that returns information about a newly
|
5688
|
-
# created
|
5682
|
+
# created QuickSight account.
|
5689
5683
|
# @return [Types::SignupResponse]
|
5690
5684
|
#
|
5691
5685
|
# @!attribute [rw] status
|
@@ -5718,7 +5712,7 @@ module Aws::QuickSight
|
|
5718
5712
|
#
|
5719
5713
|
# @!attribute [rw] name
|
5720
5714
|
# A descriptive name for the analysis that you're creating. This name
|
5721
|
-
# displays for the analysis in the
|
5715
|
+
# displays for the analysis in the QuickSight console.
|
5722
5716
|
# @return [String]
|
5723
5717
|
#
|
5724
5718
|
# @!attribute [rw] parameters
|
@@ -5748,8 +5742,8 @@ module Aws::QuickSight
|
|
5748
5742
|
#
|
5749
5743
|
# @!attribute [rw] theme_arn
|
5750
5744
|
# The ARN for the theme to apply to the analysis that you're
|
5751
|
-
# creating. To see the theme in the
|
5752
|
-
#
|
5745
|
+
# creating. To see the theme in the QuickSight console, make sure that
|
5746
|
+
# you have access to it.
|
5753
5747
|
# @return [String]
|
5754
5748
|
#
|
5755
5749
|
# @!attribute [rw] tags
|
@@ -5774,8 +5768,8 @@ module Aws::QuickSight
|
|
5774
5768
|
# @return [Types::ValidationStrategy]
|
5775
5769
|
#
|
5776
5770
|
# @!attribute [rw] folder_arns
|
5777
|
-
# When you create the analysis,
|
5778
|
-
#
|
5771
|
+
# When you create the analysis, QuickSight adds the analysis to these
|
5772
|
+
# folders.
|
5779
5773
|
# @return [Array<String>]
|
5780
5774
|
#
|
5781
5775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisRequest AWS API Documentation
|
@@ -5833,7 +5827,7 @@ module Aws::QuickSight
|
|
5833
5827
|
# @return [String]
|
5834
5828
|
#
|
5835
5829
|
# @!attribute [rw] brand_id
|
5836
|
-
# The ID of the
|
5830
|
+
# The ID of the QuickSight brand.
|
5837
5831
|
# @return [String]
|
5838
5832
|
#
|
5839
5833
|
# @!attribute [rw] brand_definition
|
@@ -5978,7 +5972,7 @@ module Aws::QuickSight
|
|
5978
5972
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
5979
5973
|
# the Amazon Resource Name (ARN) of the source template. The
|
5980
5974
|
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
5981
|
-
# any
|
5975
|
+
# any QuickSight-supported Amazon Web Services Region.
|
5982
5976
|
#
|
5983
5977
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
5984
5978
|
# the replacement datasets for the placeholders listed in the
|
@@ -6002,7 +5996,7 @@ module Aws::QuickSight
|
|
6002
5996
|
#
|
6003
5997
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
6004
5998
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
6005
|
-
#
|
5999
|
+
# QuickSight disables the left filter pane on the published
|
6006
6000
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
6007
6001
|
# option is `ENABLED` by default.
|
6008
6002
|
#
|
@@ -6014,6 +6008,16 @@ module Aws::QuickSight
|
|
6014
6008
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
6015
6009
|
# state can be either `COLLAPSED` or `EXPANDED`. This option is
|
6016
6010
|
# `COLLAPSED` by default.
|
6011
|
+
#
|
6012
|
+
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status
|
6013
|
+
# can be either `ENABLED` or `DISABLED`. The option to build an
|
6014
|
+
# executive summary is disabled when this is set to `DISABLED`. This
|
6015
|
+
# option is `ENABLED` by default.
|
6016
|
+
#
|
6017
|
+
# * `AvailabilityStatus` for `DataStoriesSharingOption` - This status
|
6018
|
+
# can be either `ENABLED` or `DISABLED`. The option to share a data
|
6019
|
+
# story is disabled when this is set to `DISABLED`. This option is
|
6020
|
+
# `ENABLED` by default.
|
6017
6021
|
# @return [Types::DashboardPublishOptions]
|
6018
6022
|
#
|
6019
6023
|
# @!attribute [rw] theme_arn
|
@@ -6040,8 +6044,8 @@ module Aws::QuickSight
|
|
6040
6044
|
# @return [Types::ValidationStrategy]
|
6041
6045
|
#
|
6042
6046
|
# @!attribute [rw] folder_arns
|
6043
|
-
# When you create the dashboard,
|
6044
|
-
#
|
6047
|
+
# When you create the dashboard, QuickSight adds the dashboard to
|
6048
|
+
# these folders.
|
6045
6049
|
# @return [Array<String>]
|
6046
6050
|
#
|
6047
6051
|
# @!attribute [rw] link_sharing_configuration
|
@@ -6142,7 +6146,7 @@ module Aws::QuickSight
|
|
6142
6146
|
# @return [String]
|
6143
6147
|
#
|
6144
6148
|
# @!attribute [rw] column_groups
|
6145
|
-
# Groupings of columns that work together in certain
|
6149
|
+
# Groupings of columns that work together in certain QuickSight
|
6146
6150
|
# features. Currently, only geospatial hierarchy is supported.
|
6147
6151
|
# @return [Array<Types::ColumnGroup>]
|
6148
6152
|
#
|
@@ -6185,8 +6189,8 @@ module Aws::QuickSight
|
|
6185
6189
|
# @return [Array<Types::DatasetParameter>]
|
6186
6190
|
#
|
6187
6191
|
# @!attribute [rw] folder_arns
|
6188
|
-
# When you create the dataset,
|
6189
|
-
#
|
6192
|
+
# When you create the dataset, QuickSight adds the dataset to these
|
6193
|
+
# folders.
|
6190
6194
|
# @return [Array<String>]
|
6191
6195
|
#
|
6192
6196
|
# @!attribute [rw] performance_configuration
|
@@ -6285,14 +6289,14 @@ module Aws::QuickSight
|
|
6285
6289
|
# @return [String]
|
6286
6290
|
#
|
6287
6291
|
# @!attribute [rw] data_source_parameters
|
6288
|
-
# The parameters that
|
6289
|
-
#
|
6292
|
+
# The parameters that QuickSight uses to connect to your underlying
|
6293
|
+
# source.
|
6290
6294
|
# @return [Types::DataSourceParameters]
|
6291
6295
|
#
|
6292
6296
|
# @!attribute [rw] credentials
|
6293
|
-
# The credentials
|
6294
|
-
#
|
6295
|
-
#
|
6297
|
+
# The credentials QuickSight that uses to connect to your underlying
|
6298
|
+
# source. Currently, only credentials based on user name and password
|
6299
|
+
# are supported.
|
6296
6300
|
# @return [Types::DataSourceCredentials]
|
6297
6301
|
#
|
6298
6302
|
# @!attribute [rw] permissions
|
@@ -6300,13 +6304,13 @@ module Aws::QuickSight
|
|
6300
6304
|
# @return [Array<Types::ResourcePermission>]
|
6301
6305
|
#
|
6302
6306
|
# @!attribute [rw] vpc_connection_properties
|
6303
|
-
# Use this parameter only when you want
|
6307
|
+
# Use this parameter only when you want QuickSight to use a VPC
|
6304
6308
|
# connection when connecting to your underlying source.
|
6305
6309
|
# @return [Types::VpcConnectionProperties]
|
6306
6310
|
#
|
6307
6311
|
# @!attribute [rw] ssl_properties
|
6308
|
-
# Secure Socket Layer (SSL) properties that apply when
|
6309
|
-
#
|
6312
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
6313
|
+
# connects to your underlying source.
|
6310
6314
|
# @return [Types::SslProperties]
|
6311
6315
|
#
|
6312
6316
|
# @!attribute [rw] tags
|
@@ -6315,8 +6319,8 @@ module Aws::QuickSight
|
|
6315
6319
|
# @return [Array<Types::Tag>]
|
6316
6320
|
#
|
6317
6321
|
# @!attribute [rw] folder_arns
|
6318
|
-
# When you create the data source,
|
6319
|
-
#
|
6322
|
+
# When you create the data source, QuickSight adds the data source to
|
6323
|
+
# these folders.
|
6320
6324
|
# @return [Array<String>]
|
6321
6325
|
#
|
6322
6326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSourceRequest AWS API Documentation
|
@@ -6609,7 +6613,7 @@ module Aws::QuickSight
|
|
6609
6613
|
|
6610
6614
|
# @!attribute [rw] aws_account_id
|
6611
6615
|
# The ID of the Amazon Web Services account where you want to assign
|
6612
|
-
# an IAM policy to
|
6616
|
+
# an IAM policy to QuickSight users or groups.
|
6613
6617
|
# @return [String]
|
6614
6618
|
#
|
6615
6619
|
# @!attribute [rw] assignment_name
|
@@ -6631,13 +6635,13 @@ module Aws::QuickSight
|
|
6631
6635
|
# @return [String]
|
6632
6636
|
#
|
6633
6637
|
# @!attribute [rw] policy_arn
|
6634
|
-
# The ARN for the IAM policy to apply to the
|
6635
|
-
#
|
6638
|
+
# The ARN for the IAM policy to apply to the QuickSight users and
|
6639
|
+
# groups specified in this assignment.
|
6636
6640
|
# @return [String]
|
6637
6641
|
#
|
6638
6642
|
# @!attribute [rw] identities
|
6639
|
-
# The
|
6640
|
-
#
|
6643
|
+
# The QuickSight users, groups, or both that you want to assign the
|
6644
|
+
# policy to.
|
6641
6645
|
# @return [Hash<String,Array<String>>]
|
6642
6646
|
#
|
6643
6647
|
# @!attribute [rw] namespace
|
@@ -6680,12 +6684,12 @@ module Aws::QuickSight
|
|
6680
6684
|
# @return [String]
|
6681
6685
|
#
|
6682
6686
|
# @!attribute [rw] policy_arn
|
6683
|
-
# The ARN for the IAM policy that is applied to the
|
6684
|
-
#
|
6687
|
+
# The ARN for the IAM policy that is applied to the QuickSight users
|
6688
|
+
# and groups specified in this assignment.
|
6685
6689
|
# @return [String]
|
6686
6690
|
#
|
6687
6691
|
# @!attribute [rw] identities
|
6688
|
-
# The
|
6692
|
+
# The QuickSight users, groups, or both that the IAM policy is
|
6689
6693
|
# assigned to.
|
6690
6694
|
# @return [Hash<String,Array<String>>]
|
6691
6695
|
#
|
@@ -6772,7 +6776,7 @@ module Aws::QuickSight
|
|
6772
6776
|
|
6773
6777
|
# @!attribute [rw] aws_account_id
|
6774
6778
|
# The ID for the Amazon Web Services account that you want to create
|
6775
|
-
# the
|
6779
|
+
# the QuickSight namespace in.
|
6776
6780
|
# @return [String]
|
6777
6781
|
#
|
6778
6782
|
# @!attribute [rw] namespace
|
@@ -6801,7 +6805,7 @@ module Aws::QuickSight
|
|
6801
6805
|
end
|
6802
6806
|
|
6803
6807
|
# @!attribute [rw] arn
|
6804
|
-
# The ARN of the
|
6808
|
+
# The ARN of the QuickSight namespace you created.
|
6805
6809
|
# @return [String]
|
6806
6810
|
#
|
6807
6811
|
# @!attribute [rw] name
|
@@ -6957,7 +6961,7 @@ module Aws::QuickSight
|
|
6957
6961
|
# @!attribute [rw] alias_name
|
6958
6962
|
# The name that you want to give to the template alias that you're
|
6959
6963
|
# creating. Don't start the alias name with the `$` character. Alias
|
6960
|
-
# names that start with `$` are reserved by
|
6964
|
+
# names that start with `$` are reserved by QuickSight.
|
6961
6965
|
# @return [String]
|
6962
6966
|
#
|
6963
6967
|
# @!attribute [rw] template_version_number
|
@@ -7025,7 +7029,7 @@ module Aws::QuickSight
|
|
7025
7029
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
7026
7030
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
7027
7031
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
7028
|
-
# any
|
7032
|
+
# any QuickSight-supported Amazon Web Services Region.
|
7029
7033
|
#
|
7030
7034
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
7031
7035
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -7723,6 +7727,21 @@ module Aws::QuickSight
|
|
7723
7727
|
include Aws::Structure
|
7724
7728
|
end
|
7725
7729
|
|
7730
|
+
# The parameters that are required to connect to a custom connection
|
7731
|
+
# data source.
|
7732
|
+
#
|
7733
|
+
# @!attribute [rw] connection_type
|
7734
|
+
# The type of custom connector.
|
7735
|
+
# @return [String]
|
7736
|
+
#
|
7737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomConnectionParameters AWS API Documentation
|
7738
|
+
#
|
7739
|
+
class CustomConnectionParameters < Struct.new(
|
7740
|
+
:connection_type)
|
7741
|
+
SENSITIVE = []
|
7742
|
+
include Aws::Structure
|
7743
|
+
end
|
7744
|
+
|
7726
7745
|
# The configuration of a `CustomContentVisual`.
|
7727
7746
|
#
|
7728
7747
|
# @!attribute [rw] content_url
|
@@ -8043,8 +8062,8 @@ module Aws::QuickSight
|
|
8043
8062
|
include Aws::Structure
|
8044
8063
|
end
|
8045
8064
|
|
8046
|
-
# The customer managed key that is registered to your
|
8047
|
-
#
|
8065
|
+
# The customer managed key that is registered to your QuickSight account
|
8066
|
+
# is unavailable.
|
8048
8067
|
#
|
8049
8068
|
# @!attribute [rw] message
|
8050
8069
|
# @return [String]
|
@@ -8183,13 +8202,21 @@ module Aws::QuickSight
|
|
8183
8202
|
# @return [Types::DataPointTooltipOption]
|
8184
8203
|
#
|
8185
8204
|
# @!attribute [rw] data_qa_enabled_option
|
8186
|
-
# Adds Q&A capabilities to an
|
8187
|
-
#
|
8188
|
-
#
|
8189
|
-
#
|
8190
|
-
#
|
8205
|
+
# Adds Q&A capabilities to an QuickSight dashboard. If no topic is
|
8206
|
+
# linked, Dashboard Q&A uses the data values that are rendered on
|
8207
|
+
# the dashboard. End users can use Dashboard Q&A to ask for
|
8208
|
+
# different slices of the data that they see on the dashboard. If a
|
8209
|
+
# topic is linked, Topic Q&A is used.
|
8191
8210
|
# @return [Types::DataQAEnabledOption]
|
8192
8211
|
#
|
8212
|
+
# @!attribute [rw] executive_summary_option
|
8213
|
+
# Executive summary option.
|
8214
|
+
# @return [Types::ExecutiveSummaryOption]
|
8215
|
+
#
|
8216
|
+
# @!attribute [rw] data_stories_sharing_option
|
8217
|
+
# Data stories sharing option.
|
8218
|
+
# @return [Types::DataStoriesSharingOption]
|
8219
|
+
#
|
8193
8220
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardPublishOptions AWS API Documentation
|
8194
8221
|
#
|
8195
8222
|
class DashboardPublishOptions < Struct.new(
|
@@ -8204,7 +8231,9 @@ module Aws::QuickSight
|
|
8204
8231
|
:data_point_drill_up_down_option,
|
8205
8232
|
:data_point_menu_label_option,
|
8206
8233
|
:data_point_tooltip_option,
|
8207
|
-
:data_qa_enabled_option
|
8234
|
+
:data_qa_enabled_option,
|
8235
|
+
:executive_summary_option,
|
8236
|
+
:data_stories_sharing_option)
|
8208
8237
|
SENSITIVE = []
|
8209
8238
|
include Aws::Structure
|
8210
8239
|
end
|
@@ -8544,28 +8573,28 @@ module Aws::QuickSight
|
|
8544
8573
|
#
|
8545
8574
|
# The `DashboardId`, `SheetId`, and `VisualId` can be found in the `IDs
|
8546
8575
|
# for developers` section of the `Embed visual` pane of the visual's
|
8547
|
-
# on-visual menu of the
|
8576
|
+
# on-visual menu of the QuickSight console. You can also get the
|
8548
8577
|
# `DashboardId` with a `ListDashboards` API operation.
|
8549
8578
|
#
|
8550
8579
|
# @!attribute [rw] dashboard_id
|
8551
8580
|
# The ID of the dashboard that has the visual that you want to embed.
|
8552
8581
|
# The `DashboardId` can be found in the `IDs for developers` section
|
8553
8582
|
# of the `Embed visual` pane of the visual's on-visual menu of the
|
8554
|
-
#
|
8583
|
+
# QuickSight console. You can also get the `DashboardId` with a
|
8555
8584
|
# `ListDashboards` API operation.
|
8556
8585
|
# @return [String]
|
8557
8586
|
#
|
8558
8587
|
# @!attribute [rw] sheet_id
|
8559
8588
|
# The ID of the sheet that the has visual that you want to embed. The
|
8560
8589
|
# `SheetId` can be found in the `IDs for developers` section of the
|
8561
|
-
# `Embed visual` pane of the visual's on-visual menu of the
|
8590
|
+
# `Embed visual` pane of the visual's on-visual menu of the
|
8562
8591
|
# QuickSight console.
|
8563
8592
|
# @return [String]
|
8564
8593
|
#
|
8565
8594
|
# @!attribute [rw] visual_id
|
8566
8595
|
# The ID of the visual that you want to embed. The `VisualID` can be
|
8567
8596
|
# found in the `IDs for developers` section of the `Embed visual` pane
|
8568
|
-
# of the visual's on-visual menu of the
|
8597
|
+
# of the visual's on-visual menu of the QuickSight console.
|
8569
8598
|
# @return [String]
|
8570
8599
|
#
|
8571
8600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVisualId AWS API Documentation
|
@@ -9045,12 +9074,10 @@ module Aws::QuickSight
|
|
9045
9074
|
include Aws::Structure
|
9046
9075
|
end
|
9047
9076
|
|
9048
|
-
# The generative Q&A settings of an embedded
|
9049
|
-
# console.
|
9077
|
+
# The generative Q&A settings of an embedded QuickSight console.
|
9050
9078
|
#
|
9051
9079
|
# @!attribute [rw] enabled
|
9052
|
-
# The generative Q&A settings of an embedded
|
9053
|
-
# console.
|
9080
|
+
# The generative Q&A settings of an embedded QuickSight console.
|
9054
9081
|
# @return [Boolean]
|
9055
9082
|
#
|
9056
9083
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataQnAConfigurations AWS API Documentation
|
@@ -9477,13 +9504,13 @@ module Aws::QuickSight
|
|
9477
9504
|
#
|
9478
9505
|
# @!attribute [rw] vpc_connection_properties
|
9479
9506
|
# The VPC connection information. You need to use this parameter only
|
9480
|
-
# when you want
|
9481
|
-
#
|
9507
|
+
# when you want QuickSight to use a VPC connection when connecting to
|
9508
|
+
# your underlying source.
|
9482
9509
|
# @return [Types::VpcConnectionProperties]
|
9483
9510
|
#
|
9484
9511
|
# @!attribute [rw] ssl_properties
|
9485
|
-
# Secure Socket Layer (SSL) properties that apply when
|
9486
|
-
#
|
9512
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
9513
|
+
# connects to your underlying source.
|
9487
9514
|
# @return [Types::SslProperties]
|
9488
9515
|
#
|
9489
9516
|
# @!attribute [rw] error_info
|
@@ -9679,6 +9706,10 @@ module Aws::QuickSight
|
|
9679
9706
|
# The parameters for Impala.
|
9680
9707
|
# @return [Types::ImpalaParameters]
|
9681
9708
|
#
|
9709
|
+
# @!attribute [rw] custom_connection_parameters
|
9710
|
+
# The parameters for custom connectors.
|
9711
|
+
# @return [Types::CustomConnectionParameters]
|
9712
|
+
#
|
9682
9713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
9683
9714
|
#
|
9684
9715
|
class DataSourceParameters < Struct.new(
|
@@ -9708,7 +9739,8 @@ module Aws::QuickSight
|
|
9708
9739
|
:starburst_parameters,
|
9709
9740
|
:trino_parameters,
|
9710
9741
|
:big_query_parameters,
|
9711
|
-
:impala_parameters
|
9742
|
+
:impala_parameters,
|
9743
|
+
:custom_connection_parameters)
|
9712
9744
|
SENSITIVE = []
|
9713
9745
|
include Aws::Structure
|
9714
9746
|
end
|
@@ -9816,10 +9848,10 @@ module Aws::QuickSight
|
|
9816
9848
|
include Aws::Structure
|
9817
9849
|
end
|
9818
9850
|
|
9819
|
-
# The data story settings of an embedded
|
9851
|
+
# The data story settings of an embedded QuickSight console.
|
9820
9852
|
#
|
9821
9853
|
# @!attribute [rw] enabled
|
9822
|
-
# The data story settings of an embedded
|
9854
|
+
# The data story settings of an embedded QuickSight console.
|
9823
9855
|
# @return [Boolean]
|
9824
9856
|
#
|
9825
9857
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataStoriesConfigurations AWS API Documentation
|
@@ -9830,6 +9862,20 @@ module Aws::QuickSight
|
|
9830
9862
|
include Aws::Structure
|
9831
9863
|
end
|
9832
9864
|
|
9865
|
+
# Executive summary option.
|
9866
|
+
#
|
9867
|
+
# @!attribute [rw] availability_status
|
9868
|
+
# Availability status.
|
9869
|
+
# @return [String]
|
9870
|
+
#
|
9871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataStoriesSharingOption AWS API Documentation
|
9872
|
+
#
|
9873
|
+
class DataStoriesSharingOption < Struct.new(
|
9874
|
+
:availability_status)
|
9875
|
+
SENSITIVE = []
|
9876
|
+
include Aws::Structure
|
9877
|
+
end
|
9878
|
+
|
9833
9879
|
# The parameters that are required to connect to a Databricks data
|
9834
9880
|
# source.
|
9835
9881
|
#
|
@@ -10830,15 +10876,44 @@ module Aws::QuickSight
|
|
10830
10876
|
include Aws::Structure
|
10831
10877
|
end
|
10832
10878
|
|
10879
|
+
# @!attribute [rw] aws_account_id
|
10880
|
+
# The ID of the Amazon Web Services account from which you want to
|
10881
|
+
# unapply the custom permissions profile.
|
10882
|
+
# @return [String]
|
10883
|
+
#
|
10884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomPermissionRequest AWS API Documentation
|
10885
|
+
#
|
10886
|
+
class DeleteAccountCustomPermissionRequest < Struct.new(
|
10887
|
+
:aws_account_id)
|
10888
|
+
SENSITIVE = []
|
10889
|
+
include Aws::Structure
|
10890
|
+
end
|
10891
|
+
|
10892
|
+
# @!attribute [rw] request_id
|
10893
|
+
# The Amazon Web Services request ID for this operation.
|
10894
|
+
# @return [String]
|
10895
|
+
#
|
10896
|
+
# @!attribute [rw] status
|
10897
|
+
# The HTTP status of the request.
|
10898
|
+
# @return [Integer]
|
10899
|
+
#
|
10900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomPermissionResponse AWS API Documentation
|
10901
|
+
#
|
10902
|
+
class DeleteAccountCustomPermissionResponse < Struct.new(
|
10903
|
+
:request_id,
|
10904
|
+
:status)
|
10905
|
+
SENSITIVE = []
|
10906
|
+
include Aws::Structure
|
10907
|
+
end
|
10908
|
+
|
10833
10909
|
# @!attribute [rw] aws_account_id
|
10834
10910
|
# The ID for the Amazon Web Services account that you want to delete
|
10835
|
-
#
|
10836
|
-
# Region.
|
10911
|
+
# QuickSight customizations from in this Amazon Web Services Region.
|
10837
10912
|
# @return [String]
|
10838
10913
|
#
|
10839
10914
|
# @!attribute [rw] namespace
|
10840
|
-
# The
|
10841
|
-
#
|
10915
|
+
# The QuickSight namespace that you're deleting the customizations
|
10916
|
+
# from.
|
10842
10917
|
# @return [String]
|
10843
10918
|
#
|
10844
10919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
@@ -10907,10 +10982,10 @@ module Aws::QuickSight
|
|
10907
10982
|
# @return [String]
|
10908
10983
|
#
|
10909
10984
|
# @!attribute [rw] recovery_window_in_days
|
10910
|
-
# A value that specifies the number of days that
|
10911
|
-
#
|
10912
|
-
#
|
10913
|
-
#
|
10985
|
+
# A value that specifies the number of days that QuickSight waits
|
10986
|
+
# before it deletes the analysis. You can't use this parameter with
|
10987
|
+
# the `ForceDeleteWithoutRecovery` option in the same API call. The
|
10988
|
+
# default value is 30.
|
10914
10989
|
# @return [Integer]
|
10915
10990
|
#
|
10916
10991
|
# @!attribute [rw] force_delete_without_recovery
|
@@ -10993,7 +11068,7 @@ module Aws::QuickSight
|
|
10993
11068
|
# @return [String]
|
10994
11069
|
#
|
10995
11070
|
# @!attribute [rw] brand_id
|
10996
|
-
# The ID of the
|
11071
|
+
# The ID of the QuickSight brand.
|
10997
11072
|
# @return [String]
|
10998
11073
|
#
|
10999
11074
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteBrandRequest AWS API Documentation
|
@@ -11236,14 +11311,14 @@ module Aws::QuickSight
|
|
11236
11311
|
end
|
11237
11312
|
|
11238
11313
|
# @!attribute [rw] aws_account_id
|
11239
|
-
# The ID of the
|
11240
|
-
#
|
11314
|
+
# The ID of the QuickSight account that you want to disconnect from a
|
11315
|
+
# Amazon Q Business application.
|
11241
11316
|
# @return [String]
|
11242
11317
|
#
|
11243
11318
|
# @!attribute [rw] namespace
|
11244
|
-
# The
|
11245
|
-
#
|
11246
|
-
#
|
11319
|
+
# The QuickSight namespace that you want to delete a linked Amazon Q
|
11320
|
+
# Business application from. If this field is left blank, the Amazon Q
|
11321
|
+
# Business application is deleted from the default namespace.
|
11247
11322
|
# Currently, the default namespace is the only valid value for this
|
11248
11323
|
# parameter.
|
11249
11324
|
# @return [String]
|
@@ -11533,7 +11608,7 @@ module Aws::QuickSight
|
|
11533
11608
|
|
11534
11609
|
# @!attribute [rw] aws_account_id
|
11535
11610
|
# The ID for the Amazon Web Services account that you want to delete
|
11536
|
-
# the
|
11611
|
+
# the QuickSight namespace from.
|
11537
11612
|
# @return [String]
|
11538
11613
|
#
|
11539
11614
|
# @!attribute [rw] namespace
|
@@ -12207,23 +12282,58 @@ module Aws::QuickSight
|
|
12207
12282
|
include Aws::Structure
|
12208
12283
|
end
|
12209
12284
|
|
12285
|
+
# @!attribute [rw] aws_account_id
|
12286
|
+
# The ID of the Amazon Web Services account for which you want to
|
12287
|
+
# describe the applied custom permissions profile.
|
12288
|
+
# @return [String]
|
12289
|
+
#
|
12290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomPermissionRequest AWS API Documentation
|
12291
|
+
#
|
12292
|
+
class DescribeAccountCustomPermissionRequest < Struct.new(
|
12293
|
+
:aws_account_id)
|
12294
|
+
SENSITIVE = []
|
12295
|
+
include Aws::Structure
|
12296
|
+
end
|
12297
|
+
|
12298
|
+
# @!attribute [rw] custom_permissions_name
|
12299
|
+
# The name of the custom permissions profile.
|
12300
|
+
# @return [String]
|
12301
|
+
#
|
12302
|
+
# @!attribute [rw] request_id
|
12303
|
+
# The Amazon Web Services request ID for this operation.
|
12304
|
+
# @return [String]
|
12305
|
+
#
|
12306
|
+
# @!attribute [rw] status
|
12307
|
+
# The HTTP status of the request.
|
12308
|
+
# @return [Integer]
|
12309
|
+
#
|
12310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomPermissionResponse AWS API Documentation
|
12311
|
+
#
|
12312
|
+
class DescribeAccountCustomPermissionResponse < Struct.new(
|
12313
|
+
:custom_permissions_name,
|
12314
|
+
:request_id,
|
12315
|
+
:status)
|
12316
|
+
SENSITIVE = []
|
12317
|
+
include Aws::Structure
|
12318
|
+
end
|
12319
|
+
|
12210
12320
|
# @!attribute [rw] aws_account_id
|
12211
12321
|
# The ID for the Amazon Web Services account that you want to describe
|
12212
|
-
#
|
12322
|
+
# QuickSight customizations for.
|
12213
12323
|
# @return [String]
|
12214
12324
|
#
|
12215
12325
|
# @!attribute [rw] namespace
|
12216
|
-
# The
|
12217
|
-
#
|
12326
|
+
# The QuickSight namespace that you want to describe QuickSight
|
12327
|
+
# customizations for.
|
12218
12328
|
# @return [String]
|
12219
12329
|
#
|
12220
12330
|
# @!attribute [rw] resolved
|
12221
12331
|
# The `Resolved` flag works with the other parameters to determine
|
12222
|
-
# which view of
|
12223
|
-
#
|
12224
|
-
#
|
12225
|
-
#
|
12226
|
-
#
|
12332
|
+
# which view of QuickSight customizations is returned. You can add
|
12333
|
+
# this flag to your command to use the same view that QuickSight uses
|
12334
|
+
# to identify which customizations to apply to the console. Omit this
|
12335
|
+
# flag, or set it to `no-resolved`, to reveal customizations that are
|
12336
|
+
# configured at different levels.
|
12227
12337
|
# @return [Boolean]
|
12228
12338
|
#
|
12229
12339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
@@ -12246,12 +12356,12 @@ module Aws::QuickSight
|
|
12246
12356
|
# @return [String]
|
12247
12357
|
#
|
12248
12358
|
# @!attribute [rw] namespace
|
12249
|
-
# The
|
12359
|
+
# The QuickSight namespace that you're describing.
|
12250
12360
|
# @return [String]
|
12251
12361
|
#
|
12252
12362
|
# @!attribute [rw] account_customization
|
12253
|
-
# The
|
12254
|
-
#
|
12363
|
+
# The QuickSight customizations that exist in the current Amazon Web
|
12364
|
+
# Services Region.
|
12255
12365
|
# @return [Types::AccountCustomization]
|
12256
12366
|
#
|
12257
12367
|
# @!attribute [rw] request_id
|
@@ -12289,17 +12399,17 @@ module Aws::QuickSight
|
|
12289
12399
|
end
|
12290
12400
|
|
12291
12401
|
# @!attribute [rw] account_settings
|
12292
|
-
# The
|
12293
|
-
#
|
12294
|
-
#
|
12295
|
-
#
|
12402
|
+
# The QuickSight settings for this Amazon Web Services account. This
|
12403
|
+
# information includes the edition of Amazon QuickSight that you
|
12404
|
+
# subscribed to (Standard or Enterprise) and the notification email
|
12405
|
+
# for the QuickSight subscription.
|
12296
12406
|
#
|
12297
|
-
# In the QuickSight console, the
|
12298
|
-
#
|
12407
|
+
# In the QuickSight console, the QuickSight subscription is sometimes
|
12408
|
+
# referred to as a QuickSight "account" even though it's
|
12299
12409
|
# technically not an account by itself. Instead, it's a subscription
|
12300
|
-
# to the
|
12301
|
-
#
|
12302
|
-
#
|
12410
|
+
# to the QuickSight service for your Amazon Web Services account. The
|
12411
|
+
# edition that you subscribe to applies to QuickSight in every Amazon
|
12412
|
+
# Web Services Region where you use it.
|
12303
12413
|
# @return [Types::AccountSettings]
|
12304
12414
|
#
|
12305
12415
|
# @!attribute [rw] request_id
|
@@ -12321,8 +12431,8 @@ module Aws::QuickSight
|
|
12321
12431
|
end
|
12322
12432
|
|
12323
12433
|
# @!attribute [rw] aws_account_id
|
12324
|
-
# The Amazon Web Services account ID associated with your
|
12325
|
-
#
|
12434
|
+
# The Amazon Web Services account ID associated with your QuickSight
|
12435
|
+
# account.
|
12326
12436
|
# @return [String]
|
12327
12437
|
#
|
12328
12438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSubscriptionRequest AWS API Documentation
|
@@ -12336,16 +12446,16 @@ module Aws::QuickSight
|
|
12336
12446
|
# @!attribute [rw] account_info
|
12337
12447
|
# A structure that contains the following elements:
|
12338
12448
|
#
|
12339
|
-
# * Your
|
12449
|
+
# * Your QuickSight account name.
|
12340
12450
|
#
|
12341
|
-
# * The edition of
|
12451
|
+
# * The edition of QuickSight that your account is using.
|
12342
12452
|
#
|
12343
|
-
# * The notification email address that is associated with the
|
12453
|
+
# * The notification email address that is associated with the
|
12344
12454
|
# QuickSight account.
|
12345
12455
|
#
|
12346
|
-
# * The authentication type of the
|
12456
|
+
# * The authentication type of the QuickSight account.
|
12347
12457
|
#
|
12348
|
-
# * The status of the
|
12458
|
+
# * The status of the QuickSight account's subscription.
|
12349
12459
|
# @return [Types::AccountInfo]
|
12350
12460
|
#
|
12351
12461
|
# @!attribute [rw] status
|
@@ -12868,7 +12978,7 @@ module Aws::QuickSight
|
|
12868
12978
|
# @return [String]
|
12869
12979
|
#
|
12870
12980
|
# @!attribute [rw] brand_id
|
12871
|
-
# The ID of the
|
12981
|
+
# The ID of the QuickSight brand.
|
12872
12982
|
# @return [String]
|
12873
12983
|
#
|
12874
12984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeBrandPublishedVersionRequest AWS API Documentation
|
@@ -12907,7 +13017,7 @@ module Aws::QuickSight
|
|
12907
13017
|
# @return [String]
|
12908
13018
|
#
|
12909
13019
|
# @!attribute [rw] brand_id
|
12910
|
-
# The ID of the
|
13020
|
+
# The ID of the QuickSight brand.
|
12911
13021
|
# @return [String]
|
12912
13022
|
#
|
12913
13023
|
# @!attribute [rw] version_id
|
@@ -13070,7 +13180,7 @@ module Aws::QuickSight
|
|
13070
13180
|
#
|
13071
13181
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
13072
13182
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
13073
|
-
#
|
13183
|
+
# QuickSight disables the left filter pane on the published
|
13074
13184
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
13075
13185
|
# option is `ENABLED` by default.
|
13076
13186
|
#
|
@@ -13082,6 +13192,16 @@ module Aws::QuickSight
|
|
13082
13192
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
13083
13193
|
# state can be either `COLLAPSED` or `EXPANDED`. This option is
|
13084
13194
|
# `COLLAPSED` by default.
|
13195
|
+
#
|
13196
|
+
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status
|
13197
|
+
# can be either `ENABLED` or `DISABLED`. The option to build an
|
13198
|
+
# executive summary is disabled when this is set to `DISABLED`. This
|
13199
|
+
# option is `ENABLED` by default.
|
13200
|
+
#
|
13201
|
+
# * `AvailabilityStatus` for `DataStoriesSharingOption` - This status
|
13202
|
+
# can be either `ENABLED` or `DISABLED`. The option to share a data
|
13203
|
+
# story is disabled when this is set to `DISABLED`. This option is
|
13204
|
+
# `ENABLED` by default.
|
13085
13205
|
# @return [Types::DashboardPublishOptions]
|
13086
13206
|
#
|
13087
13207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardDefinitionResponse AWS API Documentation
|
@@ -13650,15 +13770,15 @@ module Aws::QuickSight
|
|
13650
13770
|
end
|
13651
13771
|
|
13652
13772
|
# @!attribute [rw] aws_account_id
|
13653
|
-
# The ID of the
|
13654
|
-
#
|
13773
|
+
# The ID of the QuickSight account that is linked to the Amazon Q
|
13774
|
+
# Business application that you want described.
|
13655
13775
|
# @return [String]
|
13656
13776
|
#
|
13657
13777
|
# @!attribute [rw] namespace
|
13658
|
-
# The
|
13659
|
-
#
|
13660
|
-
#
|
13661
|
-
#
|
13778
|
+
# The QuickSight namespace that contains the linked Amazon Q Business
|
13779
|
+
# application. If this field is left blank, the default namespace is
|
13780
|
+
# used. Currently, the default namespace is the only valid value for
|
13781
|
+
# this parameter.
|
13662
13782
|
# @return [String]
|
13663
13783
|
#
|
13664
13784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDefaultQBusinessApplicationRequest AWS API Documentation
|
@@ -13680,7 +13800,7 @@ module Aws::QuickSight
|
|
13680
13800
|
#
|
13681
13801
|
# @!attribute [rw] application_id
|
13682
13802
|
# The ID of the Amazon Q Business application that is linked to the
|
13683
|
-
#
|
13803
|
+
# QuickSight account.
|
13684
13804
|
# @return [String]
|
13685
13805
|
#
|
13686
13806
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDefaultQBusinessApplicationResponse AWS API Documentation
|
@@ -14139,10 +14259,14 @@ module Aws::QuickSight
|
|
14139
14259
|
# @return [String]
|
14140
14260
|
#
|
14141
14261
|
# @!attribute [rw] key_registration
|
14142
|
-
# A list of `RegisteredCustomerManagedKey` objects in a
|
14143
|
-
#
|
14262
|
+
# A list of `RegisteredCustomerManagedKey` objects in a QuickSight
|
14263
|
+
# account.
|
14144
14264
|
# @return [Array<Types::RegisteredCustomerManagedKey>]
|
14145
14265
|
#
|
14266
|
+
# @!attribute [rw] q_data_key
|
14267
|
+
# A list of `QDataKey` objects in a QuickSight account.
|
14268
|
+
# @return [Types::QDataKey]
|
14269
|
+
#
|
14146
14270
|
# @!attribute [rw] request_id
|
14147
14271
|
# The Amazon Web Services request ID for this operation.
|
14148
14272
|
# @return [String]
|
@@ -14156,6 +14280,7 @@ module Aws::QuickSight
|
|
14156
14280
|
class DescribeKeyRegistrationResponse < Struct.new(
|
14157
14281
|
:aws_account_id,
|
14158
14282
|
:key_registration,
|
14283
|
+
:q_data_key,
|
14159
14284
|
:request_id,
|
14160
14285
|
:status)
|
14161
14286
|
SENSITIVE = []
|
@@ -14163,7 +14288,7 @@ module Aws::QuickSight
|
|
14163
14288
|
end
|
14164
14289
|
|
14165
14290
|
# @!attribute [rw] aws_account_id
|
14166
|
-
# The ID for the Amazon Web Services account that contains the
|
14291
|
+
# The ID for the Amazon Web Services account that contains the
|
14167
14292
|
# QuickSight namespace that you want to describe.
|
14168
14293
|
# @return [String]
|
14169
14294
|
#
|
@@ -14243,7 +14368,7 @@ module Aws::QuickSight
|
|
14243
14368
|
end
|
14244
14369
|
|
14245
14370
|
# @!attribute [rw] aws_account_id
|
14246
|
-
# The ID of the Amazon Web Services account that contains the
|
14371
|
+
# The ID of the Amazon Web Services account that contains the
|
14247
14372
|
# QuickSight Q Search configuration that the user wants described.
|
14248
14373
|
# @return [String]
|
14249
14374
|
#
|
@@ -14256,7 +14381,7 @@ module Aws::QuickSight
|
|
14256
14381
|
end
|
14257
14382
|
|
14258
14383
|
# @!attribute [rw] q_search_status
|
14259
|
-
# The status of
|
14384
|
+
# The status of QuickSight Q Search configuration.
|
14260
14385
|
# @return [String]
|
14261
14386
|
#
|
14262
14387
|
# @!attribute [rw] request_id
|
@@ -15241,7 +15366,7 @@ module Aws::QuickSight
|
|
15241
15366
|
#
|
15242
15367
|
# @!attribute [rw] label_visibility
|
15243
15368
|
# Determines the visibility of the label in a donut chart. In the
|
15244
|
-
#
|
15369
|
+
# QuickSight console, this option is called `'Show total'`.
|
15245
15370
|
# @return [String]
|
15246
15371
|
#
|
15247
15372
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DonutCenterOptions AWS API Documentation
|
@@ -15362,8 +15487,8 @@ module Aws::QuickSight
|
|
15362
15487
|
# An empty visual.
|
15363
15488
|
#
|
15364
15489
|
# Empty visuals are used in layouts but have not been configured to show
|
15365
|
-
# any data. A new visual created in the
|
15366
|
-
#
|
15490
|
+
# any data. A new visual created in the QuickSight console is considered
|
15491
|
+
# an `EmptyVisual` until a visual type is selected.
|
15367
15492
|
#
|
15368
15493
|
# @!attribute [rw] visual_id
|
15369
15494
|
# The unique identifier of a visual. This identifier must be unique
|
@@ -15473,12 +15598,12 @@ module Aws::QuickSight
|
|
15473
15598
|
include Aws::Structure
|
15474
15599
|
end
|
15475
15600
|
|
15476
|
-
# The executive summary settings of an embedded
|
15477
|
-
#
|
15601
|
+
# The executive summary settings of an embedded QuickSight console or
|
15602
|
+
# dashboard.
|
15478
15603
|
#
|
15479
15604
|
# @!attribute [rw] enabled
|
15480
|
-
# The executive summary settings of an embedded
|
15481
|
-
#
|
15605
|
+
# The executive summary settings of an embedded QuickSight console or
|
15606
|
+
# dashboard.
|
15482
15607
|
# @return [Boolean]
|
15483
15608
|
#
|
15484
15609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ExecutiveSummaryConfigurations AWS API Documentation
|
@@ -15489,6 +15614,20 @@ module Aws::QuickSight
|
|
15489
15614
|
include Aws::Structure
|
15490
15615
|
end
|
15491
15616
|
|
15617
|
+
# Data stories sharing option.
|
15618
|
+
#
|
15619
|
+
# @!attribute [rw] availability_status
|
15620
|
+
# Availability status.
|
15621
|
+
# @return [String]
|
15622
|
+
#
|
15623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ExecutiveSummaryOption AWS API Documentation
|
15624
|
+
#
|
15625
|
+
class ExecutiveSummaryOption < Struct.new(
|
15626
|
+
:availability_status)
|
15627
|
+
SENSITIVE = []
|
15628
|
+
include Aws::Structure
|
15629
|
+
end
|
15630
|
+
|
15492
15631
|
# The option that determines the hierarchy of the fields that are built
|
15493
15632
|
# within a visual's field wells. These fields can't be duplicated to
|
15494
15633
|
# other visuals.
|
@@ -15559,8 +15698,8 @@ module Aws::QuickSight
|
|
15559
15698
|
include Aws::Structure
|
15560
15699
|
end
|
15561
15700
|
|
15562
|
-
# An entry that appears when a `KeyRegistration` update to
|
15563
|
-
#
|
15701
|
+
# An entry that appears when a `KeyRegistration` update to QuickSight
|
15702
|
+
# fails.
|
15564
15703
|
#
|
15565
15704
|
# @!attribute [rw] key_arn
|
15566
15705
|
# The ARN of the KMS key that failed to update.
|
@@ -15581,7 +15720,7 @@ module Aws::QuickSight
|
|
15581
15720
|
# the error was caused by user error. If the value of this property is
|
15582
15721
|
# `False`, the error occurred on the backend. If your job continues
|
15583
15722
|
# fail and with a `False` `SenderFault` value, contact Amazon Web
|
15584
|
-
#
|
15723
|
+
# Services Support.
|
15585
15724
|
# @return [Boolean]
|
15586
15725
|
#
|
15587
15726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FailedKeyRegistrationEntry AWS API Documentation
|
@@ -16663,7 +16802,7 @@ module Aws::QuickSight
|
|
16663
16802
|
include Aws::Structure
|
16664
16803
|
end
|
16665
16804
|
|
16666
|
-
# A folder in
|
16805
|
+
# A folder in QuickSight.
|
16667
16806
|
#
|
16668
16807
|
# @!attribute [rw] folder_id
|
16669
16808
|
# The ID of the folder.
|
@@ -16712,8 +16851,8 @@ module Aws::QuickSight
|
|
16712
16851
|
include Aws::Structure
|
16713
16852
|
end
|
16714
16853
|
|
16715
|
-
# An asset in a
|
16716
|
-
#
|
16854
|
+
# An asset in a QuickSight folder, such as a dashboard, analysis, or
|
16855
|
+
# dataset.
|
16717
16856
|
#
|
16718
16857
|
# @!attribute [rw] member_id
|
16719
16858
|
# The ID of an asset in the folder.
|
@@ -16732,7 +16871,7 @@ module Aws::QuickSight
|
|
16732
16871
|
include Aws::Structure
|
16733
16872
|
end
|
16734
16873
|
|
16735
|
-
# A filter to use to search an
|
16874
|
+
# A filter to use to search an QuickSight folder.
|
16736
16875
|
#
|
16737
16876
|
# @!attribute [rw] operator
|
16738
16877
|
# The comparison operator that you want to use as a filter, for
|
@@ -16809,7 +16948,7 @@ module Aws::QuickSight
|
|
16809
16948
|
include Aws::Structure
|
16810
16949
|
end
|
16811
16950
|
|
16812
|
-
# A summary of information about an existing
|
16951
|
+
# A summary of information about an existing QuickSight folder.
|
16813
16952
|
#
|
16814
16953
|
# @!attribute [rw] arn
|
16815
16954
|
# The Amazon Resource Name (ARN) of the folder.
|
@@ -17708,9 +17847,9 @@ module Aws::QuickSight
|
|
17708
17847
|
# @return [Integer]
|
17709
17848
|
#
|
17710
17849
|
# @!attribute [rw] namespace
|
17711
|
-
# The
|
17712
|
-
#
|
17713
|
-
#
|
17850
|
+
# The QuickSight namespace that the anonymous user virtually belongs
|
17851
|
+
# to. If you are not using an Amazon QuickSight custom namespace, set
|
17852
|
+
# this to `default`.
|
17714
17853
|
# @return [String]
|
17715
17854
|
#
|
17716
17855
|
# @!attribute [rw] session_tags
|
@@ -17729,9 +17868,8 @@ module Aws::QuickSight
|
|
17729
17868
|
# @return [Array<Types::SessionTag>]
|
17730
17869
|
#
|
17731
17870
|
# @!attribute [rw] authorized_resource_arns
|
17732
|
-
# The Amazon Resource Names (ARNs) for the
|
17733
|
-
#
|
17734
|
-
# session.
|
17871
|
+
# The Amazon Resource Names (ARNs) for the QuickSight resources that
|
17872
|
+
# the user is authorized to access during the lifetime of the session.
|
17735
17873
|
#
|
17736
17874
|
# If you choose `Dashboard` embedding experience, pass the list of
|
17737
17875
|
# dashboard ARNs in the account that you want the user to be able to
|
@@ -17751,9 +17889,9 @@ module Aws::QuickSight
|
|
17751
17889
|
# The domains that you want to add to the allow list for access to the
|
17752
17890
|
# generated URL that is then embedded. This optional parameter
|
17753
17891
|
# overrides the static domains that are configured in the Manage
|
17754
|
-
# QuickSight menu in the
|
17755
|
-
#
|
17756
|
-
#
|
17892
|
+
# QuickSight menu in the QuickSight console. Instead, it allows only
|
17893
|
+
# the domains that you include in this parameter. You can list up to
|
17894
|
+
# three domains or subdomains in each API call.
|
17757
17895
|
#
|
17758
17896
|
# To include all subdomains under a specific domain to the allow list,
|
17759
17897
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
@@ -17818,18 +17956,18 @@ module Aws::QuickSight
|
|
17818
17956
|
#
|
17819
17957
|
# @!attribute [rw] experience_configuration
|
17820
17958
|
# The experience that you want to embed. For registered users, you can
|
17821
|
-
# embed
|
17822
|
-
#
|
17823
|
-
#
|
17959
|
+
# embed QuickSight dashboards, QuickSight visuals, the QuickSight Q
|
17960
|
+
# search bar, the QuickSight Generative Q&A experience, or the
|
17961
|
+
# entire QuickSight console.
|
17824
17962
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
17825
17963
|
#
|
17826
17964
|
# @!attribute [rw] allowed_domains
|
17827
17965
|
# The domains that you want to add to the allow list for access to the
|
17828
17966
|
# generated URL that is then embedded. This optional parameter
|
17829
17967
|
# overrides the static domains that are configured in the Manage
|
17830
|
-
# QuickSight menu in the
|
17831
|
-
#
|
17832
|
-
#
|
17968
|
+
# QuickSight menu in the QuickSight console. Instead, it allows only
|
17969
|
+
# the domains that you include in this parameter. You can list up to
|
17970
|
+
# three domains or subdomains in each API call.
|
17833
17971
|
#
|
17834
17972
|
# To include all subdomains under a specific domain to the allow list,
|
17835
17973
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
@@ -17849,8 +17987,8 @@ module Aws::QuickSight
|
|
17849
17987
|
end
|
17850
17988
|
|
17851
17989
|
# @!attribute [rw] embed_url
|
17852
|
-
# The embed URL for the
|
17853
|
-
#
|
17990
|
+
# The embed URL for the QuickSight dashboard, visual, Q search bar,
|
17991
|
+
# Generative Q&A experience, or console.
|
17854
17992
|
# @return [String]
|
17855
17993
|
#
|
17856
17994
|
# @!attribute [rw] status
|
@@ -17881,8 +18019,7 @@ module Aws::QuickSight
|
|
17881
18019
|
#
|
17882
18020
|
# @!attribute [rw] experience_configuration
|
17883
18021
|
# The type of experience you want to embed. For registered users, you
|
17884
|
-
# can embed
|
17885
|
-
# console.
|
18022
|
+
# can embed QuickSight dashboards or the QuickSight console.
|
17886
18023
|
#
|
17887
18024
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
17888
18025
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more
|
@@ -17977,12 +18114,12 @@ module Aws::QuickSight
|
|
17977
18114
|
include Aws::Structure
|
17978
18115
|
end
|
17979
18116
|
|
17980
|
-
# The generative BI authoring settings of an embedded
|
18117
|
+
# The generative BI authoring settings of an embedded QuickSight
|
17981
18118
|
# console.
|
17982
18119
|
#
|
17983
18120
|
# @!attribute [rw] enabled
|
17984
|
-
# The generative BI authoring settings of an embedded
|
17985
|
-
#
|
18121
|
+
# The generative BI authoring settings of an embedded QuickSight
|
18122
|
+
# console.
|
17986
18123
|
# @return [Boolean]
|
17987
18124
|
#
|
17988
18125
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerativeAuthoringConfigurations AWS API Documentation
|
@@ -18916,11 +19053,11 @@ module Aws::QuickSight
|
|
18916
19053
|
# Adds persistence of state for the user session in an embedded
|
18917
19054
|
# dashboard. Persistence applies to the sheet and the parameter
|
18918
19055
|
# settings. These are control settings that the dashboard subscriber
|
18919
|
-
# (
|
18920
|
-
#
|
18921
|
-
#
|
18922
|
-
#
|
18923
|
-
#
|
19056
|
+
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
19057
|
+
# set to `TRUE`, the settings are the same when the subscriber reopens
|
19058
|
+
# the same dashboard URL. The state is stored in QuickSight, not in a
|
19059
|
+
# browser cookie. If this is set to FALSE, the state of the user
|
19060
|
+
# session is not persisted. The default is `FALSE`.
|
18924
19061
|
# @return [Boolean]
|
18925
19062
|
#
|
18926
19063
|
# @!attribute [rw] user_arn
|
@@ -18942,16 +19079,16 @@ module Aws::QuickSight
|
|
18942
19079
|
# @return [String]
|
18943
19080
|
#
|
18944
19081
|
# @!attribute [rw] namespace
|
18945
|
-
# The
|
18946
|
-
#
|
18947
|
-
#
|
19082
|
+
# The QuickSight namespace that contains the dashboard IDs in this
|
19083
|
+
# request. If you're not using a custom namespace, set `Namespace =
|
19084
|
+
# default`.
|
18948
19085
|
# @return [String]
|
18949
19086
|
#
|
18950
19087
|
# @!attribute [rw] additional_dashboard_ids
|
18951
19088
|
# A list of one or more dashboard IDs that you want anonymous users to
|
18952
19089
|
# have tempporary access to. Currently, the `IdentityType` parameter
|
18953
19090
|
# must be set to `ANONYMOUS` because other identity types authenticate
|
18954
|
-
# as
|
19091
|
+
# as QuickSight or IAM users. For example, if you set
|
18955
19092
|
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
18956
19093
|
# identity-type ANONYMOUS`", the session can access all three
|
18957
19094
|
# dashboards.
|
@@ -19004,7 +19141,7 @@ module Aws::QuickSight
|
|
19004
19141
|
|
19005
19142
|
# @!attribute [rw] aws_account_id
|
19006
19143
|
# The ID for the Amazon Web Services account associated with your
|
19007
|
-
#
|
19144
|
+
# QuickSight subscription.
|
19008
19145
|
# @return [String]
|
19009
19146
|
#
|
19010
19147
|
# @!attribute [rw] entry_point
|
@@ -19020,10 +19157,10 @@ module Aws::QuickSight
|
|
19020
19157
|
# * `/start/favorites`
|
19021
19158
|
#
|
19022
19159
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
19023
|
-
# key from the
|
19160
|
+
# key from the QuickSight console URL of the dashboard
|
19024
19161
|
#
|
19025
19162
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
19026
|
-
# from the
|
19163
|
+
# from the QuickSight console URL of the analysis
|
19027
19164
|
# @return [String]
|
19028
19165
|
#
|
19029
19166
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -19062,10 +19199,10 @@ module Aws::QuickSight
|
|
19062
19199
|
|
19063
19200
|
# @!attribute [rw] embed_url
|
19064
19201
|
# A single-use URL that you can put into your server-side web page to
|
19065
|
-
# embed your
|
19066
|
-
#
|
19067
|
-
#
|
19068
|
-
#
|
19202
|
+
# embed your QuickSight session. This URL is valid for 5 minutes. The
|
19203
|
+
# API operation provides the URL with an `auth_code` value that
|
19204
|
+
# enables one (and only one) sign-on to a user session that is valid
|
19205
|
+
# for 10 hours.
|
19069
19206
|
# @return [String]
|
19070
19207
|
#
|
19071
19208
|
# @!attribute [rw] status
|
@@ -19228,11 +19365,11 @@ module Aws::QuickSight
|
|
19228
19365
|
# resized.
|
19229
19366
|
#
|
19230
19367
|
# * `FIXED`: A fixed width will be used when optimizing the layout. In
|
19231
|
-
# the
|
19368
|
+
# the QuickSight console, this option is called `Classic`.
|
19232
19369
|
#
|
19233
19370
|
# * `RESPONSIVE`: The width of the canvas will be responsive and
|
19234
|
-
# optimized to the view port. In the
|
19235
|
-
#
|
19371
|
+
# optimized to the view port. In the QuickSight console, this option
|
19372
|
+
# is called `Tiled`.
|
19236
19373
|
# @return [String]
|
19237
19374
|
#
|
19238
19375
|
# @!attribute [rw] optimized_view_port_width
|
@@ -20646,8 +20783,8 @@ module Aws::QuickSight
|
|
20646
20783
|
#
|
20647
20784
|
# @!attribute [rw] unique_key
|
20648
20785
|
# A value that indicates that a row in a table is uniquely identified
|
20649
|
-
# by the columns in a join key. This is used by
|
20650
|
-
#
|
20786
|
+
# by the columns in a join key. This is used by QuickSight to optimize
|
20787
|
+
# query performance.
|
20651
20788
|
# @return [Boolean]
|
20652
20789
|
#
|
20653
20790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
@@ -22663,8 +22800,8 @@ module Aws::QuickSight
|
|
22663
22800
|
end
|
22664
22801
|
|
22665
22802
|
# @!attribute [rw] services
|
22666
|
-
# A list of services and their authorized targets that the
|
22667
|
-
#
|
22803
|
+
# A list of services and their authorized targets that the QuickSight
|
22804
|
+
# IAM Identity Center application can access.
|
22668
22805
|
# @return [Array<Types::AuthorizedTargetsByService>]
|
22669
22806
|
#
|
22670
22807
|
# @!attribute [rw] next_token
|
@@ -22748,7 +22885,7 @@ module Aws::QuickSight
|
|
22748
22885
|
end
|
22749
22886
|
|
22750
22887
|
# @!attribute [rw] aws_account_id
|
22751
|
-
# The ID for the Amazon Web Services account that contains the
|
22888
|
+
# The ID for the Amazon Web Services account that contains the
|
22752
22889
|
# QuickSight namespaces that you want to list.
|
22753
22890
|
# @return [String]
|
22754
22891
|
#
|
@@ -23255,7 +23392,7 @@ module Aws::QuickSight
|
|
23255
23392
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
23256
23393
|
# QuickSight.
|
23257
23394
|
#
|
23258
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
23395
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
23259
23396
|
# QuickSight.
|
23260
23397
|
# @return [String]
|
23261
23398
|
#
|
@@ -25405,8 +25542,7 @@ module Aws::QuickSight
|
|
25405
25542
|
include Aws::Structure
|
25406
25543
|
end
|
25407
25544
|
|
25408
|
-
# A list of
|
25409
|
-
# values.
|
25545
|
+
# A list of QuickSight parameters and the list's override values.
|
25410
25546
|
#
|
25411
25547
|
# @!attribute [rw] string_parameters
|
25412
25548
|
# The parameters that have a data type of string.
|
@@ -26439,7 +26575,7 @@ module Aws::QuickSight
|
|
26439
26575
|
end
|
26440
26576
|
|
26441
26577
|
# A flexible visualization type that allows engineers to create new
|
26442
|
-
# custom charts in
|
26578
|
+
# custom charts in QuickSight.
|
26443
26579
|
#
|
26444
26580
|
# @!attribute [rw] visual_id
|
26445
26581
|
# The ID of the visual that you want to use.
|
@@ -26865,6 +27001,26 @@ module Aws::QuickSight
|
|
26865
27001
|
include Aws::Structure
|
26866
27002
|
end
|
26867
27003
|
|
27004
|
+
# A structure that contains information about the `QDataKey`.
|
27005
|
+
#
|
27006
|
+
# @!attribute [rw] q_data_key_arn
|
27007
|
+
# The ARN of the KMS key that is registered to a QuickSight account
|
27008
|
+
# for encryption and decryption use as a `QDataKey`.
|
27009
|
+
# @return [String]
|
27010
|
+
#
|
27011
|
+
# @!attribute [rw] q_data_key_type
|
27012
|
+
# The type of `QDataKey`.
|
27013
|
+
# @return [String]
|
27014
|
+
#
|
27015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/QDataKey AWS API Documentation
|
27016
|
+
#
|
27017
|
+
class QDataKey < Struct.new(
|
27018
|
+
:q_data_key_arn,
|
27019
|
+
:q_data_key_type)
|
27020
|
+
SENSITIVE = []
|
27021
|
+
include Aws::Structure
|
27022
|
+
end
|
27023
|
+
|
26868
27024
|
# A structure that describes the query execution options.
|
26869
27025
|
#
|
26870
27026
|
# @!attribute [rw] query_execution_mode
|
@@ -27205,11 +27361,11 @@ module Aws::QuickSight
|
|
27205
27361
|
include Aws::Structure
|
27206
27362
|
end
|
27207
27363
|
|
27208
|
-
# The recent snapshots configuration for an embedded
|
27364
|
+
# The recent snapshots configuration for an embedded QuickSight
|
27209
27365
|
# dashboard.
|
27210
27366
|
#
|
27211
27367
|
# @!attribute [rw] enabled
|
27212
|
-
# The recent snapshots configuration for an embedded
|
27368
|
+
# The recent snapshots configuration for an embedded QuickSight
|
27213
27369
|
# dashboard.
|
27214
27370
|
# @return [Boolean]
|
27215
27371
|
#
|
@@ -27221,9 +27377,9 @@ module Aws::QuickSight
|
|
27221
27377
|
include Aws::Structure
|
27222
27378
|
end
|
27223
27379
|
|
27224
|
-
# A structure that grants
|
27225
|
-
#
|
27226
|
-
#
|
27380
|
+
# A structure that grants QuickSight access to your cluster and make a
|
27381
|
+
# call to the `redshift:GetClusterCredentials` API. For more information
|
27382
|
+
# on the `redshift:GetClusterCredentials` API, see [
|
27227
27383
|
# `GetClusterCredentials` ][1].
|
27228
27384
|
#
|
27229
27385
|
#
|
@@ -27231,28 +27387,28 @@ module Aws::QuickSight
|
|
27231
27387
|
# [1]: https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html
|
27232
27388
|
#
|
27233
27389
|
# @!attribute [rw] role_arn
|
27234
|
-
# Use the `RoleArn` structure to allow
|
27390
|
+
# Use the `RoleArn` structure to allow QuickSight to call
|
27235
27391
|
# `redshift:GetClusterCredentials` on your cluster. The calling
|
27236
|
-
# principal must have `iam:PassRole` access to pass the role to
|
27237
|
-
# QuickSight. The role's trust policy must allow the
|
27238
|
-
#
|
27392
|
+
# principal must have `iam:PassRole` access to pass the role to
|
27393
|
+
# QuickSight. The role's trust policy must allow the QuickSight
|
27394
|
+
# service principal to assume the role.
|
27239
27395
|
# @return [String]
|
27240
27396
|
#
|
27241
27397
|
# @!attribute [rw] database_user
|
27242
27398
|
# The user whose permissions and group memberships will be used by
|
27243
|
-
#
|
27244
|
-
#
|
27245
|
-
#
|
27399
|
+
# QuickSight to access the cluster. If this user already exists in
|
27400
|
+
# your database, QuickSight is granted the same permissions that the
|
27401
|
+
# user has. If the user doesn't exist, set the value of
|
27246
27402
|
# `AutoCreateDatabaseUser` to `True` to create a new user with PUBLIC
|
27247
27403
|
# permissions.
|
27248
27404
|
# @return [String]
|
27249
27405
|
#
|
27250
27406
|
# @!attribute [rw] database_groups
|
27251
|
-
# A list of groups whose permissions will be granted to
|
27252
|
-
#
|
27253
|
-
#
|
27254
|
-
#
|
27255
|
-
# `
|
27407
|
+
# A list of groups whose permissions will be granted to QuickSight to
|
27408
|
+
# access the cluster. These permissions are combined with the
|
27409
|
+
# permissions granted to QuickSight by the `DatabaseUser`. If you
|
27410
|
+
# choose to include this parameter, the `RoleArn` must grant access to
|
27411
|
+
# `redshift:JoinGroup`.
|
27256
27412
|
# @return [Array<String>]
|
27257
27413
|
#
|
27258
27414
|
# @!attribute [rw] auto_create_database_user
|
@@ -27296,7 +27452,7 @@ module Aws::QuickSight
|
|
27296
27452
|
# @return [String]
|
27297
27453
|
#
|
27298
27454
|
# @!attribute [rw] iam_parameters
|
27299
|
-
# An optional parameter that uses IAM authentication to grant
|
27455
|
+
# An optional parameter that uses IAM authentication to grant
|
27300
27456
|
# QuickSight access to your cluster. This parameter can be used
|
27301
27457
|
# instead of [DataSourceCredentials][1].
|
27302
27458
|
#
|
@@ -27307,10 +27463,10 @@ module Aws::QuickSight
|
|
27307
27463
|
#
|
27308
27464
|
# @!attribute [rw] identity_center_configuration
|
27309
27465
|
# An optional parameter that configures IAM Identity Center
|
27310
|
-
# authentication to grant
|
27466
|
+
# authentication to grant QuickSight access to your cluster.
|
27311
27467
|
#
|
27312
|
-
# This parameter can only be specified if your
|
27313
|
-
#
|
27468
|
+
# This parameter can only be specified if your QuickSight account is
|
27469
|
+
# configured with IAM Identity Center.
|
27314
27470
|
# @return [Types::IdentityCenterConfiguration]
|
27315
27471
|
#
|
27316
27472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RedshiftParameters AWS API Documentation
|
@@ -27698,8 +27854,8 @@ module Aws::QuickSight
|
|
27698
27854
|
end
|
27699
27855
|
|
27700
27856
|
# @!attribute [rw] identity_type
|
27701
|
-
# The identity type that your
|
27702
|
-
#
|
27857
|
+
# The identity type that your QuickSight account uses to manage the
|
27858
|
+
# identity of users.
|
27703
27859
|
# @return [String]
|
27704
27860
|
#
|
27705
27861
|
# @!attribute [rw] email
|
@@ -27719,9 +27875,9 @@ module Aws::QuickSight
|
|
27719
27875
|
# QuickSight settings.
|
27720
27876
|
#
|
27721
27877
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
27722
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
27723
|
-
#
|
27724
|
-
#
|
27878
|
+
# Reader role. Reader Pros have access to Amazon Q in QuickSight,
|
27879
|
+
# can build stories with Amazon Q, and can generate executive
|
27880
|
+
# summaries from dashboards.
|
27725
27881
|
#
|
27726
27882
|
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
27727
27883
|
# Author role. Author Pros can author dashboards with natural
|
@@ -27790,18 +27946,18 @@ module Aws::QuickSight
|
|
27790
27946
|
#
|
27791
27947
|
# A set of custom permissions includes any combination of these
|
27792
27948
|
# restrictions. Currently, you need to create the profile names for
|
27793
|
-
# custom permission sets by using the
|
27794
|
-
#
|
27795
|
-
# permissions to a
|
27949
|
+
# custom permission sets by using the QuickSight console. Then, you
|
27950
|
+
# use the `RegisterUser` API operation to assign the named set of
|
27951
|
+
# permissions to a QuickSight user.
|
27796
27952
|
#
|
27797
|
-
#
|
27798
|
-
#
|
27799
|
-
#
|
27800
|
-
#
|
27801
|
-
#
|
27953
|
+
# QuickSight custom permissions are applied through IAM policies.
|
27954
|
+
# Therefore, they override the permissions typically granted by
|
27955
|
+
# assigning QuickSight users to one of the default security cohorts in
|
27956
|
+
# QuickSight (admin, author, reader, admin pro, author pro, reader
|
27957
|
+
# pro).
|
27802
27958
|
#
|
27803
|
-
# This feature is available only to
|
27804
|
-
#
|
27959
|
+
# This feature is available only to QuickSight Enterprise edition
|
27960
|
+
# subscriptions.
|
27805
27961
|
# @return [String]
|
27806
27962
|
#
|
27807
27963
|
# @!attribute [rw] external_login_federation_provider_type
|
@@ -27823,10 +27979,10 @@ module Aws::QuickSight
|
|
27823
27979
|
#
|
27824
27980
|
# @!attribute [rw] custom_federation_provider_url
|
27825
27981
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
27826
|
-
# identity to let a user federate into
|
27827
|
-
#
|
27828
|
-
#
|
27829
|
-
#
|
27982
|
+
# identity to let a user federate into QuickSight with an associated
|
27983
|
+
# Identity and Access Management(IAM) role. This parameter should only
|
27984
|
+
# be used when `ExternalLoginFederationProviderType` parameter is set
|
27985
|
+
# to `CUSTOM_OIDC`.
|
27830
27986
|
# @return [String]
|
27831
27987
|
#
|
27832
27988
|
# @!attribute [rw] external_login_id
|
@@ -27889,15 +28045,15 @@ module Aws::QuickSight
|
|
27889
28045
|
# A customer managed key structure that contains the information listed
|
27890
28046
|
# below:
|
27891
28047
|
#
|
27892
|
-
# * `KeyArn` - The ARN of a KMS key that is registered to a
|
27893
|
-
#
|
28048
|
+
# * `KeyArn` - The ARN of a KMS key that is registered to a QuickSight
|
28049
|
+
# account for encryption and decryption use.
|
27894
28050
|
#
|
27895
28051
|
# * `DefaultKey` - Indicates whether the current key is set as the
|
27896
28052
|
# default key for encryption and decryption use.
|
27897
28053
|
#
|
27898
28054
|
# @!attribute [rw] key_arn
|
27899
|
-
# The ARN of the KMS key that is registered to a
|
27900
|
-
#
|
28055
|
+
# The ARN of the KMS key that is registered to a QuickSight account
|
28056
|
+
# for encryption and decryption use.
|
27901
28057
|
# @return [String]
|
27902
28058
|
#
|
27903
28059
|
# @!attribute [rw] default_key
|
@@ -27914,11 +28070,11 @@ module Aws::QuickSight
|
|
27914
28070
|
include Aws::Structure
|
27915
28071
|
end
|
27916
28072
|
|
27917
|
-
# The feature configurations of an embedded
|
28073
|
+
# The feature configurations of an embedded QuickSight console.
|
27918
28074
|
#
|
27919
28075
|
# @!attribute [rw] state_persistence
|
27920
|
-
# The state persistence configurations of an embedded
|
27921
|
-
#
|
28076
|
+
# The state persistence configurations of an embedded QuickSight
|
28077
|
+
# console.
|
27922
28078
|
# @return [Types::StatePersistenceConfigurations]
|
27923
28079
|
#
|
27924
28080
|
# @!attribute [rw] shared_view
|
@@ -27926,22 +28082,20 @@ module Aws::QuickSight
|
|
27926
28082
|
# @return [Types::SharedViewConfigurations]
|
27927
28083
|
#
|
27928
28084
|
# @!attribute [rw] amazon_q_in_quick_sight
|
27929
|
-
# The Amazon Q configurations of an embedded
|
27930
|
-
# console.
|
28085
|
+
# The Amazon Q configurations of an embedded QuickSight console.
|
27931
28086
|
# @return [Types::AmazonQInQuickSightConsoleConfigurations]
|
27932
28087
|
#
|
27933
28088
|
# @!attribute [rw] schedules
|
27934
|
-
# The schedules configuration for an embedded
|
27935
|
-
# dashboard.
|
28089
|
+
# The schedules configuration for an embedded QuickSight dashboard.
|
27936
28090
|
# @return [Types::SchedulesConfigurations]
|
27937
28091
|
#
|
27938
28092
|
# @!attribute [rw] recent_snapshots
|
27939
|
-
# The recent snapshots configuration for an embedded
|
28093
|
+
# The recent snapshots configuration for an embedded QuickSight
|
27940
28094
|
# dashboard.
|
27941
28095
|
# @return [Types::RecentSnapshotsConfigurations]
|
27942
28096
|
#
|
27943
28097
|
# @!attribute [rw] threshold_alerts
|
27944
|
-
# The threshold alerts configuration for an embedded
|
28098
|
+
# The threshold alerts configuration for an embedded QuickSight
|
27945
28099
|
# dashboard.
|
27946
28100
|
# @return [Types::ThresholdAlertsConfigurations]
|
27947
28101
|
#
|
@@ -27963,16 +28117,15 @@ module Aws::QuickSight
|
|
27963
28117
|
# @!attribute [rw] initial_dashboard_id
|
27964
28118
|
# The dashboard ID for the dashboard that you want the user to see
|
27965
28119
|
# first. This ID is included in the output URL. When the URL in
|
27966
|
-
# response is accessed,
|
27967
|
-
#
|
28120
|
+
# response is accessed, QuickSight renders this dashboard if the user
|
28121
|
+
# has permissions to view it.
|
27968
28122
|
#
|
27969
28123
|
# If the user does not have permission to view this dashboard, they
|
27970
28124
|
# see a permissions error message.
|
27971
28125
|
# @return [String]
|
27972
28126
|
#
|
27973
28127
|
# @!attribute [rw] feature_configurations
|
27974
|
-
# The feature configurations of an embbedded
|
27975
|
-
# dashboard.
|
28128
|
+
# The feature configurations of an embbedded QuickSight dashboard.
|
27976
28129
|
# @return [Types::RegisteredUserDashboardFeatureConfigurations]
|
27977
28130
|
#
|
27978
28131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardEmbeddingConfiguration AWS API Documentation
|
@@ -27995,27 +28148,24 @@ module Aws::QuickSight
|
|
27995
28148
|
# @return [Types::SharedViewConfigurations]
|
27996
28149
|
#
|
27997
28150
|
# @!attribute [rw] bookmarks
|
27998
|
-
# The bookmarks configuration for an embedded dashboard in
|
27999
|
-
# QuickSight.
|
28151
|
+
# The bookmarks configuration for an embedded dashboard in QuickSight.
|
28000
28152
|
# @return [Types::BookmarksConfigurations]
|
28001
28153
|
#
|
28002
28154
|
# @!attribute [rw] amazon_q_in_quick_sight
|
28003
|
-
# The Amazon Q configurations of an embedded
|
28004
|
-
# dashboard.
|
28155
|
+
# The Amazon Q configurations of an embedded QuickSight dashboard.
|
28005
28156
|
# @return [Types::AmazonQInQuickSightDashboardConfigurations]
|
28006
28157
|
#
|
28007
28158
|
# @!attribute [rw] schedules
|
28008
|
-
# The schedules configuration for an embedded
|
28009
|
-
# dashboard.
|
28159
|
+
# The schedules configuration for an embedded QuickSight dashboard.
|
28010
28160
|
# @return [Types::SchedulesConfigurations]
|
28011
28161
|
#
|
28012
28162
|
# @!attribute [rw] recent_snapshots
|
28013
|
-
# The recent snapshots configuration for an
|
28163
|
+
# The recent snapshots configuration for an QuickSight embedded
|
28014
28164
|
# dashboard
|
28015
28165
|
# @return [Types::RecentSnapshotsConfigurations]
|
28016
28166
|
#
|
28017
28167
|
# @!attribute [rw] threshold_alerts
|
28018
|
-
# The threshold alerts configuration for an
|
28168
|
+
# The threshold alerts configuration for an QuickSight embedded
|
28019
28169
|
# dashboard.
|
28020
28170
|
# @return [Types::ThresholdAlertsConfigurations]
|
28021
28171
|
#
|
@@ -28039,7 +28189,7 @@ module Aws::QuickSight
|
|
28039
28189
|
# @!attribute [rw] initial_dashboard_visual_id
|
28040
28190
|
# The visual ID for the visual that you want the user to embed. This
|
28041
28191
|
# ID is included in the output URL. When the URL in response is
|
28042
|
-
# accessed,
|
28192
|
+
# accessed, QuickSight renders this visual.
|
28043
28193
|
#
|
28044
28194
|
# The Amazon Resource Name (ARN) of the dashboard that the visual
|
28045
28195
|
# belongs to must be included in the `AuthorizedResourceArns`
|
@@ -28056,8 +28206,7 @@ module Aws::QuickSight
|
|
28056
28206
|
end
|
28057
28207
|
|
28058
28208
|
# The type of experience you want to embed. For registered users, you
|
28059
|
-
# can embed
|
28060
|
-
# console.
|
28209
|
+
# can embed QuickSight dashboards or the QuickSight console.
|
28061
28210
|
#
|
28062
28211
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
28063
28212
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
@@ -28071,25 +28220,25 @@ module Aws::QuickSight
|
|
28071
28220
|
# @return [Types::RegisteredUserDashboardEmbeddingConfiguration]
|
28072
28221
|
#
|
28073
28222
|
# @!attribute [rw] quick_sight_console
|
28074
|
-
# The configuration details for providing each
|
28075
|
-
#
|
28076
|
-
#
|
28077
|
-
#
|
28078
|
-
#
|
28223
|
+
# The configuration details for providing each QuickSight console
|
28224
|
+
# embedding experience. This can be used along with custom permissions
|
28225
|
+
# to restrict access to certain features. For more information, see
|
28226
|
+
# [Customizing Access to the QuickSight Console][1] in the *Amazon
|
28227
|
+
# QuickSight User Guide*.
|
28079
28228
|
#
|
28080
28229
|
# Use ` GenerateEmbedUrlForRegisteredUser ` where you want to provide
|
28081
28230
|
# an authoring portal that allows users to create data sources,
|
28082
28231
|
# datasets, analyses, and dashboards. The users who accesses an
|
28083
|
-
# embedded
|
28084
|
-
#
|
28085
|
-
#
|
28232
|
+
# embedded QuickSight console needs to belong to the author or admin
|
28233
|
+
# security cohort. If you want to restrict permissions to some of
|
28234
|
+
# these features, add a custom permissions profile to the user with
|
28086
28235
|
# the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
|
28087
28236
|
# operation to add a new user with a custom permission profile
|
28088
28237
|
# attached. For more information, see the following sections in the
|
28089
28238
|
# *Amazon QuickSight User Guide*:
|
28090
28239
|
#
|
28091
|
-
# * [Embedding the Full Functionality of the
|
28092
|
-
#
|
28240
|
+
# * [Embedding the Full Functionality of the QuickSight Console for
|
28241
|
+
# Authenticated Users][2]
|
28093
28242
|
#
|
28094
28243
|
# * [Customizing Access to the Amazon QuickSight Console][1]
|
28095
28244
|
#
|
@@ -28108,7 +28257,7 @@ module Aws::QuickSight
|
|
28108
28257
|
# The configuration details for embedding the Q search bar.
|
28109
28258
|
#
|
28110
28259
|
# For more information about embedding the Q search bar, see
|
28111
|
-
# [Embedding Overview][1] in the *
|
28260
|
+
# [Embedding Overview][1] in the *QuickSight User Guide*.
|
28112
28261
|
#
|
28113
28262
|
#
|
28114
28263
|
#
|
@@ -28116,8 +28265,7 @@ module Aws::QuickSight
|
|
28116
28265
|
# @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
|
28117
28266
|
#
|
28118
28267
|
# @!attribute [rw] dashboard_visual
|
28119
|
-
# The type of embedding experience. In this case,
|
28120
|
-
# visuals.
|
28268
|
+
# The type of embedding experience. In this case, QuickSight visuals.
|
28121
28269
|
# @return [Types::RegisteredUserDashboardVisualEmbeddingConfiguration]
|
28122
28270
|
#
|
28123
28271
|
# @!attribute [rw] generative_qn_a
|
@@ -28125,8 +28273,8 @@ module Aws::QuickSight
|
|
28125
28273
|
# experience.
|
28126
28274
|
#
|
28127
28275
|
# For more information about embedding the Generative Q&A
|
28128
|
-
# experience, see [Embedding Overview][1] in the *
|
28129
|
-
#
|
28276
|
+
# experience, see [Embedding Overview][1] in the *QuickSight User
|
28277
|
+
# Guide*.
|
28130
28278
|
#
|
28131
28279
|
#
|
28132
28280
|
#
|
@@ -28151,9 +28299,9 @@ module Aws::QuickSight
|
|
28151
28299
|
# @!attribute [rw] initial_topic_id
|
28152
28300
|
# The ID of the new Q reader experience topic that you want to make
|
28153
28301
|
# the starting topic in the Generative Q&A experience. You can
|
28154
|
-
# find a topic ID by navigating to the Topics pane in the
|
28155
|
-
#
|
28156
|
-
#
|
28302
|
+
# find a topic ID by navigating to the Topics pane in the QuickSight
|
28303
|
+
# application and opening a topic. The ID is in the URL for the topic
|
28304
|
+
# that you open.
|
28157
28305
|
#
|
28158
28306
|
# If you don't specify an initial topic or you specify a legacy
|
28159
28307
|
# topic, a list of all shared new reader experience topics is shown in
|
@@ -28176,12 +28324,11 @@ module Aws::QuickSight
|
|
28176
28324
|
# @!attribute [rw] initial_topic_id
|
28177
28325
|
# The ID of the legacy Q topic that you want to use as the starting
|
28178
28326
|
# topic in the Q search bar. To locate the topic ID of the topic that
|
28179
|
-
# you want to use, open the [
|
28180
|
-
#
|
28181
|
-
#
|
28182
|
-
#
|
28183
|
-
#
|
28184
|
-
# topics.
|
28327
|
+
# you want to use, open the [QuickSight console][1], navigate to the
|
28328
|
+
# **Topics** pane, and choose thre topic that you want to use. The
|
28329
|
+
# `TopicID` is located in the URL of the topic that opens. When you
|
28330
|
+
# select an initial topic, you can specify whether or not readers are
|
28331
|
+
# allowed to select other topics from the list of available topics.
|
28185
28332
|
#
|
28186
28333
|
# If you don't specify an initial topic or if you specify a new
|
28187
28334
|
# reader experience topic, a list of all shared legacy topics is shown
|
@@ -28200,12 +28347,11 @@ module Aws::QuickSight
|
|
28200
28347
|
include Aws::Structure
|
28201
28348
|
end
|
28202
28349
|
|
28203
|
-
# Information about the
|
28204
|
-
# embed.
|
28350
|
+
# Information about the QuickSight console that you want to embed.
|
28205
28351
|
#
|
28206
28352
|
# @!attribute [rw] initial_path
|
28207
|
-
# The initial URL path for the
|
28208
|
-
#
|
28353
|
+
# The initial URL path for the QuickSight console. `InitialPath` is
|
28354
|
+
# required.
|
28209
28355
|
#
|
28210
28356
|
# The entry point URL is constrained to the following paths:
|
28211
28357
|
#
|
@@ -28218,15 +28364,14 @@ module Aws::QuickSight
|
|
28218
28364
|
# * `/start/favorites`
|
28219
28365
|
#
|
28220
28366
|
# * `/dashboards/DashboardId`. *DashboardId* is the actual ID key from
|
28221
|
-
# the
|
28367
|
+
# the QuickSight console URL of the dashboard.
|
28222
28368
|
#
|
28223
28369
|
# * `/analyses/AnalysisId`. *AnalysisId* is the actual ID key from the
|
28224
|
-
#
|
28370
|
+
# QuickSight console URL of the analysis.
|
28225
28371
|
# @return [String]
|
28226
28372
|
#
|
28227
28373
|
# @!attribute [rw] feature_configurations
|
28228
|
-
# The embedding configuration of an embedded
|
28229
|
-
# console.
|
28374
|
+
# The embedding configuration of an embedded QuickSight console.
|
28230
28375
|
# @return [Types::RegisteredUserConsoleFeatureConfigurations]
|
28231
28376
|
#
|
28232
28377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQuickSightConsoleEmbeddingConfiguration AWS API Documentation
|
@@ -28750,8 +28895,8 @@ module Aws::QuickSight
|
|
28750
28895
|
|
28751
28896
|
# An optional structure that contains the Amazon S3 bucket configuration
|
28752
28897
|
# that the generated snapshots are stored in. If you don't provide this
|
28753
|
-
# information, generated snapshots are stored in the default
|
28754
|
-
#
|
28898
|
+
# information, generated snapshots are stored in the default QuickSight
|
28899
|
+
# bucket.
|
28755
28900
|
#
|
28756
28901
|
# @!attribute [rw] bucket_name
|
28757
28902
|
# The name of an existing Amazon S3 bucket where the generated
|
@@ -28783,7 +28928,7 @@ module Aws::QuickSight
|
|
28783
28928
|
#
|
28784
28929
|
# @!attribute [rw] manifest_file_location
|
28785
28930
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
28786
|
-
# manifest file was uploaded into
|
28931
|
+
# manifest file was uploaded into QuickSight.
|
28787
28932
|
# @return [Types::ManifestFileLocation]
|
28788
28933
|
#
|
28789
28934
|
# @!attribute [rw] role_arn
|
@@ -29263,12 +29408,10 @@ module Aws::QuickSight
|
|
29263
29408
|
include Aws::Structure
|
29264
29409
|
end
|
29265
29410
|
|
29266
|
-
# The schedules configuration for an embedded
|
29267
|
-
# dashboard.
|
29411
|
+
# The schedules configuration for an embedded QuickSight dashboard.
|
29268
29412
|
#
|
29269
29413
|
# @!attribute [rw] enabled
|
29270
|
-
# The schedules configuration for an embedded
|
29271
|
-
# dashboard.
|
29414
|
+
# The schedules configuration for an embedded QuickSight dashboard.
|
29272
29415
|
# @return [Boolean]
|
29273
29416
|
#
|
29274
29417
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SchedulesConfigurations AWS API Documentation
|
@@ -30089,7 +30232,7 @@ module Aws::QuickSight
|
|
30089
30232
|
#
|
30090
30233
|
# @!attribute [rw] name
|
30091
30234
|
# The name of a sheet. This name is displayed on the sheet's tab in
|
30092
|
-
# the
|
30235
|
+
# the QuickSight console.
|
30093
30236
|
# @return [String]
|
30094
30237
|
#
|
30095
30238
|
# @!attribute [rw] images
|
@@ -30188,7 +30331,7 @@ module Aws::QuickSight
|
|
30188
30331
|
#
|
30189
30332
|
# @!attribute [rw] name
|
30190
30333
|
# The name of the sheet. This name is displayed on the sheet's tab in
|
30191
|
-
# the
|
30334
|
+
# the QuickSight console.
|
30192
30335
|
# @return [String]
|
30193
30336
|
#
|
30194
30337
|
# @!attribute [rw] parameter_controls
|
@@ -30562,22 +30705,22 @@ module Aws::QuickSight
|
|
30562
30705
|
# account.
|
30563
30706
|
#
|
30564
30707
|
# @!attribute [rw] iam_user
|
30565
|
-
# A Boolean that is `TRUE` if the
|
30708
|
+
# A Boolean that is `TRUE` if the QuickSight uses IAM as an
|
30566
30709
|
# authentication method.
|
30567
30710
|
# @return [Boolean]
|
30568
30711
|
#
|
30569
30712
|
# @!attribute [rw] user_login_name
|
30570
|
-
# The user login name for your
|
30713
|
+
# The user login name for your QuickSight account.
|
30571
30714
|
# @return [String]
|
30572
30715
|
#
|
30573
30716
|
# @!attribute [rw] account_name
|
30574
|
-
# The name of your
|
30717
|
+
# The name of your QuickSight account.
|
30575
30718
|
# @return [String]
|
30576
30719
|
#
|
30577
30720
|
# @!attribute [rw] directory_type
|
30578
30721
|
# The type of Active Directory that is being used to authenticate the
|
30579
|
-
#
|
30580
|
-
#
|
30722
|
+
# QuickSight account. Valid values are `SIMPLE_AD`, `AD_CONNECTOR`,
|
30723
|
+
# and `MICROSOFT_AD`.
|
30581
30724
|
# @return [String]
|
30582
30725
|
#
|
30583
30726
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SignupResponse AWS API Documentation
|
@@ -30734,8 +30877,8 @@ module Aws::QuickSight
|
|
30734
30877
|
#
|
30735
30878
|
# These are not the tags that are used for Amazon Web Services
|
30736
30879
|
# resource tagging. For more information on row level security in
|
30737
|
-
#
|
30738
|
-
#
|
30880
|
+
# QuickSight, see [Using Row-Level Security (RLS) with Tags][1]in the
|
30881
|
+
# *Amazon QuickSight User Guide*.
|
30739
30882
|
#
|
30740
30883
|
#
|
30741
30884
|
#
|
@@ -30779,8 +30922,7 @@ module Aws::QuickSight
|
|
30779
30922
|
# @return [Types::SnapshotDestinationConfiguration]
|
30780
30923
|
#
|
30781
30924
|
# @!attribute [rw] parameters
|
30782
|
-
# A list of
|
30783
|
-
# values.
|
30925
|
+
# A list of QuickSight parameters and the list's override values.
|
30784
30926
|
# @return [Types::Parameters]
|
30785
30927
|
#
|
30786
30928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotConfiguration AWS API Documentation
|
@@ -31073,7 +31215,7 @@ module Aws::QuickSight
|
|
31073
31215
|
#
|
31074
31216
|
# @!attribute [rw] o_auth_parameters
|
31075
31217
|
# An object that contains information needed to create a data source
|
31076
|
-
# connection between an
|
31218
|
+
# connection between an QuickSight account and Snowflake.
|
31077
31219
|
# @return [Types::OAuthParameters]
|
31078
31220
|
#
|
31079
31221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnowflakeParameters AWS API Documentation
|
@@ -31180,7 +31322,7 @@ module Aws::QuickSight
|
|
31180
31322
|
include Aws::Structure
|
31181
31323
|
end
|
31182
31324
|
|
31183
|
-
# Secure Socket Layer (SSL) properties that apply when
|
31325
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
31184
31326
|
# connects to your underlying data source.
|
31185
31327
|
#
|
31186
31328
|
# @!attribute [rw] disable_ssl
|
@@ -31225,7 +31367,7 @@ module Aws::QuickSight
|
|
31225
31367
|
#
|
31226
31368
|
# @!attribute [rw] o_auth_parameters
|
31227
31369
|
# An object that contains information needed to create a data source
|
31228
|
-
# connection between an
|
31370
|
+
# connection between an QuickSight account and Starburst.
|
31229
31371
|
# @return [Types::OAuthParameters]
|
31230
31372
|
#
|
31231
31373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StarburstParameters AWS API Documentation
|
@@ -31401,7 +31543,7 @@ module Aws::QuickSight
|
|
31401
31543
|
#
|
31402
31544
|
# If you choose `DO_NOTHING`, failed import jobs will not attempt to
|
31403
31545
|
# roll back any asset changes caused by the failed job, possibly
|
31404
|
-
# keeping the
|
31546
|
+
# keeping the QuickSight account in an inconsistent state.
|
31405
31547
|
# @return [String]
|
31406
31548
|
#
|
31407
31549
|
# @!attribute [rw] override_permissions
|
@@ -31483,7 +31625,7 @@ module Aws::QuickSight
|
|
31483
31625
|
# @!attribute [rw] user_configuration
|
31484
31626
|
# A structure that contains information about the anonymous users that
|
31485
31627
|
# the generated snapshot is for. This API will not return information
|
31486
|
-
# about registered
|
31628
|
+
# about registered QuickSight.
|
31487
31629
|
# @return [Types::SnapshotUserConfiguration]
|
31488
31630
|
#
|
31489
31631
|
# @!attribute [rw] snapshot_configuration
|
@@ -31543,9 +31685,9 @@ module Aws::QuickSight
|
|
31543
31685
|
#
|
31544
31686
|
# @!attribute [rw] schedule_id
|
31545
31687
|
# The ID of the schedule that you want to start a snapshot job
|
31546
|
-
# schedule for. The schedule ID can be found in the
|
31547
|
-
#
|
31548
|
-
#
|
31688
|
+
# schedule for. The schedule ID can be found in the QuickSight console
|
31689
|
+
# in the **Schedules** pane of the dashboard that the schedule is
|
31690
|
+
# configured for.
|
31549
31691
|
# @return [String]
|
31550
31692
|
#
|
31551
31693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJobScheduleRequest AWS API Documentation
|
@@ -31578,8 +31720,8 @@ module Aws::QuickSight
|
|
31578
31720
|
# The state perssitence configuration of an embedded dashboard.
|
31579
31721
|
#
|
31580
31722
|
# @!attribute [rw] enabled
|
31581
|
-
# Determines if a
|
31582
|
-
#
|
31723
|
+
# Determines if a QuickSight dashboard's state persistence settings
|
31724
|
+
# are turned on or off.
|
31583
31725
|
# @return [Boolean]
|
31584
31726
|
#
|
31585
31727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StatePersistenceConfigurations AWS API Documentation
|
@@ -31902,7 +32044,7 @@ module Aws::QuickSight
|
|
31902
32044
|
end
|
31903
32045
|
|
31904
32046
|
# A success entry that occurs when a `KeyRegistration` job is
|
31905
|
-
# successfully applied to the
|
32047
|
+
# successfully applied to the QuickSight account.
|
31906
32048
|
#
|
31907
32049
|
# @!attribute [rw] key_arn
|
31908
32050
|
# The ARN of the KMS key that is associated with the
|
@@ -32649,7 +32791,7 @@ module Aws::QuickSight
|
|
32649
32791
|
include Aws::Structure
|
32650
32792
|
end
|
32651
32793
|
|
32652
|
-
# A template object. A *template* is an entity in
|
32794
|
+
# A template object. A *template* is an entity in QuickSight that
|
32653
32795
|
# encapsulates the metadata required to create an analysis and that you
|
32654
32796
|
# can use to create a dashboard. A template adds a layer of abstraction
|
32655
32797
|
# by using placeholders to replace the dataset associated with an
|
@@ -33344,7 +33486,7 @@ module Aws::QuickSight
|
|
33344
33486
|
#
|
33345
33487
|
# @!attribute [rw] base_theme_id
|
33346
33488
|
# The Amazon QuickSight-defined ID of the theme that a custom theme
|
33347
|
-
# inherits from. All themes initially inherit from a default
|
33489
|
+
# inherits from. All themes initially inherit from a default
|
33348
33490
|
# QuickSight theme.
|
33349
33491
|
# @return [String]
|
33350
33492
|
#
|
@@ -33442,11 +33584,11 @@ module Aws::QuickSight
|
|
33442
33584
|
include Aws::Structure
|
33443
33585
|
end
|
33444
33586
|
|
33445
|
-
# The threshold alerts configuration for an embedded
|
33587
|
+
# The threshold alerts configuration for an embedded QuickSight
|
33446
33588
|
# dashboard.
|
33447
33589
|
#
|
33448
33590
|
# @!attribute [rw] enabled
|
33449
|
-
# The threshold alerts configuration for an embedded
|
33591
|
+
# The threshold alerts configuration for an embedded QuickSight
|
33450
33592
|
# dashboard.
|
33451
33593
|
# @return [Boolean]
|
33452
33594
|
#
|
@@ -34359,6 +34501,10 @@ module Aws::QuickSight
|
|
34359
34501
|
# The relative date filter.
|
34360
34502
|
# @return [Types::TopicRelativeDateFilter]
|
34361
34503
|
#
|
34504
|
+
# @!attribute [rw] null_filter
|
34505
|
+
# The null filter.
|
34506
|
+
# @return [Types::TopicNullFilter]
|
34507
|
+
#
|
34362
34508
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicFilter AWS API Documentation
|
34363
34509
|
#
|
34364
34510
|
class TopicFilter < Struct.new(
|
@@ -34372,7 +34518,8 @@ module Aws::QuickSight
|
|
34372
34518
|
:numeric_equality_filter,
|
34373
34519
|
:numeric_range_filter,
|
34374
34520
|
:date_range_filter,
|
34375
|
-
:relative_date_filter
|
34521
|
+
:relative_date_filter,
|
34522
|
+
:null_filter)
|
34376
34523
|
SENSITIVE = []
|
34377
34524
|
include Aws::Structure
|
34378
34525
|
end
|
@@ -34697,6 +34844,32 @@ module Aws::QuickSight
|
|
34697
34844
|
include Aws::Structure
|
34698
34845
|
end
|
34699
34846
|
|
34847
|
+
# The structure that represents a null filter.
|
34848
|
+
#
|
34849
|
+
# @!attribute [rw] null_filter_type
|
34850
|
+
# The type of the null filter. Valid values for this type are
|
34851
|
+
# `NULLS_ONLY`, `NON_NULLS_ONLY`, and `ALL_VALUES`.
|
34852
|
+
# @return [String]
|
34853
|
+
#
|
34854
|
+
# @!attribute [rw] constant
|
34855
|
+
# A structure that represents a singular filter constant, used in
|
34856
|
+
# filters to specify a single value to match against.
|
34857
|
+
# @return [Types::TopicSingularFilterConstant]
|
34858
|
+
#
|
34859
|
+
# @!attribute [rw] inverse
|
34860
|
+
# A Boolean value that indicates if the filter is inverse.
|
34861
|
+
# @return [Boolean]
|
34862
|
+
#
|
34863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicNullFilter AWS API Documentation
|
34864
|
+
#
|
34865
|
+
class TopicNullFilter < Struct.new(
|
34866
|
+
:null_filter_type,
|
34867
|
+
:constant,
|
34868
|
+
:inverse)
|
34869
|
+
SENSITIVE = [:constant]
|
34870
|
+
include Aws::Structure
|
34871
|
+
end
|
34872
|
+
|
34700
34873
|
# A filter that filters topics based on the value of a numeric field.
|
34701
34874
|
# The filter includes only topics whose numeric field value matches the
|
34702
34875
|
# specified value.
|
@@ -35698,8 +35871,8 @@ module Aws::QuickSight
|
|
35698
35871
|
# This error indicates that you are calling an embedding operation in
|
35699
35872
|
# Amazon QuickSight without the required pricing plan on your Amazon Web
|
35700
35873
|
# Services account. Before you can use embedding for anonymous users, a
|
35701
|
-
# QuickSight administrator needs to add capacity pricing to
|
35702
|
-
#
|
35874
|
+
# QuickSight administrator needs to add capacity pricing to QuickSight.
|
35875
|
+
# You can do this on the **Manage QuickSight** page.
|
35703
35876
|
#
|
35704
35877
|
# After capacity pricing is added, you can use the `
|
35705
35878
|
# GetDashboardEmbedUrl ` API operation with the `--identity-type
|
@@ -35723,9 +35896,9 @@ module Aws::QuickSight
|
|
35723
35896
|
|
35724
35897
|
# This error indicates that you are calling an operation on an Amazon
|
35725
35898
|
# QuickSight subscription where the edition doesn't include support for
|
35726
|
-
# that operation. Amazon
|
35727
|
-
#
|
35728
|
-
#
|
35899
|
+
# that operation. Amazon QuickSight currently has Standard Edition and
|
35900
|
+
# Enterprise Edition. Not every operation and capability is available in
|
35901
|
+
# every edition.
|
35729
35902
|
#
|
35730
35903
|
# @!attribute [rw] message
|
35731
35904
|
# @return [String]
|
@@ -35798,19 +35971,54 @@ module Aws::QuickSight
|
|
35798
35971
|
include Aws::Structure
|
35799
35972
|
end
|
35800
35973
|
|
35974
|
+
# @!attribute [rw] custom_permissions_name
|
35975
|
+
# The name of the custom permissions profile that you want to apply to
|
35976
|
+
# an account.
|
35977
|
+
# @return [String]
|
35978
|
+
#
|
35979
|
+
# @!attribute [rw] aws_account_id
|
35980
|
+
# The ID of the Amazon Web Services account for which you want to
|
35981
|
+
# apply a custom permissions profile.
|
35982
|
+
# @return [String]
|
35983
|
+
#
|
35984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomPermissionRequest AWS API Documentation
|
35985
|
+
#
|
35986
|
+
class UpdateAccountCustomPermissionRequest < Struct.new(
|
35987
|
+
:custom_permissions_name,
|
35988
|
+
:aws_account_id)
|
35989
|
+
SENSITIVE = []
|
35990
|
+
include Aws::Structure
|
35991
|
+
end
|
35992
|
+
|
35993
|
+
# @!attribute [rw] request_id
|
35994
|
+
# The Amazon Web Services request ID for this operation.
|
35995
|
+
# @return [String]
|
35996
|
+
#
|
35997
|
+
# @!attribute [rw] status
|
35998
|
+
# The HTTP status of the request.
|
35999
|
+
# @return [Integer]
|
36000
|
+
#
|
36001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomPermissionResponse AWS API Documentation
|
36002
|
+
#
|
36003
|
+
class UpdateAccountCustomPermissionResponse < Struct.new(
|
36004
|
+
:request_id,
|
36005
|
+
:status)
|
36006
|
+
SENSITIVE = []
|
36007
|
+
include Aws::Structure
|
36008
|
+
end
|
36009
|
+
|
35801
36010
|
# @!attribute [rw] aws_account_id
|
35802
36011
|
# The ID for the Amazon Web Services account that you want to update
|
35803
|
-
#
|
36012
|
+
# QuickSight customizations for.
|
35804
36013
|
# @return [String]
|
35805
36014
|
#
|
35806
36015
|
# @!attribute [rw] namespace
|
35807
|
-
# The namespace that you want to update
|
35808
|
-
# customizations for.
|
36016
|
+
# The namespace that you want to update QuickSight customizations for.
|
35809
36017
|
# @return [String]
|
35810
36018
|
#
|
35811
36019
|
# @!attribute [rw] account_customization
|
35812
|
-
# The
|
35813
|
-
#
|
36020
|
+
# The QuickSight customizations you're updating in the current Amazon
|
36021
|
+
# Web Services Region.
|
35814
36022
|
# @return [Types::AccountCustomization]
|
35815
36023
|
#
|
35816
36024
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -35830,7 +36038,7 @@ module Aws::QuickSight
|
|
35830
36038
|
#
|
35831
36039
|
# @!attribute [rw] aws_account_id
|
35832
36040
|
# The ID for the Amazon Web Services account that you want to update
|
35833
|
-
#
|
36041
|
+
# QuickSight customizations for.
|
35834
36042
|
# @return [String]
|
35835
36043
|
#
|
35836
36044
|
# @!attribute [rw] namespace
|
@@ -35839,8 +36047,8 @@ module Aws::QuickSight
|
|
35839
36047
|
# @return [String]
|
35840
36048
|
#
|
35841
36049
|
# @!attribute [rw] account_customization
|
35842
|
-
# The
|
35843
|
-
#
|
36050
|
+
# The QuickSight customizations you're updating in the current Amazon
|
36051
|
+
# Web Services Region.
|
35844
36052
|
# @return [Types::AccountCustomization]
|
35845
36053
|
#
|
35846
36054
|
# @!attribute [rw] request_id
|
@@ -35865,27 +36073,27 @@ module Aws::QuickSight
|
|
35865
36073
|
end
|
35866
36074
|
|
35867
36075
|
# @!attribute [rw] aws_account_id
|
35868
|
-
# The ID for the Amazon Web Services account that contains the
|
36076
|
+
# The ID for the Amazon Web Services account that contains the
|
35869
36077
|
# QuickSight settings that you want to list.
|
35870
36078
|
# @return [String]
|
35871
36079
|
#
|
35872
36080
|
# @!attribute [rw] default_namespace
|
35873
36081
|
# The default namespace for this Amazon Web Services account.
|
35874
36082
|
# Currently, the default is `default`. IAM users that register for the
|
35875
|
-
# first time with
|
35876
|
-
#
|
36083
|
+
# first time with QuickSight provide an email address that becomes
|
36084
|
+
# associated with the default namespace.
|
35877
36085
|
# @return [String]
|
35878
36086
|
#
|
35879
36087
|
# @!attribute [rw] notification_email
|
35880
|
-
# The email address that you want
|
35881
|
-
#
|
35882
|
-
#
|
36088
|
+
# The email address that you want QuickSight to send notifications to
|
36089
|
+
# regarding your Amazon Web Services account or QuickSight
|
36090
|
+
# subscription.
|
35883
36091
|
# @return [String]
|
35884
36092
|
#
|
35885
36093
|
# @!attribute [rw] termination_protection_enabled
|
35886
|
-
# A boolean value that determines whether or not an
|
35887
|
-
#
|
35888
|
-
#
|
36094
|
+
# A boolean value that determines whether or not an QuickSight account
|
36095
|
+
# can be deleted. A `True` value doesn't allow the account to be
|
36096
|
+
# deleted and results in an error message if a user tries to make a
|
35889
36097
|
# `DeleteAccountSubscription` request. A `False` value will allow the
|
35890
36098
|
# account to be deleted.
|
35891
36099
|
# @return [Boolean]
|
@@ -35995,7 +36203,7 @@ module Aws::QuickSight
|
|
35995
36203
|
#
|
35996
36204
|
# @!attribute [rw] name
|
35997
36205
|
# A descriptive name for the analysis that you're updating. This name
|
35998
|
-
# displays for the analysis in the
|
36206
|
+
# displays for the analysis in the QuickSight console.
|
35999
36207
|
# @return [String]
|
36000
36208
|
#
|
36001
36209
|
# @!attribute [rw] parameters
|
@@ -36012,8 +36220,8 @@ module Aws::QuickSight
|
|
36012
36220
|
#
|
36013
36221
|
# @!attribute [rw] theme_arn
|
36014
36222
|
# The Amazon Resource Name (ARN) for the theme to apply to the
|
36015
|
-
# analysis that you're creating. To see the theme in the
|
36016
|
-
#
|
36223
|
+
# analysis that you're creating. To see the theme in the QuickSight
|
36224
|
+
# console, make sure that you have access to it.
|
36017
36225
|
# @return [String]
|
36018
36226
|
#
|
36019
36227
|
# @!attribute [rw] definition
|
@@ -36082,7 +36290,7 @@ module Aws::QuickSight
|
|
36082
36290
|
# @return [String]
|
36083
36291
|
#
|
36084
36292
|
# @!attribute [rw] namespace
|
36085
|
-
# The namespace of the
|
36293
|
+
# The namespace of the QuickSight application.
|
36086
36294
|
# @return [String]
|
36087
36295
|
#
|
36088
36296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateApplicationWithTokenExchangeGrantRequest AWS API Documentation
|
@@ -36151,7 +36359,7 @@ module Aws::QuickSight
|
|
36151
36359
|
# @return [String]
|
36152
36360
|
#
|
36153
36361
|
# @!attribute [rw] brand_id
|
36154
|
-
# The ID of the
|
36362
|
+
# The ID of the QuickSight brand.
|
36155
36363
|
# @return [String]
|
36156
36364
|
#
|
36157
36365
|
# @!attribute [rw] version_id
|
@@ -36190,7 +36398,7 @@ module Aws::QuickSight
|
|
36190
36398
|
# @return [String]
|
36191
36399
|
#
|
36192
36400
|
# @!attribute [rw] brand_id
|
36193
|
-
# The ID of the
|
36401
|
+
# The ID of the QuickSight brand.
|
36194
36402
|
# @return [String]
|
36195
36403
|
#
|
36196
36404
|
# @!attribute [rw] brand_definition
|
@@ -36385,8 +36593,7 @@ module Aws::QuickSight
|
|
36385
36593
|
# @return [Integer]
|
36386
36594
|
#
|
36387
36595
|
# @!attribute [rw] link_sharing_configuration
|
36388
|
-
# Updates the permissions of a shared link to an
|
36389
|
-
# dashboard.
|
36596
|
+
# Updates the permissions of a shared link to an QuickSight dashboard.
|
36390
36597
|
# @return [Types::LinkSharingConfiguration]
|
36391
36598
|
#
|
36392
36599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissionsResponse AWS API Documentation
|
@@ -36474,7 +36681,7 @@ module Aws::QuickSight
|
|
36474
36681
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
36475
36682
|
# the Amazon Resource Name (ARN) of the source template. The
|
36476
36683
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
36477
|
-
# any
|
36684
|
+
# any QuickSight-supported Amazon Web Services Region.
|
36478
36685
|
#
|
36479
36686
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
36480
36687
|
# the replacement datasets for the placeholders listed in the
|
@@ -36496,7 +36703,7 @@ module Aws::QuickSight
|
|
36496
36703
|
#
|
36497
36704
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
36498
36705
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
36499
|
-
#
|
36706
|
+
# QuickSight disables the left filter pane on the published
|
36500
36707
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
36501
36708
|
# option is `ENABLED` by default.
|
36502
36709
|
#
|
@@ -36508,6 +36715,16 @@ module Aws::QuickSight
|
|
36508
36715
|
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
36509
36716
|
# state can be either `COLLAPSED` or `EXPANDED`. This option is
|
36510
36717
|
# `COLLAPSED` by default.
|
36718
|
+
#
|
36719
|
+
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status
|
36720
|
+
# can be either `ENABLED` or `DISABLED`. The option to build an
|
36721
|
+
# executive summary is disabled when this is set to `DISABLED`. This
|
36722
|
+
# option is `ENABLED` by default.
|
36723
|
+
#
|
36724
|
+
# * `AvailabilityStatus` for `DataStoriesSharingOption` - This status
|
36725
|
+
# can be either `ENABLED` or `DISABLED`. The option to share a data
|
36726
|
+
# story is disabled when this is set to `DISABLED`. This option is
|
36727
|
+
# `ENABLED` by default.
|
36511
36728
|
# @return [Types::DashboardPublishOptions]
|
36512
36729
|
#
|
36513
36730
|
# @!attribute [rw] theme_arn
|
@@ -36712,7 +36929,7 @@ module Aws::QuickSight
|
|
36712
36929
|
# @return [String]
|
36713
36930
|
#
|
36714
36931
|
# @!attribute [rw] column_groups
|
36715
|
-
# Groupings of columns that work together in certain
|
36932
|
+
# Groupings of columns that work together in certain QuickSight
|
36716
36933
|
# features. Currently, only geospatial hierarchy is supported.
|
36717
36934
|
# @return [Array<Types::ColumnGroup>]
|
36718
36935
|
#
|
@@ -36883,24 +37100,24 @@ module Aws::QuickSight
|
|
36883
37100
|
# @return [String]
|
36884
37101
|
#
|
36885
37102
|
# @!attribute [rw] data_source_parameters
|
36886
|
-
# The parameters that
|
36887
|
-
#
|
37103
|
+
# The parameters that QuickSight uses to connect to your underlying
|
37104
|
+
# source.
|
36888
37105
|
# @return [Types::DataSourceParameters]
|
36889
37106
|
#
|
36890
37107
|
# @!attribute [rw] credentials
|
36891
|
-
# The credentials that
|
37108
|
+
# The credentials that QuickSight that uses to connect to your
|
36892
37109
|
# underlying source. Currently, only credentials based on user name
|
36893
37110
|
# and password are supported.
|
36894
37111
|
# @return [Types::DataSourceCredentials]
|
36895
37112
|
#
|
36896
37113
|
# @!attribute [rw] vpc_connection_properties
|
36897
|
-
# Use this parameter only when you want
|
37114
|
+
# Use this parameter only when you want QuickSight to use a VPC
|
36898
37115
|
# connection when connecting to your underlying source.
|
36899
37116
|
# @return [Types::VpcConnectionProperties]
|
36900
37117
|
#
|
36901
37118
|
# @!attribute [rw] ssl_properties
|
36902
|
-
# Secure Socket Layer (SSL) properties that apply when
|
36903
|
-
#
|
37119
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
37120
|
+
# connects to your underlying source.
|
36904
37121
|
# @return [Types::SslProperties]
|
36905
37122
|
#
|
36906
37123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSourceRequest AWS API Documentation
|
@@ -36951,15 +37168,15 @@ module Aws::QuickSight
|
|
36951
37168
|
end
|
36952
37169
|
|
36953
37170
|
# @!attribute [rw] aws_account_id
|
36954
|
-
# The ID of the
|
36955
|
-
#
|
37171
|
+
# The ID of the QuickSight account that is connected to the Amazon Q
|
37172
|
+
# Business application that you want to update.
|
36956
37173
|
# @return [String]
|
36957
37174
|
#
|
36958
37175
|
# @!attribute [rw] namespace
|
36959
|
-
# The
|
36960
|
-
#
|
36961
|
-
#
|
36962
|
-
#
|
37176
|
+
# The QuickSight namespace that contains the linked Amazon Q Business
|
37177
|
+
# application. If this field is left blank, the default namespace is
|
37178
|
+
# used. Currently, the default namespace is the only valid value for
|
37179
|
+
# this parameter.
|
36963
37180
|
# @return [String]
|
36964
37181
|
#
|
36965
37182
|
# @!attribute [rw] application_id
|
@@ -37184,13 +37401,13 @@ module Aws::QuickSight
|
|
37184
37401
|
# @return [String]
|
37185
37402
|
#
|
37186
37403
|
# @!attribute [rw] policy_arn
|
37187
|
-
# The ARN for the IAM policy to apply to the
|
37188
|
-
#
|
37404
|
+
# The ARN for the IAM policy to apply to the QuickSight users and
|
37405
|
+
# groups specified in this assignment.
|
37189
37406
|
# @return [String]
|
37190
37407
|
#
|
37191
37408
|
# @!attribute [rw] identities
|
37192
|
-
# The
|
37193
|
-
#
|
37409
|
+
# The QuickSight users, groups, or both that you want to assign the
|
37410
|
+
# policy to.
|
37194
37411
|
# @return [Hash<String,Array<String>>]
|
37195
37412
|
#
|
37196
37413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -37215,12 +37432,12 @@ module Aws::QuickSight
|
|
37215
37432
|
# @return [String]
|
37216
37433
|
#
|
37217
37434
|
# @!attribute [rw] policy_arn
|
37218
|
-
# The ARN for the IAM policy applied to the
|
37219
|
-
#
|
37435
|
+
# The ARN for the IAM policy applied to the QuickSight users and
|
37436
|
+
# groups specified in this assignment.
|
37220
37437
|
# @return [String]
|
37221
37438
|
#
|
37222
37439
|
# @!attribute [rw] identities
|
37223
|
-
# The
|
37440
|
+
# The QuickSight users, groups, or both that the IAM policy is
|
37224
37441
|
# assigned to.
|
37225
37442
|
# @return [Hash<String,Array<String>>]
|
37226
37443
|
#
|
@@ -37368,7 +37585,7 @@ module Aws::QuickSight
|
|
37368
37585
|
#
|
37369
37586
|
# @!attribute [rw] key_registration
|
37370
37587
|
# A list of `RegisteredCustomerManagedKey` objects to be updated to
|
37371
|
-
# the
|
37588
|
+
# the QuickSight account.
|
37372
37589
|
# @return [Array<Types::RegisteredCustomerManagedKey>]
|
37373
37590
|
#
|
37374
37591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateKeyRegistrationRequest AWS API Documentation
|
@@ -37405,13 +37622,13 @@ module Aws::QuickSight
|
|
37405
37622
|
end
|
37406
37623
|
|
37407
37624
|
# @!attribute [rw] aws_account_id
|
37408
|
-
# The Amazon Web Services account ID associated with your
|
37409
|
-
#
|
37625
|
+
# The Amazon Web Services account ID associated with your QuickSight
|
37626
|
+
# subscription.
|
37410
37627
|
# @return [String]
|
37411
37628
|
#
|
37412
37629
|
# @!attribute [rw] public_sharing_enabled
|
37413
37630
|
# A Boolean value that indicates whether public sharing is turned on
|
37414
|
-
# for an
|
37631
|
+
# for an QuickSight account.
|
37415
37632
|
# @return [Boolean]
|
37416
37633
|
#
|
37417
37634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdatePublicSharingSettingsRequest AWS API Documentation
|
@@ -37446,9 +37663,9 @@ module Aws::QuickSight
|
|
37446
37663
|
# @return [String]
|
37447
37664
|
#
|
37448
37665
|
# @!attribute [rw] personalization_mode
|
37449
|
-
# An option to allow
|
37450
|
-
#
|
37451
|
-
#
|
37666
|
+
# An option to allow QuickSight to customize data stories with user
|
37667
|
+
# specific metadata, specifically location and job information, in
|
37668
|
+
# your IAM Identity Center instance.
|
37452
37669
|
# @return [String]
|
37453
37670
|
#
|
37454
37671
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateQPersonalizationConfigurationRequest AWS API Documentation
|
@@ -37484,13 +37701,13 @@ module Aws::QuickSight
|
|
37484
37701
|
end
|
37485
37702
|
|
37486
37703
|
# @!attribute [rw] aws_account_id
|
37487
|
-
# The ID of the Amazon Web Services account that contains the
|
37704
|
+
# The ID of the Amazon Web Services account that contains the
|
37488
37705
|
# QuickSight Q Search configuration that you want to update.
|
37489
37706
|
# @return [String]
|
37490
37707
|
#
|
37491
37708
|
# @!attribute [rw] q_search_status
|
37492
|
-
# The status of the
|
37493
|
-
#
|
37709
|
+
# The status of the QuickSight Q Search configuration that the user
|
37710
|
+
# wants to update.
|
37494
37711
|
# @return [String]
|
37495
37712
|
#
|
37496
37713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateQuickSightQSearchConfigurationRequest AWS API Documentation
|
@@ -37503,7 +37720,7 @@ module Aws::QuickSight
|
|
37503
37720
|
end
|
37504
37721
|
|
37505
37722
|
# @!attribute [rw] q_search_status
|
37506
|
-
# The status of the
|
37723
|
+
# The status of the QuickSight Q Search configuration.
|
37507
37724
|
# @return [String]
|
37508
37725
|
#
|
37509
37726
|
# @!attribute [rw] request_id
|
@@ -37794,7 +38011,7 @@ module Aws::QuickSight
|
|
37794
38011
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
37795
38012
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
37796
38013
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
37797
|
-
# any
|
38014
|
+
# any QuickSight-supported Amazon Web Services Region;.
|
37798
38015
|
#
|
37799
38016
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
37800
38017
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -38002,7 +38219,7 @@ module Aws::QuickSight
|
|
38002
38219
|
#
|
38003
38220
|
# @!attribute [rw] base_theme_id
|
38004
38221
|
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
38005
|
-
# inherits from. All themes initially inherit from a default
|
38222
|
+
# inherits from. All themes initially inherit from a default
|
38006
38223
|
# QuickSight theme.
|
38007
38224
|
# @return [String]
|
38008
38225
|
#
|
@@ -38331,9 +38548,9 @@ module Aws::QuickSight
|
|
38331
38548
|
# QuickSight settings.
|
38332
38549
|
#
|
38333
38550
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
38334
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
38335
|
-
#
|
38336
|
-
#
|
38551
|
+
# Reader role. Reader Pros have access to Amazon Q in QuickSight,
|
38552
|
+
# can build stories with Amazon Q, and can generate executive
|
38553
|
+
# summaries from dashboards.
|
38337
38554
|
#
|
38338
38555
|
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
38339
38556
|
# Author role. Author Pros can author dashboards with natural
|
@@ -38344,8 +38561,8 @@ module Aws::QuickSight
|
|
38344
38561
|
# QuickSight administrative settings. Admin Pro users are billed at
|
38345
38562
|
# Author Pro pricing.
|
38346
38563
|
#
|
38347
|
-
# The name of the
|
38348
|
-
#
|
38564
|
+
# The name of the QuickSight role is invisible to the user except for
|
38565
|
+
# the console screens dealing with permissions.
|
38349
38566
|
# @return [String]
|
38350
38567
|
#
|
38351
38568
|
# @!attribute [rw] custom_permissions_name
|
@@ -38364,17 +38581,17 @@ module Aws::QuickSight
|
|
38364
38581
|
#
|
38365
38582
|
# A set of custom permissions includes any combination of these
|
38366
38583
|
# restrictions. Currently, you need to create the profile names for
|
38367
|
-
# custom permission sets by using the
|
38368
|
-
#
|
38369
|
-
# permissions to a
|
38584
|
+
# custom permission sets by using the QuickSight console. Then, you
|
38585
|
+
# use the `RegisterUser` API operation to assign the named set of
|
38586
|
+
# permissions to a QuickSight user.
|
38370
38587
|
#
|
38371
|
-
#
|
38372
|
-
#
|
38373
|
-
#
|
38374
|
-
#
|
38588
|
+
# QuickSight custom permissions are applied through IAM policies.
|
38589
|
+
# Therefore, they override the permissions typically granted by
|
38590
|
+
# assigning QuickSight users to one of the default security cohorts in
|
38591
|
+
# QuickSight (admin, author, reader).
|
38375
38592
|
#
|
38376
|
-
# This feature is available only to
|
38377
|
-
#
|
38593
|
+
# This feature is available only to QuickSight Enterprise edition
|
38594
|
+
# subscriptions.
|
38378
38595
|
# @return [String]
|
38379
38596
|
#
|
38380
38597
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -38387,9 +38604,9 @@ module Aws::QuickSight
|
|
38387
38604
|
#
|
38388
38605
|
# @!attribute [rw] external_login_federation_provider_type
|
38389
38606
|
# The type of supported external login provider that provides identity
|
38390
|
-
# to let a user federate into
|
38391
|
-
#
|
38392
|
-
#
|
38607
|
+
# to let a user federate into QuickSight with an associated Identity
|
38608
|
+
# and Access Management(IAM) role. The type of supported external
|
38609
|
+
# login provider can be one of the following.
|
38393
38610
|
#
|
38394
38611
|
# * `COGNITO`: Amazon Cognito. The provider URL is
|
38395
38612
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
@@ -38408,10 +38625,10 @@ module Aws::QuickSight
|
|
38408
38625
|
#
|
38409
38626
|
# @!attribute [rw] custom_federation_provider_url
|
38410
38627
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
38411
|
-
# identity to let a user federate into
|
38412
|
-
#
|
38413
|
-
#
|
38414
|
-
#
|
38628
|
+
# identity to let a user federate into QuickSight with an associated
|
38629
|
+
# Identity and Access Management(IAM) role. This parameter should only
|
38630
|
+
# be used when `ExternalLoginFederationProviderType` parameter is set
|
38631
|
+
# to `CUSTOM_OIDC`.
|
38415
38632
|
# @return [String]
|
38416
38633
|
#
|
38417
38634
|
# @!attribute [rw] external_login_id
|
@@ -38585,9 +38802,9 @@ module Aws::QuickSight
|
|
38585
38802
|
#
|
38586
38803
|
# @!attribute [rw] user_name
|
38587
38804
|
# The user's user name. This value is required if you are registering
|
38588
|
-
# a user that will be managed in
|
38589
|
-
#
|
38590
|
-
#
|
38805
|
+
# a user that will be managed in QuickSight. In the output, the value
|
38806
|
+
# for `UserName` is `N/A` when the value for `IdentityType` is `IAM`
|
38807
|
+
# and the corresponding IAM user is deleted.
|
38591
38808
|
# @return [String]
|
38592
38809
|
#
|
38593
38810
|
# @!attribute [rw] email
|
@@ -38604,12 +38821,12 @@ module Aws::QuickSight
|
|
38604
38821
|
# and dashboards.
|
38605
38822
|
#
|
38606
38823
|
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
38607
|
-
#
|
38824
|
+
# QuickSight settings.
|
38608
38825
|
#
|
38609
38826
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
38610
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
38611
|
-
#
|
38612
|
-
#
|
38827
|
+
# Reader role. Reader Pros have access to Amazon Q in QuickSight,
|
38828
|
+
# can build stories with Amazon Q, and can generate executive
|
38829
|
+
# summaries from dashboards.
|
38613
38830
|
#
|
38614
38831
|
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
38615
38832
|
# Author role. Author Pros can author dashboards with natural
|