aws-sdk-quicksight 1.52.0 → 1.56.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +550 -411
- data/lib/aws-sdk-quicksight/client_api.rb +108 -21
- data/lib/aws-sdk-quicksight/types.rb +789 -475
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +4 -4
@@ -33,8 +33,8 @@ module Aws::QuickSight
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# The Amazon QuickSight customizations associated with your Amazon Web
|
36
|
-
# Services account
|
37
|
-
# Services Region
|
36
|
+
# Services account or a Amazon QuickSight namespace in a specific Amazon
|
37
|
+
# Web Services Region.
|
38
38
|
#
|
39
39
|
# @note When making an API call, you may pass AccountCustomization
|
40
40
|
# data as a hash:
|
@@ -44,7 +44,7 @@ module Aws::QuickSight
|
|
44
44
|
# }
|
45
45
|
#
|
46
46
|
# @!attribute [rw] default_theme
|
47
|
-
# The default theme for this QuickSight subscription.
|
47
|
+
# The default theme for this Amazon QuickSight subscription.
|
48
48
|
# @return [String]
|
49
49
|
#
|
50
50
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation
|
@@ -55,28 +55,28 @@ module Aws::QuickSight
|
|
55
55
|
include Aws::Structure
|
56
56
|
end
|
57
57
|
|
58
|
-
# The QuickSight settings associated with your Amazon Web
|
59
|
-
# account
|
58
|
+
# The Amazon QuickSight settings associated with your Amazon Web
|
59
|
+
# Services account.
|
60
60
|
#
|
61
61
|
# @!attribute [rw] account_name
|
62
|
-
# The "account name" you provided for the QuickSight
|
63
|
-
# your Amazon Web Services account
|
64
|
-
# sign up for QuickSight. It is unique in all of
|
65
|
-
# and it appears only when users sign in.
|
62
|
+
# The "account name" you provided for the Amazon QuickSight
|
63
|
+
# subscription in your Amazon Web Services account. You create this
|
64
|
+
# name when you sign up for Amazon QuickSight. It is unique in all of
|
65
|
+
# Amazon Web Services and it appears only when users sign in.
|
66
66
|
# @return [String]
|
67
67
|
#
|
68
68
|
# @!attribute [rw] edition
|
69
|
-
# The edition of QuickSight that you're currently subscribed
|
70
|
-
# Enterprise edition or Standard edition.
|
69
|
+
# The edition of Amazon QuickSight that you're currently subscribed
|
70
|
+
# to: Enterprise edition or Standard edition.
|
71
71
|
# @return [String]
|
72
72
|
#
|
73
73
|
# @!attribute [rw] default_namespace
|
74
|
-
# The default QuickSight namespace for your Amazon Web Services
|
75
|
-
# account
|
74
|
+
# The default Amazon QuickSight namespace for your Amazon Web Services
|
75
|
+
# account.
|
76
76
|
# @return [String]
|
77
77
|
#
|
78
78
|
# @!attribute [rw] notification_email
|
79
|
-
# The main notification email for your QuickSight subscription.
|
79
|
+
# The main notification email for your Amazon QuickSight subscription.
|
80
80
|
# @return [String]
|
81
81
|
#
|
82
82
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
@@ -93,7 +93,7 @@ module Aws::QuickSight
|
|
93
93
|
# The active Identity and Access Management (IAM) policy assignment.
|
94
94
|
#
|
95
95
|
# @!attribute [rw] assignment_name
|
96
|
-
# A name for the
|
96
|
+
# A name for the IAMpolicy assignment.
|
97
97
|
# @return [String]
|
98
98
|
#
|
99
99
|
# @!attribute [rw] policy_arn
|
@@ -130,7 +130,7 @@ module Aws::QuickSight
|
|
130
130
|
include Aws::Structure
|
131
131
|
end
|
132
132
|
|
133
|
-
#
|
133
|
+
# The parameters for OpenSearch.
|
134
134
|
#
|
135
135
|
# @note When making an API call, you may pass AmazonElasticsearchParameters
|
136
136
|
# data as a hash:
|
@@ -140,7 +140,7 @@ module Aws::QuickSight
|
|
140
140
|
# }
|
141
141
|
#
|
142
142
|
# @!attribute [rw] domain
|
143
|
-
# The
|
143
|
+
# The OpenSearch domain.
|
144
144
|
# @return [String]
|
145
145
|
#
|
146
146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonElasticsearchParameters AWS API Documentation
|
@@ -151,6 +151,24 @@ module Aws::QuickSight
|
|
151
151
|
include Aws::Structure
|
152
152
|
end
|
153
153
|
|
154
|
+
# @note When making an API call, you may pass AmazonOpenSearchParameters
|
155
|
+
# data as a hash:
|
156
|
+
#
|
157
|
+
# {
|
158
|
+
# domain: "Domain", # required
|
159
|
+
# }
|
160
|
+
#
|
161
|
+
# @!attribute [rw] domain
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonOpenSearchParameters AWS API Documentation
|
165
|
+
#
|
166
|
+
class AmazonOpenSearchParameters < Struct.new(
|
167
|
+
:domain)
|
168
|
+
SENSITIVE = []
|
169
|
+
include Aws::Structure
|
170
|
+
end
|
171
|
+
|
154
172
|
# Metadata structure for an analysis in Amazon QuickSight
|
155
173
|
#
|
156
174
|
# @!attribute [rw] analysis_id
|
@@ -211,7 +229,7 @@ module Aws::QuickSight
|
|
211
229
|
include Aws::Structure
|
212
230
|
end
|
213
231
|
|
214
|
-
#
|
232
|
+
# Analysis error.
|
215
233
|
#
|
216
234
|
# @!attribute [rw] type
|
217
235
|
# The type of the analysis error.
|
@@ -340,8 +358,8 @@ module Aws::QuickSight
|
|
340
358
|
# @return [String]
|
341
359
|
#
|
342
360
|
# @!attribute [rw] name
|
343
|
-
# The name of the analysis. This name is displayed in the
|
344
|
-
# console.
|
361
|
+
# The name of the analysis. This name is displayed in the Amazon
|
362
|
+
# QuickSight console.
|
345
363
|
# @return [String]
|
346
364
|
#
|
347
365
|
# @!attribute [rw] status
|
@@ -421,7 +439,7 @@ module Aws::QuickSight
|
|
421
439
|
include Aws::Structure
|
422
440
|
end
|
423
441
|
|
424
|
-
# Amazon Athena
|
442
|
+
# Parameters for Amazon Athena.
|
425
443
|
#
|
426
444
|
# @note When making an API call, you may pass AthenaParameters
|
427
445
|
# data as a hash:
|
@@ -442,7 +460,7 @@ module Aws::QuickSight
|
|
442
460
|
include Aws::Structure
|
443
461
|
end
|
444
462
|
|
445
|
-
# Amazon Aurora
|
463
|
+
# Parameters for Amazon Aurora.
|
446
464
|
#
|
447
465
|
# @note When making an API call, you may pass AuroraParameters
|
448
466
|
# data as a hash:
|
@@ -475,7 +493,7 @@ module Aws::QuickSight
|
|
475
493
|
include Aws::Structure
|
476
494
|
end
|
477
495
|
|
478
|
-
# Amazon Aurora
|
496
|
+
# Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
|
479
497
|
#
|
480
498
|
# @note When making an API call, you may pass AuroraPostgreSqlParameters
|
481
499
|
# data as a hash:
|
@@ -487,15 +505,15 @@ module Aws::QuickSight
|
|
487
505
|
# }
|
488
506
|
#
|
489
507
|
# @!attribute [rw] host
|
490
|
-
#
|
508
|
+
# The Amazon Aurora PostgreSQL-Compatible host to connect to.
|
491
509
|
# @return [String]
|
492
510
|
#
|
493
511
|
# @!attribute [rw] port
|
494
|
-
#
|
512
|
+
# The port that Amazon Aurora PostgreSQL is listening on.
|
495
513
|
# @return [Integer]
|
496
514
|
#
|
497
515
|
# @!attribute [rw] database
|
498
|
-
#
|
516
|
+
# The Amazon Aurora PostgreSQL database to connect to.
|
499
517
|
# @return [String]
|
500
518
|
#
|
501
519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AuroraPostgreSqlParameters AWS API Documentation
|
@@ -508,7 +526,7 @@ module Aws::QuickSight
|
|
508
526
|
include Aws::Structure
|
509
527
|
end
|
510
528
|
|
511
|
-
#
|
529
|
+
# The parameters for IoT Analytics.
|
512
530
|
#
|
513
531
|
# @note When making an API call, you may pass AwsIotAnalyticsParameters
|
514
532
|
# data as a hash:
|
@@ -591,12 +609,12 @@ module Aws::QuickSight
|
|
591
609
|
#
|
592
610
|
# {
|
593
611
|
# aws_account_id: "AwsAccountId", # required
|
594
|
-
# data_set_id: "
|
612
|
+
# data_set_id: "String", # required
|
595
613
|
# ingestion_id: "IngestionId", # required
|
596
614
|
# }
|
597
615
|
#
|
598
616
|
# @!attribute [rw] aws_account_id
|
599
|
-
# The Amazon Web Services account
|
617
|
+
# The Amazon Web Services account ID.
|
600
618
|
# @return [String]
|
601
619
|
#
|
602
620
|
# @!attribute [rw] data_set_id
|
@@ -776,8 +794,8 @@ module Aws::QuickSight
|
|
776
794
|
# }
|
777
795
|
#
|
778
796
|
# @!attribute [rw] principals
|
779
|
-
# An array of Amazon Resource Names (ARNs) for QuickSight users
|
780
|
-
# groups.
|
797
|
+
# An array of Amazon Resource Names (ARNs) for Amazon QuickSight users
|
798
|
+
# or groups.
|
781
799
|
# @return [Array<String>]
|
782
800
|
#
|
783
801
|
# @!attribute [rw] column_names
|
@@ -902,18 +920,19 @@ module Aws::QuickSight
|
|
902
920
|
# }
|
903
921
|
#
|
904
922
|
# @!attribute [rw] aws_account_id
|
905
|
-
# The ID for the Amazon Web Services account
|
906
|
-
# customize QuickSight for.
|
923
|
+
# The ID for the Amazon Web Services account that you want to
|
924
|
+
# customize Amazon QuickSight for.
|
907
925
|
# @return [String]
|
908
926
|
#
|
909
927
|
# @!attribute [rw] namespace
|
910
|
-
# The QuickSight namespace that you want to add customizations
|
928
|
+
# The Amazon QuickSight namespace that you want to add customizations
|
929
|
+
# to.
|
911
930
|
# @return [String]
|
912
931
|
#
|
913
932
|
# @!attribute [rw] account_customization
|
914
|
-
# The QuickSight customizations you're adding in the current
|
915
|
-
# Web Services Region
|
916
|
-
# account
|
933
|
+
# The Amazon QuickSight customizations you're adding in the current
|
934
|
+
# Amazon Web Services Region. You can add these to an Amazon Web
|
935
|
+
# Services account and a Amazon QuickSight namespace.
|
917
936
|
#
|
918
937
|
# For example, you can add a default theme by setting
|
919
938
|
# `AccountCustomization` to the midnight theme:
|
@@ -942,12 +961,12 @@ module Aws::QuickSight
|
|
942
961
|
|
943
962
|
# @!attribute [rw] arn
|
944
963
|
# The Amazon Resource Name (ARN) for the customization that you
|
945
|
-
# created for this Amazon Web Services account
|
964
|
+
# created for this Amazon Web Services account.
|
946
965
|
# @return [String]
|
947
966
|
#
|
948
967
|
# @!attribute [rw] aws_account_id
|
949
|
-
# The ID for the Amazon Web Services account
|
950
|
-
# customize QuickSight for.
|
968
|
+
# The ID for the Amazon Web Services account that you want to
|
969
|
+
# customize Amazon QuickSight for.
|
951
970
|
# @return [String]
|
952
971
|
#
|
953
972
|
# @!attribute [rw] namespace
|
@@ -955,8 +974,8 @@ module Aws::QuickSight
|
|
955
974
|
# @return [String]
|
956
975
|
#
|
957
976
|
# @!attribute [rw] account_customization
|
958
|
-
# The QuickSight customizations you're adding in the current
|
959
|
-
# Web Services Region
|
977
|
+
# The Amazon QuickSight customizations you're adding in the current
|
978
|
+
# Amazon Web Services Region.
|
960
979
|
# @return [Types::AccountCustomization]
|
961
980
|
#
|
962
981
|
# @!attribute [rw] request_id
|
@@ -1040,7 +1059,7 @@ module Aws::QuickSight
|
|
1040
1059
|
# }
|
1041
1060
|
#
|
1042
1061
|
# @!attribute [rw] aws_account_id
|
1043
|
-
# The ID of the Amazon Web Services account
|
1062
|
+
# The ID of the Amazon Web Services account where you are creating an
|
1044
1063
|
# analysis.
|
1045
1064
|
# @return [String]
|
1046
1065
|
#
|
@@ -1051,7 +1070,7 @@ module Aws::QuickSight
|
|
1051
1070
|
#
|
1052
1071
|
# @!attribute [rw] name
|
1053
1072
|
# A descriptive name for the analysis that you're creating. This name
|
1054
|
-
# displays for the analysis in the QuickSight console.
|
1073
|
+
# displays for the analysis in the Amazon QuickSight console.
|
1055
1074
|
# @return [String]
|
1056
1075
|
#
|
1057
1076
|
# @!attribute [rw] parameters
|
@@ -1078,8 +1097,8 @@ module Aws::QuickSight
|
|
1078
1097
|
#
|
1079
1098
|
# @!attribute [rw] theme_arn
|
1080
1099
|
# The ARN for the theme to apply to the analysis that you're
|
1081
|
-
# creating. To see the theme in the QuickSight console, make
|
1082
|
-
# you have access to it.
|
1100
|
+
# creating. To see the theme in the Amazon QuickSight console, make
|
1101
|
+
# sure that you have access to it.
|
1083
1102
|
# @return [String]
|
1084
1103
|
#
|
1085
1104
|
# @!attribute [rw] tags
|
@@ -1234,12 +1253,12 @@ module Aws::QuickSight
|
|
1234
1253
|
# }
|
1235
1254
|
#
|
1236
1255
|
# @!attribute [rw] aws_account_id
|
1237
|
-
# The ID of the Amazon Web Services account
|
1256
|
+
# The ID of the Amazon Web Services account where you want to create
|
1238
1257
|
# the dashboard.
|
1239
1258
|
# @return [String]
|
1240
1259
|
#
|
1241
1260
|
# @!attribute [rw] dashboard_id
|
1242
|
-
# The ID for the dashboard, also added to the
|
1261
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
1243
1262
|
# @return [String]
|
1244
1263
|
#
|
1245
1264
|
# @!attribute [rw] name
|
@@ -1255,7 +1274,7 @@ module Aws::QuickSight
|
|
1255
1274
|
# @!attribute [rw] permissions
|
1256
1275
|
# A structure that contains the permissions of the dashboard. You can
|
1257
1276
|
# use this structure for granting permissions by providing a list of
|
1258
|
-
#
|
1277
|
+
# IAMaction information for each principal ARN.
|
1259
1278
|
#
|
1260
1279
|
# To specify no permissions, omit the permissions list.
|
1261
1280
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1268,8 +1287,8 @@ module Aws::QuickSight
|
|
1268
1287
|
# from an analysis, first convert the analysis to a template by using
|
1269
1288
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
1270
1289
|
# Amazon Resource Name (ARN) of the source template. The
|
1271
|
-
# `SourceTemplate`ARN can contain any Amazon Web Services account
|
1272
|
-
# any QuickSight-supported Amazon Web Services Region
|
1290
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
1291
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
1273
1292
|
#
|
1274
1293
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
1275
1294
|
# the replacement datasets for the placeholders listed in the
|
@@ -1290,7 +1309,7 @@ module Aws::QuickSight
|
|
1290
1309
|
#
|
1291
1310
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
1292
1311
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
1293
|
-
# QuickSight disables the left filter pane on the published
|
1312
|
+
# Amazon QuickSight disables the left filter pane on the published
|
1294
1313
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
1295
1314
|
# option is `ENABLED` by default.
|
1296
1315
|
#
|
@@ -1308,8 +1327,7 @@ module Aws::QuickSight
|
|
1308
1327
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
1309
1328
|
# this dashboard. If you add a value for this field, it overrides the
|
1310
1329
|
# value that is used in the source entity. The theme ARN must exist in
|
1311
|
-
# the same Amazon Web Services account
|
1312
|
-
# dashboard.
|
1330
|
+
# the same Amazon Web Services account where you create the dashboard.
|
1313
1331
|
# @return [String]
|
1314
1332
|
#
|
1315
1333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -1457,6 +1475,10 @@ module Aws::QuickSight
|
|
1457
1475
|
# },
|
1458
1476
|
# ],
|
1459
1477
|
# },
|
1478
|
+
# untag_column_operation: {
|
1479
|
+
# column_name: "ColumnName", # required
|
1480
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
1481
|
+
# },
|
1460
1482
|
# },
|
1461
1483
|
# ],
|
1462
1484
|
# source: { # required
|
@@ -1473,6 +1495,7 @@ module Aws::QuickSight
|
|
1473
1495
|
# on_clause: "OnClause", # required
|
1474
1496
|
# },
|
1475
1497
|
# physical_table_id: "PhysicalTableId",
|
1498
|
+
# data_set_arn: "Arn",
|
1476
1499
|
# },
|
1477
1500
|
# },
|
1478
1501
|
# },
|
@@ -1528,15 +1551,19 @@ module Aws::QuickSight
|
|
1528
1551
|
# value: "TagValue", # required
|
1529
1552
|
# },
|
1530
1553
|
# ],
|
1554
|
+
# data_set_usage_configuration: {
|
1555
|
+
# disable_use_as_direct_query_source: false,
|
1556
|
+
# disable_use_as_imported_source: false,
|
1557
|
+
# },
|
1531
1558
|
# }
|
1532
1559
|
#
|
1533
1560
|
# @!attribute [rw] aws_account_id
|
1534
|
-
# The Amazon Web Services account
|
1561
|
+
# The Amazon Web Services account ID.
|
1535
1562
|
# @return [String]
|
1536
1563
|
#
|
1537
1564
|
# @!attribute [rw] data_set_id
|
1538
1565
|
# An ID for the dataset that you want to create. This ID is unique per
|
1539
|
-
# Amazon Web Services Region
|
1566
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
1540
1567
|
# @return [String]
|
1541
1568
|
#
|
1542
1569
|
# @!attribute [rw] name
|
@@ -1558,7 +1585,7 @@ module Aws::QuickSight
|
|
1558
1585
|
# @return [String]
|
1559
1586
|
#
|
1560
1587
|
# @!attribute [rw] column_groups
|
1561
|
-
# Groupings of columns that work together in certain QuickSight
|
1588
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
1562
1589
|
# features. Currently, only geospatial hierarchy is supported.
|
1563
1590
|
# @return [Array<Types::ColumnGroup>]
|
1564
1591
|
#
|
@@ -1591,6 +1618,11 @@ module Aws::QuickSight
|
|
1591
1618
|
# assigned to the dataset.
|
1592
1619
|
# @return [Array<Types::Tag>]
|
1593
1620
|
#
|
1621
|
+
# @!attribute [rw] data_set_usage_configuration
|
1622
|
+
# The usage configuration to apply to child datasets that reference
|
1623
|
+
# this dataset as a source.
|
1624
|
+
# @return [Types::DataSetUsageConfiguration]
|
1625
|
+
#
|
1594
1626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
1595
1627
|
#
|
1596
1628
|
class CreateDataSetRequest < Struct.new(
|
@@ -1606,7 +1638,8 @@ module Aws::QuickSight
|
|
1606
1638
|
:row_level_permission_data_set,
|
1607
1639
|
:row_level_permission_tag_configuration,
|
1608
1640
|
:column_level_permission_rules,
|
1609
|
-
:tags
|
1641
|
+
:tags,
|
1642
|
+
:data_set_usage_configuration)
|
1610
1643
|
SENSITIVE = []
|
1611
1644
|
include Aws::Structure
|
1612
1645
|
end
|
@@ -1617,8 +1650,7 @@ module Aws::QuickSight
|
|
1617
1650
|
#
|
1618
1651
|
# @!attribute [rw] data_set_id
|
1619
1652
|
# The ID for the dataset that you want to create. This ID is unique
|
1620
|
-
# per Amazon Web Services Region
|
1621
|
-
# account;.
|
1653
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
1622
1654
|
# @return [String]
|
1623
1655
|
#
|
1624
1656
|
# @!attribute [rw] ingestion_arn
|
@@ -1659,7 +1691,7 @@ module Aws::QuickSight
|
|
1659
1691
|
# aws_account_id: "AwsAccountId", # required
|
1660
1692
|
# data_source_id: "ResourceId", # required
|
1661
1693
|
# name: "ResourceName", # required
|
1662
|
-
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM
|
1694
|
+
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH
|
1663
1695
|
# data_source_parameters: {
|
1664
1696
|
# amazon_elasticsearch_parameters: {
|
1665
1697
|
# domain: "Domain", # required
|
@@ -1750,6 +1782,9 @@ module Aws::QuickSight
|
|
1750
1782
|
# query: "Query", # required
|
1751
1783
|
# max_rows: 1, # required
|
1752
1784
|
# },
|
1785
|
+
# amazon_open_search_parameters: {
|
1786
|
+
# domain: "Domain", # required
|
1787
|
+
# },
|
1753
1788
|
# },
|
1754
1789
|
# credentials: {
|
1755
1790
|
# credential_pair: {
|
@@ -1846,6 +1881,9 @@ module Aws::QuickSight
|
|
1846
1881
|
# query: "Query", # required
|
1847
1882
|
# max_rows: 1, # required
|
1848
1883
|
# },
|
1884
|
+
# amazon_open_search_parameters: {
|
1885
|
+
# domain: "Domain", # required
|
1886
|
+
# },
|
1849
1887
|
# },
|
1850
1888
|
# ],
|
1851
1889
|
# },
|
@@ -1872,12 +1910,12 @@ module Aws::QuickSight
|
|
1872
1910
|
# }
|
1873
1911
|
#
|
1874
1912
|
# @!attribute [rw] aws_account_id
|
1875
|
-
# The Amazon Web Services account
|
1913
|
+
# The Amazon Web Services account ID.
|
1876
1914
|
# @return [String]
|
1877
1915
|
#
|
1878
1916
|
# @!attribute [rw] data_source_id
|
1879
1917
|
# An ID for the data source. This ID is unique per Amazon Web Services
|
1880
|
-
# Region
|
1918
|
+
# Region for each Amazon Web Services account.
|
1881
1919
|
# @return [String]
|
1882
1920
|
#
|
1883
1921
|
# @!attribute [rw] name
|
@@ -1885,24 +1923,21 @@ module Aws::QuickSight
|
|
1885
1923
|
# @return [String]
|
1886
1924
|
#
|
1887
1925
|
# @!attribute [rw] type
|
1888
|
-
# The type of the data source.
|
1889
|
-
#
|
1890
|
-
# AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
|
1891
|
-
# S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
|
1892
|
-
# return a list of all data sources.
|
1926
|
+
# The type of the data source. To return a list of all data sources,
|
1927
|
+
# use `ListDataSources`.
|
1893
1928
|
#
|
1894
|
-
# `AMAZON_ELASTICSEARCH`
|
1929
|
+
# Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.
|
1895
1930
|
# @return [String]
|
1896
1931
|
#
|
1897
1932
|
# @!attribute [rw] data_source_parameters
|
1898
|
-
# The parameters that QuickSight uses to connect to your
|
1899
|
-
# source.
|
1933
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
1934
|
+
# underlying source.
|
1900
1935
|
# @return [Types::DataSourceParameters]
|
1901
1936
|
#
|
1902
1937
|
# @!attribute [rw] credentials
|
1903
|
-
# The credentials QuickSight that uses to connect to your
|
1904
|
-
# source. Currently, only credentials based on user name
|
1905
|
-
# are supported.
|
1938
|
+
# The credentials Amazon QuickSight that uses to connect to your
|
1939
|
+
# underlying source. Currently, only credentials based on user name
|
1940
|
+
# and password are supported.
|
1906
1941
|
# @return [Types::DataSourceCredentials]
|
1907
1942
|
#
|
1908
1943
|
# @!attribute [rw] permissions
|
@@ -1910,13 +1945,13 @@ module Aws::QuickSight
|
|
1910
1945
|
# @return [Array<Types::ResourcePermission>]
|
1911
1946
|
#
|
1912
1947
|
# @!attribute [rw] vpc_connection_properties
|
1913
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
1948
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
1914
1949
|
# connection when connecting to your underlying source.
|
1915
1950
|
# @return [Types::VpcConnectionProperties]
|
1916
1951
|
#
|
1917
1952
|
# @!attribute [rw] ssl_properties
|
1918
|
-
# Secure Socket Layer (SSL) properties that apply when
|
1919
|
-
# connects to your underlying source.
|
1953
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
1954
|
+
# QuickSight connects to your underlying source.
|
1920
1955
|
# @return [Types::SslProperties]
|
1921
1956
|
#
|
1922
1957
|
# @!attribute [rw] tags
|
@@ -1947,7 +1982,7 @@ module Aws::QuickSight
|
|
1947
1982
|
#
|
1948
1983
|
# @!attribute [rw] data_source_id
|
1949
1984
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
1950
|
-
# Region
|
1985
|
+
# Region for each Amazon Web Services account.
|
1951
1986
|
# @return [String]
|
1952
1987
|
#
|
1953
1988
|
# @!attribute [rw] creation_status
|
@@ -2153,8 +2188,8 @@ module Aws::QuickSight
|
|
2153
2188
|
# @return [String]
|
2154
2189
|
#
|
2155
2190
|
# @!attribute [rw] aws_account_id
|
2156
|
-
# The ID for the Amazon Web Services account
|
2157
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2191
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2192
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2158
2193
|
# contains your Amazon QuickSight account.
|
2159
2194
|
# @return [String]
|
2160
2195
|
#
|
@@ -2216,8 +2251,8 @@ module Aws::QuickSight
|
|
2216
2251
|
# @return [String]
|
2217
2252
|
#
|
2218
2253
|
# @!attribute [rw] aws_account_id
|
2219
|
-
# The ID for the Amazon Web Services account
|
2220
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2254
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2255
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2221
2256
|
# contains your Amazon QuickSight account.
|
2222
2257
|
# @return [String]
|
2223
2258
|
#
|
@@ -2275,13 +2310,13 @@ module Aws::QuickSight
|
|
2275
2310
|
# }
|
2276
2311
|
#
|
2277
2312
|
# @!attribute [rw] aws_account_id
|
2278
|
-
# The ID of the Amazon Web Services account
|
2279
|
-
# an
|
2313
|
+
# The ID of the Amazon Web Services account where you want to assign
|
2314
|
+
# an IAMpolicy to Amazon QuickSight users or groups.
|
2280
2315
|
# @return [String]
|
2281
2316
|
#
|
2282
2317
|
# @!attribute [rw] assignment_name
|
2283
2318
|
# The name of the assignment, also called a rule. It must be unique
|
2284
|
-
# within an Amazon Web Services account
|
2319
|
+
# within an Amazon Web Services account.
|
2285
2320
|
# @return [String]
|
2286
2321
|
#
|
2287
2322
|
# @!attribute [rw] assignment_status
|
@@ -2298,13 +2333,13 @@ module Aws::QuickSight
|
|
2298
2333
|
# @return [String]
|
2299
2334
|
#
|
2300
2335
|
# @!attribute [rw] policy_arn
|
2301
|
-
# The ARN for the
|
2302
|
-
# groups specified in this assignment.
|
2336
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users
|
2337
|
+
# and groups specified in this assignment.
|
2303
2338
|
# @return [String]
|
2304
2339
|
#
|
2305
2340
|
# @!attribute [rw] identities
|
2306
|
-
# The QuickSight users, groups, or both that you want to assign
|
2307
|
-
# policy to.
|
2341
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
2342
|
+
# the policy to.
|
2308
2343
|
# @return [Hash<String,Array<String>>]
|
2309
2344
|
#
|
2310
2345
|
# @!attribute [rw] namespace
|
@@ -2326,7 +2361,7 @@ module Aws::QuickSight
|
|
2326
2361
|
|
2327
2362
|
# @!attribute [rw] assignment_name
|
2328
2363
|
# The name of the assignment. This name must be unique within the
|
2329
|
-
# Amazon Web Services account
|
2364
|
+
# Amazon Web Services account.
|
2330
2365
|
# @return [String]
|
2331
2366
|
#
|
2332
2367
|
# @!attribute [rw] assignment_id
|
@@ -2347,12 +2382,12 @@ module Aws::QuickSight
|
|
2347
2382
|
# @return [String]
|
2348
2383
|
#
|
2349
2384
|
# @!attribute [rw] policy_arn
|
2350
|
-
# The ARN for the
|
2351
|
-
# and groups specified in this assignment.
|
2385
|
+
# The ARN for the IAMpolicy that is applied to the Amazon QuickSight
|
2386
|
+
# users and groups specified in this assignment.
|
2352
2387
|
# @return [String]
|
2353
2388
|
#
|
2354
2389
|
# @!attribute [rw] identities
|
2355
|
-
# The QuickSight users, groups, or both that the
|
2390
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
2356
2391
|
# assigned to.
|
2357
2392
|
# @return [Hash<String,Array<String>>]
|
2358
2393
|
#
|
@@ -2382,9 +2417,10 @@ module Aws::QuickSight
|
|
2382
2417
|
# data as a hash:
|
2383
2418
|
#
|
2384
2419
|
# {
|
2385
|
-
# data_set_id: "
|
2420
|
+
# data_set_id: "String", # required
|
2386
2421
|
# ingestion_id: "IngestionId", # required
|
2387
2422
|
# aws_account_id: "AwsAccountId", # required
|
2423
|
+
# ingestion_type: "INCREMENTAL_REFRESH", # accepts INCREMENTAL_REFRESH, FULL_REFRESH
|
2388
2424
|
# }
|
2389
2425
|
#
|
2390
2426
|
# @!attribute [rw] data_set_id
|
@@ -2396,7 +2432,11 @@ module Aws::QuickSight
|
|
2396
2432
|
# @return [String]
|
2397
2433
|
#
|
2398
2434
|
# @!attribute [rw] aws_account_id
|
2399
|
-
# The Amazon Web Services account
|
2435
|
+
# The Amazon Web Services account ID.
|
2436
|
+
# @return [String]
|
2437
|
+
#
|
2438
|
+
# @!attribute [rw] ingestion_type
|
2439
|
+
# The type of ingestion that you want to create.
|
2400
2440
|
# @return [String]
|
2401
2441
|
#
|
2402
2442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
@@ -2404,7 +2444,8 @@ module Aws::QuickSight
|
|
2404
2444
|
class CreateIngestionRequest < Struct.new(
|
2405
2445
|
:data_set_id,
|
2406
2446
|
:ingestion_id,
|
2407
|
-
:aws_account_id
|
2447
|
+
:aws_account_id,
|
2448
|
+
:ingestion_type)
|
2408
2449
|
SENSITIVE = []
|
2409
2450
|
include Aws::Structure
|
2410
2451
|
end
|
@@ -2457,8 +2498,8 @@ module Aws::QuickSight
|
|
2457
2498
|
# }
|
2458
2499
|
#
|
2459
2500
|
# @!attribute [rw] aws_account_id
|
2460
|
-
# The ID for the Amazon Web Services account
|
2461
|
-
# the QuickSight namespace in.
|
2501
|
+
# The ID for the Amazon Web Services account that you want to create
|
2502
|
+
# the Amazon QuickSight namespace in.
|
2462
2503
|
# @return [String]
|
2463
2504
|
#
|
2464
2505
|
# @!attribute [rw] namespace
|
@@ -2487,7 +2528,7 @@ module Aws::QuickSight
|
|
2487
2528
|
end
|
2488
2529
|
|
2489
2530
|
# @!attribute [rw] arn
|
2490
|
-
# The ARN of the QuickSight namespace you created.
|
2531
|
+
# The ARN of the Amazon QuickSight namespace you created.
|
2491
2532
|
# @return [String]
|
2492
2533
|
#
|
2493
2534
|
# @!attribute [rw] name
|
@@ -2546,8 +2587,8 @@ module Aws::QuickSight
|
|
2546
2587
|
# }
|
2547
2588
|
#
|
2548
2589
|
# @!attribute [rw] aws_account_id
|
2549
|
-
# The ID of the Amazon Web Services account
|
2550
|
-
#
|
2590
|
+
# The ID of the Amazon Web Services account that contains the template
|
2591
|
+
# that you creating an alias for.
|
2551
2592
|
# @return [String]
|
2552
2593
|
#
|
2553
2594
|
# @!attribute [rw] template_id
|
@@ -2634,15 +2675,15 @@ module Aws::QuickSight
|
|
2634
2675
|
# }
|
2635
2676
|
#
|
2636
2677
|
# @!attribute [rw] aws_account_id
|
2637
|
-
# The ID for the Amazon Web Services account
|
2638
|
-
#
|
2639
|
-
#
|
2678
|
+
# The ID for the Amazon Web Services account that the group is in. You
|
2679
|
+
# use the ID for the Amazon Web Services account that contains your
|
2680
|
+
# Amazon QuickSight account.
|
2640
2681
|
# @return [String]
|
2641
2682
|
#
|
2642
2683
|
# @!attribute [rw] template_id
|
2643
2684
|
# An ID for the template that you want to create. This template is
|
2644
2685
|
# unique per Amazon Web Services Region; in each Amazon Web Services
|
2645
|
-
# account
|
2686
|
+
# account.
|
2646
2687
|
# @return [String]
|
2647
2688
|
#
|
2648
2689
|
# @!attribute [rw] name
|
@@ -2660,8 +2701,8 @@ module Aws::QuickSight
|
|
2660
2701
|
# for an analysis. Both of these require an Amazon Resource Name
|
2661
2702
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2662
2703
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2663
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
2664
|
-
#
|
2704
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
2705
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
2665
2706
|
#
|
2666
2707
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2667
2708
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -2745,7 +2786,7 @@ module Aws::QuickSight
|
|
2745
2786
|
# }
|
2746
2787
|
#
|
2747
2788
|
# @!attribute [rw] aws_account_id
|
2748
|
-
# The ID of the Amazon Web Services account
|
2789
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2749
2790
|
# for the new theme alias.
|
2750
2791
|
# @return [String]
|
2751
2792
|
#
|
@@ -2860,14 +2901,13 @@ module Aws::QuickSight
|
|
2860
2901
|
# }
|
2861
2902
|
#
|
2862
2903
|
# @!attribute [rw] aws_account_id
|
2863
|
-
# The ID of the Amazon Web Services account
|
2904
|
+
# The ID of the Amazon Web Services account where you want to store
|
2864
2905
|
# the new theme.
|
2865
2906
|
# @return [String]
|
2866
2907
|
#
|
2867
2908
|
# @!attribute [rw] theme_id
|
2868
2909
|
# An ID for the theme that you want to create. The theme ID is unique
|
2869
|
-
# per Amazon Web Services Region
|
2870
|
-
# account;.
|
2910
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
2871
2911
|
# @return [String]
|
2872
2912
|
#
|
2873
2913
|
# @!attribute [rw] name
|
@@ -2878,7 +2918,7 @@ module Aws::QuickSight
|
|
2878
2918
|
# The ID of the theme that a custom theme will inherit from. All
|
2879
2919
|
# themes inherit from one of the starting themes defined by Amazon
|
2880
2920
|
# QuickSight. For a list of the starting themes, use `ListThemes` or
|
2881
|
-
# choose **Themes** from within a QuickSight analysis.
|
2921
|
+
# choose **Themes** from within a Amazon QuickSight analysis.
|
2882
2922
|
# @return [String]
|
2883
2923
|
#
|
2884
2924
|
# @!attribute [rw] version_description
|
@@ -3054,6 +3094,9 @@ module Aws::QuickSight
|
|
3054
3094
|
# query: "Query", # required
|
3055
3095
|
# max_rows: 1, # required
|
3056
3096
|
# },
|
3097
|
+
# amazon_open_search_parameters: {
|
3098
|
+
# domain: "Domain", # required
|
3099
|
+
# },
|
3057
3100
|
# },
|
3058
3101
|
# ],
|
3059
3102
|
# }
|
@@ -3584,6 +3627,11 @@ module Aws::QuickSight
|
|
3584
3627
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3585
3628
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
3586
3629
|
#
|
3630
|
+
# @!attribute [rw] data_set_usage_configuration
|
3631
|
+
# The usage configuration to apply to child datasets that reference
|
3632
|
+
# this dataset as a source.
|
3633
|
+
# @return [Types::DataSetUsageConfiguration]
|
3634
|
+
#
|
3587
3635
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
3588
3636
|
#
|
3589
3637
|
class DataSet < Struct.new(
|
@@ -3601,7 +3649,8 @@ module Aws::QuickSight
|
|
3601
3649
|
:field_folders,
|
3602
3650
|
:row_level_permission_data_set,
|
3603
3651
|
:row_level_permission_tag_configuration,
|
3604
|
-
:column_level_permission_rules
|
3652
|
+
:column_level_permission_rules,
|
3653
|
+
:data_set_usage_configuration)
|
3605
3654
|
SENSITIVE = []
|
3606
3655
|
include Aws::Structure
|
3607
3656
|
end
|
@@ -3727,6 +3776,36 @@ module Aws::QuickSight
|
|
3727
3776
|
include Aws::Structure
|
3728
3777
|
end
|
3729
3778
|
|
3779
|
+
# The usage configuration to apply to child datasets that reference this
|
3780
|
+
# dataset as a source.
|
3781
|
+
#
|
3782
|
+
# @note When making an API call, you may pass DataSetUsageConfiguration
|
3783
|
+
# data as a hash:
|
3784
|
+
#
|
3785
|
+
# {
|
3786
|
+
# disable_use_as_direct_query_source: false,
|
3787
|
+
# disable_use_as_imported_source: false,
|
3788
|
+
# }
|
3789
|
+
#
|
3790
|
+
# @!attribute [rw] disable_use_as_direct_query_source
|
3791
|
+
# An option that controls whether a child dataset of a direct query
|
3792
|
+
# can use this dataset as a source.
|
3793
|
+
# @return [Boolean]
|
3794
|
+
#
|
3795
|
+
# @!attribute [rw] disable_use_as_imported_source
|
3796
|
+
# An option that controls whether a child dataset that's stored in
|
3797
|
+
# QuickSight can use this dataset as a source.
|
3798
|
+
# @return [Boolean]
|
3799
|
+
#
|
3800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetUsageConfiguration AWS API Documentation
|
3801
|
+
#
|
3802
|
+
class DataSetUsageConfiguration < Struct.new(
|
3803
|
+
:disable_use_as_direct_query_source,
|
3804
|
+
:disable_use_as_imported_source)
|
3805
|
+
SENSITIVE = []
|
3806
|
+
include Aws::Structure
|
3807
|
+
end
|
3808
|
+
|
3730
3809
|
# The structure of a data source.
|
3731
3810
|
#
|
3732
3811
|
# @!attribute [rw] arn
|
@@ -3735,7 +3814,7 @@ module Aws::QuickSight
|
|
3735
3814
|
#
|
3736
3815
|
# @!attribute [rw] data_source_id
|
3737
3816
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3738
|
-
# Region
|
3817
|
+
# Region for each Amazon Web Services account.
|
3739
3818
|
# @return [String]
|
3740
3819
|
#
|
3741
3820
|
# @!attribute [rw] name
|
@@ -3781,13 +3860,13 @@ module Aws::QuickSight
|
|
3781
3860
|
#
|
3782
3861
|
# @!attribute [rw] vpc_connection_properties
|
3783
3862
|
# The VPC connection information. You need to use this parameter only
|
3784
|
-
# when you want QuickSight to use a VPC connection when
|
3785
|
-
# your underlying source.
|
3863
|
+
# when you want Amazon QuickSight to use a VPC connection when
|
3864
|
+
# connecting to your underlying source.
|
3786
3865
|
# @return [Types::VpcConnectionProperties]
|
3787
3866
|
#
|
3788
3867
|
# @!attribute [rw] ssl_properties
|
3789
|
-
# Secure Socket Layer (SSL) properties that apply when
|
3790
|
-
# connects to your underlying source.
|
3868
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
3869
|
+
# QuickSight connects to your underlying source.
|
3791
3870
|
# @return [Types::SslProperties]
|
3792
3871
|
#
|
3793
3872
|
# @!attribute [rw] error_info
|
@@ -3915,6 +3994,9 @@ module Aws::QuickSight
|
|
3915
3994
|
# query: "Query", # required
|
3916
3995
|
# max_rows: 1, # required
|
3917
3996
|
# },
|
3997
|
+
# amazon_open_search_parameters: {
|
3998
|
+
# domain: "Domain", # required
|
3999
|
+
# },
|
3918
4000
|
# },
|
3919
4001
|
# ],
|
3920
4002
|
# },
|
@@ -4057,88 +4139,94 @@ module Aws::QuickSight
|
|
4057
4139
|
# query: "Query", # required
|
4058
4140
|
# max_rows: 1, # required
|
4059
4141
|
# },
|
4142
|
+
# amazon_open_search_parameters: {
|
4143
|
+
# domain: "Domain", # required
|
4144
|
+
# },
|
4060
4145
|
# }
|
4061
4146
|
#
|
4062
4147
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
4063
|
-
#
|
4148
|
+
# The parameters for OpenSearch.
|
4064
4149
|
# @return [Types::AmazonElasticsearchParameters]
|
4065
4150
|
#
|
4066
4151
|
# @!attribute [rw] athena_parameters
|
4067
|
-
# Amazon Athena
|
4152
|
+
# The parameters for Amazon Athena.
|
4068
4153
|
# @return [Types::AthenaParameters]
|
4069
4154
|
#
|
4070
4155
|
# @!attribute [rw] aurora_parameters
|
4071
|
-
# Amazon Aurora MySQL
|
4156
|
+
# The parameters for Amazon Aurora MySQL.
|
4072
4157
|
# @return [Types::AuroraParameters]
|
4073
4158
|
#
|
4074
4159
|
# @!attribute [rw] aurora_postgre_sql_parameters
|
4075
|
-
#
|
4160
|
+
# The parameters for Amazon Aurora.
|
4076
4161
|
# @return [Types::AuroraPostgreSqlParameters]
|
4077
4162
|
#
|
4078
4163
|
# @!attribute [rw] aws_iot_analytics_parameters
|
4079
|
-
#
|
4164
|
+
# The parameters for IoT Analytics.
|
4080
4165
|
# @return [Types::AwsIotAnalyticsParameters]
|
4081
4166
|
#
|
4082
4167
|
# @!attribute [rw] jira_parameters
|
4083
|
-
#
|
4168
|
+
# The parameters for Jira.
|
4084
4169
|
# @return [Types::JiraParameters]
|
4085
4170
|
#
|
4086
4171
|
# @!attribute [rw] maria_db_parameters
|
4087
|
-
#
|
4172
|
+
# The parameters for MariaDB.
|
4088
4173
|
# @return [Types::MariaDbParameters]
|
4089
4174
|
#
|
4090
4175
|
# @!attribute [rw] my_sql_parameters
|
4091
|
-
#
|
4176
|
+
# The parameters for MySQL.
|
4092
4177
|
# @return [Types::MySqlParameters]
|
4093
4178
|
#
|
4094
4179
|
# @!attribute [rw] oracle_parameters
|
4095
|
-
#
|
4180
|
+
# The parameters for Oracle.
|
4096
4181
|
# @return [Types::OracleParameters]
|
4097
4182
|
#
|
4098
4183
|
# @!attribute [rw] postgre_sql_parameters
|
4099
|
-
#
|
4184
|
+
# The parameters for PostgreSQL.
|
4100
4185
|
# @return [Types::PostgreSqlParameters]
|
4101
4186
|
#
|
4102
4187
|
# @!attribute [rw] presto_parameters
|
4103
|
-
#
|
4188
|
+
# The parameters for Presto.
|
4104
4189
|
# @return [Types::PrestoParameters]
|
4105
4190
|
#
|
4106
4191
|
# @!attribute [rw] rds_parameters
|
4107
|
-
# Amazon RDS
|
4192
|
+
# The parameters for Amazon RDS.
|
4108
4193
|
# @return [Types::RdsParameters]
|
4109
4194
|
#
|
4110
4195
|
# @!attribute [rw] redshift_parameters
|
4111
|
-
# Amazon Redshift
|
4196
|
+
# The parameters for Amazon Redshift.
|
4112
4197
|
# @return [Types::RedshiftParameters]
|
4113
4198
|
#
|
4114
4199
|
# @!attribute [rw] s3_parameters
|
4115
|
-
#
|
4200
|
+
# The parameters for S3.
|
4116
4201
|
# @return [Types::S3Parameters]
|
4117
4202
|
#
|
4118
4203
|
# @!attribute [rw] service_now_parameters
|
4119
|
-
#
|
4204
|
+
# The parameters for ServiceNow.
|
4120
4205
|
# @return [Types::ServiceNowParameters]
|
4121
4206
|
#
|
4122
4207
|
# @!attribute [rw] snowflake_parameters
|
4123
|
-
#
|
4208
|
+
# The parameters for Snowflake.
|
4124
4209
|
# @return [Types::SnowflakeParameters]
|
4125
4210
|
#
|
4126
4211
|
# @!attribute [rw] spark_parameters
|
4127
|
-
#
|
4212
|
+
# The parameters for Spark.
|
4128
4213
|
# @return [Types::SparkParameters]
|
4129
4214
|
#
|
4130
4215
|
# @!attribute [rw] sql_server_parameters
|
4131
|
-
# SQL Server
|
4216
|
+
# The parameters for SQL Server.
|
4132
4217
|
# @return [Types::SqlServerParameters]
|
4133
4218
|
#
|
4134
4219
|
# @!attribute [rw] teradata_parameters
|
4135
|
-
#
|
4220
|
+
# The parameters for Teradata.
|
4136
4221
|
# @return [Types::TeradataParameters]
|
4137
4222
|
#
|
4138
4223
|
# @!attribute [rw] twitter_parameters
|
4139
|
-
#
|
4224
|
+
# The parameters for Twitter.
|
4140
4225
|
# @return [Types::TwitterParameters]
|
4141
4226
|
#
|
4227
|
+
# @!attribute [rw] amazon_open_search_parameters
|
4228
|
+
# @return [Types::AmazonOpenSearchParameters]
|
4229
|
+
#
|
4142
4230
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
4143
4231
|
#
|
4144
4232
|
class DataSourceParameters < Struct.new(
|
@@ -4161,7 +4249,8 @@ module Aws::QuickSight
|
|
4161
4249
|
:spark_parameters,
|
4162
4250
|
:sql_server_parameters,
|
4163
4251
|
:teradata_parameters,
|
4164
|
-
:twitter_parameters
|
4252
|
+
:twitter_parameters,
|
4253
|
+
:amazon_open_search_parameters)
|
4165
4254
|
SENSITIVE = []
|
4166
4255
|
include Aws::Structure
|
4167
4256
|
end
|
@@ -4229,13 +4318,14 @@ module Aws::QuickSight
|
|
4229
4318
|
# }
|
4230
4319
|
#
|
4231
4320
|
# @!attribute [rw] aws_account_id
|
4232
|
-
# The ID for the Amazon Web Services account
|
4233
|
-
# QuickSight customizations from in this Amazon Web Services
|
4321
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4322
|
+
# Amazon QuickSight customizations from in this Amazon Web Services
|
4323
|
+
# Region.
|
4234
4324
|
# @return [String]
|
4235
4325
|
#
|
4236
4326
|
# @!attribute [rw] namespace
|
4237
|
-
# The QuickSight namespace that you're deleting the
|
4238
|
-
# from.
|
4327
|
+
# The Amazon QuickSight namespace that you're deleting the
|
4328
|
+
# customizations from.
|
4239
4329
|
# @return [String]
|
4240
4330
|
#
|
4241
4331
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
@@ -4275,7 +4365,7 @@ module Aws::QuickSight
|
|
4275
4365
|
# }
|
4276
4366
|
#
|
4277
4367
|
# @!attribute [rw] aws_account_id
|
4278
|
-
# The ID of the Amazon Web Services account
|
4368
|
+
# The ID of the Amazon Web Services account where you want to delete
|
4279
4369
|
# an analysis.
|
4280
4370
|
# @return [String]
|
4281
4371
|
#
|
@@ -4284,10 +4374,10 @@ module Aws::QuickSight
|
|
4284
4374
|
# @return [String]
|
4285
4375
|
#
|
4286
4376
|
# @!attribute [rw] recovery_window_in_days
|
4287
|
-
# A value that specifies the number of days that QuickSight
|
4288
|
-
# before it deletes the analysis. You can't use this parameter
|
4289
|
-
# the `ForceDeleteWithoutRecovery` option in the same API call.
|
4290
|
-
# default value is 30.
|
4377
|
+
# A value that specifies the number of days that Amazon QuickSight
|
4378
|
+
# waits before it deletes the analysis. You can't use this parameter
|
4379
|
+
# with the `ForceDeleteWithoutRecovery` option in the same API call.
|
4380
|
+
# The default value is 30.
|
4291
4381
|
# @return [Integer]
|
4292
4382
|
#
|
4293
4383
|
# @!attribute [rw] force_delete_without_recovery
|
@@ -4350,7 +4440,7 @@ module Aws::QuickSight
|
|
4350
4440
|
# }
|
4351
4441
|
#
|
4352
4442
|
# @!attribute [rw] aws_account_id
|
4353
|
-
# The ID of the Amazon Web Services account
|
4443
|
+
# The ID of the Amazon Web Services account that contains the
|
4354
4444
|
# dashboard that you're deleting.
|
4355
4445
|
# @return [String]
|
4356
4446
|
#
|
@@ -4410,13 +4500,12 @@ module Aws::QuickSight
|
|
4410
4500
|
# }
|
4411
4501
|
#
|
4412
4502
|
# @!attribute [rw] aws_account_id
|
4413
|
-
# The Amazon Web Services account
|
4503
|
+
# The Amazon Web Services account ID.
|
4414
4504
|
# @return [String]
|
4415
4505
|
#
|
4416
4506
|
# @!attribute [rw] data_set_id
|
4417
4507
|
# The ID for the dataset that you want to create. This ID is unique
|
4418
|
-
# per Amazon Web Services Region
|
4419
|
-
# account;.
|
4508
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
4420
4509
|
# @return [String]
|
4421
4510
|
#
|
4422
4511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4434,8 +4523,7 @@ module Aws::QuickSight
|
|
4434
4523
|
#
|
4435
4524
|
# @!attribute [rw] data_set_id
|
4436
4525
|
# The ID for the dataset that you want to create. This ID is unique
|
4437
|
-
# per Amazon Web Services Region
|
4438
|
-
# account;.
|
4526
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
4439
4527
|
# @return [String]
|
4440
4528
|
#
|
4441
4529
|
# @!attribute [rw] request_id
|
@@ -4466,12 +4554,12 @@ module Aws::QuickSight
|
|
4466
4554
|
# }
|
4467
4555
|
#
|
4468
4556
|
# @!attribute [rw] aws_account_id
|
4469
|
-
# The Amazon Web Services account
|
4557
|
+
# The Amazon Web Services account ID.
|
4470
4558
|
# @return [String]
|
4471
4559
|
#
|
4472
4560
|
# @!attribute [rw] data_source_id
|
4473
4561
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
4474
|
-
# Region
|
4562
|
+
# Region for each Amazon Web Services account.
|
4475
4563
|
# @return [String]
|
4476
4564
|
#
|
4477
4565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4489,7 +4577,7 @@ module Aws::QuickSight
|
|
4489
4577
|
#
|
4490
4578
|
# @!attribute [rw] data_source_id
|
4491
4579
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
4492
|
-
# Region
|
4580
|
+
# Region for each Amazon Web Services account.
|
4493
4581
|
# @return [String]
|
4494
4582
|
#
|
4495
4583
|
# @!attribute [rw] request_id
|
@@ -4641,8 +4729,8 @@ module Aws::QuickSight
|
|
4641
4729
|
# @return [String]
|
4642
4730
|
#
|
4643
4731
|
# @!attribute [rw] aws_account_id
|
4644
|
-
# The ID for the Amazon Web Services account
|
4645
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4732
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4733
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4646
4734
|
# contains your Amazon QuickSight account.
|
4647
4735
|
# @return [String]
|
4648
4736
|
#
|
@@ -4692,8 +4780,8 @@ module Aws::QuickSight
|
|
4692
4780
|
# @return [String]
|
4693
4781
|
#
|
4694
4782
|
# @!attribute [rw] aws_account_id
|
4695
|
-
# The ID for the Amazon Web Services account
|
4696
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4783
|
+
# The ID for the Amazon Web Services account that the group is in.
|
4784
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4697
4785
|
# contains your Amazon QuickSight account.
|
4698
4786
|
# @return [String]
|
4699
4787
|
#
|
@@ -4738,8 +4826,8 @@ module Aws::QuickSight
|
|
4738
4826
|
# }
|
4739
4827
|
#
|
4740
4828
|
# @!attribute [rw] aws_account_id
|
4741
|
-
# The Amazon Web Services account
|
4742
|
-
#
|
4829
|
+
# The Amazon Web Services account ID where you want to delete the
|
4830
|
+
# IAMpolicy assignment.
|
4743
4831
|
# @return [String]
|
4744
4832
|
#
|
4745
4833
|
# @!attribute [rw] assignment_name
|
@@ -4791,8 +4879,8 @@ module Aws::QuickSight
|
|
4791
4879
|
# }
|
4792
4880
|
#
|
4793
4881
|
# @!attribute [rw] aws_account_id
|
4794
|
-
# The ID for the Amazon Web Services account
|
4795
|
-
# the QuickSight namespace from.
|
4882
|
+
# The ID for the Amazon Web Services account that you want to delete
|
4883
|
+
# the Amazon QuickSight namespace from.
|
4796
4884
|
# @return [String]
|
4797
4885
|
#
|
4798
4886
|
# @!attribute [rw] namespace
|
@@ -4835,7 +4923,7 @@ module Aws::QuickSight
|
|
4835
4923
|
# }
|
4836
4924
|
#
|
4837
4925
|
# @!attribute [rw] aws_account_id
|
4838
|
-
# The ID of the Amazon Web Services account
|
4926
|
+
# The ID of the Amazon Web Services account that contains the item to
|
4839
4927
|
# delete.
|
4840
4928
|
# @return [String]
|
4841
4929
|
#
|
@@ -4902,8 +4990,8 @@ module Aws::QuickSight
|
|
4902
4990
|
# }
|
4903
4991
|
#
|
4904
4992
|
# @!attribute [rw] aws_account_id
|
4905
|
-
# The ID of the Amazon Web Services account
|
4906
|
-
#
|
4993
|
+
# The ID of the Amazon Web Services account that contains the template
|
4994
|
+
# that you're deleting.
|
4907
4995
|
# @return [String]
|
4908
4996
|
#
|
4909
4997
|
# @!attribute [rw] template_id
|
@@ -4963,7 +5051,7 @@ module Aws::QuickSight
|
|
4963
5051
|
# }
|
4964
5052
|
#
|
4965
5053
|
# @!attribute [rw] aws_account_id
|
4966
|
-
# The ID of the Amazon Web Services account
|
5054
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4967
5055
|
# alias to delete.
|
4968
5056
|
# @return [String]
|
4969
5057
|
#
|
@@ -5028,7 +5116,7 @@ module Aws::QuickSight
|
|
5028
5116
|
# }
|
5029
5117
|
#
|
5030
5118
|
# @!attribute [rw] aws_account_id
|
5031
|
-
# The ID of the Amazon Web Services account
|
5119
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5032
5120
|
# that you're deleting.
|
5033
5121
|
# @return [String]
|
5034
5122
|
#
|
@@ -5094,8 +5182,8 @@ module Aws::QuickSight
|
|
5094
5182
|
# @return [String]
|
5095
5183
|
#
|
5096
5184
|
# @!attribute [rw] aws_account_id
|
5097
|
-
# The ID for the Amazon Web Services account
|
5098
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5185
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5186
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5099
5187
|
# contains your Amazon QuickSight account.
|
5100
5188
|
# @return [String]
|
5101
5189
|
#
|
@@ -5144,8 +5232,8 @@ module Aws::QuickSight
|
|
5144
5232
|
# @return [String]
|
5145
5233
|
#
|
5146
5234
|
# @!attribute [rw] aws_account_id
|
5147
|
-
# The ID for the Amazon Web Services account
|
5148
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5235
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5236
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5149
5237
|
# contains your Amazon QuickSight account.
|
5150
5238
|
# @return [String]
|
5151
5239
|
#
|
@@ -5190,22 +5278,22 @@ module Aws::QuickSight
|
|
5190
5278
|
# }
|
5191
5279
|
#
|
5192
5280
|
# @!attribute [rw] aws_account_id
|
5193
|
-
# The ID for the Amazon Web Services account
|
5194
|
-
#
|
5281
|
+
# The ID for the Amazon Web Services account that you want to describe
|
5282
|
+
# Amazon QuickSight customizations for.
|
5195
5283
|
# @return [String]
|
5196
5284
|
#
|
5197
5285
|
# @!attribute [rw] namespace
|
5198
|
-
# The QuickSight namespace that you want to describe
|
5199
|
-
# customizations for.
|
5286
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
5287
|
+
# QuickSight customizations for.
|
5200
5288
|
# @return [String]
|
5201
5289
|
#
|
5202
5290
|
# @!attribute [rw] resolved
|
5203
5291
|
# The `Resolved` flag works with the other parameters to determine
|
5204
|
-
# which view of QuickSight customizations is returned. You can
|
5205
|
-
# this flag to your command to use the same view that
|
5206
|
-
# to identify which customizations to apply to the
|
5207
|
-
# flag, or set it to `no-resolved`, to reveal
|
5208
|
-
# configured at different levels.
|
5292
|
+
# which view of Amazon QuickSight customizations is returned. You can
|
5293
|
+
# add this flag to your command to use the same view that Amazon
|
5294
|
+
# QuickSight uses to identify which customizations to apply to the
|
5295
|
+
# console. Omit this flag, or set it to `no-resolved`, to reveal
|
5296
|
+
# customizations that are configured at different levels.
|
5209
5297
|
# @return [Boolean]
|
5210
5298
|
#
|
5211
5299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
@@ -5220,20 +5308,20 @@ module Aws::QuickSight
|
|
5220
5308
|
|
5221
5309
|
# @!attribute [rw] arn
|
5222
5310
|
# The Amazon Resource Name (ARN) of the customization that's
|
5223
|
-
# associated with this Amazon Web Services account
|
5311
|
+
# associated with this Amazon Web Services account.
|
5224
5312
|
# @return [String]
|
5225
5313
|
#
|
5226
5314
|
# @!attribute [rw] aws_account_id
|
5227
|
-
# The ID for the Amazon Web Services account
|
5315
|
+
# The ID for the Amazon Web Services account that you're describing.
|
5228
5316
|
# @return [String]
|
5229
5317
|
#
|
5230
5318
|
# @!attribute [rw] namespace
|
5231
|
-
# The QuickSight namespace that you're describing.
|
5319
|
+
# The Amazon QuickSight namespace that you're describing.
|
5232
5320
|
# @return [String]
|
5233
5321
|
#
|
5234
5322
|
# @!attribute [rw] account_customization
|
5235
|
-
# The QuickSight customizations that exist in the current
|
5236
|
-
# Services Region
|
5323
|
+
# The Amazon QuickSight customizations that exist in the current
|
5324
|
+
# Amazon Web Services Region.
|
5237
5325
|
# @return [Types::AccountCustomization]
|
5238
5326
|
#
|
5239
5327
|
# @!attribute [rw] request_id
|
@@ -5265,7 +5353,7 @@ module Aws::QuickSight
|
|
5265
5353
|
# }
|
5266
5354
|
#
|
5267
5355
|
# @!attribute [rw] aws_account_id
|
5268
|
-
# The ID for the Amazon Web Services account
|
5356
|
+
# The ID for the Amazon Web Services account that contains the
|
5269
5357
|
# settings that you want to list.
|
5270
5358
|
# @return [String]
|
5271
5359
|
#
|
@@ -5278,16 +5366,16 @@ module Aws::QuickSight
|
|
5278
5366
|
end
|
5279
5367
|
|
5280
5368
|
# @!attribute [rw] account_settings
|
5281
|
-
# The QuickSight settings for this Amazon Web Services account
|
5282
|
-
# information includes the edition of Amazon QuickSight
|
5283
|
-
# subscribed to (Standard or Enterprise) and the notification
|
5284
|
-
# for the QuickSight subscription. In the
|
5285
|
-
# QuickSight
|
5286
|
-
# "account" even though it's
|
5287
|
-
# Instead, it's a subscription
|
5288
|
-
#
|
5289
|
-
#
|
5290
|
-
# use it.
|
5369
|
+
# The Amazon QuickSight settings for this Amazon Web Services account.
|
5370
|
+
# This information includes the edition of Amazon Amazon QuickSight
|
5371
|
+
# that you subscribed to (Standard or Enterprise) and the notification
|
5372
|
+
# email for the Amazon QuickSight subscription. In the Amazon
|
5373
|
+
# QuickSight console, the Amazon QuickSight subscription is sometimes
|
5374
|
+
# referred to as a Amazon QuickSight "account" even though it's
|
5375
|
+
# technically not an account by itself. Instead, it's a subscription
|
5376
|
+
# to the Amazon QuickSight service for your Amazon Web Services
|
5377
|
+
# account. The edition that you subscribe to applies to Amazon
|
5378
|
+
# QuickSight in every Amazon Web Services Region where you use it.
|
5291
5379
|
# @return [Types::AccountSettings]
|
5292
5380
|
#
|
5293
5381
|
# @!attribute [rw] request_id
|
@@ -5317,9 +5405,9 @@ module Aws::QuickSight
|
|
5317
5405
|
# }
|
5318
5406
|
#
|
5319
5407
|
# @!attribute [rw] aws_account_id
|
5320
|
-
# The ID of the Amazon Web Services account
|
5321
|
-
#
|
5322
|
-
#
|
5408
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
5409
|
+
# whose permissions you're describing. You must be using the Amazon
|
5410
|
+
# Web Services account that the analysis is in.
|
5323
5411
|
# @return [String]
|
5324
5412
|
#
|
5325
5413
|
# @!attribute [rw] analysis_id
|
@@ -5379,9 +5467,9 @@ module Aws::QuickSight
|
|
5379
5467
|
# }
|
5380
5468
|
#
|
5381
5469
|
# @!attribute [rw] aws_account_id
|
5382
|
-
# The ID of the Amazon Web Services account
|
5383
|
-
# analysis. You must be using the Amazon Web Services account
|
5384
|
-
#
|
5470
|
+
# The ID of the Amazon Web Services account that contains the
|
5471
|
+
# analysis. You must be using the Amazon Web Services account that the
|
5472
|
+
# analysis is in.
|
5385
5473
|
# @return [String]
|
5386
5474
|
#
|
5387
5475
|
# @!attribute [rw] analysis_id
|
@@ -5430,12 +5518,12 @@ module Aws::QuickSight
|
|
5430
5518
|
# }
|
5431
5519
|
#
|
5432
5520
|
# @!attribute [rw] aws_account_id
|
5433
|
-
# The ID of the Amazon Web Services account
|
5521
|
+
# The ID of the Amazon Web Services account that contains the
|
5434
5522
|
# dashboard that you're describing permissions for.
|
5435
5523
|
# @return [String]
|
5436
5524
|
#
|
5437
5525
|
# @!attribute [rw] dashboard_id
|
5438
|
-
# The ID for the dashboard, also added to the
|
5526
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
5439
5527
|
# @return [String]
|
5440
5528
|
#
|
5441
5529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -5490,7 +5578,7 @@ module Aws::QuickSight
|
|
5490
5578
|
# }
|
5491
5579
|
#
|
5492
5580
|
# @!attribute [rw] aws_account_id
|
5493
|
-
# The ID of the Amazon Web Services account
|
5581
|
+
# The ID of the Amazon Web Services account that contains the
|
5494
5582
|
# dashboard that you're describing.
|
5495
5583
|
# @return [String]
|
5496
5584
|
#
|
@@ -5549,13 +5637,12 @@ module Aws::QuickSight
|
|
5549
5637
|
# }
|
5550
5638
|
#
|
5551
5639
|
# @!attribute [rw] aws_account_id
|
5552
|
-
# The Amazon Web Services account
|
5640
|
+
# The Amazon Web Services account ID.
|
5553
5641
|
# @return [String]
|
5554
5642
|
#
|
5555
5643
|
# @!attribute [rw] data_set_id
|
5556
5644
|
# The ID for the dataset that you want to create. This ID is unique
|
5557
|
-
# per Amazon Web Services Region
|
5558
|
-
# account;.
|
5645
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
5559
5646
|
# @return [String]
|
5560
5647
|
#
|
5561
5648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5573,8 +5660,7 @@ module Aws::QuickSight
|
|
5573
5660
|
#
|
5574
5661
|
# @!attribute [rw] data_set_id
|
5575
5662
|
# The ID for the dataset that you want to create. This ID is unique
|
5576
|
-
# per Amazon Web Services Region
|
5577
|
-
# account;.
|
5663
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
5578
5664
|
# @return [String]
|
5579
5665
|
#
|
5580
5666
|
# @!attribute [rw] permissions
|
@@ -5610,13 +5696,12 @@ module Aws::QuickSight
|
|
5610
5696
|
# }
|
5611
5697
|
#
|
5612
5698
|
# @!attribute [rw] aws_account_id
|
5613
|
-
# The Amazon Web Services account
|
5699
|
+
# The Amazon Web Services account ID.
|
5614
5700
|
# @return [String]
|
5615
5701
|
#
|
5616
5702
|
# @!attribute [rw] data_set_id
|
5617
5703
|
# The ID for the dataset that you want to create. This ID is unique
|
5618
|
-
# per Amazon Web Services Region
|
5619
|
-
# account;.
|
5704
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
5620
5705
|
# @return [String]
|
5621
5706
|
#
|
5622
5707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5659,12 +5744,12 @@ module Aws::QuickSight
|
|
5659
5744
|
# }
|
5660
5745
|
#
|
5661
5746
|
# @!attribute [rw] aws_account_id
|
5662
|
-
# The Amazon Web Services account
|
5747
|
+
# The Amazon Web Services account ID.
|
5663
5748
|
# @return [String]
|
5664
5749
|
#
|
5665
5750
|
# @!attribute [rw] data_source_id
|
5666
5751
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5667
|
-
# Region
|
5752
|
+
# Region for each Amazon Web Services account.
|
5668
5753
|
# @return [String]
|
5669
5754
|
#
|
5670
5755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5682,7 +5767,7 @@ module Aws::QuickSight
|
|
5682
5767
|
#
|
5683
5768
|
# @!attribute [rw] data_source_id
|
5684
5769
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5685
|
-
# Region
|
5770
|
+
# Region for each Amazon Web Services account.
|
5686
5771
|
# @return [String]
|
5687
5772
|
#
|
5688
5773
|
# @!attribute [rw] permissions
|
@@ -5718,12 +5803,12 @@ module Aws::QuickSight
|
|
5718
5803
|
# }
|
5719
5804
|
#
|
5720
5805
|
# @!attribute [rw] aws_account_id
|
5721
|
-
# The Amazon Web Services account
|
5806
|
+
# The Amazon Web Services account ID.
|
5722
5807
|
# @return [String]
|
5723
5808
|
#
|
5724
5809
|
# @!attribute [rw] data_source_id
|
5725
5810
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5726
|
-
# Region
|
5811
|
+
# Region for each Amazon Web Services account.
|
5727
5812
|
# @return [String]
|
5728
5813
|
#
|
5729
5814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -5932,8 +6017,8 @@ module Aws::QuickSight
|
|
5932
6017
|
# @return [String]
|
5933
6018
|
#
|
5934
6019
|
# @!attribute [rw] aws_account_id
|
5935
|
-
# The ID for the Amazon Web Services account
|
5936
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6020
|
+
# The ID for the Amazon Web Services account that the group is in.
|
6021
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5937
6022
|
# contains your Amazon QuickSight account.
|
5938
6023
|
# @return [String]
|
5939
6024
|
#
|
@@ -5983,7 +6068,7 @@ module Aws::QuickSight
|
|
5983
6068
|
# }
|
5984
6069
|
#
|
5985
6070
|
# @!attribute [rw] aws_account_id
|
5986
|
-
# The ID of the Amazon Web Services account
|
6071
|
+
# The ID of the Amazon Web Services account that contains the
|
5987
6072
|
# assignment that you want to describe.
|
5988
6073
|
# @return [String]
|
5989
6074
|
#
|
@@ -6006,7 +6091,7 @@ module Aws::QuickSight
|
|
6006
6091
|
end
|
6007
6092
|
|
6008
6093
|
# @!attribute [rw] iam_policy_assignment
|
6009
|
-
# Information describing the
|
6094
|
+
# Information describing the IAMpolicy assignment.
|
6010
6095
|
# @return [Types::IAMPolicyAssignment]
|
6011
6096
|
#
|
6012
6097
|
# @!attribute [rw] request_id
|
@@ -6032,12 +6117,12 @@ module Aws::QuickSight
|
|
6032
6117
|
#
|
6033
6118
|
# {
|
6034
6119
|
# aws_account_id: "AwsAccountId", # required
|
6035
|
-
# data_set_id: "
|
6120
|
+
# data_set_id: "String", # required
|
6036
6121
|
# ingestion_id: "IngestionId", # required
|
6037
6122
|
# }
|
6038
6123
|
#
|
6039
6124
|
# @!attribute [rw] aws_account_id
|
6040
|
-
# The Amazon Web Services account
|
6125
|
+
# The Amazon Web Services account ID.
|
6041
6126
|
# @return [String]
|
6042
6127
|
#
|
6043
6128
|
# @!attribute [rw] data_set_id
|
@@ -6080,6 +6165,58 @@ module Aws::QuickSight
|
|
6080
6165
|
include Aws::Structure
|
6081
6166
|
end
|
6082
6167
|
|
6168
|
+
# @note When making an API call, you may pass DescribeIpRestrictionRequest
|
6169
|
+
# data as a hash:
|
6170
|
+
#
|
6171
|
+
# {
|
6172
|
+
# aws_account_id: "AwsAccountId", # required
|
6173
|
+
# }
|
6174
|
+
#
|
6175
|
+
# @!attribute [rw] aws_account_id
|
6176
|
+
# Your AWS account ID.
|
6177
|
+
# @return [String]
|
6178
|
+
#
|
6179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionRequest AWS API Documentation
|
6180
|
+
#
|
6181
|
+
class DescribeIpRestrictionRequest < Struct.new(
|
6182
|
+
:aws_account_id)
|
6183
|
+
SENSITIVE = []
|
6184
|
+
include Aws::Structure
|
6185
|
+
end
|
6186
|
+
|
6187
|
+
# @!attribute [rw] aws_account_id
|
6188
|
+
# Your AWS account ID.
|
6189
|
+
# @return [String]
|
6190
|
+
#
|
6191
|
+
# @!attribute [rw] ip_restriction_rule_map
|
6192
|
+
# Describes the IP rules with CIDR range and description.
|
6193
|
+
# @return [Hash<String,String>]
|
6194
|
+
#
|
6195
|
+
# @!attribute [rw] enabled
|
6196
|
+
# Whether or not IP rules are enabled.
|
6197
|
+
# @return [Boolean]
|
6198
|
+
#
|
6199
|
+
# @!attribute [rw] request_id
|
6200
|
+
# The ID of the describe request.
|
6201
|
+
# @return [String]
|
6202
|
+
#
|
6203
|
+
# @!attribute [rw] status
|
6204
|
+
# The status of a set of IP restrictions. A successful request returns
|
6205
|
+
# a 200 status code.
|
6206
|
+
# @return [Integer]
|
6207
|
+
#
|
6208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionResponse AWS API Documentation
|
6209
|
+
#
|
6210
|
+
class DescribeIpRestrictionResponse < Struct.new(
|
6211
|
+
:aws_account_id,
|
6212
|
+
:ip_restriction_rule_map,
|
6213
|
+
:enabled,
|
6214
|
+
:request_id,
|
6215
|
+
:status)
|
6216
|
+
SENSITIVE = []
|
6217
|
+
include Aws::Structure
|
6218
|
+
end
|
6219
|
+
|
6083
6220
|
# @note When making an API call, you may pass DescribeNamespaceRequest
|
6084
6221
|
# data as a hash:
|
6085
6222
|
#
|
@@ -6089,7 +6226,7 @@ module Aws::QuickSight
|
|
6089
6226
|
# }
|
6090
6227
|
#
|
6091
6228
|
# @!attribute [rw] aws_account_id
|
6092
|
-
# The ID for the Amazon Web Services account
|
6229
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6093
6230
|
# QuickSight namespace that you want to describe.
|
6094
6231
|
# @return [String]
|
6095
6232
|
#
|
@@ -6109,7 +6246,7 @@ module Aws::QuickSight
|
|
6109
6246
|
# @!attribute [rw] namespace
|
6110
6247
|
# The information about the namespace that you're describing. The
|
6111
6248
|
# response includes the namespace ARN, name, Amazon Web Services
|
6112
|
-
# Region
|
6249
|
+
# Region, creation status, and identity store. `DescribeNamespace`
|
6113
6250
|
# also works for namespaces that are in the process of being created.
|
6114
6251
|
# For incomplete namespaces, this API operation lists the namespace
|
6115
6252
|
# error types and messages associated with the creation process.
|
@@ -6143,8 +6280,8 @@ module Aws::QuickSight
|
|
6143
6280
|
# }
|
6144
6281
|
#
|
6145
6282
|
# @!attribute [rw] aws_account_id
|
6146
|
-
# The ID of the Amazon Web Services account
|
6147
|
-
#
|
6283
|
+
# The ID of the Amazon Web Services account that contains the template
|
6284
|
+
# alias that you're describing.
|
6148
6285
|
# @return [String]
|
6149
6286
|
#
|
6150
6287
|
# @!attribute [rw] template_id
|
@@ -6200,8 +6337,8 @@ module Aws::QuickSight
|
|
6200
6337
|
# }
|
6201
6338
|
#
|
6202
6339
|
# @!attribute [rw] aws_account_id
|
6203
|
-
# The ID of the Amazon Web Services account
|
6204
|
-
#
|
6340
|
+
# The ID of the Amazon Web Services account that contains the template
|
6341
|
+
# that you're describing.
|
6205
6342
|
# @return [String]
|
6206
6343
|
#
|
6207
6344
|
# @!attribute [rw] template_id
|
@@ -6260,8 +6397,8 @@ module Aws::QuickSight
|
|
6260
6397
|
# }
|
6261
6398
|
#
|
6262
6399
|
# @!attribute [rw] aws_account_id
|
6263
|
-
# The ID of the Amazon Web Services account
|
6264
|
-
#
|
6400
|
+
# The ID of the Amazon Web Services account that contains the template
|
6401
|
+
# that you're describing.
|
6265
6402
|
# @return [String]
|
6266
6403
|
#
|
6267
6404
|
# @!attribute [rw] template_id
|
@@ -6325,7 +6462,7 @@ module Aws::QuickSight
|
|
6325
6462
|
# }
|
6326
6463
|
#
|
6327
6464
|
# @!attribute [rw] aws_account_id
|
6328
|
-
# The ID of the Amazon Web Services account
|
6465
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6329
6466
|
# alias that you're describing.
|
6330
6467
|
# @return [String]
|
6331
6468
|
#
|
@@ -6378,7 +6515,7 @@ module Aws::QuickSight
|
|
6378
6515
|
# }
|
6379
6516
|
#
|
6380
6517
|
# @!attribute [rw] aws_account_id
|
6381
|
-
# The ID of the Amazon Web Services account
|
6518
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6382
6519
|
# that you're describing.
|
6383
6520
|
# @return [String]
|
6384
6521
|
#
|
@@ -6438,7 +6575,7 @@ module Aws::QuickSight
|
|
6438
6575
|
# }
|
6439
6576
|
#
|
6440
6577
|
# @!attribute [rw] aws_account_id
|
6441
|
-
# The ID of the Amazon Web Services account
|
6578
|
+
# The ID of the Amazon Web Services account that contains the theme
|
6442
6579
|
# that you're describing.
|
6443
6580
|
# @return [String]
|
6444
6581
|
#
|
@@ -6507,8 +6644,8 @@ module Aws::QuickSight
|
|
6507
6644
|
# @return [String]
|
6508
6645
|
#
|
6509
6646
|
# @!attribute [rw] aws_account_id
|
6510
|
-
# The ID for the Amazon Web Services account
|
6511
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6647
|
+
# The ID for the Amazon Web Services account that the user is in.
|
6648
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6512
6649
|
# contains your Amazon QuickSight account.
|
6513
6650
|
# @return [String]
|
6514
6651
|
#
|
@@ -6910,6 +7047,9 @@ module Aws::QuickSight
|
|
6910
7047
|
# quick_sight_console: {
|
6911
7048
|
# initial_path: "EntryPath",
|
6912
7049
|
# },
|
7050
|
+
# q_search_bar: {
|
7051
|
+
# initial_topic_id: "RestrictiveResourceId",
|
7052
|
+
# },
|
6913
7053
|
# },
|
6914
7054
|
# }
|
6915
7055
|
#
|
@@ -6929,8 +7069,8 @@ module Aws::QuickSight
|
|
6929
7069
|
#
|
6930
7070
|
# @!attribute [rw] experience_configuration
|
6931
7071
|
# The experience you are embedding. For registered users, you can
|
6932
|
-
# embed Amazon QuickSight dashboards
|
6933
|
-
# console.
|
7072
|
+
# embed Amazon QuickSight dashboards, the entire Amazon QuickSight
|
7073
|
+
# console, or the Amazon QuickSight Q search bar.
|
6934
7074
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
6935
7075
|
#
|
6936
7076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
@@ -6945,7 +7085,8 @@ module Aws::QuickSight
|
|
6945
7085
|
end
|
6946
7086
|
|
6947
7087
|
# @!attribute [rw] embed_url
|
6948
|
-
# The embed URL for the Amazon QuickSight dashboard or
|
7088
|
+
# The embed URL for the Amazon QuickSight dashboard, console, or Q
|
7089
|
+
# search bar.
|
6949
7090
|
# @return [String]
|
6950
7091
|
#
|
6951
7092
|
# @!attribute [rw] status
|
@@ -7016,7 +7157,7 @@ module Aws::QuickSight
|
|
7016
7157
|
# }
|
7017
7158
|
#
|
7018
7159
|
# @!attribute [rw] aws_account_id
|
7019
|
-
# The ID for the Amazon Web Services account
|
7160
|
+
# The ID for the Amazon Web Services account that contains the
|
7020
7161
|
# dashboard that you're embedding.
|
7021
7162
|
# @return [String]
|
7022
7163
|
#
|
@@ -7048,11 +7189,11 @@ module Aws::QuickSight
|
|
7048
7189
|
# Adds persistence of state for the user session in an embedded
|
7049
7190
|
# dashboard. Persistence applies to the sheet and the parameter
|
7050
7191
|
# settings. These are control settings that the dashboard subscriber
|
7051
|
-
# (QuickSight reader) chooses while viewing the dashboard. If
|
7052
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
7053
|
-
# the same dashboard URL. The state is stored in
|
7054
|
-
# browser cookie. If this is set to FALSE, the
|
7055
|
-
# session is not persisted. The default is `FALSE`.
|
7192
|
+
# (Amazon QuickSight reader) chooses while viewing the dashboard. If
|
7193
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
7194
|
+
# reopens the same dashboard URL. The state is stored in Amazon
|
7195
|
+
# QuickSight, not in a browser cookie. If this is set to FALSE, the
|
7196
|
+
# state of the user session is not persisted. The default is `FALSE`.
|
7056
7197
|
# @return [Boolean]
|
7057
7198
|
#
|
7058
7199
|
# @!attribute [rw] user_arn
|
@@ -7065,26 +7206,26 @@ module Aws::QuickSight
|
|
7065
7206
|
#
|
7066
7207
|
# * Invited nonfederated users
|
7067
7208
|
#
|
7068
|
-
# *
|
7069
|
-
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7070
|
-
#
|
7209
|
+
# * IAMusers and IAMrole-based sessions authenticated through
|
7210
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7211
|
+
# IAMfederation.
|
7071
7212
|
#
|
7072
|
-
# Omit this parameter for users in the third group –
|
7213
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
7073
7214
|
# role-based sessions.
|
7074
7215
|
# @return [String]
|
7075
7216
|
#
|
7076
7217
|
# @!attribute [rw] namespace
|
7077
|
-
# The Amazon QuickSight namespace that the
|
7078
|
-
# If you
|
7079
|
-
#
|
7218
|
+
# The Amazon QuickSight namespace that contains the dashboard IDs in
|
7219
|
+
# this request. If you're not using a custom namespace, set
|
7220
|
+
# `Namespace = default`.
|
7080
7221
|
# @return [String]
|
7081
7222
|
#
|
7082
7223
|
# @!attribute [rw] additional_dashboard_ids
|
7083
7224
|
# A list of one or more dashboard IDs that you want to add to a
|
7084
7225
|
# session that includes anonymous users. The `IdentityType` parameter
|
7085
7226
|
# must be set to `ANONYMOUS` for this to work, because other identity
|
7086
|
-
# types authenticate as QuickSight or
|
7087
|
-
# set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7227
|
+
# types authenticate as Amazon QuickSight or IAMusers. For example, if
|
7228
|
+
# you set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
7088
7229
|
# identity-type ANONYMOUS`", the session can access all three
|
7089
7230
|
# dashboards.
|
7090
7231
|
# @return [Array<String>]
|
@@ -7145,8 +7286,8 @@ module Aws::QuickSight
|
|
7145
7286
|
# }
|
7146
7287
|
#
|
7147
7288
|
# @!attribute [rw] aws_account_id
|
7148
|
-
# The ID for the Amazon Web Services account
|
7149
|
-
# QuickSight subscription.
|
7289
|
+
# The ID for the Amazon Web Services account associated with your
|
7290
|
+
# Amazon QuickSight subscription.
|
7150
7291
|
# @return [String]
|
7151
7292
|
#
|
7152
7293
|
# @!attribute [rw] entry_point
|
@@ -7162,10 +7303,10 @@ module Aws::QuickSight
|
|
7162
7303
|
# * `/start/favorites`
|
7163
7304
|
#
|
7164
7305
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
7165
|
-
# key from the QuickSight console URL of the dashboard
|
7306
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
7166
7307
|
#
|
7167
7308
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
7168
|
-
# from the QuickSight console URL of the analysis
|
7309
|
+
# from the Amazon QuickSight console URL of the analysis
|
7169
7310
|
# @return [String]
|
7170
7311
|
#
|
7171
7312
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -7204,10 +7345,10 @@ module Aws::QuickSight
|
|
7204
7345
|
|
7205
7346
|
# @!attribute [rw] embed_url
|
7206
7347
|
# A single-use URL that you can put into your server-side web page to
|
7207
|
-
# embed your QuickSight session. This URL is valid for 5
|
7208
|
-
# API operation provides the URL with an `auth_code`
|
7209
|
-
# enables one (and only one) sign-on to a user session that
|
7210
|
-
# for 10 hours.
|
7348
|
+
# embed your Amazon QuickSight session. This URL is valid for 5
|
7349
|
+
# minutes. The API operation provides the URL with an `auth_code`
|
7350
|
+
# value that enables one (and only one) sign-on to a user session that
|
7351
|
+
# is valid for 10 hours.
|
7211
7352
|
# @return [String]
|
7212
7353
|
#
|
7213
7354
|
# @!attribute [rw] status
|
@@ -7303,7 +7444,7 @@ module Aws::QuickSight
|
|
7303
7444
|
# An Identity and Access Management (IAM) policy assignment.
|
7304
7445
|
#
|
7305
7446
|
# @!attribute [rw] aws_account_id
|
7306
|
-
# The Amazon Web Services account
|
7447
|
+
# The Amazon Web Services account ID.
|
7307
7448
|
# @return [String]
|
7308
7449
|
#
|
7309
7450
|
# @!attribute [rw] assignment_id
|
@@ -7315,7 +7456,7 @@ module Aws::QuickSight
|
|
7315
7456
|
# @return [String]
|
7316
7457
|
#
|
7317
7458
|
# @!attribute [rw] policy_arn
|
7318
|
-
# The Amazon Resource Name (ARN) for the
|
7459
|
+
# The Amazon Resource Name (ARN) for the IAMpolicy.
|
7319
7460
|
# @return [String]
|
7320
7461
|
#
|
7321
7462
|
# @!attribute [rw] identities
|
@@ -7339,7 +7480,7 @@ module Aws::QuickSight
|
|
7339
7480
|
include Aws::Structure
|
7340
7481
|
end
|
7341
7482
|
|
7342
|
-
#
|
7483
|
+
# IAMpolicy assignment summary.
|
7343
7484
|
#
|
7344
7485
|
# @!attribute [rw] assignment_name
|
7345
7486
|
# Assignment name.
|
@@ -7550,7 +7691,7 @@ module Aws::QuickSight
|
|
7550
7691
|
include Aws::Structure
|
7551
7692
|
end
|
7552
7693
|
|
7553
|
-
#
|
7694
|
+
# The parameters for Jira.
|
7554
7695
|
#
|
7555
7696
|
# @note When making an API call, you may pass JiraParameters
|
7556
7697
|
# data as a hash:
|
@@ -7637,8 +7778,8 @@ module Aws::QuickSight
|
|
7637
7778
|
#
|
7638
7779
|
# @!attribute [rw] unique_key
|
7639
7780
|
# A value that indicates that a row in a table is uniquely identified
|
7640
|
-
# by the columns in a join key. This is used by QuickSight to
|
7641
|
-
# query performance.
|
7781
|
+
# by the columns in a join key. This is used by Amazon QuickSight to
|
7782
|
+
# optimize query performance.
|
7642
7783
|
# @return [Boolean]
|
7643
7784
|
#
|
7644
7785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/JoinKeyProperties AWS API Documentation
|
@@ -7682,7 +7823,7 @@ module Aws::QuickSight
|
|
7682
7823
|
# }
|
7683
7824
|
#
|
7684
7825
|
# @!attribute [rw] aws_account_id
|
7685
|
-
# The ID of the Amazon Web Services account
|
7826
|
+
# The ID of the Amazon Web Services account that contains the
|
7686
7827
|
# analyses.
|
7687
7828
|
# @return [String]
|
7688
7829
|
#
|
@@ -7742,7 +7883,7 @@ module Aws::QuickSight
|
|
7742
7883
|
# }
|
7743
7884
|
#
|
7744
7885
|
# @!attribute [rw] aws_account_id
|
7745
|
-
# The ID of the Amazon Web Services account
|
7886
|
+
# The ID of the Amazon Web Services account that contains the
|
7746
7887
|
# dashboard that you're listing versions for.
|
7747
7888
|
# @return [String]
|
7748
7889
|
#
|
@@ -7809,7 +7950,7 @@ module Aws::QuickSight
|
|
7809
7950
|
# }
|
7810
7951
|
#
|
7811
7952
|
# @!attribute [rw] aws_account_id
|
7812
|
-
# The ID of the Amazon Web Services account
|
7953
|
+
# The ID of the Amazon Web Services account that contains the
|
7813
7954
|
# dashboards that you're listing.
|
7814
7955
|
# @return [String]
|
7815
7956
|
#
|
@@ -7834,7 +7975,7 @@ module Aws::QuickSight
|
|
7834
7975
|
|
7835
7976
|
# @!attribute [rw] dashboard_summary_list
|
7836
7977
|
# A structure that contains all of the dashboards in your Amazon Web
|
7837
|
-
# Services account
|
7978
|
+
# Services account. This structure provides basic information about
|
7838
7979
|
# the dashboards.
|
7839
7980
|
# @return [Array<Types::DashboardSummary>]
|
7840
7981
|
#
|
@@ -7872,7 +8013,7 @@ module Aws::QuickSight
|
|
7872
8013
|
# }
|
7873
8014
|
#
|
7874
8015
|
# @!attribute [rw] aws_account_id
|
7875
|
-
# The Amazon Web Services account
|
8016
|
+
# The Amazon Web Services account ID.
|
7876
8017
|
# @return [String]
|
7877
8018
|
#
|
7878
8019
|
# @!attribute [rw] next_token
|
@@ -7932,7 +8073,7 @@ module Aws::QuickSight
|
|
7932
8073
|
# }
|
7933
8074
|
#
|
7934
8075
|
# @!attribute [rw] aws_account_id
|
7935
|
-
# The Amazon Web Services account
|
8076
|
+
# The Amazon Web Services account ID.
|
7936
8077
|
# @return [String]
|
7937
8078
|
#
|
7938
8079
|
# @!attribute [rw] next_token
|
@@ -8134,8 +8275,8 @@ module Aws::QuickSight
|
|
8134
8275
|
# @return [Integer]
|
8135
8276
|
#
|
8136
8277
|
# @!attribute [rw] aws_account_id
|
8137
|
-
# The ID for the Amazon Web Services account
|
8138
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8278
|
+
# The ID for the Amazon Web Services account that the group is in.
|
8279
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8139
8280
|
# contains your Amazon QuickSight account.
|
8140
8281
|
# @return [String]
|
8141
8282
|
#
|
@@ -8193,8 +8334,8 @@ module Aws::QuickSight
|
|
8193
8334
|
# }
|
8194
8335
|
#
|
8195
8336
|
# @!attribute [rw] aws_account_id
|
8196
|
-
# The ID for the Amazon Web Services account
|
8197
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8337
|
+
# The ID for the Amazon Web Services account that the group is in.
|
8338
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8198
8339
|
# contains your Amazon QuickSight account.
|
8199
8340
|
# @return [String]
|
8200
8341
|
#
|
@@ -8260,7 +8401,7 @@ module Aws::QuickSight
|
|
8260
8401
|
# }
|
8261
8402
|
#
|
8262
8403
|
# @!attribute [rw] aws_account_id
|
8263
|
-
# The ID of the Amazon Web Services account
|
8404
|
+
# The ID of the Amazon Web Services account that contains the
|
8264
8405
|
# assignments.
|
8265
8406
|
# @return [String]
|
8266
8407
|
#
|
@@ -8333,8 +8474,8 @@ module Aws::QuickSight
|
|
8333
8474
|
# }
|
8334
8475
|
#
|
8335
8476
|
# @!attribute [rw] aws_account_id
|
8336
|
-
# The ID of the Amazon Web Services account
|
8337
|
-
#
|
8477
|
+
# The ID of the Amazon Web Services account that contains these
|
8478
|
+
# IAMpolicy assignments.
|
8338
8479
|
# @return [String]
|
8339
8480
|
#
|
8340
8481
|
# @!attribute [rw] assignment_status
|
@@ -8367,7 +8508,7 @@ module Aws::QuickSight
|
|
8367
8508
|
end
|
8368
8509
|
|
8369
8510
|
# @!attribute [rw] iam_policy_assignments
|
8370
|
-
# Information describing the
|
8511
|
+
# Information describing the IAMpolicy assignments.
|
8371
8512
|
# @return [Array<Types::IAMPolicyAssignmentSummary>]
|
8372
8513
|
#
|
8373
8514
|
# @!attribute [rw] next_token
|
@@ -8398,8 +8539,8 @@ module Aws::QuickSight
|
|
8398
8539
|
# data as a hash:
|
8399
8540
|
#
|
8400
8541
|
# {
|
8401
|
-
# data_set_id: "
|
8402
|
-
# next_token: "
|
8542
|
+
# data_set_id: "String", # required
|
8543
|
+
# next_token: "String",
|
8403
8544
|
# aws_account_id: "AwsAccountId", # required
|
8404
8545
|
# max_results: 1,
|
8405
8546
|
# }
|
@@ -8414,7 +8555,7 @@ module Aws::QuickSight
|
|
8414
8555
|
# @return [String]
|
8415
8556
|
#
|
8416
8557
|
# @!attribute [rw] aws_account_id
|
8417
|
-
# The Amazon Web Services account
|
8558
|
+
# The Amazon Web Services account ID.
|
8418
8559
|
# @return [String]
|
8419
8560
|
#
|
8420
8561
|
# @!attribute [rw] max_results
|
@@ -8470,7 +8611,7 @@ module Aws::QuickSight
|
|
8470
8611
|
# }
|
8471
8612
|
#
|
8472
8613
|
# @!attribute [rw] aws_account_id
|
8473
|
-
# The ID for the Amazon Web Services account
|
8614
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
8474
8615
|
# QuickSight namespaces that you want to list.
|
8475
8616
|
# @return [String]
|
8476
8617
|
#
|
@@ -8494,8 +8635,8 @@ module Aws::QuickSight
|
|
8494
8635
|
|
8495
8636
|
# @!attribute [rw] namespaces
|
8496
8637
|
# The information about the namespaces in this Amazon Web Services
|
8497
|
-
# account
|
8498
|
-
# Services Region
|
8638
|
+
# account. The response includes the namespace ARN, name, Amazon Web
|
8639
|
+
# Services Region, notification email address, creation status, and
|
8499
8640
|
# identity store.
|
8500
8641
|
# @return [Array<Types::NamespaceInfoV2>]
|
8501
8642
|
#
|
@@ -8576,8 +8717,8 @@ module Aws::QuickSight
|
|
8576
8717
|
# }
|
8577
8718
|
#
|
8578
8719
|
# @!attribute [rw] aws_account_id
|
8579
|
-
# The ID of the Amazon Web Services account
|
8580
|
-
#
|
8720
|
+
# The ID of the Amazon Web Services account that contains the template
|
8721
|
+
# aliases that you're listing.
|
8581
8722
|
# @return [String]
|
8582
8723
|
#
|
8583
8724
|
# @!attribute [rw] template_id
|
@@ -8643,7 +8784,7 @@ module Aws::QuickSight
|
|
8643
8784
|
# }
|
8644
8785
|
#
|
8645
8786
|
# @!attribute [rw] aws_account_id
|
8646
|
-
# The ID of the Amazon Web Services account
|
8787
|
+
# The ID of the Amazon Web Services account that contains the
|
8647
8788
|
# templates that you're listing.
|
8648
8789
|
# @return [String]
|
8649
8790
|
#
|
@@ -8710,7 +8851,7 @@ module Aws::QuickSight
|
|
8710
8851
|
# }
|
8711
8852
|
#
|
8712
8853
|
# @!attribute [rw] aws_account_id
|
8713
|
-
# The ID of the Amazon Web Services account
|
8854
|
+
# The ID of the Amazon Web Services account that contains the
|
8714
8855
|
# templates that you're listing.
|
8715
8856
|
# @return [String]
|
8716
8857
|
#
|
@@ -8772,7 +8913,7 @@ module Aws::QuickSight
|
|
8772
8913
|
# }
|
8773
8914
|
#
|
8774
8915
|
# @!attribute [rw] aws_account_id
|
8775
|
-
# The ID of the Amazon Web Services account
|
8916
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8776
8917
|
# aliases that you're listing.
|
8777
8918
|
# @return [String]
|
8778
8919
|
#
|
@@ -8839,7 +8980,7 @@ module Aws::QuickSight
|
|
8839
8980
|
# }
|
8840
8981
|
#
|
8841
8982
|
# @!attribute [rw] aws_account_id
|
8842
|
-
# The ID of the Amazon Web Services account
|
8983
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8843
8984
|
# that you're listing.
|
8844
8985
|
# @return [String]
|
8845
8986
|
#
|
@@ -8907,7 +9048,7 @@ module Aws::QuickSight
|
|
8907
9048
|
# }
|
8908
9049
|
#
|
8909
9050
|
# @!attribute [rw] aws_account_id
|
8910
|
-
# The ID of the Amazon Web Services account
|
9051
|
+
# The ID of the Amazon Web Services account that contains the themes
|
8911
9052
|
# that you're listing.
|
8912
9053
|
# @return [String]
|
8913
9054
|
#
|
@@ -8989,8 +9130,8 @@ module Aws::QuickSight
|
|
8989
9130
|
# @return [String]
|
8990
9131
|
#
|
8991
9132
|
# @!attribute [rw] aws_account_id
|
8992
|
-
# The Amazon Web Services account
|
8993
|
-
# you use the ID for the Amazon Web Services account
|
9133
|
+
# The Amazon Web Services account ID that the user is in. Currently,
|
9134
|
+
# you use the ID for the Amazon Web Services account that contains
|
8994
9135
|
# your Amazon QuickSight account.
|
8995
9136
|
# @return [String]
|
8996
9137
|
#
|
@@ -9056,8 +9197,8 @@ module Aws::QuickSight
|
|
9056
9197
|
# }
|
9057
9198
|
#
|
9058
9199
|
# @!attribute [rw] aws_account_id
|
9059
|
-
# The ID for the Amazon Web Services account
|
9060
|
-
# Currently, you use the ID for the Amazon Web Services account
|
9200
|
+
# The ID for the Amazon Web Services account that the user is in.
|
9201
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
9061
9202
|
# contains your Amazon QuickSight account.
|
9062
9203
|
# @return [String]
|
9063
9204
|
#
|
@@ -9159,6 +9300,10 @@ module Aws::QuickSight
|
|
9159
9300
|
# },
|
9160
9301
|
# ],
|
9161
9302
|
# },
|
9303
|
+
# untag_column_operation: {
|
9304
|
+
# column_name: "ColumnName", # required
|
9305
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
9306
|
+
# },
|
9162
9307
|
# },
|
9163
9308
|
# ],
|
9164
9309
|
# source: { # required
|
@@ -9175,6 +9320,7 @@ module Aws::QuickSight
|
|
9175
9320
|
# on_clause: "OnClause", # required
|
9176
9321
|
# },
|
9177
9322
|
# physical_table_id: "PhysicalTableId",
|
9323
|
+
# data_set_arn: "Arn",
|
9178
9324
|
# },
|
9179
9325
|
# }
|
9180
9326
|
#
|
@@ -9221,6 +9367,7 @@ module Aws::QuickSight
|
|
9221
9367
|
# on_clause: "OnClause", # required
|
9222
9368
|
# },
|
9223
9369
|
# physical_table_id: "PhysicalTableId",
|
9370
|
+
# data_set_arn: "Arn",
|
9224
9371
|
# }
|
9225
9372
|
#
|
9226
9373
|
# @!attribute [rw] join_instruction
|
@@ -9231,11 +9378,16 @@ module Aws::QuickSight
|
|
9231
9378
|
# Physical table ID.
|
9232
9379
|
# @return [String]
|
9233
9380
|
#
|
9381
|
+
# @!attribute [rw] data_set_arn
|
9382
|
+
# The Amazon Resource Number (ARN) of the parent dataset.
|
9383
|
+
# @return [String]
|
9384
|
+
#
|
9234
9385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LogicalTableSource AWS API Documentation
|
9235
9386
|
#
|
9236
9387
|
class LogicalTableSource < Struct.new(
|
9237
9388
|
:join_instruction,
|
9238
|
-
:physical_table_id
|
9389
|
+
:physical_table_id,
|
9390
|
+
:data_set_arn)
|
9239
9391
|
SENSITIVE = []
|
9240
9392
|
include Aws::Structure
|
9241
9393
|
end
|
@@ -9288,7 +9440,7 @@ module Aws::QuickSight
|
|
9288
9440
|
include Aws::Structure
|
9289
9441
|
end
|
9290
9442
|
|
9291
|
-
#
|
9443
|
+
# The parameters for MariaDB.
|
9292
9444
|
#
|
9293
9445
|
# @note When making an API call, you may pass MariaDbParameters
|
9294
9446
|
# data as a hash:
|
@@ -9341,7 +9493,7 @@ module Aws::QuickSight
|
|
9341
9493
|
include Aws::Structure
|
9342
9494
|
end
|
9343
9495
|
|
9344
|
-
#
|
9496
|
+
# The parameters for MySQL.
|
9345
9497
|
#
|
9346
9498
|
# @note When making an API call, you may pass MySqlParameters
|
9347
9499
|
# data as a hash:
|
@@ -9404,7 +9556,7 @@ module Aws::QuickSight
|
|
9404
9556
|
# @return [String]
|
9405
9557
|
#
|
9406
9558
|
# @!attribute [rw] capacity_region
|
9407
|
-
# The namespace Amazon Web Services Region
|
9559
|
+
# The namespace Amazon Web Services Region.
|
9408
9560
|
# @return [String]
|
9409
9561
|
#
|
9410
9562
|
# @!attribute [rw] creation_status
|
@@ -9433,7 +9585,7 @@ module Aws::QuickSight
|
|
9433
9585
|
include Aws::Structure
|
9434
9586
|
end
|
9435
9587
|
|
9436
|
-
#
|
9588
|
+
# The parameters for Oracle.
|
9437
9589
|
#
|
9438
9590
|
# @note When making an API call, you may pass OracleParameters
|
9439
9591
|
# data as a hash:
|
@@ -9490,7 +9642,8 @@ module Aws::QuickSight
|
|
9490
9642
|
include Aws::Structure
|
9491
9643
|
end
|
9492
9644
|
|
9493
|
-
# A list of QuickSight parameters and the list's override
|
9645
|
+
# A list of Amazon QuickSight parameters and the list's override
|
9646
|
+
# values.
|
9494
9647
|
#
|
9495
9648
|
# @note When making an API call, you may pass Parameters
|
9496
9649
|
# data as a hash:
|
@@ -9523,19 +9676,19 @@ module Aws::QuickSight
|
|
9523
9676
|
# }
|
9524
9677
|
#
|
9525
9678
|
# @!attribute [rw] string_parameters
|
9526
|
-
#
|
9679
|
+
# The parameters that have a data type of string.
|
9527
9680
|
# @return [Array<Types::StringParameter>]
|
9528
9681
|
#
|
9529
9682
|
# @!attribute [rw] integer_parameters
|
9530
|
-
#
|
9683
|
+
# The parameters that have a data type of integer.
|
9531
9684
|
# @return [Array<Types::IntegerParameter>]
|
9532
9685
|
#
|
9533
9686
|
# @!attribute [rw] decimal_parameters
|
9534
|
-
#
|
9687
|
+
# The parameters that have a data type of decimal.
|
9535
9688
|
# @return [Array<Types::DecimalParameter>]
|
9536
9689
|
#
|
9537
9690
|
# @!attribute [rw] date_time_parameters
|
9538
|
-
#
|
9691
|
+
# The parameters that have a data type of date-time.
|
9539
9692
|
# @return [Array<Types::DateTimeParameter>]
|
9540
9693
|
#
|
9541
9694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
|
@@ -9622,7 +9775,7 @@ module Aws::QuickSight
|
|
9622
9775
|
include Aws::Structure
|
9623
9776
|
end
|
9624
9777
|
|
9625
|
-
#
|
9778
|
+
# The parameters for PostgreSQL.
|
9626
9779
|
#
|
9627
9780
|
# @note When making an API call, you may pass PostgreSqlParameters
|
9628
9781
|
# data as a hash:
|
@@ -9673,7 +9826,7 @@ module Aws::QuickSight
|
|
9673
9826
|
include Aws::Structure
|
9674
9827
|
end
|
9675
9828
|
|
9676
|
-
#
|
9829
|
+
# The parameters for Presto.
|
9677
9830
|
#
|
9678
9831
|
# @note When making an API call, you may pass PrestoParameters
|
9679
9832
|
# data as a hash:
|
@@ -9768,7 +9921,7 @@ module Aws::QuickSight
|
|
9768
9921
|
include Aws::Structure
|
9769
9922
|
end
|
9770
9923
|
|
9771
|
-
# Amazon RDS
|
9924
|
+
# The parameters for Amazon RDS.
|
9772
9925
|
#
|
9773
9926
|
# @note When making an API call, you may pass RdsParameters
|
9774
9927
|
# data as a hash:
|
@@ -9795,8 +9948,8 @@ module Aws::QuickSight
|
|
9795
9948
|
include Aws::Structure
|
9796
9949
|
end
|
9797
9950
|
|
9798
|
-
# Amazon Redshift
|
9799
|
-
# `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
9951
|
+
# The parameters for Amazon Redshift. The `ClusterId` field can be blank
|
9952
|
+
# if `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
9800
9953
|
# blank if the `ClusterId` field is set.
|
9801
9954
|
#
|
9802
9955
|
# @note When making an API call, you may pass RedshiftParameters
|
@@ -9859,8 +10012,7 @@ module Aws::QuickSight
|
|
9859
10012
|
# Amazon QuickSight supports several ways of managing the identity of
|
9860
10013
|
# users. This parameter accepts two values:
|
9861
10014
|
#
|
9862
|
-
# * `IAM`\: A user whose identity maps to an existing
|
9863
|
-
# role.
|
10015
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
9864
10016
|
#
|
9865
10017
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed
|
9866
10018
|
# internally by Amazon QuickSight.
|
@@ -9890,17 +10042,17 @@ module Aws::QuickSight
|
|
9890
10042
|
# @return [String]
|
9891
10043
|
#
|
9892
10044
|
# @!attribute [rw] iam_arn
|
9893
|
-
# The ARN of the
|
10045
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
9894
10046
|
# QuickSight.
|
9895
10047
|
# @return [String]
|
9896
10048
|
#
|
9897
10049
|
# @!attribute [rw] session_name
|
9898
10050
|
# You need to use this parameter only when you register one or more
|
9899
|
-
# users using an assumed
|
10051
|
+
# users using an assumed IAMrole. You don't need to provide the
|
9900
10052
|
# session name for other scenarios, for example when you are
|
9901
|
-
# registering an
|
9902
|
-
# register multiple users using the same
|
9903
|
-
# different session name. For more information on assuming
|
10053
|
+
# registering an IAMuser or an Amazon QuickSight user. You can
|
10054
|
+
# register multiple users using the same IAMrole if each user has a
|
10055
|
+
# different session name. For more information on assuming IAMroles,
|
9904
10056
|
# see [ `assume-role` ][1] in the *AWS CLI Reference.*
|
9905
10057
|
#
|
9906
10058
|
#
|
@@ -9909,8 +10061,8 @@ module Aws::QuickSight
|
|
9909
10061
|
# @return [String]
|
9910
10062
|
#
|
9911
10063
|
# @!attribute [rw] aws_account_id
|
9912
|
-
# The ID for the Amazon Web Services account
|
9913
|
-
# Currently, you use the ID for the Amazon Web Services account
|
10064
|
+
# The ID for the Amazon Web Services account that the user is in.
|
10065
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
9914
10066
|
# contains your Amazon QuickSight account.
|
9915
10067
|
# @return [String]
|
9916
10068
|
#
|
@@ -9942,23 +10094,23 @@ module Aws::QuickSight
|
|
9942
10094
|
#
|
9943
10095
|
# A set of custom permissions includes any combination of these
|
9944
10096
|
# restrictions. Currently, you need to create the profile names for
|
9945
|
-
# custom permission sets by using the QuickSight console. Then,
|
9946
|
-
# use the `RegisterUser` API operation to assign the named set of
|
9947
|
-
# permissions to a QuickSight user.
|
10097
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
10098
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
10099
|
+
# permissions to a Amazon QuickSight user.
|
9948
10100
|
#
|
9949
|
-
# QuickSight custom permissions are applied through
|
9950
|
-
# Therefore, they override the permissions typically
|
9951
|
-
# assigning QuickSight users to one of the default
|
9952
|
-
# QuickSight (admin, author, reader).
|
10101
|
+
# Amazon QuickSight custom permissions are applied through
|
10102
|
+
# IAMpolicies. Therefore, they override the permissions typically
|
10103
|
+
# granted by assigning Amazon QuickSight users to one of the default
|
10104
|
+
# security cohorts in Amazon QuickSight (admin, author, reader).
|
9953
10105
|
#
|
9954
|
-
# This feature is available only to QuickSight Enterprise
|
9955
|
-
# subscriptions.
|
10106
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
10107
|
+
# edition subscriptions.
|
9956
10108
|
# @return [String]
|
9957
10109
|
#
|
9958
10110
|
# @!attribute [rw] external_login_federation_provider_type
|
9959
10111
|
# The type of supported external login provider that provides identity
|
9960
|
-
# to let a user federate into Amazon QuickSight with an associated
|
9961
|
-
# Identity and Access Management
|
10112
|
+
# to let a user federate into Amazon QuickSight with an associated
|
10113
|
+
# Identity and Access Management(IAM) role. The type of supported
|
9962
10114
|
# external login provider can be one of the following.
|
9963
10115
|
#
|
9964
10116
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -9974,10 +10126,10 @@ module Aws::QuickSight
|
|
9974
10126
|
#
|
9975
10127
|
# @!attribute [rw] custom_federation_provider_url
|
9976
10128
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
9977
|
-
# identity to let a user federate into QuickSight with an
|
9978
|
-
#
|
9979
|
-
# only be used when `ExternalLoginFederationProviderType`
|
9980
|
-
# set to `CUSTOM_OIDC`.
|
10129
|
+
# identity to let a user federate into Amazon QuickSight with an
|
10130
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
10131
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
10132
|
+
# parameter is set to `CUSTOM_OIDC`.
|
9981
10133
|
# @return [String]
|
9982
10134
|
#
|
9983
10135
|
# @!attribute [rw] external_login_id
|
@@ -10079,6 +10231,9 @@ module Aws::QuickSight
|
|
10079
10231
|
# quick_sight_console: {
|
10080
10232
|
# initial_path: "EntryPath",
|
10081
10233
|
# },
|
10234
|
+
# q_search_bar: {
|
10235
|
+
# initial_topic_id: "RestrictiveResourceId",
|
10236
|
+
# },
|
10082
10237
|
# }
|
10083
10238
|
#
|
10084
10239
|
# @!attribute [rw] dashboard
|
@@ -10120,11 +10275,52 @@ module Aws::QuickSight
|
|
10120
10275
|
# [3]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
10121
10276
|
# @return [Types::RegisteredUserQuickSightConsoleEmbeddingConfiguration]
|
10122
10277
|
#
|
10278
|
+
# @!attribute [rw] q_search_bar
|
10279
|
+
# The configuration details for embedding the Q search bar.
|
10280
|
+
#
|
10281
|
+
# For more information about embedding the Q search bar, see
|
10282
|
+
# [Embedding Overview][1].
|
10283
|
+
#
|
10284
|
+
#
|
10285
|
+
#
|
10286
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
|
10287
|
+
# @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
|
10288
|
+
#
|
10123
10289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
|
10124
10290
|
#
|
10125
10291
|
class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
|
10126
10292
|
:dashboard,
|
10127
|
-
:quick_sight_console
|
10293
|
+
:quick_sight_console,
|
10294
|
+
:q_search_bar)
|
10295
|
+
SENSITIVE = []
|
10296
|
+
include Aws::Structure
|
10297
|
+
end
|
10298
|
+
|
10299
|
+
# Information about the Q search bar embedding experience.
|
10300
|
+
#
|
10301
|
+
# @note When making an API call, you may pass RegisteredUserQSearchBarEmbeddingConfiguration
|
10302
|
+
# data as a hash:
|
10303
|
+
#
|
10304
|
+
# {
|
10305
|
+
# initial_topic_id: "RestrictiveResourceId",
|
10306
|
+
# }
|
10307
|
+
#
|
10308
|
+
# @!attribute [rw] initial_topic_id
|
10309
|
+
# The ID of the Q topic that you want to make the starting topic in
|
10310
|
+
# the Q search bar. You can find a topic ID by navigating to the
|
10311
|
+
# Topics pane in the Amazon QuickSight application and opening a
|
10312
|
+
# topic. The ID is in the URL for the topic that you open.
|
10313
|
+
#
|
10314
|
+
# If you don't specify an initial topic, a list of all shared topics
|
10315
|
+
# is shown in the Q bar for your readers. When you select an initial
|
10316
|
+
# topic, you can specify whether or not readers are allowed to select
|
10317
|
+
# other topics from the available ones in the list.
|
10318
|
+
# @return [String]
|
10319
|
+
#
|
10320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQSearchBarEmbeddingConfiguration AWS API Documentation
|
10321
|
+
#
|
10322
|
+
class RegisteredUserQSearchBarEmbeddingConfiguration < Struct.new(
|
10323
|
+
:initial_topic_id)
|
10128
10324
|
SENSITIVE = []
|
10129
10325
|
include Aws::Structure
|
10130
10326
|
end
|
@@ -10313,14 +10509,14 @@ module Aws::QuickSight
|
|
10313
10509
|
# associated with an analysis, dashboard, template, or theme. (This
|
10314
10510
|
# is common.)
|
10315
10511
|
#
|
10316
|
-
# * The ARN of an Amazon Web Services account
|
10317
|
-
#
|
10512
|
+
# * The ARN of an Amazon Web Services account root: This is an IAMARN
|
10513
|
+
# rather than a Amazon QuickSight ARN. Use this option only to share
|
10318
10514
|
# resources (templates) across Amazon Web Services accounts. (This
|
10319
10515
|
# is less common.)
|
10320
10516
|
# @return [String]
|
10321
10517
|
#
|
10322
10518
|
# @!attribute [rw] actions
|
10323
|
-
# The
|
10519
|
+
# The IAMaction to grant or revoke permissions on.
|
10324
10520
|
# @return [Array<String>]
|
10325
10521
|
#
|
10326
10522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -10364,7 +10560,7 @@ module Aws::QuickSight
|
|
10364
10560
|
# }
|
10365
10561
|
#
|
10366
10562
|
# @!attribute [rw] aws_account_id
|
10367
|
-
# The ID of the Amazon Web Services account
|
10563
|
+
# The ID of the Amazon Web Services account that contains the
|
10368
10564
|
# analysis.
|
10369
10565
|
# @return [String]
|
10370
10566
|
#
|
@@ -10419,11 +10615,16 @@ module Aws::QuickSight
|
|
10419
10615
|
# The number of rows that were not ingested.
|
10420
10616
|
# @return [Integer]
|
10421
10617
|
#
|
10618
|
+
# @!attribute [rw] total_rows_in_dataset
|
10619
|
+
# The total number of rows in the dataset.
|
10620
|
+
# @return [Integer]
|
10621
|
+
#
|
10422
10622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowInfo AWS API Documentation
|
10423
10623
|
#
|
10424
10624
|
class RowInfo < Struct.new(
|
10425
10625
|
:rows_ingested,
|
10426
|
-
:rows_dropped
|
10626
|
+
:rows_dropped,
|
10627
|
+
:total_rows_in_dataset)
|
10427
10628
|
SENSITIVE = []
|
10428
10629
|
include Aws::Structure
|
10429
10630
|
end
|
@@ -10463,8 +10664,8 @@ module Aws::QuickSight
|
|
10463
10664
|
# @return [String]
|
10464
10665
|
#
|
10465
10666
|
# @!attribute [rw] permission_policy
|
10466
|
-
# The type of permissions to use when
|
10467
|
-
#
|
10667
|
+
# The type of permissions to use when interpreting the permissions for
|
10668
|
+
# RLS. `DENY_ACCESS` is included for backward compatibility only.
|
10468
10669
|
# @return [String]
|
10469
10670
|
#
|
10470
10671
|
# @!attribute [rw] format_version
|
@@ -10573,7 +10774,7 @@ module Aws::QuickSight
|
|
10573
10774
|
include Aws::Structure
|
10574
10775
|
end
|
10575
10776
|
|
10576
|
-
#
|
10777
|
+
# The parameters for S3.
|
10577
10778
|
#
|
10578
10779
|
# @note When making an API call, you may pass S3Parameters
|
10579
10780
|
# data as a hash:
|
@@ -10587,7 +10788,7 @@ module Aws::QuickSight
|
|
10587
10788
|
#
|
10588
10789
|
# @!attribute [rw] manifest_file_location
|
10589
10790
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
10590
|
-
# manifest file was uploaded into QuickSight.
|
10791
|
+
# manifest file was uploaded into Amazon QuickSight.
|
10591
10792
|
# @return [Types::ManifestFileLocation]
|
10592
10793
|
#
|
10593
10794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
@@ -10631,8 +10832,8 @@ module Aws::QuickSight
|
|
10631
10832
|
# @!attribute [rw] input_columns
|
10632
10833
|
# A physical table type for an S3 data source.
|
10633
10834
|
#
|
10634
|
-
# <note markdown="1"> For
|
10635
|
-
# columns.
|
10835
|
+
# <note markdown="1"> For files that aren't JSON, only `STRING` data types are supported
|
10836
|
+
# in input columns.
|
10636
10837
|
#
|
10637
10838
|
# </note>
|
10638
10839
|
# @return [Array<Types::InputColumn>]
|
@@ -10664,8 +10865,8 @@ module Aws::QuickSight
|
|
10664
10865
|
# }
|
10665
10866
|
#
|
10666
10867
|
# @!attribute [rw] aws_account_id
|
10667
|
-
# The ID of the Amazon Web Services account
|
10668
|
-
#
|
10868
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
10869
|
+
# that you're searching for.
|
10669
10870
|
# @return [String]
|
10670
10871
|
#
|
10671
10872
|
# @!attribute [rw] filters
|
@@ -10736,7 +10937,7 @@ module Aws::QuickSight
|
|
10736
10937
|
# }
|
10737
10938
|
#
|
10738
10939
|
# @!attribute [rw] aws_account_id
|
10739
|
-
# The ID of the Amazon Web Services account
|
10940
|
+
# The ID of the Amazon Web Services account that contains the user
|
10740
10941
|
# whose dashboards you're searching for.
|
10741
10942
|
# @return [String]
|
10742
10943
|
#
|
@@ -10872,7 +11073,7 @@ module Aws::QuickSight
|
|
10872
11073
|
include Aws::Structure
|
10873
11074
|
end
|
10874
11075
|
|
10875
|
-
#
|
11076
|
+
# The parameters for ServiceNow.
|
10876
11077
|
#
|
10877
11078
|
# @note When making an API call, you may pass ServiceNowParameters
|
10878
11079
|
# data as a hash:
|
@@ -10952,7 +11153,7 @@ module Aws::QuickSight
|
|
10952
11153
|
#
|
10953
11154
|
# @!attribute [rw] name
|
10954
11155
|
# The name of a sheet. This name is displayed on the sheet's tab in
|
10955
|
-
# the QuickSight console.
|
11156
|
+
# the Amazon QuickSight console.
|
10956
11157
|
# @return [String]
|
10957
11158
|
#
|
10958
11159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Sheet AWS API Documentation
|
@@ -11023,7 +11224,7 @@ module Aws::QuickSight
|
|
11023
11224
|
include Aws::Structure
|
11024
11225
|
end
|
11025
11226
|
|
11026
|
-
#
|
11227
|
+
# The parameters for Snowflake.
|
11027
11228
|
#
|
11028
11229
|
# @note When making an API call, you may pass SnowflakeParameters
|
11029
11230
|
# data as a hash:
|
@@ -11056,7 +11257,7 @@ module Aws::QuickSight
|
|
11056
11257
|
include Aws::Structure
|
11057
11258
|
end
|
11058
11259
|
|
11059
|
-
#
|
11260
|
+
# The parameters for Spark.
|
11060
11261
|
#
|
11061
11262
|
# @note When making an API call, you may pass SparkParameters
|
11062
11263
|
# data as a hash:
|
@@ -11083,7 +11284,7 @@ module Aws::QuickSight
|
|
11083
11284
|
include Aws::Structure
|
11084
11285
|
end
|
11085
11286
|
|
11086
|
-
# SQL Server
|
11287
|
+
# The parameters for SQL Server.
|
11087
11288
|
#
|
11088
11289
|
# @note When making an API call, you may pass SqlServerParameters
|
11089
11290
|
# data as a hash:
|
@@ -11116,7 +11317,7 @@ module Aws::QuickSight
|
|
11116
11317
|
include Aws::Structure
|
11117
11318
|
end
|
11118
11319
|
|
11119
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
11320
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
11120
11321
|
# connects to your underlying data source.
|
11121
11322
|
#
|
11122
11323
|
# @note When making an API call, you may pass SslProperties
|
@@ -11280,7 +11481,7 @@ module Aws::QuickSight
|
|
11280
11481
|
include Aws::Structure
|
11281
11482
|
end
|
11282
11483
|
|
11283
|
-
# A template object. A *template* is an entity in QuickSight that
|
11484
|
+
# A template object. A *template* is an entity in Amazon QuickSight that
|
11284
11485
|
# encapsulates the metadata required to create an analysis and that you
|
11285
11486
|
# can use to create a dashboard. A template adds a layer of abstraction
|
11286
11487
|
# by using placeholders to replace the dataset associated with an
|
@@ -11306,7 +11507,7 @@ module Aws::QuickSight
|
|
11306
11507
|
#
|
11307
11508
|
# @!attribute [rw] template_id
|
11308
11509
|
# The ID for the template. This is unique per Amazon Web Services
|
11309
|
-
# Region
|
11510
|
+
# Region for each Amazon Web Services account.
|
11310
11511
|
# @return [String]
|
11311
11512
|
#
|
11312
11513
|
# @!attribute [rw] last_updated_time
|
@@ -11473,7 +11674,7 @@ module Aws::QuickSight
|
|
11473
11674
|
#
|
11474
11675
|
# @!attribute [rw] template_id
|
11475
11676
|
# The ID of the template. This ID is unique per Amazon Web Services
|
11476
|
-
# Region
|
11677
|
+
# Region for each Amazon Web Services account.
|
11477
11678
|
# @return [String]
|
11478
11679
|
#
|
11479
11680
|
# @!attribute [rw] name
|
@@ -11598,7 +11799,7 @@ module Aws::QuickSight
|
|
11598
11799
|
include Aws::Structure
|
11599
11800
|
end
|
11600
11801
|
|
11601
|
-
#
|
11802
|
+
# The parameters for Teradata.
|
11602
11803
|
#
|
11603
11804
|
# @note When making an API call, you may pass TeradataParameters
|
11604
11805
|
# data as a hash:
|
@@ -11801,7 +12002,7 @@ module Aws::QuickSight
|
|
11801
12002
|
#
|
11802
12003
|
# @!attribute [rw] theme_id
|
11803
12004
|
# The ID of the theme. This ID is unique per Amazon Web Services
|
11804
|
-
# Region
|
12005
|
+
# Region for each Amazon Web Services account.
|
11805
12006
|
# @return [String]
|
11806
12007
|
#
|
11807
12008
|
# @!attribute [rw] latest_version_number
|
@@ -11845,7 +12046,7 @@ module Aws::QuickSight
|
|
11845
12046
|
#
|
11846
12047
|
# @!attribute [rw] base_theme_id
|
11847
12048
|
# The Amazon QuickSight-defined ID of the theme that a custom theme
|
11848
|
-
# inherits from. All themes initially inherit from a default
|
12049
|
+
# inherits from. All themes initially inherit from a default Amazon
|
11849
12050
|
# QuickSight theme.
|
11850
12051
|
# @return [String]
|
11851
12052
|
#
|
@@ -12030,6 +12231,10 @@ module Aws::QuickSight
|
|
12030
12231
|
# },
|
12031
12232
|
# ],
|
12032
12233
|
# },
|
12234
|
+
# untag_column_operation: {
|
12235
|
+
# column_name: "ColumnName", # required
|
12236
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12237
|
+
# },
|
12033
12238
|
# }
|
12034
12239
|
#
|
12035
12240
|
# @!attribute [rw] project_operation
|
@@ -12058,6 +12263,10 @@ module Aws::QuickSight
|
|
12058
12263
|
# An operation that tags a column with additional information.
|
12059
12264
|
# @return [Types::TagColumnOperation]
|
12060
12265
|
#
|
12266
|
+
# @!attribute [rw] untag_column_operation
|
12267
|
+
# A transform operation that removes tags associated with a column.
|
12268
|
+
# @return [Types::UntagColumnOperation]
|
12269
|
+
#
|
12061
12270
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
|
12062
12271
|
#
|
12063
12272
|
class TransformOperation < Struct.new(
|
@@ -12066,12 +12275,13 @@ module Aws::QuickSight
|
|
12066
12275
|
:create_columns_operation,
|
12067
12276
|
:rename_column_operation,
|
12068
12277
|
:cast_column_type_operation,
|
12069
|
-
:tag_column_operation
|
12278
|
+
:tag_column_operation,
|
12279
|
+
:untag_column_operation)
|
12070
12280
|
SENSITIVE = []
|
12071
12281
|
include Aws::Structure
|
12072
12282
|
end
|
12073
12283
|
|
12074
|
-
#
|
12284
|
+
# The parameters for Twitter.
|
12075
12285
|
#
|
12076
12286
|
# @note When making an API call, you may pass TwitterParameters
|
12077
12287
|
# data as a hash:
|
@@ -12233,9 +12443,10 @@ module Aws::QuickSight
|
|
12233
12443
|
|
12234
12444
|
# This error indicates that you are calling an embedding operation in
|
12235
12445
|
# Amazon QuickSight without the required pricing plan on your Amazon Web
|
12236
|
-
# Services account
|
12237
|
-
# QuickSight administrator needs to add capacity pricing to
|
12238
|
-
# You can do this on the **Manage QuickSight**
|
12446
|
+
# Services account. Before you can use embedding for anonymous users, a
|
12447
|
+
# Amazon QuickSight administrator needs to add capacity pricing to
|
12448
|
+
# Amazon QuickSight. You can do this on the **Manage Amazon QuickSight**
|
12449
|
+
# page.
|
12239
12450
|
#
|
12240
12451
|
# After capacity pricing is added, you can use the GetDashboardEmbedUrl
|
12241
12452
|
# API operation with the `--identity-type ANONYMOUS` option.
|
@@ -12258,9 +12469,9 @@ module Aws::QuickSight
|
|
12258
12469
|
|
12259
12470
|
# This error indicates that you are calling an operation on an Amazon
|
12260
12471
|
# QuickSight subscription where the edition doesn't include support for
|
12261
|
-
# that operation. Amazon QuickSight currently has Standard
|
12262
|
-
# Enterprise Edition. Not every operation and capability is
|
12263
|
-
# every edition.
|
12472
|
+
# that operation. Amazon Amazon QuickSight currently has Standard
|
12473
|
+
# Edition and Enterprise Edition. Not every operation and capability is
|
12474
|
+
# available in every edition.
|
12264
12475
|
#
|
12265
12476
|
# @!attribute [rw] message
|
12266
12477
|
# @return [String]
|
@@ -12278,6 +12489,33 @@ module Aws::QuickSight
|
|
12278
12489
|
include Aws::Structure
|
12279
12490
|
end
|
12280
12491
|
|
12492
|
+
# A transform operation that removes tags associated with a column.
|
12493
|
+
#
|
12494
|
+
# @note When making an API call, you may pass UntagColumnOperation
|
12495
|
+
# data as a hash:
|
12496
|
+
#
|
12497
|
+
# {
|
12498
|
+
# column_name: "ColumnName", # required
|
12499
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
12500
|
+
# }
|
12501
|
+
#
|
12502
|
+
# @!attribute [rw] column_name
|
12503
|
+
# The column that this operation acts on.
|
12504
|
+
# @return [String]
|
12505
|
+
#
|
12506
|
+
# @!attribute [rw] tag_names
|
12507
|
+
# The column tags to remove from this column.
|
12508
|
+
# @return [Array<String>]
|
12509
|
+
#
|
12510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagColumnOperation AWS API Documentation
|
12511
|
+
#
|
12512
|
+
class UntagColumnOperation < Struct.new(
|
12513
|
+
:column_name,
|
12514
|
+
:tag_names)
|
12515
|
+
SENSITIVE = []
|
12516
|
+
include Aws::Structure
|
12517
|
+
end
|
12518
|
+
|
12281
12519
|
# @note When making an API call, you may pass UntagResourceRequest
|
12282
12520
|
# data as a hash:
|
12283
12521
|
#
|
@@ -12334,17 +12572,18 @@ module Aws::QuickSight
|
|
12334
12572
|
# }
|
12335
12573
|
#
|
12336
12574
|
# @!attribute [rw] aws_account_id
|
12337
|
-
# The ID for the Amazon Web Services account
|
12338
|
-
# QuickSight customizations for.
|
12575
|
+
# The ID for the Amazon Web Services account that you want to update
|
12576
|
+
# Amazon QuickSight customizations for.
|
12339
12577
|
# @return [String]
|
12340
12578
|
#
|
12341
12579
|
# @!attribute [rw] namespace
|
12342
|
-
# The namespace that you want to update QuickSight
|
12580
|
+
# The namespace that you want to update Amazon QuickSight
|
12581
|
+
# customizations for.
|
12343
12582
|
# @return [String]
|
12344
12583
|
#
|
12345
12584
|
# @!attribute [rw] account_customization
|
12346
|
-
# The QuickSight customizations you're updating in the current
|
12347
|
-
# Web Services Region
|
12585
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12586
|
+
# Amazon Web Services Region.
|
12348
12587
|
# @return [Types::AccountCustomization]
|
12349
12588
|
#
|
12350
12589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -12359,12 +12598,12 @@ module Aws::QuickSight
|
|
12359
12598
|
|
12360
12599
|
# @!attribute [rw] arn
|
12361
12600
|
# The Amazon Resource Name (ARN) for the updated customization for
|
12362
|
-
# this Amazon Web Services account
|
12601
|
+
# this Amazon Web Services account.
|
12363
12602
|
# @return [String]
|
12364
12603
|
#
|
12365
12604
|
# @!attribute [rw] aws_account_id
|
12366
|
-
# The ID for the Amazon Web Services account
|
12367
|
-
# QuickSight customizations for.
|
12605
|
+
# The ID for the Amazon Web Services account that you want to update
|
12606
|
+
# Amazon QuickSight customizations for.
|
12368
12607
|
# @return [String]
|
12369
12608
|
#
|
12370
12609
|
# @!attribute [rw] namespace
|
@@ -12373,8 +12612,8 @@ module Aws::QuickSight
|
|
12373
12612
|
# @return [String]
|
12374
12613
|
#
|
12375
12614
|
# @!attribute [rw] account_customization
|
12376
|
-
# The QuickSight customizations you're updating in the current
|
12377
|
-
# Web Services Region
|
12615
|
+
# The Amazon QuickSight customizations you're updating in the current
|
12616
|
+
# Amazon Web Services Region.
|
12378
12617
|
# @return [Types::AccountCustomization]
|
12379
12618
|
#
|
12380
12619
|
# @!attribute [rw] request_id
|
@@ -12408,21 +12647,21 @@ module Aws::QuickSight
|
|
12408
12647
|
# }
|
12409
12648
|
#
|
12410
12649
|
# @!attribute [rw] aws_account_id
|
12411
|
-
# The ID for the Amazon Web Services account
|
12650
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
12412
12651
|
# QuickSight settings that you want to list.
|
12413
12652
|
# @return [String]
|
12414
12653
|
#
|
12415
12654
|
# @!attribute [rw] default_namespace
|
12416
|
-
# The default namespace for this Amazon Web Services account
|
12655
|
+
# The default namespace for this Amazon Web Services account.
|
12417
12656
|
# Currently, the default is `default`. Identity and Access Management
|
12418
|
-
# (IAM) users that register for the first time with QuickSight
|
12419
|
-
# an email that becomes associated with the default namespace.
|
12657
|
+
# (IAM) users that register for the first time with Amazon QuickSight
|
12658
|
+
# provide an email that becomes associated with the default namespace.
|
12420
12659
|
# @return [String]
|
12421
12660
|
#
|
12422
12661
|
# @!attribute [rw] notification_email
|
12423
|
-
# The email address that you want QuickSight to send
|
12424
|
-
# regarding your Amazon Web Services account
|
12425
|
-
# subscription.
|
12662
|
+
# The email address that you want Amazon QuickSight to send
|
12663
|
+
# notifications to regarding your Amazon Web Services account or
|
12664
|
+
# Amazon QuickSight subscription.
|
12426
12665
|
# @return [String]
|
12427
12666
|
#
|
12428
12667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -12473,9 +12712,9 @@ module Aws::QuickSight
|
|
12473
12712
|
# }
|
12474
12713
|
#
|
12475
12714
|
# @!attribute [rw] aws_account_id
|
12476
|
-
# The ID of the Amazon Web Services account
|
12477
|
-
#
|
12478
|
-
#
|
12715
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12716
|
+
# whose permissions you're updating. You must be using the Amazon Web
|
12717
|
+
# Services account that the analysis is in.
|
12479
12718
|
# @return [String]
|
12480
12719
|
#
|
12481
12720
|
# @!attribute [rw] analysis_id
|
@@ -12585,8 +12824,8 @@ module Aws::QuickSight
|
|
12585
12824
|
# }
|
12586
12825
|
#
|
12587
12826
|
# @!attribute [rw] aws_account_id
|
12588
|
-
# The ID of the Amazon Web Services account
|
12589
|
-
#
|
12827
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
12828
|
+
# that you're updating.
|
12590
12829
|
# @return [String]
|
12591
12830
|
#
|
12592
12831
|
# @!attribute [rw] analysis_id
|
@@ -12596,7 +12835,7 @@ module Aws::QuickSight
|
|
12596
12835
|
#
|
12597
12836
|
# @!attribute [rw] name
|
12598
12837
|
# A descriptive name for the analysis that you're updating. This name
|
12599
|
-
# displays for the analysis in the QuickSight console.
|
12838
|
+
# displays for the analysis in the Amazon QuickSight console.
|
12600
12839
|
# @return [String]
|
12601
12840
|
#
|
12602
12841
|
# @!attribute [rw] parameters
|
@@ -12613,8 +12852,8 @@ module Aws::QuickSight
|
|
12613
12852
|
#
|
12614
12853
|
# @!attribute [rw] theme_arn
|
12615
12854
|
# The Amazon Resource Name (ARN) for the theme to apply to the
|
12616
|
-
# analysis that you're creating. To see the theme in the
|
12617
|
-
# console, make sure that you have access to it.
|
12855
|
+
# analysis that you're creating. To see the theme in the Amazon
|
12856
|
+
# QuickSight console, make sure that you have access to it.
|
12618
12857
|
# @return [String]
|
12619
12858
|
#
|
12620
12859
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
|
@@ -12683,7 +12922,7 @@ module Aws::QuickSight
|
|
12683
12922
|
# }
|
12684
12923
|
#
|
12685
12924
|
# @!attribute [rw] aws_account_id
|
12686
|
-
# The ID of the Amazon Web Services account
|
12925
|
+
# The ID of the Amazon Web Services account that contains the
|
12687
12926
|
# dashboard whose permissions you're updating.
|
12688
12927
|
# @return [String]
|
12689
12928
|
#
|
@@ -12752,7 +12991,7 @@ module Aws::QuickSight
|
|
12752
12991
|
# }
|
12753
12992
|
#
|
12754
12993
|
# @!attribute [rw] aws_account_id
|
12755
|
-
# The ID of the Amazon Web Services account
|
12994
|
+
# The ID of the Amazon Web Services account that contains the
|
12756
12995
|
# dashboard that you're updating.
|
12757
12996
|
# @return [String]
|
12758
12997
|
#
|
@@ -12861,7 +13100,7 @@ module Aws::QuickSight
|
|
12861
13100
|
# }
|
12862
13101
|
#
|
12863
13102
|
# @!attribute [rw] aws_account_id
|
12864
|
-
# The ID of the Amazon Web Services account
|
13103
|
+
# The ID of the Amazon Web Services account that contains the
|
12865
13104
|
# dashboard that you're updating.
|
12866
13105
|
# @return [String]
|
12867
13106
|
#
|
@@ -12881,8 +13120,8 @@ module Aws::QuickSight
|
|
12881
13120
|
# from an analysis, first convert the analysis to a template by using
|
12882
13121
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
12883
13122
|
# Amazon Resource Name (ARN) of the source template. The
|
12884
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
12885
|
-
#
|
13123
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
13124
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
12886
13125
|
#
|
12887
13126
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
12888
13127
|
# the replacement datasets for the placeholders listed in the
|
@@ -12904,7 +13143,7 @@ module Aws::QuickSight
|
|
12904
13143
|
#
|
12905
13144
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
12906
13145
|
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
12907
|
-
# QuickSight disables the left filter pane on the published
|
13146
|
+
# Amazon QuickSight disables the left filter pane on the published
|
12908
13147
|
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
12909
13148
|
# option is `ENABLED` by default.
|
12910
13149
|
#
|
@@ -12922,7 +13161,7 @@ module Aws::QuickSight
|
|
12922
13161
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
12923
13162
|
# this dashboard. If you add a value for this field, it overrides the
|
12924
13163
|
# value that was originally associated with the entity. The theme ARN
|
12925
|
-
# must exist in the same Amazon Web Services account
|
13164
|
+
# must exist in the same Amazon Web Services account where you create
|
12926
13165
|
# the dashboard.
|
12927
13166
|
# @return [String]
|
12928
13167
|
#
|
@@ -12999,13 +13238,13 @@ module Aws::QuickSight
|
|
12999
13238
|
# }
|
13000
13239
|
#
|
13001
13240
|
# @!attribute [rw] aws_account_id
|
13002
|
-
# The Amazon Web Services account
|
13241
|
+
# The Amazon Web Services account ID.
|
13003
13242
|
# @return [String]
|
13004
13243
|
#
|
13005
13244
|
# @!attribute [rw] data_set_id
|
13006
13245
|
# The ID for the dataset whose permissions you want to update. This ID
|
13007
|
-
# is unique per Amazon Web Services Region
|
13008
|
-
# Services account
|
13246
|
+
# is unique per Amazon Web Services Region for each Amazon Web
|
13247
|
+
# Services account.
|
13009
13248
|
# @return [String]
|
13010
13249
|
#
|
13011
13250
|
# @!attribute [rw] grant_permissions
|
@@ -13033,8 +13272,8 @@ module Aws::QuickSight
|
|
13033
13272
|
#
|
13034
13273
|
# @!attribute [rw] data_set_id
|
13035
13274
|
# The ID for the dataset whose permissions you want to update. This ID
|
13036
|
-
# is unique per Amazon Web Services Region
|
13037
|
-
# Services account
|
13275
|
+
# is unique per Amazon Web Services Region for each Amazon Web
|
13276
|
+
# Services account.
|
13038
13277
|
# @return [String]
|
13039
13278
|
#
|
13040
13279
|
# @!attribute [rw] request_id
|
@@ -13146,6 +13385,10 @@ module Aws::QuickSight
|
|
13146
13385
|
# },
|
13147
13386
|
# ],
|
13148
13387
|
# },
|
13388
|
+
# untag_column_operation: {
|
13389
|
+
# column_name: "ColumnName", # required
|
13390
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
13391
|
+
# },
|
13149
13392
|
# },
|
13150
13393
|
# ],
|
13151
13394
|
# source: { # required
|
@@ -13162,6 +13405,7 @@ module Aws::QuickSight
|
|
13162
13405
|
# on_clause: "OnClause", # required
|
13163
13406
|
# },
|
13164
13407
|
# physical_table_id: "PhysicalTableId",
|
13408
|
+
# data_set_arn: "Arn",
|
13165
13409
|
# },
|
13166
13410
|
# },
|
13167
13411
|
# },
|
@@ -13205,16 +13449,19 @@ module Aws::QuickSight
|
|
13205
13449
|
# column_names: ["String"],
|
13206
13450
|
# },
|
13207
13451
|
# ],
|
13452
|
+
# data_set_usage_configuration: {
|
13453
|
+
# disable_use_as_direct_query_source: false,
|
13454
|
+
# disable_use_as_imported_source: false,
|
13455
|
+
# },
|
13208
13456
|
# }
|
13209
13457
|
#
|
13210
13458
|
# @!attribute [rw] aws_account_id
|
13211
|
-
# The Amazon Web Services account
|
13459
|
+
# The Amazon Web Services account ID.
|
13212
13460
|
# @return [String]
|
13213
13461
|
#
|
13214
13462
|
# @!attribute [rw] data_set_id
|
13215
13463
|
# The ID for the dataset that you want to update. This ID is unique
|
13216
|
-
# per Amazon Web Services Region
|
13217
|
-
# account;.
|
13464
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
13218
13465
|
# @return [String]
|
13219
13466
|
#
|
13220
13467
|
# @!attribute [rw] name
|
@@ -13236,7 +13483,7 @@ module Aws::QuickSight
|
|
13236
13483
|
# @return [String]
|
13237
13484
|
#
|
13238
13485
|
# @!attribute [rw] column_groups
|
13239
|
-
# Groupings of columns that work together in certain QuickSight
|
13486
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
13240
13487
|
# features. Currently, only geospatial hierarchy is supported.
|
13241
13488
|
# @return [Array<Types::ColumnGroup>]
|
13242
13489
|
#
|
@@ -13260,6 +13507,11 @@ module Aws::QuickSight
|
|
13260
13507
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
13261
13508
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
13262
13509
|
#
|
13510
|
+
# @!attribute [rw] data_set_usage_configuration
|
13511
|
+
# The usage configuration to apply to child datasets that reference
|
13512
|
+
# this dataset as a source.
|
13513
|
+
# @return [Types::DataSetUsageConfiguration]
|
13514
|
+
#
|
13263
13515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
13264
13516
|
#
|
13265
13517
|
class UpdateDataSetRequest < Struct.new(
|
@@ -13273,7 +13525,8 @@ module Aws::QuickSight
|
|
13273
13525
|
:field_folders,
|
13274
13526
|
:row_level_permission_data_set,
|
13275
13527
|
:row_level_permission_tag_configuration,
|
13276
|
-
:column_level_permission_rules
|
13528
|
+
:column_level_permission_rules,
|
13529
|
+
:data_set_usage_configuration)
|
13277
13530
|
SENSITIVE = []
|
13278
13531
|
include Aws::Structure
|
13279
13532
|
end
|
@@ -13284,8 +13537,7 @@ module Aws::QuickSight
|
|
13284
13537
|
#
|
13285
13538
|
# @!attribute [rw] data_set_id
|
13286
13539
|
# The ID for the dataset that you want to create. This ID is unique
|
13287
|
-
# per Amazon Web Services Region
|
13288
|
-
# account;.
|
13540
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
13289
13541
|
# @return [String]
|
13290
13542
|
#
|
13291
13543
|
# @!attribute [rw] ingestion_arn
|
@@ -13340,12 +13592,12 @@ module Aws::QuickSight
|
|
13340
13592
|
# }
|
13341
13593
|
#
|
13342
13594
|
# @!attribute [rw] aws_account_id
|
13343
|
-
# The Amazon Web Services account
|
13595
|
+
# The Amazon Web Services account ID.
|
13344
13596
|
# @return [String]
|
13345
13597
|
#
|
13346
13598
|
# @!attribute [rw] data_source_id
|
13347
13599
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13348
|
-
# Region
|
13600
|
+
# Region for each Amazon Web Services account.
|
13349
13601
|
# @return [String]
|
13350
13602
|
#
|
13351
13603
|
# @!attribute [rw] grant_permissions
|
@@ -13375,7 +13627,7 @@ module Aws::QuickSight
|
|
13375
13627
|
#
|
13376
13628
|
# @!attribute [rw] data_source_id
|
13377
13629
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13378
|
-
# Region
|
13630
|
+
# Region for each Amazon Web Services account.
|
13379
13631
|
# @return [String]
|
13380
13632
|
#
|
13381
13633
|
# @!attribute [rw] request_id
|
@@ -13494,6 +13746,9 @@ module Aws::QuickSight
|
|
13494
13746
|
# query: "Query", # required
|
13495
13747
|
# max_rows: 1, # required
|
13496
13748
|
# },
|
13749
|
+
# amazon_open_search_parameters: {
|
13750
|
+
# domain: "Domain", # required
|
13751
|
+
# },
|
13497
13752
|
# },
|
13498
13753
|
# credentials: {
|
13499
13754
|
# credential_pair: {
|
@@ -13590,6 +13845,9 @@ module Aws::QuickSight
|
|
13590
13845
|
# query: "Query", # required
|
13591
13846
|
# max_rows: 1, # required
|
13592
13847
|
# },
|
13848
|
+
# amazon_open_search_parameters: {
|
13849
|
+
# domain: "Domain", # required
|
13850
|
+
# },
|
13593
13851
|
# },
|
13594
13852
|
# ],
|
13595
13853
|
# },
|
@@ -13604,12 +13862,12 @@ module Aws::QuickSight
|
|
13604
13862
|
# }
|
13605
13863
|
#
|
13606
13864
|
# @!attribute [rw] aws_account_id
|
13607
|
-
# The Amazon Web Services account
|
13865
|
+
# The Amazon Web Services account ID.
|
13608
13866
|
# @return [String]
|
13609
13867
|
#
|
13610
13868
|
# @!attribute [rw] data_source_id
|
13611
13869
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13612
|
-
# Region
|
13870
|
+
# Region for each Amazon Web Services account.
|
13613
13871
|
# @return [String]
|
13614
13872
|
#
|
13615
13873
|
# @!attribute [rw] name
|
@@ -13617,24 +13875,24 @@ module Aws::QuickSight
|
|
13617
13875
|
# @return [String]
|
13618
13876
|
#
|
13619
13877
|
# @!attribute [rw] data_source_parameters
|
13620
|
-
# The parameters that QuickSight uses to connect to your
|
13621
|
-
# source.
|
13878
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
13879
|
+
# underlying source.
|
13622
13880
|
# @return [Types::DataSourceParameters]
|
13623
13881
|
#
|
13624
13882
|
# @!attribute [rw] credentials
|
13625
|
-
# The credentials that QuickSight that uses to connect to your
|
13883
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
13626
13884
|
# underlying source. Currently, only credentials based on user name
|
13627
13885
|
# and password are supported.
|
13628
13886
|
# @return [Types::DataSourceCredentials]
|
13629
13887
|
#
|
13630
13888
|
# @!attribute [rw] vpc_connection_properties
|
13631
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
13889
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
13632
13890
|
# connection when connecting to your underlying source.
|
13633
13891
|
# @return [Types::VpcConnectionProperties]
|
13634
13892
|
#
|
13635
13893
|
# @!attribute [rw] ssl_properties
|
13636
|
-
# Secure Socket Layer (SSL) properties that apply when
|
13637
|
-
# connects to your underlying source.
|
13894
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon
|
13895
|
+
# QuickSight connects to your underlying source.
|
13638
13896
|
# @return [Types::SslProperties]
|
13639
13897
|
#
|
13640
13898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSourceRequest AWS API Documentation
|
@@ -13657,7 +13915,7 @@ module Aws::QuickSight
|
|
13657
13915
|
#
|
13658
13916
|
# @!attribute [rw] data_source_id
|
13659
13917
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13660
|
-
# Region
|
13918
|
+
# Region for each Amazon Web Services account.
|
13661
13919
|
# @return [String]
|
13662
13920
|
#
|
13663
13921
|
# @!attribute [rw] update_status
|
@@ -13840,8 +14098,8 @@ module Aws::QuickSight
|
|
13840
14098
|
# @return [String]
|
13841
14099
|
#
|
13842
14100
|
# @!attribute [rw] aws_account_id
|
13843
|
-
# The ID for the Amazon Web Services account
|
13844
|
-
# Currently, you use the ID for the Amazon Web Services account
|
14101
|
+
# The ID for the Amazon Web Services account that the group is in.
|
14102
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
13845
14103
|
# contains your Amazon QuickSight account.
|
13846
14104
|
# @return [String]
|
13847
14105
|
#
|
@@ -13897,13 +14155,13 @@ module Aws::QuickSight
|
|
13897
14155
|
# }
|
13898
14156
|
#
|
13899
14157
|
# @!attribute [rw] aws_account_id
|
13900
|
-
# The ID of the Amazon Web Services account
|
13901
|
-
#
|
14158
|
+
# The ID of the Amazon Web Services account that contains the
|
14159
|
+
# IAMpolicy assignment.
|
13902
14160
|
# @return [String]
|
13903
14161
|
#
|
13904
14162
|
# @!attribute [rw] assignment_name
|
13905
14163
|
# The name of the assignment, also called a rule. This name must be
|
13906
|
-
# unique within an Amazon Web Services account
|
14164
|
+
# unique within an Amazon Web Services account.
|
13907
14165
|
# @return [String]
|
13908
14166
|
#
|
13909
14167
|
# @!attribute [rw] namespace
|
@@ -13924,13 +14182,13 @@ module Aws::QuickSight
|
|
13924
14182
|
# @return [String]
|
13925
14183
|
#
|
13926
14184
|
# @!attribute [rw] policy_arn
|
13927
|
-
# The ARN for the
|
13928
|
-
# groups specified in this assignment.
|
14185
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users
|
14186
|
+
# and groups specified in this assignment.
|
13929
14187
|
# @return [String]
|
13930
14188
|
#
|
13931
14189
|
# @!attribute [rw] identities
|
13932
|
-
# The QuickSight users, groups, or both that you want to assign
|
13933
|
-
# policy to.
|
14190
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
14191
|
+
# the policy to.
|
13934
14192
|
# @return [Hash<String,Array<String>>]
|
13935
14193
|
#
|
13936
14194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -13955,12 +14213,12 @@ module Aws::QuickSight
|
|
13955
14213
|
# @return [String]
|
13956
14214
|
#
|
13957
14215
|
# @!attribute [rw] policy_arn
|
13958
|
-
# The ARN for the
|
14216
|
+
# The ARN for the IAMpolicy applied to the Amazon QuickSight users and
|
13959
14217
|
# groups specified in this assignment.
|
13960
14218
|
# @return [String]
|
13961
14219
|
#
|
13962
14220
|
# @!attribute [rw] identities
|
13963
|
-
# The QuickSight users, groups, or both that the
|
14221
|
+
# The Amazon QuickSight users, groups, or both that the IAMpolicy is
|
13964
14222
|
# assigned to.
|
13965
14223
|
# @return [Hash<String,Array<String>>]
|
13966
14224
|
#
|
@@ -13999,6 +14257,62 @@ module Aws::QuickSight
|
|
13999
14257
|
include Aws::Structure
|
14000
14258
|
end
|
14001
14259
|
|
14260
|
+
# @note When making an API call, you may pass UpdateIpRestrictionRequest
|
14261
|
+
# data as a hash:
|
14262
|
+
#
|
14263
|
+
# {
|
14264
|
+
# aws_account_id: "AwsAccountId", # required
|
14265
|
+
# ip_restriction_rule_map: {
|
14266
|
+
# "CIDR" => "IpRestrictionRuleDescription",
|
14267
|
+
# },
|
14268
|
+
# enabled: false,
|
14269
|
+
# }
|
14270
|
+
#
|
14271
|
+
# @!attribute [rw] aws_account_id
|
14272
|
+
# Your AWS account ID.
|
14273
|
+
# @return [String]
|
14274
|
+
#
|
14275
|
+
# @!attribute [rw] ip_restriction_rule_map
|
14276
|
+
# Describes updated IP rules.
|
14277
|
+
# @return [Hash<String,String>]
|
14278
|
+
#
|
14279
|
+
# @!attribute [rw] enabled
|
14280
|
+
# Whether or not IP rules are enabled.
|
14281
|
+
# @return [Boolean]
|
14282
|
+
#
|
14283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionRequest AWS API Documentation
|
14284
|
+
#
|
14285
|
+
class UpdateIpRestrictionRequest < Struct.new(
|
14286
|
+
:aws_account_id,
|
14287
|
+
:ip_restriction_rule_map,
|
14288
|
+
:enabled)
|
14289
|
+
SENSITIVE = []
|
14290
|
+
include Aws::Structure
|
14291
|
+
end
|
14292
|
+
|
14293
|
+
# @!attribute [rw] aws_account_id
|
14294
|
+
# Your AWS account ID.
|
14295
|
+
# @return [String]
|
14296
|
+
#
|
14297
|
+
# @!attribute [rw] request_id
|
14298
|
+
# The ID of the update request.
|
14299
|
+
# @return [String]
|
14300
|
+
#
|
14301
|
+
# @!attribute [rw] status
|
14302
|
+
# The status of the updated IP rules. A successful request returns a
|
14303
|
+
# 200 code.
|
14304
|
+
# @return [Integer]
|
14305
|
+
#
|
14306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionResponse AWS API Documentation
|
14307
|
+
#
|
14308
|
+
class UpdateIpRestrictionResponse < Struct.new(
|
14309
|
+
:aws_account_id,
|
14310
|
+
:request_id,
|
14311
|
+
:status)
|
14312
|
+
SENSITIVE = []
|
14313
|
+
include Aws::Structure
|
14314
|
+
end
|
14315
|
+
|
14002
14316
|
# @note When making an API call, you may pass UpdateTemplateAliasRequest
|
14003
14317
|
# data as a hash:
|
14004
14318
|
#
|
@@ -14010,8 +14324,8 @@ module Aws::QuickSight
|
|
14010
14324
|
# }
|
14011
14325
|
#
|
14012
14326
|
# @!attribute [rw] aws_account_id
|
14013
|
-
# The ID of the Amazon Web Services account
|
14014
|
-
#
|
14327
|
+
# The ID of the Amazon Web Services account that contains the template
|
14328
|
+
# alias that you're updating.
|
14015
14329
|
# @return [String]
|
14016
14330
|
#
|
14017
14331
|
# @!attribute [rw] template_id
|
@@ -14084,7 +14398,7 @@ module Aws::QuickSight
|
|
14084
14398
|
# }
|
14085
14399
|
#
|
14086
14400
|
# @!attribute [rw] aws_account_id
|
14087
|
-
# The ID of the Amazon Web Services account
|
14401
|
+
# The ID of the Amazon Web Services account that contains the
|
14088
14402
|
# template.
|
14089
14403
|
# @return [String]
|
14090
14404
|
#
|
@@ -14168,8 +14482,8 @@ module Aws::QuickSight
|
|
14168
14482
|
# }
|
14169
14483
|
#
|
14170
14484
|
# @!attribute [rw] aws_account_id
|
14171
|
-
# The ID of the Amazon Web Services account
|
14172
|
-
#
|
14485
|
+
# The ID of the Amazon Web Services account that contains the template
|
14486
|
+
# that you're updating.
|
14173
14487
|
# @return [String]
|
14174
14488
|
#
|
14175
14489
|
# @!attribute [rw] template_id
|
@@ -14183,8 +14497,8 @@ module Aws::QuickSight
|
|
14183
14497
|
# for an analysis. Both of these require an Amazon Resource Name
|
14184
14498
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
14185
14499
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
14186
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
14187
|
-
#
|
14500
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
14501
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
14188
14502
|
#
|
14189
14503
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
14190
14504
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -14264,7 +14578,7 @@ module Aws::QuickSight
|
|
14264
14578
|
# }
|
14265
14579
|
#
|
14266
14580
|
# @!attribute [rw] aws_account_id
|
14267
|
-
# The ID of the Amazon Web Services account
|
14581
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14268
14582
|
# alias that you're updating.
|
14269
14583
|
# @return [String]
|
14270
14584
|
#
|
@@ -14334,7 +14648,7 @@ module Aws::QuickSight
|
|
14334
14648
|
# }
|
14335
14649
|
#
|
14336
14650
|
# @!attribute [rw] aws_account_id
|
14337
|
-
# The ID of the Amazon Web Services account
|
14651
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
14338
14652
|
# @return [String]
|
14339
14653
|
#
|
14340
14654
|
# @!attribute [rw] theme_id
|
@@ -14444,7 +14758,7 @@ module Aws::QuickSight
|
|
14444
14758
|
# }
|
14445
14759
|
#
|
14446
14760
|
# @!attribute [rw] aws_account_id
|
14447
|
-
# The ID of the Amazon Web Services account
|
14761
|
+
# The ID of the Amazon Web Services account that contains the theme
|
14448
14762
|
# that you're updating.
|
14449
14763
|
# @return [String]
|
14450
14764
|
#
|
@@ -14545,8 +14859,8 @@ module Aws::QuickSight
|
|
14545
14859
|
# @return [String]
|
14546
14860
|
#
|
14547
14861
|
# @!attribute [rw] aws_account_id
|
14548
|
-
# The ID for the Amazon Web Services account
|
14549
|
-
# Currently, you use the ID for the Amazon Web Services account
|
14862
|
+
# The ID for the Amazon Web Services account that the user is in.
|
14863
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
14550
14864
|
# contains your Amazon QuickSight account.
|
14551
14865
|
# @return [String]
|
14552
14866
|
#
|
@@ -14570,8 +14884,8 @@ module Aws::QuickSight
|
|
14570
14884
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14571
14885
|
# QuickSight settings.
|
14572
14886
|
#
|
14573
|
-
# The name of the QuickSight role is invisible to the user
|
14574
|
-
# the console screens dealing with permissions.
|
14887
|
+
# The name of the Amazon QuickSight role is invisible to the user
|
14888
|
+
# except for the console screens dealing with permissions.
|
14575
14889
|
# @return [String]
|
14576
14890
|
#
|
14577
14891
|
# @!attribute [rw] custom_permissions_name
|
@@ -14590,17 +14904,17 @@ module Aws::QuickSight
|
|
14590
14904
|
#
|
14591
14905
|
# A set of custom permissions includes any combination of these
|
14592
14906
|
# restrictions. Currently, you need to create the profile names for
|
14593
|
-
# custom permission sets by using the QuickSight console. Then,
|
14594
|
-
# use the `RegisterUser` API operation to assign the named set of
|
14595
|
-
# permissions to a QuickSight user.
|
14907
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
14908
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
14909
|
+
# permissions to a Amazon QuickSight user.
|
14596
14910
|
#
|
14597
|
-
# QuickSight custom permissions are applied through
|
14598
|
-
# Therefore, they override the permissions typically
|
14599
|
-
# assigning QuickSight users to one of the default
|
14600
|
-
# QuickSight (admin, author, reader).
|
14911
|
+
# Amazon QuickSight custom permissions are applied through
|
14912
|
+
# IAMpolicies. Therefore, they override the permissions typically
|
14913
|
+
# granted by assigning Amazon QuickSight users to one of the default
|
14914
|
+
# security cohorts in Amazon QuickSight (admin, author, reader).
|
14601
14915
|
#
|
14602
|
-
# This feature is available only to QuickSight Enterprise
|
14603
|
-
# subscriptions.
|
14916
|
+
# This feature is available only to Amazon QuickSight Enterprise
|
14917
|
+
# edition subscriptions.
|
14604
14918
|
# @return [String]
|
14605
14919
|
#
|
14606
14920
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -14613,8 +14927,8 @@ module Aws::QuickSight
|
|
14613
14927
|
#
|
14614
14928
|
# @!attribute [rw] external_login_federation_provider_type
|
14615
14929
|
# The type of supported external login provider that provides identity
|
14616
|
-
# to let a user federate into QuickSight with an associated
|
14617
|
-
# Identity and Access Management
|
14930
|
+
# to let a user federate into Amazon QuickSight with an associated
|
14931
|
+
# Identity and Access Management(IAM) role. The type of supported
|
14618
14932
|
# external login provider can be one of the following.
|
14619
14933
|
#
|
14620
14934
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -14634,10 +14948,10 @@ module Aws::QuickSight
|
|
14634
14948
|
#
|
14635
14949
|
# @!attribute [rw] custom_federation_provider_url
|
14636
14950
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
14637
|
-
# identity to let a user federate into QuickSight with an
|
14638
|
-
#
|
14639
|
-
# only be used when `ExternalLoginFederationProviderType`
|
14640
|
-
# set to `CUSTOM_OIDC`.
|
14951
|
+
# identity to let a user federate into Amazon QuickSight with an
|
14952
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
14953
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
14954
|
+
# parameter is set to `CUSTOM_OIDC`.
|
14641
14955
|
# @return [String]
|
14642
14956
|
#
|
14643
14957
|
# @!attribute [rw] external_login_id
|
@@ -14753,7 +15067,7 @@ module Aws::QuickSight
|
|
14753
15067
|
# and dashboards.
|
14754
15068
|
#
|
14755
15069
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
14756
|
-
# QuickSight settings.
|
15070
|
+
# Amazon QuickSight settings.
|
14757
15071
|
#
|
14758
15072
|
# * `RESTRICTED_READER`\: This role isn't currently available for
|
14759
15073
|
# use.
|
@@ -14783,7 +15097,7 @@ module Aws::QuickSight
|
|
14783
15097
|
# @!attribute [rw] external_login_federation_provider_type
|
14784
15098
|
# The type of supported external login provider that provides identity
|
14785
15099
|
# to let the user federate into Amazon QuickSight with an associated
|
14786
|
-
#
|
15100
|
+
# IAMrole. The type can be one of the following.
|
14787
15101
|
#
|
14788
15102
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
14789
15103
|
# cognito-identity.amazonaws.com.
|