aws-sdk-quicksight 1.108.0 → 1.110.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +212 -74
- 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 +4 -4
@@ -50,6 +50,7 @@ module Aws::QuickSight
|
|
50
50
|
AnonymousUserDashboardEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserDashboardEmbeddingConfiguration')
|
51
51
|
AnonymousUserDashboardVisualEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserDashboardVisualEmbeddingConfiguration')
|
52
52
|
AnonymousUserEmbeddingExperienceConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserEmbeddingExperienceConfiguration')
|
53
|
+
AnonymousUserGenerativeQnAEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserGenerativeQnAEmbeddingConfiguration')
|
53
54
|
AnonymousUserQSearchBarEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserQSearchBarEmbeddingConfiguration')
|
54
55
|
AnonymousUserSnapshotJobResult = Shapes::StructureShape.new(name: 'AnonymousUserSnapshotJobResult')
|
55
56
|
AnonymousUserSnapshotJobResultList = Shapes::ListShape.new(name: 'AnonymousUserSnapshotJobResultList')
|
@@ -791,6 +792,7 @@ module Aws::QuickSight
|
|
791
792
|
FunnelChartSortConfiguration = Shapes::StructureShape.new(name: 'FunnelChartSortConfiguration')
|
792
793
|
FunnelChartVisual = Shapes::StructureShape.new(name: 'FunnelChartVisual')
|
793
794
|
GaugeChartArcConditionalFormatting = Shapes::StructureShape.new(name: 'GaugeChartArcConditionalFormatting')
|
795
|
+
GaugeChartColorConfiguration = Shapes::StructureShape.new(name: 'GaugeChartColorConfiguration')
|
794
796
|
GaugeChartConditionalFormatting = Shapes::StructureShape.new(name: 'GaugeChartConditionalFormatting')
|
795
797
|
GaugeChartConditionalFormattingOption = Shapes::StructureShape.new(name: 'GaugeChartConditionalFormattingOption')
|
796
798
|
GaugeChartConditionalFormattingOptionList = Shapes::ListShape.new(name: 'GaugeChartConditionalFormattingOptionList')
|
@@ -1213,6 +1215,7 @@ module Aws::QuickSight
|
|
1213
1215
|
ProjectedColumnList = Shapes::ListShape.new(name: 'ProjectedColumnList')
|
1214
1216
|
PropertyRole = Shapes::StringShape.new(name: 'PropertyRole')
|
1215
1217
|
PropertyUsage = Shapes::StringShape.new(name: 'PropertyUsage')
|
1218
|
+
PurchaseMode = Shapes::StringShape.new(name: 'PurchaseMode')
|
1216
1219
|
PutDataSetRefreshPropertiesRequest = Shapes::StructureShape.new(name: 'PutDataSetRefreshPropertiesRequest')
|
1217
1220
|
PutDataSetRefreshPropertiesResponse = Shapes::StructureShape.new(name: 'PutDataSetRefreshPropertiesResponse')
|
1218
1221
|
Query = Shapes::StringShape.new(name: 'Query')
|
@@ -1263,6 +1266,7 @@ module Aws::QuickSight
|
|
1263
1266
|
RegisteredUserDashboardFeatureConfigurations = Shapes::StructureShape.new(name: 'RegisteredUserDashboardFeatureConfigurations')
|
1264
1267
|
RegisteredUserDashboardVisualEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserDashboardVisualEmbeddingConfiguration')
|
1265
1268
|
RegisteredUserEmbeddingExperienceConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserEmbeddingExperienceConfiguration')
|
1269
|
+
RegisteredUserGenerativeQnAEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserGenerativeQnAEmbeddingConfiguration')
|
1266
1270
|
RegisteredUserQSearchBarEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserQSearchBarEmbeddingConfiguration')
|
1267
1271
|
RegisteredUserQuickSightConsoleEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserQuickSightConsoleEmbeddingConfiguration')
|
1268
1272
|
RelationalTable = Shapes::StructureShape.new(name: 'RelationalTable')
|
@@ -1715,6 +1719,8 @@ module Aws::QuickSight
|
|
1715
1719
|
UpdateResourcePermissionList = Shapes::ListShape.new(name: 'UpdateResourcePermissionList')
|
1716
1720
|
UpdateRoleCustomPermissionRequest = Shapes::StructureShape.new(name: 'UpdateRoleCustomPermissionRequest')
|
1717
1721
|
UpdateRoleCustomPermissionResponse = Shapes::StructureShape.new(name: 'UpdateRoleCustomPermissionResponse')
|
1722
|
+
UpdateSPICECapacityConfigurationRequest = Shapes::StructureShape.new(name: 'UpdateSPICECapacityConfigurationRequest')
|
1723
|
+
UpdateSPICECapacityConfigurationResponse = Shapes::StructureShape.new(name: 'UpdateSPICECapacityConfigurationResponse')
|
1718
1724
|
UpdateTemplateAliasRequest = Shapes::StructureShape.new(name: 'UpdateTemplateAliasRequest')
|
1719
1725
|
UpdateTemplateAliasResponse = Shapes::StructureShape.new(name: 'UpdateTemplateAliasResponse')
|
1720
1726
|
UpdateTemplatePermissionsRequest = Shapes::StructureShape.new(name: 'UpdateTemplatePermissionsRequest')
|
@@ -1940,8 +1946,12 @@ module Aws::QuickSight
|
|
1940
1946
|
AnonymousUserEmbeddingExperienceConfiguration.add_member(:dashboard, Shapes::ShapeRef.new(shape: AnonymousUserDashboardEmbeddingConfiguration, location_name: "Dashboard"))
|
1941
1947
|
AnonymousUserEmbeddingExperienceConfiguration.add_member(:dashboard_visual, Shapes::ShapeRef.new(shape: AnonymousUserDashboardVisualEmbeddingConfiguration, location_name: "DashboardVisual"))
|
1942
1948
|
AnonymousUserEmbeddingExperienceConfiguration.add_member(:q_search_bar, Shapes::ShapeRef.new(shape: AnonymousUserQSearchBarEmbeddingConfiguration, location_name: "QSearchBar"))
|
1949
|
+
AnonymousUserEmbeddingExperienceConfiguration.add_member(:generative_qn_a, Shapes::ShapeRef.new(shape: AnonymousUserGenerativeQnAEmbeddingConfiguration, location_name: "GenerativeQnA"))
|
1943
1950
|
AnonymousUserEmbeddingExperienceConfiguration.struct_class = Types::AnonymousUserEmbeddingExperienceConfiguration
|
1944
1951
|
|
1952
|
+
AnonymousUserGenerativeQnAEmbeddingConfiguration.add_member(:initial_topic_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "InitialTopicId"))
|
1953
|
+
AnonymousUserGenerativeQnAEmbeddingConfiguration.struct_class = Types::AnonymousUserGenerativeQnAEmbeddingConfiguration
|
1954
|
+
|
1945
1955
|
AnonymousUserQSearchBarEmbeddingConfiguration.add_member(:initial_topic_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "InitialTopicId"))
|
1946
1956
|
AnonymousUserQSearchBarEmbeddingConfiguration.struct_class = Types::AnonymousUserQSearchBarEmbeddingConfiguration
|
1947
1957
|
|
@@ -2780,7 +2790,7 @@ module Aws::QuickSight
|
|
2780
2790
|
CreateAccountCustomizationResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
2781
2791
|
CreateAccountCustomizationResponse.struct_class = Types::CreateAccountCustomizationResponse
|
2782
2792
|
|
2783
|
-
CreateAccountSubscriptionRequest.add_member(:edition, Shapes::ShapeRef.new(shape: Edition,
|
2793
|
+
CreateAccountSubscriptionRequest.add_member(:edition, Shapes::ShapeRef.new(shape: Edition, location_name: "Edition"))
|
2784
2794
|
CreateAccountSubscriptionRequest.add_member(:authentication_method, Shapes::ShapeRef.new(shape: AuthenticationMethodOption, required: true, location_name: "AuthenticationMethod"))
|
2785
2795
|
CreateAccountSubscriptionRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
2786
2796
|
CreateAccountSubscriptionRequest.add_member(:account_name, Shapes::ShapeRef.new(shape: AccountName, required: true, location_name: "AccountName"))
|
@@ -2791,6 +2801,9 @@ module Aws::QuickSight
|
|
2791
2801
|
CreateAccountSubscriptionRequest.add_member(:admin_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "AdminGroup"))
|
2792
2802
|
CreateAccountSubscriptionRequest.add_member(:author_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "AuthorGroup"))
|
2793
2803
|
CreateAccountSubscriptionRequest.add_member(:reader_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "ReaderGroup"))
|
2804
|
+
CreateAccountSubscriptionRequest.add_member(:admin_pro_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "AdminProGroup"))
|
2805
|
+
CreateAccountSubscriptionRequest.add_member(:author_pro_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "AuthorProGroup"))
|
2806
|
+
CreateAccountSubscriptionRequest.add_member(:reader_pro_group, Shapes::ShapeRef.new(shape: GroupsList, location_name: "ReaderProGroup"))
|
2794
2807
|
CreateAccountSubscriptionRequest.add_member(:first_name, Shapes::ShapeRef.new(shape: String, location_name: "FirstName"))
|
2795
2808
|
CreateAccountSubscriptionRequest.add_member(:last_name, Shapes::ShapeRef.new(shape: String, location_name: "LastName"))
|
2796
2809
|
CreateAccountSubscriptionRequest.add_member(:email_address, Shapes::ShapeRef.new(shape: String, location_name: "EmailAddress"))
|
@@ -4936,6 +4949,10 @@ module Aws::QuickSight
|
|
4936
4949
|
GaugeChartArcConditionalFormatting.add_member(:foreground_color, Shapes::ShapeRef.new(shape: ConditionalFormattingColor, location_name: "ForegroundColor"))
|
4937
4950
|
GaugeChartArcConditionalFormatting.struct_class = Types::GaugeChartArcConditionalFormatting
|
4938
4951
|
|
4952
|
+
GaugeChartColorConfiguration.add_member(:foreground_color, Shapes::ShapeRef.new(shape: HexColor, location_name: "ForegroundColor"))
|
4953
|
+
GaugeChartColorConfiguration.add_member(:background_color, Shapes::ShapeRef.new(shape: HexColor, location_name: "BackgroundColor"))
|
4954
|
+
GaugeChartColorConfiguration.struct_class = Types::GaugeChartColorConfiguration
|
4955
|
+
|
4939
4956
|
GaugeChartConditionalFormatting.add_member(:conditional_formatting_options, Shapes::ShapeRef.new(shape: GaugeChartConditionalFormattingOptionList, location_name: "ConditionalFormattingOptions"))
|
4940
4957
|
GaugeChartConditionalFormatting.struct_class = Types::GaugeChartConditionalFormatting
|
4941
4958
|
|
@@ -4950,6 +4967,7 @@ module Aws::QuickSight
|
|
4950
4967
|
GaugeChartConfiguration.add_member(:data_labels, Shapes::ShapeRef.new(shape: DataLabelOptions, location_name: "DataLabels"))
|
4951
4968
|
GaugeChartConfiguration.add_member(:tooltip_options, Shapes::ShapeRef.new(shape: TooltipOptions, location_name: "TooltipOptions"))
|
4952
4969
|
GaugeChartConfiguration.add_member(:visual_palette, Shapes::ShapeRef.new(shape: VisualPalette, location_name: "VisualPalette"))
|
4970
|
+
GaugeChartConfiguration.add_member(:color_configuration, Shapes::ShapeRef.new(shape: GaugeChartColorConfiguration, location_name: "ColorConfiguration"))
|
4953
4971
|
GaugeChartConfiguration.add_member(:interactions, Shapes::ShapeRef.new(shape: VisualInteractionOptions, location_name: "Interactions"))
|
4954
4972
|
GaugeChartConfiguration.struct_class = Types::GaugeChartConfiguration
|
4955
4973
|
|
@@ -6660,8 +6678,12 @@ module Aws::QuickSight
|
|
6660
6678
|
RegisteredUserEmbeddingExperienceConfiguration.add_member(:quick_sight_console, Shapes::ShapeRef.new(shape: RegisteredUserQuickSightConsoleEmbeddingConfiguration, location_name: "QuickSightConsole"))
|
6661
6679
|
RegisteredUserEmbeddingExperienceConfiguration.add_member(:q_search_bar, Shapes::ShapeRef.new(shape: RegisteredUserQSearchBarEmbeddingConfiguration, location_name: "QSearchBar"))
|
6662
6680
|
RegisteredUserEmbeddingExperienceConfiguration.add_member(:dashboard_visual, Shapes::ShapeRef.new(shape: RegisteredUserDashboardVisualEmbeddingConfiguration, location_name: "DashboardVisual"))
|
6681
|
+
RegisteredUserEmbeddingExperienceConfiguration.add_member(:generative_qn_a, Shapes::ShapeRef.new(shape: RegisteredUserGenerativeQnAEmbeddingConfiguration, location_name: "GenerativeQnA"))
|
6663
6682
|
RegisteredUserEmbeddingExperienceConfiguration.struct_class = Types::RegisteredUserEmbeddingExperienceConfiguration
|
6664
6683
|
|
6684
|
+
RegisteredUserGenerativeQnAEmbeddingConfiguration.add_member(:initial_topic_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "InitialTopicId"))
|
6685
|
+
RegisteredUserGenerativeQnAEmbeddingConfiguration.struct_class = Types::RegisteredUserGenerativeQnAEmbeddingConfiguration
|
6686
|
+
|
6665
6687
|
RegisteredUserQSearchBarEmbeddingConfiguration.add_member(:initial_topic_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "InitialTopicId"))
|
6666
6688
|
RegisteredUserQSearchBarEmbeddingConfiguration.struct_class = Types::RegisteredUserQSearchBarEmbeddingConfiguration
|
6667
6689
|
|
@@ -7872,6 +7894,7 @@ module Aws::QuickSight
|
|
7872
7894
|
TopicSummary.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
7873
7895
|
TopicSummary.add_member(:topic_id, Shapes::ShapeRef.new(shape: TopicId, location_name: "TopicId"))
|
7874
7896
|
TopicSummary.add_member(:name, Shapes::ShapeRef.new(shape: ResourceName, location_name: "Name"))
|
7897
|
+
TopicSummary.add_member(:user_experience_version, Shapes::ShapeRef.new(shape: TopicUserExperienceVersion, location_name: "UserExperienceVersion"))
|
7875
7898
|
TopicSummary.struct_class = Types::TopicSummary
|
7876
7899
|
|
7877
7900
|
TotalAggregationComputation.add_member(:computation_id, Shapes::ShapeRef.new(shape: ShortRestrictiveResourceId, required: true, location_name: "ComputationId"))
|
@@ -8292,6 +8315,14 @@ module Aws::QuickSight
|
|
8292
8315
|
UpdateRoleCustomPermissionResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location_name: "Status"))
|
8293
8316
|
UpdateRoleCustomPermissionResponse.struct_class = Types::UpdateRoleCustomPermissionResponse
|
8294
8317
|
|
8318
|
+
UpdateSPICECapacityConfigurationRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
8319
|
+
UpdateSPICECapacityConfigurationRequest.add_member(:purchase_mode, Shapes::ShapeRef.new(shape: PurchaseMode, required: true, location_name: "PurchaseMode"))
|
8320
|
+
UpdateSPICECapacityConfigurationRequest.struct_class = Types::UpdateSPICECapacityConfigurationRequest
|
8321
|
+
|
8322
|
+
UpdateSPICECapacityConfigurationResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
8323
|
+
UpdateSPICECapacityConfigurationResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
8324
|
+
UpdateSPICECapacityConfigurationResponse.struct_class = Types::UpdateSPICECapacityConfigurationResponse
|
8325
|
+
|
8295
8326
|
UpdateTemplateAliasRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
8296
8327
|
UpdateTemplateAliasRequest.add_member(:template_id, Shapes::ShapeRef.new(shape: ShortRestrictiveResourceId, required: true, location: "uri", location_name: "TemplateId"))
|
8297
8328
|
UpdateTemplateAliasRequest.add_member(:alias_name, Shapes::ShapeRef.new(shape: AliasName, required: true, location: "uri", location_name: "AliasName"))
|
@@ -8684,6 +8715,7 @@ module Aws::QuickSight
|
|
8684
8715
|
"endpointPrefix" => "quicksight",
|
8685
8716
|
"jsonVersion" => "1.0",
|
8686
8717
|
"protocol" => "rest-json",
|
8718
|
+
"protocols" => ["rest-json"],
|
8687
8719
|
"serviceFullName" => "Amazon QuickSight",
|
8688
8720
|
"serviceId" => "QuickSight",
|
8689
8721
|
"signatureVersion" => "v4",
|
@@ -11241,6 +11273,19 @@ module Aws::QuickSight
|
|
11241
11273
|
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
11242
11274
|
end)
|
11243
11275
|
|
11276
|
+
api.add_operation(:update_spice_capacity_configuration, Seahorse::Model::Operation.new.tap do |o|
|
11277
|
+
o.name = "UpdateSPICECapacityConfiguration"
|
11278
|
+
o.http_method = "POST"
|
11279
|
+
o.http_request_uri = "/accounts/{AwsAccountId}/spice-capacity-configuration"
|
11280
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateSPICECapacityConfigurationRequest)
|
11281
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateSPICECapacityConfigurationResponse)
|
11282
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
11283
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
11284
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
11285
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
11286
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
11287
|
+
end)
|
11288
|
+
|
11244
11289
|
api.add_operation(:update_template, Seahorse::Model::Operation.new.tap do |o|
|
11245
11290
|
o.name = "UpdateTemplate"
|
11246
11291
|
o.http_method = "PUT"
|
@@ -2252,6 +2252,20 @@ module Aws::QuickSight
|
|
2252
2252
|
end
|
2253
2253
|
end
|
2254
2254
|
|
2255
|
+
class UpdateSPICECapacityConfiguration
|
2256
|
+
def self.build(context)
|
2257
|
+
unless context.config.regional_endpoint
|
2258
|
+
endpoint = context.config.endpoint.to_s
|
2259
|
+
end
|
2260
|
+
Aws::QuickSight::EndpointParameters.new(
|
2261
|
+
region: context.config.region,
|
2262
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
2263
|
+
use_fips: context.config.use_fips_endpoint,
|
2264
|
+
endpoint: endpoint,
|
2265
|
+
)
|
2266
|
+
end
|
2267
|
+
end
|
2268
|
+
|
2255
2269
|
class UpdateTemplate
|
2256
2270
|
def self.build(context)
|
2257
2271
|
unless context.config.regional_endpoint
|
@@ -378,6 +378,8 @@ module Aws::QuickSight
|
|
378
378
|
Aws::QuickSight::Endpoints::UpdateRefreshSchedule.build(context)
|
379
379
|
when :update_role_custom_permission
|
380
380
|
Aws::QuickSight::Endpoints::UpdateRoleCustomPermission.build(context)
|
381
|
+
when :update_spice_capacity_configuration
|
382
|
+
Aws::QuickSight::Endpoints::UpdateSPICECapacityConfiguration.build(context)
|
381
383
|
when :update_template
|
382
384
|
Aws::QuickSight::Endpoints::UpdateTemplate.build(context)
|
383
385
|
when :update_template_alias
|
@@ -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.
|