aws-sdk-quicksight 1.109.0 → 1.110.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +143 -29
- data/lib/aws-sdk-quicksight/client_api.rb +46 -1
- data/lib/aws-sdk-quicksight/endpoints.rb +14 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-quicksight/types.rb +262 -33
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +54 -9
- data/sig/types.rbs +44 -9
- metadata +2 -2
@@ -714,12 +714,42 @@ module Aws::QuickSight
|
|
714
714
|
# The Q search bar that you want to use for anonymous user embedding.
|
715
715
|
# @return [Types::AnonymousUserQSearchBarEmbeddingConfiguration]
|
716
716
|
#
|
717
|
+
# @!attribute [rw] generative_qn_a
|
718
|
+
# The Generative Q&A experience that you want to use for anonymous
|
719
|
+
# user embedding.
|
720
|
+
# @return [Types::AnonymousUserGenerativeQnAEmbeddingConfiguration]
|
721
|
+
#
|
717
722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
|
718
723
|
#
|
719
724
|
class AnonymousUserEmbeddingExperienceConfiguration < Struct.new(
|
720
725
|
:dashboard,
|
721
726
|
:dashboard_visual,
|
722
|
-
:q_search_bar
|
727
|
+
:q_search_bar,
|
728
|
+
:generative_qn_a)
|
729
|
+
SENSITIVE = []
|
730
|
+
include Aws::Structure
|
731
|
+
end
|
732
|
+
|
733
|
+
# The settings that you want to use for the Generative Q&A
|
734
|
+
# experience.
|
735
|
+
#
|
736
|
+
# @!attribute [rw] initial_topic_id
|
737
|
+
# The Amazon QuickSight Q topic ID of the new reader experience topic
|
738
|
+
# that you want the anonymous user to see first. This ID is included
|
739
|
+
# in the output URL. When the URL in response is accessed, Amazon
|
740
|
+
# QuickSight renders the Generative Q&A experience with this new
|
741
|
+
# reader experience topic pre selected.
|
742
|
+
#
|
743
|
+
# The Amazon Resource Name (ARN) of this Q new reader experience topic
|
744
|
+
# must be included in the `AuthorizedResourceArns` parameter.
|
745
|
+
# Otherwise, the request fails with an
|
746
|
+
# `InvalidParameterValueException` error.
|
747
|
+
# @return [String]
|
748
|
+
#
|
749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserGenerativeQnAEmbeddingConfiguration AWS API Documentation
|
750
|
+
#
|
751
|
+
class AnonymousUserGenerativeQnAEmbeddingConfiguration < Struct.new(
|
752
|
+
:initial_topic_id)
|
723
753
|
SENSITIVE = []
|
724
754
|
include Aws::Structure
|
725
755
|
end
|
@@ -727,14 +757,14 @@ module Aws::QuickSight
|
|
727
757
|
# The settings that you want to use with the Q search bar.
|
728
758
|
#
|
729
759
|
# @!attribute [rw] initial_topic_id
|
730
|
-
# The QuickSight Q topic ID of the topic that you want
|
731
|
-
# user to see first. This ID is included in the output
|
732
|
-
# URL in response is accessed, Amazon QuickSight renders
|
733
|
-
# bar with this topic pre-selected.
|
760
|
+
# The Amazon QuickSight Q topic ID of the legacy topic that you want
|
761
|
+
# the anonymous user to see first. This ID is included in the output
|
762
|
+
# URL. When the URL in response is accessed, Amazon QuickSight renders
|
763
|
+
# the Q search bar with this legacy topic pre-selected.
|
734
764
|
#
|
735
|
-
# The Amazon Resource Name (ARN) of this Q topic must be
|
736
|
-
# the `AuthorizedResourceArns` parameter. Otherwise, the
|
737
|
-
#
|
765
|
+
# The Amazon Resource Name (ARN) of this Q legacy topic must be
|
766
|
+
# included in the `AuthorizedResourceArns` parameter. Otherwise, the
|
767
|
+
# request fails with an `InvalidParameterValueException` error.
|
738
768
|
# @return [String]
|
739
769
|
#
|
740
770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserQSearchBarEmbeddingConfiguration AWS API Documentation
|
@@ -4500,9 +4530,10 @@ module Aws::QuickSight
|
|
4500
4530
|
#
|
4501
4531
|
# @!attribute [rw] admin_group
|
4502
4532
|
# The admin group associated with your Active Directory or IAM
|
4503
|
-
# Identity Center account.
|
4504
|
-
# `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is
|
4505
|
-
# authentication method of the new Amazon QuickSight
|
4533
|
+
# Identity Center account. Either this field or the `AdminProGroup`
|
4534
|
+
# field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is
|
4535
|
+
# the selected authentication method of the new Amazon QuickSight
|
4536
|
+
# account.
|
4506
4537
|
#
|
4507
4538
|
# For more information about using IAM Identity Center in Amazon
|
4508
4539
|
# QuickSight, see [Using IAM Identity Center with Amazon QuickSight
|
@@ -4551,6 +4582,59 @@ module Aws::QuickSight
|
|
4551
4582
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
4552
4583
|
# @return [Array<String>]
|
4553
4584
|
#
|
4585
|
+
# @!attribute [rw] admin_pro_group
|
4586
|
+
# The admin pro group associated with your Active Directory or IAM
|
4587
|
+
# Identity Center account. Either this field or the `AdminGroup` field
|
4588
|
+
# is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
4589
|
+
# selected authentication method of the new Amazon QuickSight account.
|
4590
|
+
#
|
4591
|
+
# For more information about using IAM Identity Center in Amazon
|
4592
|
+
# QuickSight, see [Using IAM Identity Center with Amazon QuickSight
|
4593
|
+
# Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
|
4594
|
+
# information about using Active Directory in Amazon QuickSight, see
|
4595
|
+
# [Using Active Directory with Amazon QuickSight Enterprise
|
4596
|
+
# Edition][2] in the Amazon QuickSight User Guide.
|
4597
|
+
#
|
4598
|
+
#
|
4599
|
+
#
|
4600
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
|
4601
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
4602
|
+
# @return [Array<String>]
|
4603
|
+
#
|
4604
|
+
# @!attribute [rw] author_pro_group
|
4605
|
+
# The author pro group associated with your Active Directory or IAM
|
4606
|
+
# Identity Center account.
|
4607
|
+
#
|
4608
|
+
# For more information about using IAM Identity Center in Amazon
|
4609
|
+
# QuickSight, see [Using IAM Identity Center with Amazon QuickSight
|
4610
|
+
# Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
|
4611
|
+
# information about using Active Directory in Amazon QuickSight, see
|
4612
|
+
# [Using Active Directory with Amazon QuickSight Enterprise
|
4613
|
+
# Edition][2] in the Amazon QuickSight User Guide.
|
4614
|
+
#
|
4615
|
+
#
|
4616
|
+
#
|
4617
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
|
4618
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
4619
|
+
# @return [Array<String>]
|
4620
|
+
#
|
4621
|
+
# @!attribute [rw] reader_pro_group
|
4622
|
+
# The reader pro group associated with your Active Directory or IAM
|
4623
|
+
# Identity Center account.
|
4624
|
+
#
|
4625
|
+
# For more information about using IAM Identity Center in Amazon
|
4626
|
+
# QuickSight, see [Using IAM Identity Center with Amazon QuickSight
|
4627
|
+
# Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
|
4628
|
+
# information about using Active Directory in Amazon QuickSight, see
|
4629
|
+
# [Using Active Directory with Amazon QuickSight Enterprise
|
4630
|
+
# Edition][2] in the Amazon QuickSight User Guide.
|
4631
|
+
#
|
4632
|
+
#
|
4633
|
+
#
|
4634
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
|
4635
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
4636
|
+
# @return [Array<String>]
|
4637
|
+
#
|
4554
4638
|
# @!attribute [rw] first_name
|
4555
4639
|
# The first name of the author of the Amazon QuickSight account to use
|
4556
4640
|
# for future communications. This field is required if
|
@@ -4597,6 +4681,9 @@ module Aws::QuickSight
|
|
4597
4681
|
:admin_group,
|
4598
4682
|
:author_group,
|
4599
4683
|
:reader_group,
|
4684
|
+
:admin_pro_group,
|
4685
|
+
:author_pro_group,
|
4686
|
+
:reader_pro_group,
|
4600
4687
|
:first_name,
|
4601
4688
|
:last_name,
|
4602
4689
|
:email_address,
|
@@ -15345,6 +15432,25 @@ module Aws::QuickSight
|
|
15345
15432
|
include Aws::Structure
|
15346
15433
|
end
|
15347
15434
|
|
15435
|
+
# The color configuration of a `GaugeChartVisual`.
|
15436
|
+
#
|
15437
|
+
# @!attribute [rw] foreground_color
|
15438
|
+
# The foreground color configuration of a `GaugeChartVisual`.
|
15439
|
+
# @return [String]
|
15440
|
+
#
|
15441
|
+
# @!attribute [rw] background_color
|
15442
|
+
# The background color configuration of a `GaugeChartVisual`.
|
15443
|
+
# @return [String]
|
15444
|
+
#
|
15445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GaugeChartColorConfiguration AWS API Documentation
|
15446
|
+
#
|
15447
|
+
class GaugeChartColorConfiguration < Struct.new(
|
15448
|
+
:foreground_color,
|
15449
|
+
:background_color)
|
15450
|
+
SENSITIVE = []
|
15451
|
+
include Aws::Structure
|
15452
|
+
end
|
15453
|
+
|
15348
15454
|
# The conditional formatting of a `GaugeChartVisual`.
|
15349
15455
|
#
|
15350
15456
|
# @!attribute [rw] conditional_formatting_options
|
@@ -15403,6 +15509,10 @@ module Aws::QuickSight
|
|
15403
15509
|
# The visual palette configuration of a `GaugeChartVisual`.
|
15404
15510
|
# @return [Types::VisualPalette]
|
15405
15511
|
#
|
15512
|
+
# @!attribute [rw] color_configuration
|
15513
|
+
# The color configuration of a `GaugeChartVisual`.
|
15514
|
+
# @return [Types::GaugeChartColorConfiguration]
|
15515
|
+
#
|
15406
15516
|
# @!attribute [rw] interactions
|
15407
15517
|
# The general visual interactions setup for a visual.
|
15408
15518
|
# @return [Types::VisualInteractionOptions]
|
@@ -15415,6 +15525,7 @@ module Aws::QuickSight
|
|
15415
15525
|
:data_labels,
|
15416
15526
|
:tooltip_options,
|
15417
15527
|
:visual_palette,
|
15528
|
+
:color_configuration,
|
15418
15529
|
:interactions)
|
15419
15530
|
SENSITIVE = []
|
15420
15531
|
include Aws::Structure
|
@@ -15662,10 +15773,10 @@ module Aws::QuickSight
|
|
15662
15773
|
# @return [String]
|
15663
15774
|
#
|
15664
15775
|
# @!attribute [rw] experience_configuration
|
15665
|
-
# The experience you
|
15776
|
+
# The experience that you want to embed. For registered users, you can
|
15666
15777
|
# embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the
|
15667
|
-
# Amazon QuickSight Q search bar,
|
15668
|
-
# console.
|
15778
|
+
# Amazon QuickSight Q search bar, the Amazon QuickSight Generative
|
15779
|
+
# Q&A experience, or the entire Amazon QuickSight console.
|
15669
15780
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
15670
15781
|
#
|
15671
15782
|
# @!attribute [rw] allowed_domains
|
@@ -15695,7 +15806,7 @@ module Aws::QuickSight
|
|
15695
15806
|
|
15696
15807
|
# @!attribute [rw] embed_url
|
15697
15808
|
# The embed URL for the Amazon QuickSight dashboard, visual, Q search
|
15698
|
-
# bar, or console.
|
15809
|
+
# bar, Generative Q&A experience, or console.
|
15699
15810
|
# @return [String]
|
15700
15811
|
#
|
15701
15812
|
# @!attribute [rw] status
|
@@ -23570,13 +23681,8 @@ module Aws::QuickSight
|
|
23570
23681
|
end
|
23571
23682
|
|
23572
23683
|
# @!attribute [rw] identity_type
|
23573
|
-
#
|
23574
|
-
#
|
23575
|
-
#
|
23576
|
-
# * `IAM`: A user whose identity maps to an existing IAM user or role.
|
23577
|
-
#
|
23578
|
-
# * `QUICKSIGHT`: A user whose identity is owned and managed
|
23579
|
-
# internally by Amazon QuickSight.
|
23684
|
+
# The identity type that your Amazon QuickSight account uses to manage
|
23685
|
+
# the identity of users.
|
23580
23686
|
# @return [String]
|
23581
23687
|
#
|
23582
23688
|
# @!attribute [rw] email
|
@@ -23660,7 +23766,8 @@ module Aws::QuickSight
|
|
23660
23766
|
# Amazon QuickSight custom permissions are applied through IAM
|
23661
23767
|
# policies. Therefore, they override the permissions typically granted
|
23662
23768
|
# by assigning Amazon QuickSight users to one of the default security
|
23663
|
-
# cohorts in Amazon QuickSight (admin, author, reader
|
23769
|
+
# cohorts in Amazon QuickSight (admin, author, reader, admin pro,
|
23770
|
+
# author pro, reader pro).
|
23664
23771
|
#
|
23665
23772
|
# This feature is available only to Amazon QuickSight Enterprise
|
23666
23773
|
# edition subscriptions.
|
@@ -23896,13 +24003,53 @@ module Aws::QuickSight
|
|
23896
24003
|
# visuals.
|
23897
24004
|
# @return [Types::RegisteredUserDashboardVisualEmbeddingConfiguration]
|
23898
24005
|
#
|
24006
|
+
# @!attribute [rw] generative_qn_a
|
24007
|
+
# The configuration details for embedding the Generative Q&A
|
24008
|
+
# experience.
|
24009
|
+
#
|
24010
|
+
# For more information about embedding the Generative Q&A
|
24011
|
+
# experience, see [Embedding Overview][1] in the *Amazon QuickSight
|
24012
|
+
# User Guide*.
|
24013
|
+
#
|
24014
|
+
#
|
24015
|
+
#
|
24016
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
|
24017
|
+
# @return [Types::RegisteredUserGenerativeQnAEmbeddingConfiguration]
|
24018
|
+
#
|
23899
24019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
|
23900
24020
|
#
|
23901
24021
|
class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
|
23902
24022
|
:dashboard,
|
23903
24023
|
:quick_sight_console,
|
23904
24024
|
:q_search_bar,
|
23905
|
-
:dashboard_visual
|
24025
|
+
:dashboard_visual,
|
24026
|
+
:generative_qn_a)
|
24027
|
+
SENSITIVE = []
|
24028
|
+
include Aws::Structure
|
24029
|
+
end
|
24030
|
+
|
24031
|
+
# An object that provides information about the configuration of a
|
24032
|
+
# Generative Q&A experience.
|
24033
|
+
#
|
24034
|
+
# @!attribute [rw] initial_topic_id
|
24035
|
+
# The ID of the new Q reader experience topic that you want to make
|
24036
|
+
# the starting topic in the Generative Q&A experience. You can
|
24037
|
+
# find a topic ID by navigating to the Topics pane in the Amazon
|
24038
|
+
# QuickSight application and opening a topic. The ID is in the URL for
|
24039
|
+
# the topic that you open.
|
24040
|
+
#
|
24041
|
+
# If you don't specify an initial topic or you specify a legacy
|
24042
|
+
# topic, a list of all shared new reader experience topics is shown in
|
24043
|
+
# the Generative Q&A experience for your readers. When you select
|
24044
|
+
# an initial new reader experience topic, you can specify whether or
|
24045
|
+
# not readers are allowed to select other new reader experience topics
|
24046
|
+
# from the available ones in the list.
|
24047
|
+
# @return [String]
|
24048
|
+
#
|
24049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserGenerativeQnAEmbeddingConfiguration AWS API Documentation
|
24050
|
+
#
|
24051
|
+
class RegisteredUserGenerativeQnAEmbeddingConfiguration < Struct.new(
|
24052
|
+
:initial_topic_id)
|
23906
24053
|
SENSITIVE = []
|
23907
24054
|
include Aws::Structure
|
23908
24055
|
end
|
@@ -23910,15 +24057,22 @@ module Aws::QuickSight
|
|
23910
24057
|
# Information about the Q search bar embedding experience.
|
23911
24058
|
#
|
23912
24059
|
# @!attribute [rw] initial_topic_id
|
23913
|
-
# The ID of the Q topic that you want to
|
23914
|
-
# the Q search bar.
|
23915
|
-
#
|
23916
|
-
#
|
24060
|
+
# The ID of the legacy Q topic that you want to use as the starting
|
24061
|
+
# topic in the Q search bar. To locate the topic ID of the topic that
|
24062
|
+
# you want to use, open the [Amazon QuickSight console][1], navigate
|
24063
|
+
# to the **Topics** pane, and choose thre topic that you want to use.
|
24064
|
+
# The `TopicID` is located in the URL of the topic that opens. When
|
24065
|
+
# you select an initial topic, you can specify whether or not readers
|
24066
|
+
# are allowed to select other topics from the list of available
|
24067
|
+
# topics.
|
24068
|
+
#
|
24069
|
+
# If you don't specify an initial topic or if you specify a new
|
24070
|
+
# reader experience topic, a list of all shared legacy topics is shown
|
24071
|
+
# in the Q bar.
|
24072
|
+
#
|
24073
|
+
#
|
23917
24074
|
#
|
23918
|
-
#
|
23919
|
-
# is shown in the Q bar for your readers. When you select an initial
|
23920
|
-
# topic, you can specify whether or not readers are allowed to select
|
23921
|
-
# other topics from the available ones in the list.
|
24075
|
+
# [1]: https://quicksight.aws.amazon.com/
|
23922
24076
|
# @return [String]
|
23923
24077
|
#
|
23924
24078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQSearchBarEmbeddingConfiguration AWS API Documentation
|
@@ -29741,12 +29895,17 @@ module Aws::QuickSight
|
|
29741
29895
|
# The name of the topic.
|
29742
29896
|
# @return [String]
|
29743
29897
|
#
|
29898
|
+
# @!attribute [rw] user_experience_version
|
29899
|
+
# The user experience version of the topic.
|
29900
|
+
# @return [String]
|
29901
|
+
#
|
29744
29902
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicSummary AWS API Documentation
|
29745
29903
|
#
|
29746
29904
|
class TopicSummary < Struct.new(
|
29747
29905
|
:arn,
|
29748
29906
|
:topic_id,
|
29749
|
-
:name
|
29907
|
+
:name,
|
29908
|
+
:user_experience_version)
|
29750
29909
|
SENSITIVE = []
|
29751
29910
|
include Aws::Structure
|
29752
29911
|
end
|
@@ -31819,6 +31978,48 @@ module Aws::QuickSight
|
|
31819
31978
|
include Aws::Structure
|
31820
31979
|
end
|
31821
31980
|
|
31981
|
+
# @!attribute [rw] aws_account_id
|
31982
|
+
# The ID of the Amazon Web Services account that contains the SPICE
|
31983
|
+
# configuration that you want to update.
|
31984
|
+
# @return [String]
|
31985
|
+
#
|
31986
|
+
# @!attribute [rw] purchase_mode
|
31987
|
+
# Determines how SPICE capacity can be purchased. The following
|
31988
|
+
# options are available.
|
31989
|
+
#
|
31990
|
+
# * `MANUAL`: SPICE capacity can only be purchased manually.
|
31991
|
+
#
|
31992
|
+
# * `AUTO_PURCHASE`: Extra SPICE capacity is automatically purchased
|
31993
|
+
# on your behalf as needed. SPICE capacity can also be purchased
|
31994
|
+
# manually with this option.
|
31995
|
+
# @return [String]
|
31996
|
+
#
|
31997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSPICECapacityConfigurationRequest AWS API Documentation
|
31998
|
+
#
|
31999
|
+
class UpdateSPICECapacityConfigurationRequest < Struct.new(
|
32000
|
+
:aws_account_id,
|
32001
|
+
:purchase_mode)
|
32002
|
+
SENSITIVE = []
|
32003
|
+
include Aws::Structure
|
32004
|
+
end
|
32005
|
+
|
32006
|
+
# @!attribute [rw] request_id
|
32007
|
+
# The Amazon Web Services request ID for this operation.
|
32008
|
+
# @return [String]
|
32009
|
+
#
|
32010
|
+
# @!attribute [rw] status
|
32011
|
+
# The HTTP status of the request.
|
32012
|
+
# @return [Integer]
|
32013
|
+
#
|
32014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateSPICECapacityConfigurationResponse AWS API Documentation
|
32015
|
+
#
|
32016
|
+
class UpdateSPICECapacityConfigurationResponse < Struct.new(
|
32017
|
+
:request_id,
|
32018
|
+
:status)
|
32019
|
+
SENSITIVE = []
|
32020
|
+
include Aws::Structure
|
32021
|
+
end
|
32022
|
+
|
31822
32023
|
# @!attribute [rw] aws_account_id
|
31823
32024
|
# The ID of the Amazon Web Services account that contains the template
|
31824
32025
|
# alias that you're updating.
|
@@ -32435,6 +32636,20 @@ module Aws::QuickSight
|
|
32435
32636
|
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
32436
32637
|
# QuickSight settings.
|
32437
32638
|
#
|
32639
|
+
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
32640
|
+
# Reader role. Reader Pros have access to Amazon Q Business, can
|
32641
|
+
# build stories with Amazon Q, and can generate executive summaries
|
32642
|
+
# from dashboards.
|
32643
|
+
#
|
32644
|
+
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
32645
|
+
# Author role. Author Pros can author dashboards with natural
|
32646
|
+
# language with Amazon Q, build stories with Amazon Q, create Topics
|
32647
|
+
# for Q&A, and generate executive summaries from dashboards.
|
32648
|
+
#
|
32649
|
+
# * `ADMIN_PRO`: Admin Pros are Author Pros who can also manage Amazon
|
32650
|
+
# QuickSight administrative settings. Admin Pro users are billed at
|
32651
|
+
# Author Pro pricing.
|
32652
|
+
#
|
32438
32653
|
# The name of the Amazon QuickSight role is invisible to the user
|
32439
32654
|
# except for the console screens dealing with permissions.
|
32440
32655
|
# @return [String]
|
@@ -32697,6 +32912,20 @@ module Aws::QuickSight
|
|
32697
32912
|
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
32698
32913
|
# Amazon QuickSight settings.
|
32699
32914
|
#
|
32915
|
+
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
32916
|
+
# Reader role. Reader Pros have access to Amazon Q Business, can
|
32917
|
+
# build stories with Amazon Q, and can generate executive summaries
|
32918
|
+
# from dashboards.
|
32919
|
+
#
|
32920
|
+
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
32921
|
+
# Author role. Author Pros can author dashboards with natural
|
32922
|
+
# language with Amazon Q, build stories with Amazon Q, create Topics
|
32923
|
+
# for Q&A, and generate executive summaries from dashboards.
|
32924
|
+
#
|
32925
|
+
# * `ADMIN_PRO`: Admin Pros are Author Pros who can also manage Amazon
|
32926
|
+
# QuickSight administrative settings. Admin Pro users are billed at
|
32927
|
+
# Author Pro pricing.
|
32928
|
+
#
|
32700
32929
|
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
32701
32930
|
#
|
32702
32931
|
# * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
|
data/lib/aws-sdk-quicksight.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -121,7 +121,7 @@ module Aws
|
|
121
121
|
end
|
122
122
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#create_account_subscription-instance_method
|
123
123
|
def create_account_subscription: (
|
124
|
-
edition: ("STANDARD" | "ENTERPRISE" | "ENTERPRISE_AND_Q"),
|
124
|
+
?edition: ("STANDARD" | "ENTERPRISE" | "ENTERPRISE_AND_Q"),
|
125
125
|
authentication_method: ("IAM_AND_QUICKSIGHT" | "IAM_ONLY" | "ACTIVE_DIRECTORY" | "IAM_IDENTITY_CENTER"),
|
126
126
|
aws_account_id: ::String,
|
127
127
|
account_name: ::String,
|
@@ -132,6 +132,9 @@ module Aws
|
|
132
132
|
?admin_group: Array[::String],
|
133
133
|
?author_group: Array[::String],
|
134
134
|
?reader_group: Array[::String],
|
135
|
+
?admin_pro_group: Array[::String],
|
136
|
+
?author_pro_group: Array[::String],
|
137
|
+
?reader_pro_group: Array[::String],
|
135
138
|
?first_name: ::String,
|
136
139
|
?last_name: ::String,
|
137
140
|
?email_address: ::String,
|
@@ -8694,6 +8697,10 @@ module Aws
|
|
8694
8697
|
},
|
8695
8698
|
]?
|
8696
8699
|
}?,
|
8700
|
+
color_configuration: {
|
8701
|
+
foreground_color: ::String?,
|
8702
|
+
background_color: ::String?
|
8703
|
+
}?,
|
8697
8704
|
interactions: {
|
8698
8705
|
visual_menu_option: {
|
8699
8706
|
availability_status: ("ENABLED" | "DISABLED")?
|
@@ -42153,6 +42160,10 @@ module Aws
|
|
42153
42160
|
},
|
42154
42161
|
]?
|
42155
42162
|
}?,
|
42163
|
+
color_configuration: {
|
42164
|
+
foreground_color: ::String?,
|
42165
|
+
background_color: ::String?
|
42166
|
+
}?,
|
42156
42167
|
interactions: {
|
42157
42168
|
visual_menu_option: {
|
42158
42169
|
availability_status: ("ENABLED" | "DISABLED")?
|
@@ -67737,7 +67748,7 @@ module Aws
|
|
67737
67748
|
member_name: ::String,
|
67738
67749
|
aws_account_id: ::String,
|
67739
67750
|
namespace: ::String,
|
67740
|
-
role: ("ADMIN" | "AUTHOR" | "READER")
|
67751
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO")
|
67741
67752
|
) -> _CreateRoleMembershipResponseSuccess
|
67742
67753
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRoleMembershipResponseSuccess
|
67743
67754
|
|
@@ -76291,6 +76302,10 @@ module Aws
|
|
76291
76302
|
},
|
76292
76303
|
]?
|
76293
76304
|
}?,
|
76305
|
+
color_configuration: {
|
76306
|
+
foreground_color: ::String?,
|
76307
|
+
background_color: ::String?
|
76308
|
+
}?,
|
76294
76309
|
interactions: {
|
76295
76310
|
visual_menu_option: {
|
76296
76311
|
availability_status: ("ENABLED" | "DISABLED")?
|
@@ -101759,7 +101774,7 @@ module Aws
|
|
101759
101774
|
end
|
101760
101775
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#delete_role_custom_permission-instance_method
|
101761
101776
|
def delete_role_custom_permission: (
|
101762
|
-
role: ("ADMIN" | "AUTHOR" | "READER"),
|
101777
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
101763
101778
|
aws_account_id: ::String,
|
101764
101779
|
namespace: ::String
|
101765
101780
|
) -> _DeleteRoleCustomPermissionResponseSuccess
|
@@ -101773,7 +101788,7 @@ module Aws
|
|
101773
101788
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#delete_role_membership-instance_method
|
101774
101789
|
def delete_role_membership: (
|
101775
101790
|
member_name: ::String,
|
101776
|
-
role: ("ADMIN" | "AUTHOR" | "READER"),
|
101791
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
101777
101792
|
aws_account_id: ::String,
|
101778
101793
|
namespace: ::String
|
101779
101794
|
) -> _DeleteRoleMembershipResponseSuccess
|
@@ -102375,7 +102390,7 @@ module Aws
|
|
102375
102390
|
end
|
102376
102391
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#describe_role_custom_permission-instance_method
|
102377
102392
|
def describe_role_custom_permission: (
|
102378
|
-
role: ("ADMIN" | "AUTHOR" | "READER"),
|
102393
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
102379
102394
|
aws_account_id: ::String,
|
102380
102395
|
namespace: ::String
|
102381
102396
|
) -> _DescribeRoleCustomPermissionResponseSuccess
|
@@ -102609,6 +102624,9 @@ module Aws
|
|
102609
102624
|
}?,
|
102610
102625
|
q_search_bar: {
|
102611
102626
|
initial_topic_id: ::String
|
102627
|
+
}?,
|
102628
|
+
generative_qn_a: {
|
102629
|
+
initial_topic_id: ::String
|
102612
102630
|
}?
|
102613
102631
|
},
|
102614
102632
|
?allowed_domains: Array[::String]
|
@@ -102655,6 +102673,9 @@ module Aws
|
|
102655
102673
|
sheet_id: ::String,
|
102656
102674
|
visual_id: ::String
|
102657
102675
|
}
|
102676
|
+
}?,
|
102677
|
+
generative_qn_a: {
|
102678
|
+
initial_topic_id: ::String?
|
102658
102679
|
}?
|
102659
102680
|
},
|
102660
102681
|
?allowed_domains: Array[::String]
|
@@ -102969,7 +102990,7 @@ module Aws
|
|
102969
102990
|
end
|
102970
102991
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#list_role_memberships-instance_method
|
102971
102992
|
def list_role_memberships: (
|
102972
|
-
role: ("ADMIN" | "AUTHOR" | "READER"),
|
102993
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
102973
102994
|
?next_token: ::String,
|
102974
102995
|
?max_results: ::Integer,
|
102975
102996
|
aws_account_id: ::String,
|
@@ -103196,7 +103217,7 @@ module Aws
|
|
103196
103217
|
def register_user: (
|
103197
103218
|
identity_type: ("IAM" | "QUICKSIGHT" | "IAM_IDENTITY_CENTER"),
|
103198
103219
|
email: ::String,
|
103199
|
-
user_role: ("ADMIN" | "AUTHOR" | "READER" | "RESTRICTED_AUTHOR" | "RESTRICTED_READER"),
|
103220
|
+
user_role: ("ADMIN" | "AUTHOR" | "READER" | "RESTRICTED_AUTHOR" | "RESTRICTED_READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
103200
103221
|
?iam_arn: ::String,
|
103201
103222
|
?session_name: ::String,
|
103202
103223
|
aws_account_id: ::String,
|
@@ -112455,6 +112476,10 @@ module Aws
|
|
112455
112476
|
},
|
112456
112477
|
]?
|
112457
112478
|
}?,
|
112479
|
+
color_configuration: {
|
112480
|
+
foreground_color: ::String?,
|
112481
|
+
background_color: ::String?
|
112482
|
+
}?,
|
112458
112483
|
interactions: {
|
112459
112484
|
visual_menu_option: {
|
112460
112485
|
availability_status: ("ENABLED" | "DISABLED")?
|
@@ -145928,6 +145953,10 @@ module Aws
|
|
145928
145953
|
},
|
145929
145954
|
]?
|
145930
145955
|
}?,
|
145956
|
+
color_configuration: {
|
145957
|
+
foreground_color: ::String?,
|
145958
|
+
background_color: ::String?
|
145959
|
+
}?,
|
145931
145960
|
interactions: {
|
145932
145961
|
visual_menu_option: {
|
145933
145962
|
availability_status: ("ENABLED" | "DISABLED")?
|
@@ -171577,12 +171606,24 @@ module Aws
|
|
171577
171606
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#update_role_custom_permission-instance_method
|
171578
171607
|
def update_role_custom_permission: (
|
171579
171608
|
custom_permissions_name: ::String,
|
171580
|
-
role: ("ADMIN" | "AUTHOR" | "READER"),
|
171609
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
171581
171610
|
aws_account_id: ::String,
|
171582
171611
|
namespace: ::String
|
171583
171612
|
) -> _UpdateRoleCustomPermissionResponseSuccess
|
171584
171613
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRoleCustomPermissionResponseSuccess
|
171585
171614
|
|
171615
|
+
interface _UpdateSPICECapacityConfigurationResponseSuccess
|
171616
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSPICECapacityConfigurationResponse]
|
171617
|
+
def request_id: () -> ::String
|
171618
|
+
def status: () -> ::Integer
|
171619
|
+
end
|
171620
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QuickSight/Client.html#update_spice_capacity_configuration-instance_method
|
171621
|
+
def update_spice_capacity_configuration: (
|
171622
|
+
aws_account_id: ::String,
|
171623
|
+
purchase_mode: ("MANUAL" | "AUTO_PURCHASE")
|
171624
|
+
) -> _UpdateSPICECapacityConfigurationResponseSuccess
|
171625
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSPICECapacityConfigurationResponseSuccess
|
171626
|
+
|
171586
171627
|
interface _UpdateTemplateResponseSuccess
|
171587
171628
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateTemplateResponse]
|
171588
171629
|
def template_id: () -> ::String
|
@@ -180121,6 +180162,10 @@ module Aws
|
|
180121
180162
|
},
|
180122
180163
|
]?
|
180123
180164
|
}?,
|
180165
|
+
color_configuration: {
|
180166
|
+
foreground_color: ::String?,
|
180167
|
+
background_color: ::String?
|
180168
|
+
}?,
|
180124
180169
|
interactions: {
|
180125
180170
|
visual_menu_option: {
|
180126
180171
|
availability_status: ("ENABLED" | "DISABLED")?
|
@@ -205426,7 +205471,7 @@ module Aws
|
|
205426
205471
|
aws_account_id: ::String,
|
205427
205472
|
namespace: ::String,
|
205428
205473
|
email: ::String,
|
205429
|
-
role: ("ADMIN" | "AUTHOR" | "READER" | "RESTRICTED_AUTHOR" | "RESTRICTED_READER"),
|
205474
|
+
role: ("ADMIN" | "AUTHOR" | "READER" | "RESTRICTED_AUTHOR" | "RESTRICTED_READER" | "ADMIN_PRO" | "AUTHOR_PRO" | "READER_PRO"),
|
205430
205475
|
?custom_permissions_name: ::String,
|
205431
205476
|
?unapply_custom_permissions: bool,
|
205432
205477
|
?external_login_federation_provider_type: ::String,
|