aws-sdk-quicksight 1.67.0 → 1.69.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +28 -8
- data/lib/aws-sdk-quicksight/client_api.rb +20 -1
- data/lib/aws-sdk-quicksight/types.rb +192 -13
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0d6ef761e43ff73bfd0f9dbf79e8900e6d6155139a87ee7f9869badffa490340
|
4
|
+
data.tar.gz: 76755ae322ce09b9ec0eadcf1ed1c5ca92af5d94f4a2587b5227ea9379a39a0b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 26d778dc0aa1b13c9c2e1faa371ddc3e63d110aba4359cb9f2c299c532887c515de588c41687d68a9107e2267f8a186a1e36896bb155437acbfd876726b4fa49
|
7
|
+
data.tar.gz: dfac09b0ffcaade260add9374b98a5bb97939cc6e25431864951bda594453ed7d066f11135cfee8dc7cff9328b404cd775f1298fc9f46862c6301d7cb2643843
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.69.0 (2022-10-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon QuickSight now supports SecretsManager Secret ARN in place of CredentialPair for DataSource creation and update. This release also has some minor documentation updates and removes CountryCode as a required parameter in GeoSpatialColumnGroup
|
8
|
+
|
9
|
+
1.68.0 (2022-08-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Added a new optional property DashboardVisual under ExperienceConfiguration parameter of GenerateEmbedUrlForAnonymousUser and GenerateEmbedUrlForRegisteredUser API operations. This supports embedding of specific visuals in QuickSight dashboards.
|
13
|
+
|
4
14
|
1.67.0 (2022-08-08)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.69.0
|
@@ -1165,7 +1165,7 @@ module Aws::QuickSight
|
|
1165
1165
|
# {
|
1166
1166
|
# geo_spatial_column_group: {
|
1167
1167
|
# name: "ColumnGroupName", # required
|
1168
|
-
# country_code: "US", #
|
1168
|
+
# country_code: "US", # accepts US
|
1169
1169
|
# columns: ["ColumnName"], # required
|
1170
1170
|
# },
|
1171
1171
|
# },
|
@@ -1497,6 +1497,7 @@ module Aws::QuickSight
|
|
1497
1497
|
# ],
|
1498
1498
|
# },
|
1499
1499
|
# copy_source_arn: "CopySourceArn",
|
1500
|
+
# secret_arn: "SecretArn",
|
1500
1501
|
# },
|
1501
1502
|
# permissions: [
|
1502
1503
|
# {
|
@@ -3790,6 +3791,7 @@ module Aws::QuickSight
|
|
3790
3791
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
3791
3792
|
# resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
3792
3793
|
# resp.data_source.error_info.message #=> String
|
3794
|
+
# resp.data_source.secret_arn #=> String
|
3793
3795
|
# resp.request_id #=> String
|
3794
3796
|
# resp.status #=> Integer
|
3795
3797
|
#
|
@@ -4652,9 +4654,9 @@ module Aws::QuickSight
|
|
4652
4654
|
end
|
4653
4655
|
|
4654
4656
|
# Generates an embed URL that you can use to embed an Amazon QuickSight
|
4655
|
-
# dashboard in your website, without having to register any
|
4656
|
-
# users. Before you use this action, make sure that you have
|
4657
|
-
# the dashboards and permissions.
|
4657
|
+
# dashboard or visual in your website, without having to register any
|
4658
|
+
# reader users. Before you use this action, make sure that you have
|
4659
|
+
# configured the dashboards and permissions.
|
4658
4660
|
#
|
4659
4661
|
# The following rules apply to the generated URL:
|
4660
4662
|
#
|
@@ -4756,6 +4758,13 @@ module Aws::QuickSight
|
|
4756
4758
|
# dashboard: {
|
4757
4759
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
4758
4760
|
# },
|
4761
|
+
# dashboard_visual: {
|
4762
|
+
# initial_dashboard_visual_id: { # required
|
4763
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
4764
|
+
# sheet_id: "RestrictiveResourceId", # required
|
4765
|
+
# visual_id: "RestrictiveResourceId", # required
|
4766
|
+
# },
|
4767
|
+
# },
|
4759
4768
|
# },
|
4760
4769
|
# allowed_domains: ["String"],
|
4761
4770
|
# })
|
@@ -4822,7 +4831,8 @@ module Aws::QuickSight
|
|
4822
4831
|
#
|
4823
4832
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
4824
4833
|
# The experience you are embedding. For registered users, you can embed
|
4825
|
-
# Amazon QuickSight dashboards
|
4834
|
+
# Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon
|
4835
|
+
# QuickSight Q search bar, or the entire Amazon QuickSight console.
|
4826
4836
|
#
|
4827
4837
|
# @option params [Array<String>] :allowed_domains
|
4828
4838
|
# The domains that you want to add to the allow list for access to the
|
@@ -4858,6 +4868,13 @@ module Aws::QuickSight
|
|
4858
4868
|
# q_search_bar: {
|
4859
4869
|
# initial_topic_id: "RestrictiveResourceId",
|
4860
4870
|
# },
|
4871
|
+
# dashboard_visual: {
|
4872
|
+
# initial_dashboard_visual_id: { # required
|
4873
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
4874
|
+
# sheet_id: "RestrictiveResourceId", # required
|
4875
|
+
# visual_id: "RestrictiveResourceId", # required
|
4876
|
+
# },
|
4877
|
+
# },
|
4861
4878
|
# },
|
4862
4879
|
# allowed_domains: ["String"],
|
4863
4880
|
# })
|
@@ -5473,6 +5490,7 @@ module Aws::QuickSight
|
|
5473
5490
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
5474
5491
|
# resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
5475
5492
|
# resp.data_sources[0].error_info.message #=> String
|
5493
|
+
# resp.data_sources[0].secret_arn #=> String
|
5476
5494
|
# resp.next_token #=> String
|
5477
5495
|
# resp.request_id #=> String
|
5478
5496
|
# resp.status #=> Integer
|
@@ -7533,7 +7551,8 @@ module Aws::QuickSight
|
|
7533
7551
|
end
|
7534
7552
|
|
7535
7553
|
# Updates a dataset. This operation doesn't support datasets that
|
7536
|
-
# include uploaded files as a source.
|
7554
|
+
# include uploaded files as a source. Partial updates are not supported
|
7555
|
+
# by this operation.
|
7537
7556
|
#
|
7538
7557
|
# @option params [required, String] :aws_account_id
|
7539
7558
|
# The Amazon Web Services account ID.
|
@@ -7706,7 +7725,7 @@ module Aws::QuickSight
|
|
7706
7725
|
# {
|
7707
7726
|
# geo_spatial_column_group: {
|
7708
7727
|
# name: "ColumnGroupName", # required
|
7709
|
-
# country_code: "US", #
|
7728
|
+
# country_code: "US", # accepts US
|
7710
7729
|
# columns: ["ColumnName"], # required
|
7711
7730
|
# },
|
7712
7731
|
# },
|
@@ -8073,6 +8092,7 @@ module Aws::QuickSight
|
|
8073
8092
|
# ],
|
8074
8093
|
# },
|
8075
8094
|
# copy_source_arn: "CopySourceArn",
|
8095
|
+
# secret_arn: "SecretArn",
|
8076
8096
|
# },
|
8077
8097
|
# vpc_connection_properties: {
|
8078
8098
|
# vpc_connection_arn: "Arn", # required
|
@@ -9089,7 +9109,7 @@ module Aws::QuickSight
|
|
9089
9109
|
params: params,
|
9090
9110
|
config: config)
|
9091
9111
|
context[:gem_name] = 'aws-sdk-quicksight'
|
9092
|
-
context[:gem_version] = '1.
|
9112
|
+
context[:gem_version] = '1.69.0'
|
9093
9113
|
Seahorse::Client::Request.new(handlers, context)
|
9094
9114
|
end
|
9095
9115
|
|
@@ -38,6 +38,7 @@ module Aws::QuickSight
|
|
38
38
|
AnalysisSummary = Shapes::StructureShape.new(name: 'AnalysisSummary')
|
39
39
|
AnalysisSummaryList = Shapes::ListShape.new(name: 'AnalysisSummaryList')
|
40
40
|
AnonymousUserDashboardEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserDashboardEmbeddingConfiguration')
|
41
|
+
AnonymousUserDashboardVisualEmbeddingConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserDashboardVisualEmbeddingConfiguration')
|
41
42
|
AnonymousUserEmbeddingExperienceConfiguration = Shapes::StructureShape.new(name: 'AnonymousUserEmbeddingExperienceConfiguration')
|
42
43
|
Arn = Shapes::StringShape.new(name: 'Arn')
|
43
44
|
ArnList = Shapes::ListShape.new(name: 'ArnList')
|
@@ -141,6 +142,7 @@ module Aws::QuickSight
|
|
141
142
|
DashboardVersion = Shapes::StructureShape.new(name: 'DashboardVersion')
|
142
143
|
DashboardVersionSummary = Shapes::StructureShape.new(name: 'DashboardVersionSummary')
|
143
144
|
DashboardVersionSummaryList = Shapes::ListShape.new(name: 'DashboardVersionSummaryList')
|
145
|
+
DashboardVisualId = Shapes::StructureShape.new(name: 'DashboardVisualId')
|
144
146
|
DataColorPalette = Shapes::StructureShape.new(name: 'DataColorPalette')
|
145
147
|
DataSet = Shapes::StructureShape.new(name: 'DataSet')
|
146
148
|
DataSetArnsList = Shapes::ListShape.new(name: 'DataSetArnsList')
|
@@ -445,6 +447,7 @@ module Aws::QuickSight
|
|
445
447
|
RegisterUserRequest = Shapes::StructureShape.new(name: 'RegisterUserRequest')
|
446
448
|
RegisterUserResponse = Shapes::StructureShape.new(name: 'RegisterUserResponse')
|
447
449
|
RegisteredUserDashboardEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserDashboardEmbeddingConfiguration')
|
450
|
+
RegisteredUserDashboardVisualEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserDashboardVisualEmbeddingConfiguration')
|
448
451
|
RegisteredUserEmbeddingExperienceConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserEmbeddingExperienceConfiguration')
|
449
452
|
RegisteredUserQSearchBarEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserQSearchBarEmbeddingConfiguration')
|
450
453
|
RegisteredUserQuickSightConsoleEmbeddingConfiguration = Shapes::StructureShape.new(name: 'RegisteredUserQuickSightConsoleEmbeddingConfiguration')
|
@@ -486,6 +489,7 @@ module Aws::QuickSight
|
|
486
489
|
SearchFoldersResponse = Shapes::StructureShape.new(name: 'SearchFoldersResponse')
|
487
490
|
SearchGroupsRequest = Shapes::StructureShape.new(name: 'SearchGroupsRequest')
|
488
491
|
SearchGroupsResponse = Shapes::StructureShape.new(name: 'SearchGroupsResponse')
|
492
|
+
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
489
493
|
ServiceNowParameters = Shapes::StructureShape.new(name: 'ServiceNowParameters')
|
490
494
|
SessionLifetimeInMinutes = Shapes::IntegerShape.new(name: 'SessionLifetimeInMinutes')
|
491
495
|
SessionLifetimeInMinutesInvalidException = Shapes::StructureShape.new(name: 'SessionLifetimeInMinutesInvalidException')
|
@@ -713,7 +717,11 @@ module Aws::QuickSight
|
|
713
717
|
AnonymousUserDashboardEmbeddingConfiguration.add_member(:initial_dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "InitialDashboardId"))
|
714
718
|
AnonymousUserDashboardEmbeddingConfiguration.struct_class = Types::AnonymousUserDashboardEmbeddingConfiguration
|
715
719
|
|
720
|
+
AnonymousUserDashboardVisualEmbeddingConfiguration.add_member(:initial_dashboard_visual_id, Shapes::ShapeRef.new(shape: DashboardVisualId, required: true, location_name: "InitialDashboardVisualId"))
|
721
|
+
AnonymousUserDashboardVisualEmbeddingConfiguration.struct_class = Types::AnonymousUserDashboardVisualEmbeddingConfiguration
|
722
|
+
|
716
723
|
AnonymousUserEmbeddingExperienceConfiguration.add_member(:dashboard, Shapes::ShapeRef.new(shape: AnonymousUserDashboardEmbeddingConfiguration, location_name: "Dashboard"))
|
724
|
+
AnonymousUserEmbeddingExperienceConfiguration.add_member(:dashboard_visual, Shapes::ShapeRef.new(shape: AnonymousUserDashboardVisualEmbeddingConfiguration, location_name: "DashboardVisual"))
|
717
725
|
AnonymousUserEmbeddingExperienceConfiguration.struct_class = Types::AnonymousUserEmbeddingExperienceConfiguration
|
718
726
|
|
719
727
|
ArnList.member = Shapes::ShapeRef.new(shape: Arn)
|
@@ -1161,6 +1169,11 @@ module Aws::QuickSight
|
|
1161
1169
|
|
1162
1170
|
DashboardVersionSummaryList.member = Shapes::ShapeRef.new(shape: DashboardVersionSummary)
|
1163
1171
|
|
1172
|
+
DashboardVisualId.add_member(:dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "DashboardId"))
|
1173
|
+
DashboardVisualId.add_member(:sheet_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "SheetId"))
|
1174
|
+
DashboardVisualId.add_member(:visual_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "VisualId"))
|
1175
|
+
DashboardVisualId.struct_class = Types::DashboardVisualId
|
1176
|
+
|
1164
1177
|
DataColorPalette.add_member(:colors, Shapes::ShapeRef.new(shape: ColorList, location_name: "Colors"))
|
1165
1178
|
DataColorPalette.add_member(:min_max_gradient, Shapes::ShapeRef.new(shape: ColorList, location_name: "MinMaxGradient"))
|
1166
1179
|
DataColorPalette.add_member(:empty_fill_color, Shapes::ShapeRef.new(shape: HexColor, location_name: "EmptyFillColor"))
|
@@ -1231,10 +1244,12 @@ module Aws::QuickSight
|
|
1231
1244
|
DataSource.add_member(:vpc_connection_properties, Shapes::ShapeRef.new(shape: VpcConnectionProperties, location_name: "VpcConnectionProperties"))
|
1232
1245
|
DataSource.add_member(:ssl_properties, Shapes::ShapeRef.new(shape: SslProperties, location_name: "SslProperties"))
|
1233
1246
|
DataSource.add_member(:error_info, Shapes::ShapeRef.new(shape: DataSourceErrorInfo, location_name: "ErrorInfo"))
|
1247
|
+
DataSource.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
|
1234
1248
|
DataSource.struct_class = Types::DataSource
|
1235
1249
|
|
1236
1250
|
DataSourceCredentials.add_member(:credential_pair, Shapes::ShapeRef.new(shape: CredentialPair, location_name: "CredentialPair"))
|
1237
1251
|
DataSourceCredentials.add_member(:copy_source_arn, Shapes::ShapeRef.new(shape: CopySourceArn, location_name: "CopySourceArn"))
|
1252
|
+
DataSourceCredentials.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, location_name: "SecretArn"))
|
1238
1253
|
DataSourceCredentials.struct_class = Types::DataSourceCredentials
|
1239
1254
|
|
1240
1255
|
DataSourceErrorInfo.add_member(:type, Shapes::ShapeRef.new(shape: DataSourceErrorInfoType, location_name: "Type"))
|
@@ -1819,7 +1834,7 @@ module Aws::QuickSight
|
|
1819
1834
|
GenerateEmbedUrlForRegisteredUserResponse.struct_class = Types::GenerateEmbedUrlForRegisteredUserResponse
|
1820
1835
|
|
1821
1836
|
GeoSpatialColumnGroup.add_member(:name, Shapes::ShapeRef.new(shape: ColumnGroupName, required: true, location_name: "Name"))
|
1822
|
-
GeoSpatialColumnGroup.add_member(:country_code, Shapes::ShapeRef.new(shape: GeoSpatialCountryCode,
|
1837
|
+
GeoSpatialColumnGroup.add_member(:country_code, Shapes::ShapeRef.new(shape: GeoSpatialCountryCode, location_name: "CountryCode"))
|
1823
1838
|
GeoSpatialColumnGroup.add_member(:columns, Shapes::ShapeRef.new(shape: ColumnList, required: true, location_name: "Columns"))
|
1824
1839
|
GeoSpatialColumnGroup.struct_class = Types::GeoSpatialColumnGroup
|
1825
1840
|
|
@@ -2361,9 +2376,13 @@ module Aws::QuickSight
|
|
2361
2376
|
RegisteredUserDashboardEmbeddingConfiguration.add_member(:initial_dashboard_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, required: true, location_name: "InitialDashboardId"))
|
2362
2377
|
RegisteredUserDashboardEmbeddingConfiguration.struct_class = Types::RegisteredUserDashboardEmbeddingConfiguration
|
2363
2378
|
|
2379
|
+
RegisteredUserDashboardVisualEmbeddingConfiguration.add_member(:initial_dashboard_visual_id, Shapes::ShapeRef.new(shape: DashboardVisualId, required: true, location_name: "InitialDashboardVisualId"))
|
2380
|
+
RegisteredUserDashboardVisualEmbeddingConfiguration.struct_class = Types::RegisteredUserDashboardVisualEmbeddingConfiguration
|
2381
|
+
|
2364
2382
|
RegisteredUserEmbeddingExperienceConfiguration.add_member(:dashboard, Shapes::ShapeRef.new(shape: RegisteredUserDashboardEmbeddingConfiguration, location_name: "Dashboard"))
|
2365
2383
|
RegisteredUserEmbeddingExperienceConfiguration.add_member(:quick_sight_console, Shapes::ShapeRef.new(shape: RegisteredUserQuickSightConsoleEmbeddingConfiguration, location_name: "QuickSightConsole"))
|
2366
2384
|
RegisteredUserEmbeddingExperienceConfiguration.add_member(:q_search_bar, Shapes::ShapeRef.new(shape: RegisteredUserQSearchBarEmbeddingConfiguration, location_name: "QSearchBar"))
|
2385
|
+
RegisteredUserEmbeddingExperienceConfiguration.add_member(:dashboard_visual, Shapes::ShapeRef.new(shape: RegisteredUserDashboardVisualEmbeddingConfiguration, location_name: "DashboardVisual"))
|
2367
2386
|
RegisteredUserEmbeddingExperienceConfiguration.struct_class = Types::RegisteredUserEmbeddingExperienceConfiguration
|
2368
2387
|
|
2369
2388
|
RegisteredUserQSearchBarEmbeddingConfiguration.add_member(:initial_topic_id, Shapes::ShapeRef.new(shape: RestrictiveResourceId, location_name: "InitialTopicId"))
|
@@ -484,6 +484,39 @@ module Aws::QuickSight
|
|
484
484
|
include Aws::Structure
|
485
485
|
end
|
486
486
|
|
487
|
+
# The experience that you are embedding. You can use this object to
|
488
|
+
# generate a url that embeds a visual into your application.
|
489
|
+
#
|
490
|
+
# @note When making an API call, you may pass AnonymousUserDashboardVisualEmbeddingConfiguration
|
491
|
+
# data as a hash:
|
492
|
+
#
|
493
|
+
# {
|
494
|
+
# initial_dashboard_visual_id: { # required
|
495
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
496
|
+
# sheet_id: "RestrictiveResourceId", # required
|
497
|
+
# visual_id: "RestrictiveResourceId", # required
|
498
|
+
# },
|
499
|
+
# }
|
500
|
+
#
|
501
|
+
# @!attribute [rw] initial_dashboard_visual_id
|
502
|
+
# The visual ID for the visual that you want the user to see. This ID
|
503
|
+
# is included in the output URL. When the URL in response is accessed,
|
504
|
+
# Amazon QuickSight renders this visual.
|
505
|
+
#
|
506
|
+
# The Amazon Resource Name (ARN) of the dashboard that the visual
|
507
|
+
# belongs to must be included in the `AuthorizedResourceArns`
|
508
|
+
# parameter. Otherwise, the request will fail with
|
509
|
+
# `InvalidParameterValueException`.
|
510
|
+
# @return [Types::DashboardVisualId]
|
511
|
+
#
|
512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserDashboardVisualEmbeddingConfiguration AWS API Documentation
|
513
|
+
#
|
514
|
+
class AnonymousUserDashboardVisualEmbeddingConfiguration < Struct.new(
|
515
|
+
:initial_dashboard_visual_id)
|
516
|
+
SENSITIVE = []
|
517
|
+
include Aws::Structure
|
518
|
+
end
|
519
|
+
|
487
520
|
# The type of experience you want to embed. For anonymous users, you can
|
488
521
|
# embed Amazon QuickSight dashboards.
|
489
522
|
#
|
@@ -494,6 +527,13 @@ module Aws::QuickSight
|
|
494
527
|
# dashboard: {
|
495
528
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
496
529
|
# },
|
530
|
+
# dashboard_visual: {
|
531
|
+
# initial_dashboard_visual_id: { # required
|
532
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
533
|
+
# sheet_id: "RestrictiveResourceId", # required
|
534
|
+
# visual_id: "RestrictiveResourceId", # required
|
535
|
+
# },
|
536
|
+
# },
|
497
537
|
# }
|
498
538
|
#
|
499
539
|
# @!attribute [rw] dashboard
|
@@ -501,10 +541,16 @@ module Aws::QuickSight
|
|
501
541
|
# dashboards.
|
502
542
|
# @return [Types::AnonymousUserDashboardEmbeddingConfiguration]
|
503
543
|
#
|
544
|
+
# @!attribute [rw] dashboard_visual
|
545
|
+
# The type of embedding experience. In this case, Amazon QuickSight
|
546
|
+
# visuals.
|
547
|
+
# @return [Types::AnonymousUserDashboardVisualEmbeddingConfiguration]
|
548
|
+
#
|
504
549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
|
505
550
|
#
|
506
551
|
class AnonymousUserEmbeddingExperienceConfiguration < Struct.new(
|
507
|
-
:dashboard
|
552
|
+
:dashboard,
|
553
|
+
:dashboard_visual)
|
508
554
|
SENSITIVE = []
|
509
555
|
include Aws::Structure
|
510
556
|
end
|
@@ -798,7 +844,7 @@ module Aws::QuickSight
|
|
798
844
|
# {
|
799
845
|
# geo_spatial_column_group: {
|
800
846
|
# name: "ColumnGroupName", # required
|
801
|
-
# country_code: "US", #
|
847
|
+
# country_code: "US", # accepts US
|
802
848
|
# columns: ["ColumnName"], # required
|
803
849
|
# },
|
804
850
|
# }
|
@@ -1765,7 +1811,7 @@ module Aws::QuickSight
|
|
1765
1811
|
# {
|
1766
1812
|
# geo_spatial_column_group: {
|
1767
1813
|
# name: "ColumnGroupName", # required
|
1768
|
-
# country_code: "US", #
|
1814
|
+
# country_code: "US", # accepts US
|
1769
1815
|
# columns: ["ColumnName"], # required
|
1770
1816
|
# },
|
1771
1817
|
# },
|
@@ -2157,6 +2203,7 @@ module Aws::QuickSight
|
|
2157
2203
|
# ],
|
2158
2204
|
# },
|
2159
2205
|
# copy_source_arn: "CopySourceArn",
|
2206
|
+
# secret_arn: "SecretArn",
|
2160
2207
|
# },
|
2161
2208
|
# permissions: [
|
2162
2209
|
# {
|
@@ -3793,6 +3840,61 @@ module Aws::QuickSight
|
|
3793
3840
|
include Aws::Structure
|
3794
3841
|
end
|
3795
3842
|
|
3843
|
+
# A structure that contains the following elements:
|
3844
|
+
#
|
3845
|
+
# * The `DashboardId` of the dashboard that has the visual that you want
|
3846
|
+
# to embed.
|
3847
|
+
#
|
3848
|
+
# * The `SheetId` of the sheet that has the visual that you want to
|
3849
|
+
# embed.
|
3850
|
+
#
|
3851
|
+
# * The `VisualId` of the visual that you want to embed.
|
3852
|
+
#
|
3853
|
+
# The `DashboardId`, `SheetId`, and `VisualId` can be found in the `IDs
|
3854
|
+
# for developers` section of the `Embed visual` pane of the visual's
|
3855
|
+
# on-visual menu of the Amazon QuickSight console. You can also get the
|
3856
|
+
# `DashboardId` with a `ListDashboards` API operation.
|
3857
|
+
#
|
3858
|
+
# @note When making an API call, you may pass DashboardVisualId
|
3859
|
+
# data as a hash:
|
3860
|
+
#
|
3861
|
+
# {
|
3862
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
3863
|
+
# sheet_id: "RestrictiveResourceId", # required
|
3864
|
+
# visual_id: "RestrictiveResourceId", # required
|
3865
|
+
# }
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] dashboard_id
|
3868
|
+
# The ID of the dashboard that has the visual that you want to embed.
|
3869
|
+
# The `DashboardId` can be found in the `IDs for developers` section
|
3870
|
+
# of the `Embed visual` pane of the visual's on-visual menu of the
|
3871
|
+
# Amazon QuickSight console. You can also get the `DashboardId` with a
|
3872
|
+
# `ListDashboards` API operation.
|
3873
|
+
# @return [String]
|
3874
|
+
#
|
3875
|
+
# @!attribute [rw] sheet_id
|
3876
|
+
# The ID of the sheet that the has visual that you want to embed. The
|
3877
|
+
# `SheetId` can be found in the `IDs for developers` section of the
|
3878
|
+
# `Embed visual` pane of the visual's on-visual menu of the Amazon
|
3879
|
+
# QuickSight console.
|
3880
|
+
# @return [String]
|
3881
|
+
#
|
3882
|
+
# @!attribute [rw] visual_id
|
3883
|
+
# The ID of the visual that you want to embed. The `VisualID` can be
|
3884
|
+
# found in the `IDs for developers` section of the `Embed visual` pane
|
3885
|
+
# of the visual's on-visual menu of the Amazon QuickSight console.
|
3886
|
+
# @return [String]
|
3887
|
+
#
|
3888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVisualId AWS API Documentation
|
3889
|
+
#
|
3890
|
+
class DashboardVisualId < Struct.new(
|
3891
|
+
:dashboard_id,
|
3892
|
+
:sheet_id,
|
3893
|
+
:visual_id)
|
3894
|
+
SENSITIVE = []
|
3895
|
+
include Aws::Structure
|
3896
|
+
end
|
3897
|
+
|
3796
3898
|
# The theme colors that are used for data colors in charts. The colors
|
3797
3899
|
# description is a hexadecimal color code that consists of six
|
3798
3900
|
# alphanumerical characters, prefixed with `#`, for example #37BFF5.
|
@@ -4146,6 +4248,11 @@ module Aws::QuickSight
|
|
4146
4248
|
# source.
|
4147
4249
|
# @return [Types::DataSourceErrorInfo]
|
4148
4250
|
#
|
4251
|
+
# @!attribute [rw] secret_arn
|
4252
|
+
# The Amazon Resource Name (ARN) of the secret associated with the
|
4253
|
+
# data source in Amazon Secrets Manager.
|
4254
|
+
# @return [String]
|
4255
|
+
#
|
4149
4256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSource AWS API Documentation
|
4150
4257
|
#
|
4151
4258
|
class DataSource < Struct.new(
|
@@ -4160,7 +4267,8 @@ module Aws::QuickSight
|
|
4160
4267
|
:alternate_data_source_parameters,
|
4161
4268
|
:vpc_connection_properties,
|
4162
4269
|
:ssl_properties,
|
4163
|
-
:error_info
|
4270
|
+
:error_info,
|
4271
|
+
:secret_arn)
|
4164
4272
|
SENSITIVE = []
|
4165
4273
|
include Aws::Structure
|
4166
4274
|
end
|
@@ -4277,6 +4385,7 @@ module Aws::QuickSight
|
|
4277
4385
|
# ],
|
4278
4386
|
# },
|
4279
4387
|
# copy_source_arn: "CopySourceArn",
|
4388
|
+
# secret_arn: "SecretArn",
|
4280
4389
|
# }
|
4281
4390
|
#
|
4282
4391
|
# @!attribute [rw] credential_pair
|
@@ -4290,11 +4399,17 @@ module Aws::QuickSight
|
|
4290
4399
|
# the credentials for the `DataSourceCredentials` structure.
|
4291
4400
|
# @return [String]
|
4292
4401
|
#
|
4402
|
+
# @!attribute [rw] secret_arn
|
4403
|
+
# The Amazon Resource Name (ARN) of the secret associated with the
|
4404
|
+
# data source in Amazon Secrets Manager.
|
4405
|
+
# @return [String]
|
4406
|
+
#
|
4293
4407
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceCredentials AWS API Documentation
|
4294
4408
|
#
|
4295
4409
|
class DataSourceCredentials < Struct.new(
|
4296
4410
|
:credential_pair,
|
4297
|
-
:copy_source_arn
|
4411
|
+
:copy_source_arn,
|
4412
|
+
:secret_arn)
|
4298
4413
|
SENSITIVE = []
|
4299
4414
|
include Aws::Structure
|
4300
4415
|
end
|
@@ -7394,6 +7509,13 @@ module Aws::QuickSight
|
|
7394
7509
|
# dashboard: {
|
7395
7510
|
# initial_dashboard_id: "RestrictiveResourceId", # required
|
7396
7511
|
# },
|
7512
|
+
# dashboard_visual: {
|
7513
|
+
# initial_dashboard_visual_id: { # required
|
7514
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
7515
|
+
# sheet_id: "RestrictiveResourceId", # required
|
7516
|
+
# visual_id: "RestrictiveResourceId", # required
|
7517
|
+
# },
|
7518
|
+
# },
|
7397
7519
|
# },
|
7398
7520
|
# allowed_domains: ["String"],
|
7399
7521
|
# }
|
@@ -7508,6 +7630,13 @@ module Aws::QuickSight
|
|
7508
7630
|
# q_search_bar: {
|
7509
7631
|
# initial_topic_id: "RestrictiveResourceId",
|
7510
7632
|
# },
|
7633
|
+
# dashboard_visual: {
|
7634
|
+
# initial_dashboard_visual_id: { # required
|
7635
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
7636
|
+
# sheet_id: "RestrictiveResourceId", # required
|
7637
|
+
# visual_id: "RestrictiveResourceId", # required
|
7638
|
+
# },
|
7639
|
+
# },
|
7511
7640
|
# },
|
7512
7641
|
# allowed_domains: ["String"],
|
7513
7642
|
# }
|
@@ -7528,7 +7657,8 @@ module Aws::QuickSight
|
|
7528
7657
|
#
|
7529
7658
|
# @!attribute [rw] experience_configuration
|
7530
7659
|
# The experience you are embedding. For registered users, you can
|
7531
|
-
# embed Amazon QuickSight dashboards
|
7660
|
+
# embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the
|
7661
|
+
# Amazon QuickSight Q search bar, or the entire Amazon QuickSight
|
7532
7662
|
# console.
|
7533
7663
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
7534
7664
|
#
|
@@ -7558,7 +7688,8 @@ module Aws::QuickSight
|
|
7558
7688
|
end
|
7559
7689
|
|
7560
7690
|
# @!attribute [rw] embed_url
|
7561
|
-
# The embed URL for the Amazon QuickSight dashboard
|
7691
|
+
# The embed URL for the Amazon QuickSight dashboard, visual, Q search
|
7692
|
+
# bar, or console.
|
7562
7693
|
# @return [String]
|
7563
7694
|
#
|
7564
7695
|
# @!attribute [rw] status
|
@@ -7586,7 +7717,7 @@ module Aws::QuickSight
|
|
7586
7717
|
#
|
7587
7718
|
# {
|
7588
7719
|
# name: "ColumnGroupName", # required
|
7589
|
-
# country_code: "US", #
|
7720
|
+
# country_code: "US", # accepts US
|
7590
7721
|
# columns: ["ColumnName"], # required
|
7591
7722
|
# }
|
7592
7723
|
#
|
@@ -10751,6 +10882,39 @@ module Aws::QuickSight
|
|
10751
10882
|
include Aws::Structure
|
10752
10883
|
end
|
10753
10884
|
|
10885
|
+
# The experience that you are embedding. You can use this object to
|
10886
|
+
# generate a url that embeds a visual into your application.
|
10887
|
+
#
|
10888
|
+
# @note When making an API call, you may pass RegisteredUserDashboardVisualEmbeddingConfiguration
|
10889
|
+
# data as a hash:
|
10890
|
+
#
|
10891
|
+
# {
|
10892
|
+
# initial_dashboard_visual_id: { # required
|
10893
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
10894
|
+
# sheet_id: "RestrictiveResourceId", # required
|
10895
|
+
# visual_id: "RestrictiveResourceId", # required
|
10896
|
+
# },
|
10897
|
+
# }
|
10898
|
+
#
|
10899
|
+
# @!attribute [rw] initial_dashboard_visual_id
|
10900
|
+
# The visual ID for the visual that you want the user to embed. This
|
10901
|
+
# ID is included in the output URL. When the URL in response is
|
10902
|
+
# accessed, Amazon QuickSight renders this visual.
|
10903
|
+
#
|
10904
|
+
# The Amazon Resource Name (ARN) of the dashboard that the visual
|
10905
|
+
# belongs to must be included in the `AuthorizedResourceArns`
|
10906
|
+
# parameter. Otherwise, the request will fail with
|
10907
|
+
# `InvalidParameterValueException`.
|
10908
|
+
# @return [Types::DashboardVisualId]
|
10909
|
+
#
|
10910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardVisualEmbeddingConfiguration AWS API Documentation
|
10911
|
+
#
|
10912
|
+
class RegisteredUserDashboardVisualEmbeddingConfiguration < Struct.new(
|
10913
|
+
:initial_dashboard_visual_id)
|
10914
|
+
SENSITIVE = []
|
10915
|
+
include Aws::Structure
|
10916
|
+
end
|
10917
|
+
|
10754
10918
|
# The type of experience you want to embed. For registered users, you
|
10755
10919
|
# can embed Amazon QuickSight dashboards or the Amazon QuickSight
|
10756
10920
|
# console.
|
@@ -10774,6 +10938,13 @@ module Aws::QuickSight
|
|
10774
10938
|
# q_search_bar: {
|
10775
10939
|
# initial_topic_id: "RestrictiveResourceId",
|
10776
10940
|
# },
|
10941
|
+
# dashboard_visual: {
|
10942
|
+
# initial_dashboard_visual_id: { # required
|
10943
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
10944
|
+
# sheet_id: "RestrictiveResourceId", # required
|
10945
|
+
# visual_id: "RestrictiveResourceId", # required
|
10946
|
+
# },
|
10947
|
+
# },
|
10777
10948
|
# }
|
10778
10949
|
#
|
10779
10950
|
# @!attribute [rw] dashboard
|
@@ -10826,12 +10997,18 @@ module Aws::QuickSight
|
|
10826
10997
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
|
10827
10998
|
# @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
|
10828
10999
|
#
|
11000
|
+
# @!attribute [rw] dashboard_visual
|
11001
|
+
# The type of embedding experience. In this case, Amazon QuickSight
|
11002
|
+
# visuals.
|
11003
|
+
# @return [Types::RegisteredUserDashboardVisualEmbeddingConfiguration]
|
11004
|
+
#
|
10829
11005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
|
10830
11006
|
#
|
10831
11007
|
class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
|
10832
11008
|
:dashboard,
|
10833
11009
|
:quick_sight_console,
|
10834
|
-
:q_search_bar
|
11010
|
+
:q_search_bar,
|
11011
|
+
:dashboard_visual)
|
10835
11012
|
SENSITIVE = []
|
10836
11013
|
include Aws::Structure
|
10837
11014
|
end
|
@@ -14098,7 +14275,7 @@ module Aws::QuickSight
|
|
14098
14275
|
# {
|
14099
14276
|
# geo_spatial_column_group: {
|
14100
14277
|
# name: "ColumnGroupName", # required
|
14101
|
-
# country_code: "US", #
|
14278
|
+
# country_code: "US", # accepts US
|
14102
14279
|
# columns: ["ColumnName"], # required
|
14103
14280
|
# },
|
14104
14281
|
# },
|
@@ -14544,6 +14721,7 @@ module Aws::QuickSight
|
|
14544
14721
|
# ],
|
14545
14722
|
# },
|
14546
14723
|
# copy_source_arn: "CopySourceArn",
|
14724
|
+
# secret_arn: "SecretArn",
|
14547
14725
|
# },
|
14548
14726
|
# vpc_connection_properties: {
|
14549
14727
|
# vpc_connection_arn: "Arn", # required
|
@@ -15790,9 +15968,10 @@ module Aws::QuickSight
|
|
15790
15968
|
# @return [String]
|
15791
15969
|
#
|
15792
15970
|
# @!attribute [rw] user_name
|
15793
|
-
# The user's user name.
|
15794
|
-
#
|
15795
|
-
#
|
15971
|
+
# The user's user name. This value is required if you are registering
|
15972
|
+
# a user that will be managed in Amazon QuickSight. In the output, the
|
15973
|
+
# value for `UserName` is `N/A` when the value for `IdentityType` is
|
15974
|
+
# `IAM` and the corresponding IAM user is deleted.
|
15796
15975
|
# @return [String]
|
15797
15976
|
#
|
15798
15977
|
# @!attribute [rw] email
|
data/lib/aws-sdk-quicksight.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-quicksight
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.69.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-10-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|