aws-sdk-quicksight 1.44.0 → 1.48.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.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1283 -321
- data/lib/aws-sdk-quicksight/client_api.rb +521 -0
- data/lib/aws-sdk-quicksight/types.rb +2078 -497
- metadata +5 -6
@@ -20,7 +20,7 @@ module Aws::QuickSight
|
|
20
20
|
# @return [String]
|
21
21
|
#
|
22
22
|
# @!attribute [rw] request_id
|
23
|
-
# The
|
23
|
+
# The Amazon Web Services request ID for this request.
|
24
24
|
# @return [String]
|
25
25
|
#
|
26
26
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccessDeniedException AWS API Documentation
|
@@ -32,8 +32,8 @@ module Aws::QuickSight
|
|
32
32
|
include Aws::Structure
|
33
33
|
end
|
34
34
|
|
35
|
-
# The Amazon QuickSight customizations associated with your
|
36
|
-
# or a QuickSight namespace in a specific
|
35
|
+
# The Amazon QuickSight customizations associated with your Amazon Web
|
36
|
+
# Services account; or a QuickSight namespace in a specific Region;.
|
37
37
|
#
|
38
38
|
# @note When making an API call, you may pass AccountCustomization
|
39
39
|
# data as a hash:
|
@@ -54,13 +54,14 @@ module Aws::QuickSight
|
|
54
54
|
include Aws::Structure
|
55
55
|
end
|
56
56
|
|
57
|
-
# The QuickSight settings associated with your
|
57
|
+
# The QuickSight settings associated with your Amazon Web Services
|
58
|
+
# account;.
|
58
59
|
#
|
59
60
|
# @!attribute [rw] account_name
|
60
61
|
# The "account name" you provided for the QuickSight subscription in
|
61
|
-
# your
|
62
|
-
# QuickSight. It is unique in all of
|
63
|
-
#
|
62
|
+
# your Amazon Web Services account;. You create this name when you
|
63
|
+
# sign up for QuickSight. It is unique in all of Amazon Web Services
|
64
|
+
# and it appears only when users sign in.
|
64
65
|
# @return [String]
|
65
66
|
#
|
66
67
|
# @!attribute [rw] edition
|
@@ -69,7 +70,8 @@ module Aws::QuickSight
|
|
69
70
|
# @return [String]
|
70
71
|
#
|
71
72
|
# @!attribute [rw] default_namespace
|
72
|
-
# The default QuickSight namespace for your
|
73
|
+
# The default QuickSight namespace for your Amazon Web Services
|
74
|
+
# account;.
|
73
75
|
# @return [String]
|
74
76
|
#
|
75
77
|
# @!attribute [rw] notification_email
|
@@ -87,7 +89,7 @@ module Aws::QuickSight
|
|
87
89
|
include Aws::Structure
|
88
90
|
end
|
89
91
|
|
90
|
-
# The active
|
92
|
+
# The active Identity and Access Management (IAM) policy assignment.
|
91
93
|
#
|
92
94
|
# @!attribute [rw] assignment_name
|
93
95
|
# A name for the IAM policy assignment.
|
@@ -366,6 +368,58 @@ module Aws::QuickSight
|
|
366
368
|
include Aws::Structure
|
367
369
|
end
|
368
370
|
|
371
|
+
# Information about the dashboard that you want to embed.
|
372
|
+
#
|
373
|
+
# @note When making an API call, you may pass AnonymousUserDashboardEmbeddingConfiguration
|
374
|
+
# data as a hash:
|
375
|
+
#
|
376
|
+
# {
|
377
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
378
|
+
# }
|
379
|
+
#
|
380
|
+
# @!attribute [rw] initial_dashboard_id
|
381
|
+
# The dashboard ID for the dashboard that you want the user to see
|
382
|
+
# first. This ID is included in the output URL. When the URL in
|
383
|
+
# response is accessed, Amazon QuickSight renders this dashboard.
|
384
|
+
#
|
385
|
+
# The Amazon Resource Name (ARN) of this dashboard must be included in
|
386
|
+
# the `AuthorizedResourceArns` parameter. Otherwise, the request will
|
387
|
+
# fail with `InvalidParameterValueException`.
|
388
|
+
# @return [String]
|
389
|
+
#
|
390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserDashboardEmbeddingConfiguration AWS API Documentation
|
391
|
+
#
|
392
|
+
class AnonymousUserDashboardEmbeddingConfiguration < Struct.new(
|
393
|
+
:initial_dashboard_id)
|
394
|
+
SENSITIVE = []
|
395
|
+
include Aws::Structure
|
396
|
+
end
|
397
|
+
|
398
|
+
# The type of experience you want to embed. For anonymous users, you can
|
399
|
+
# embed an Amazon QuickSight dashboard.
|
400
|
+
#
|
401
|
+
# @note When making an API call, you may pass AnonymousUserEmbeddingExperienceConfiguration
|
402
|
+
# data as a hash:
|
403
|
+
#
|
404
|
+
# {
|
405
|
+
# dashboard: {
|
406
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
407
|
+
# },
|
408
|
+
# }
|
409
|
+
#
|
410
|
+
# @!attribute [rw] dashboard
|
411
|
+
# The type of embedding experience. In this case, an Amazon QuickSight
|
412
|
+
# dashboard.
|
413
|
+
# @return [Types::AnonymousUserDashboardEmbeddingConfiguration]
|
414
|
+
#
|
415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
|
416
|
+
#
|
417
|
+
class AnonymousUserEmbeddingExperienceConfiguration < Struct.new(
|
418
|
+
:dashboard)
|
419
|
+
SENSITIVE = []
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
369
423
|
# Amazon Athena parameters.
|
370
424
|
#
|
371
425
|
# @note When making an API call, you may pass AthenaParameters
|
@@ -453,7 +507,7 @@ module Aws::QuickSight
|
|
453
507
|
include Aws::Structure
|
454
508
|
end
|
455
509
|
|
456
|
-
#
|
510
|
+
# Amazon Web Services IoT Analytics parameters.
|
457
511
|
#
|
458
512
|
# @note When making an API call, you may pass AwsIotAnalyticsParameters
|
459
513
|
# data as a hash:
|
@@ -541,7 +595,7 @@ module Aws::QuickSight
|
|
541
595
|
# }
|
542
596
|
#
|
543
597
|
# @!attribute [rw] aws_account_id
|
544
|
-
# The
|
598
|
+
# The Amazon Web Services account; ID.
|
545
599
|
# @return [String]
|
546
600
|
#
|
547
601
|
# @!attribute [rw] data_set_id
|
@@ -571,7 +625,7 @@ module Aws::QuickSight
|
|
571
625
|
# @return [String]
|
572
626
|
#
|
573
627
|
# @!attribute [rw] request_id
|
574
|
-
# The
|
628
|
+
# The Amazon Web Services request ID for this operation.
|
575
629
|
# @return [String]
|
576
630
|
#
|
577
631
|
# @!attribute [rw] status
|
@@ -817,7 +871,7 @@ module Aws::QuickSight
|
|
817
871
|
# @return [String]
|
818
872
|
#
|
819
873
|
# @!attribute [rw] request_id
|
820
|
-
# The
|
874
|
+
# The Amazon Web Services request ID for this request.
|
821
875
|
# @return [String]
|
822
876
|
#
|
823
877
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConflictException AWS API Documentation
|
@@ -847,8 +901,8 @@ module Aws::QuickSight
|
|
847
901
|
# }
|
848
902
|
#
|
849
903
|
# @!attribute [rw] aws_account_id
|
850
|
-
# The ID for the
|
851
|
-
# for.
|
904
|
+
# The ID for the Amazon Web Services account; that you want to
|
905
|
+
# customize QuickSight for.
|
852
906
|
# @return [String]
|
853
907
|
#
|
854
908
|
# @!attribute [rw] namespace
|
@@ -856,9 +910,9 @@ module Aws::QuickSight
|
|
856
910
|
# @return [String]
|
857
911
|
#
|
858
912
|
# @!attribute [rw] account_customization
|
859
|
-
# The QuickSight customizations you're adding in the current
|
860
|
-
#
|
861
|
-
# namespace.
|
913
|
+
# The QuickSight customizations you're adding in the current Region;.
|
914
|
+
# You can add these to an Amazon Web Services account; and a
|
915
|
+
# QuickSight namespace.
|
862
916
|
#
|
863
917
|
# For example, you can add a default theme by setting
|
864
918
|
# `AccountCustomization` to the midnight theme:
|
@@ -887,12 +941,12 @@ module Aws::QuickSight
|
|
887
941
|
|
888
942
|
# @!attribute [rw] arn
|
889
943
|
# The Amazon Resource Name (ARN) for the customization that you
|
890
|
-
# created for this
|
944
|
+
# created for this Amazon Web Services account;.
|
891
945
|
# @return [String]
|
892
946
|
#
|
893
947
|
# @!attribute [rw] aws_account_id
|
894
|
-
# The ID for the
|
895
|
-
# for.
|
948
|
+
# The ID for the Amazon Web Services account; that you want to
|
949
|
+
# customize QuickSight for.
|
896
950
|
# @return [String]
|
897
951
|
#
|
898
952
|
# @!attribute [rw] namespace
|
@@ -900,12 +954,11 @@ module Aws::QuickSight
|
|
900
954
|
# @return [String]
|
901
955
|
#
|
902
956
|
# @!attribute [rw] account_customization
|
903
|
-
# The QuickSight customizations you're adding in the current
|
904
|
-
# Region.
|
957
|
+
# The QuickSight customizations you're adding in the current Region;.
|
905
958
|
# @return [Types::AccountCustomization]
|
906
959
|
#
|
907
960
|
# @!attribute [rw] request_id
|
908
|
-
# The
|
961
|
+
# The Amazon Web Services request ID for this operation.
|
909
962
|
# @return [String]
|
910
963
|
#
|
911
964
|
# @!attribute [rw] status
|
@@ -985,7 +1038,8 @@ module Aws::QuickSight
|
|
985
1038
|
# }
|
986
1039
|
#
|
987
1040
|
# @!attribute [rw] aws_account_id
|
988
|
-
# The ID of the
|
1041
|
+
# The ID of the Amazon Web Services account; where you are creating an
|
1042
|
+
# analysis.
|
989
1043
|
# @return [String]
|
990
1044
|
#
|
991
1045
|
# @!attribute [rw] analysis_id
|
@@ -1007,7 +1061,7 @@ module Aws::QuickSight
|
|
1007
1061
|
# @!attribute [rw] permissions
|
1008
1062
|
# A structure that describes the principals and the resource-level
|
1009
1063
|
# permissions on an analysis. You can use the `Permissions` structure
|
1010
|
-
# to grant permissions by providing a list of
|
1064
|
+
# to grant permissions by providing a list of Identity and Access
|
1011
1065
|
# Management (IAM) action information for each principal listed by
|
1012
1066
|
# Amazon Resource Name (ARN).
|
1013
1067
|
#
|
@@ -1063,7 +1117,7 @@ module Aws::QuickSight
|
|
1063
1117
|
# @return [Integer]
|
1064
1118
|
#
|
1065
1119
|
# @!attribute [rw] request_id
|
1066
|
-
# The
|
1120
|
+
# The Amazon Web Services request ID for this operation.
|
1067
1121
|
# @return [String]
|
1068
1122
|
#
|
1069
1123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisResponse AWS API Documentation
|
@@ -1178,7 +1232,8 @@ module Aws::QuickSight
|
|
1178
1232
|
# }
|
1179
1233
|
#
|
1180
1234
|
# @!attribute [rw] aws_account_id
|
1181
|
-
# The ID of the
|
1235
|
+
# The ID of the Amazon Web Services account; where you want to create
|
1236
|
+
# the dashboard.
|
1182
1237
|
# @return [String]
|
1183
1238
|
#
|
1184
1239
|
# @!attribute [rw] dashboard_id
|
@@ -1211,8 +1266,8 @@ module Aws::QuickSight
|
|
1211
1266
|
# from an analysis, first convert the analysis to a template by using
|
1212
1267
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
1213
1268
|
# Amazon Resource Name (ARN) of the source template. The
|
1214
|
-
# `SourceTemplate`ARN can contain any
|
1215
|
-
# QuickSight-supported
|
1269
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account; and
|
1270
|
+
# any QuickSight-supported Region;.
|
1216
1271
|
#
|
1217
1272
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
1218
1273
|
# the replacement datasets for the placeholders listed in the
|
@@ -1251,7 +1306,8 @@ module Aws::QuickSight
|
|
1251
1306
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
1252
1307
|
# this dashboard. If you add a value for this field, it overrides the
|
1253
1308
|
# value that is used in the source entity. The theme ARN must exist in
|
1254
|
-
# the same
|
1309
|
+
# the same Amazon Web Services account; where you create the
|
1310
|
+
# dashboard.
|
1255
1311
|
# @return [String]
|
1256
1312
|
#
|
1257
1313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -1293,7 +1349,7 @@ module Aws::QuickSight
|
|
1293
1349
|
# @return [Integer]
|
1294
1350
|
#
|
1295
1351
|
# @!attribute [rw] request_id
|
1296
|
-
# The
|
1352
|
+
# The Amazon Web Services request ID for this operation.
|
1297
1353
|
# @return [String]
|
1298
1354
|
#
|
1299
1355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardResponse AWS API Documentation
|
@@ -1444,6 +1500,19 @@ module Aws::QuickSight
|
|
1444
1500
|
# namespace: "Namespace",
|
1445
1501
|
# arn: "Arn", # required
|
1446
1502
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
1503
|
+
# format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
|
1504
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
1505
|
+
# },
|
1506
|
+
# row_level_permission_tag_configuration: {
|
1507
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
1508
|
+
# tag_rules: [ # required
|
1509
|
+
# {
|
1510
|
+
# tag_key: "SessionTagKey", # required
|
1511
|
+
# column_name: "String", # required
|
1512
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
1513
|
+
# match_all_value: "SessionTagValue",
|
1514
|
+
# },
|
1515
|
+
# ],
|
1447
1516
|
# },
|
1448
1517
|
# column_level_permission_rules: [
|
1449
1518
|
# {
|
@@ -1460,12 +1529,12 @@ module Aws::QuickSight
|
|
1460
1529
|
# }
|
1461
1530
|
#
|
1462
1531
|
# @!attribute [rw] aws_account_id
|
1463
|
-
# The
|
1532
|
+
# The Amazon Web Services account; ID.
|
1464
1533
|
# @return [String]
|
1465
1534
|
#
|
1466
1535
|
# @!attribute [rw] data_set_id
|
1467
1536
|
# An ID for the dataset that you want to create. This ID is unique per
|
1468
|
-
#
|
1537
|
+
# Region; for each Amazon Web Services account;.
|
1469
1538
|
# @return [String]
|
1470
1539
|
#
|
1471
1540
|
# @!attribute [rw] name
|
@@ -1505,6 +1574,12 @@ module Aws::QuickSight
|
|
1505
1574
|
# create.
|
1506
1575
|
# @return [Types::RowLevelPermissionDataSet]
|
1507
1576
|
#
|
1577
|
+
# @!attribute [rw] row_level_permission_tag_configuration
|
1578
|
+
# The configuration of tags on a dataset to set row-level security.
|
1579
|
+
# Row-level security tags are currently supported for anonymous
|
1580
|
+
# embedding only.
|
1581
|
+
# @return [Types::RowLevelPermissionTagConfiguration]
|
1582
|
+
#
|
1508
1583
|
# @!attribute [rw] column_level_permission_rules
|
1509
1584
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
1510
1585
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
@@ -1527,6 +1602,7 @@ module Aws::QuickSight
|
|
1527
1602
|
:field_folders,
|
1528
1603
|
:permissions,
|
1529
1604
|
:row_level_permission_data_set,
|
1605
|
+
:row_level_permission_tag_configuration,
|
1530
1606
|
:column_level_permission_rules,
|
1531
1607
|
:tags)
|
1532
1608
|
SENSITIVE = []
|
@@ -1539,7 +1615,7 @@ module Aws::QuickSight
|
|
1539
1615
|
#
|
1540
1616
|
# @!attribute [rw] data_set_id
|
1541
1617
|
# The ID for the dataset that you want to create. This ID is unique
|
1542
|
-
# per
|
1618
|
+
# per Region; for each Amazon Web Services account;.
|
1543
1619
|
# @return [String]
|
1544
1620
|
#
|
1545
1621
|
# @!attribute [rw] ingestion_arn
|
@@ -1553,7 +1629,7 @@ module Aws::QuickSight
|
|
1553
1629
|
# @return [String]
|
1554
1630
|
#
|
1555
1631
|
# @!attribute [rw] request_id
|
1556
|
-
# The
|
1632
|
+
# The Amazon Web Services request ID for this operation.
|
1557
1633
|
# @return [String]
|
1558
1634
|
#
|
1559
1635
|
# @!attribute [rw] status
|
@@ -1793,12 +1869,12 @@ module Aws::QuickSight
|
|
1793
1869
|
# }
|
1794
1870
|
#
|
1795
1871
|
# @!attribute [rw] aws_account_id
|
1796
|
-
# The
|
1872
|
+
# The Amazon Web Services account; ID.
|
1797
1873
|
# @return [String]
|
1798
1874
|
#
|
1799
1875
|
# @!attribute [rw] data_source_id
|
1800
|
-
# An ID for the data source. This ID is unique per
|
1801
|
-
#
|
1876
|
+
# An ID for the data source. This ID is unique per Region; for each
|
1877
|
+
# Amazon Web Services account;.
|
1802
1878
|
# @return [String]
|
1803
1879
|
#
|
1804
1880
|
# @!attribute [rw] name
|
@@ -1867,8 +1943,8 @@ module Aws::QuickSight
|
|
1867
1943
|
# @return [String]
|
1868
1944
|
#
|
1869
1945
|
# @!attribute [rw] data_source_id
|
1870
|
-
# The ID of the data source. This ID is unique per
|
1871
|
-
#
|
1946
|
+
# The ID of the data source. This ID is unique per Region; for each
|
1947
|
+
# Amazon Web Services account;.
|
1872
1948
|
# @return [String]
|
1873
1949
|
#
|
1874
1950
|
# @!attribute [rw] creation_status
|
@@ -1876,7 +1952,7 @@ module Aws::QuickSight
|
|
1876
1952
|
# @return [String]
|
1877
1953
|
#
|
1878
1954
|
# @!attribute [rw] request_id
|
1879
|
-
# The
|
1955
|
+
# The Amazon Web Services request ID for this operation.
|
1880
1956
|
# @return [String]
|
1881
1957
|
#
|
1882
1958
|
# @!attribute [rw] status
|
@@ -1895,6 +1971,166 @@ module Aws::QuickSight
|
|
1895
1971
|
include Aws::Structure
|
1896
1972
|
end
|
1897
1973
|
|
1974
|
+
# @note When making an API call, you may pass CreateFolderMembershipRequest
|
1975
|
+
# data as a hash:
|
1976
|
+
#
|
1977
|
+
# {
|
1978
|
+
# aws_account_id: "AwsAccountId", # required
|
1979
|
+
# folder_id: "RestrictiveResourceId", # required
|
1980
|
+
# member_id: "RestrictiveResourceId", # required
|
1981
|
+
# member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
|
1982
|
+
# }
|
1983
|
+
#
|
1984
|
+
# @!attribute [rw] aws_account_id
|
1985
|
+
# The AWS Account ID.
|
1986
|
+
# @return [String]
|
1987
|
+
#
|
1988
|
+
# @!attribute [rw] folder_id
|
1989
|
+
# The folder ID.
|
1990
|
+
# @return [String]
|
1991
|
+
#
|
1992
|
+
# @!attribute [rw] member_id
|
1993
|
+
# The ID of the asset (the dashboard, analysis, or dataset).
|
1994
|
+
# @return [String]
|
1995
|
+
#
|
1996
|
+
# @!attribute [rw] member_type
|
1997
|
+
# The type of the member, including `DASHBOARD`, `ANALYSIS`, and
|
1998
|
+
# `DATASET`.
|
1999
|
+
# @return [String]
|
2000
|
+
#
|
2001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipRequest AWS API Documentation
|
2002
|
+
#
|
2003
|
+
class CreateFolderMembershipRequest < Struct.new(
|
2004
|
+
:aws_account_id,
|
2005
|
+
:folder_id,
|
2006
|
+
:member_id,
|
2007
|
+
:member_type)
|
2008
|
+
SENSITIVE = []
|
2009
|
+
include Aws::Structure
|
2010
|
+
end
|
2011
|
+
|
2012
|
+
# @!attribute [rw] status
|
2013
|
+
# The status of the folder membership. If succeeded, the status is
|
2014
|
+
# `SC_OK (200)`.
|
2015
|
+
# @return [Integer]
|
2016
|
+
#
|
2017
|
+
# @!attribute [rw] folder_member
|
2018
|
+
# Information about the member in the folder.
|
2019
|
+
# @return [Types::FolderMember]
|
2020
|
+
#
|
2021
|
+
# @!attribute [rw] request_id
|
2022
|
+
# The request ID.
|
2023
|
+
# @return [String]
|
2024
|
+
#
|
2025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipResponse AWS API Documentation
|
2026
|
+
#
|
2027
|
+
class CreateFolderMembershipResponse < Struct.new(
|
2028
|
+
:status,
|
2029
|
+
:folder_member,
|
2030
|
+
:request_id)
|
2031
|
+
SENSITIVE = []
|
2032
|
+
include Aws::Structure
|
2033
|
+
end
|
2034
|
+
|
2035
|
+
# @note When making an API call, you may pass CreateFolderRequest
|
2036
|
+
# data as a hash:
|
2037
|
+
#
|
2038
|
+
# {
|
2039
|
+
# aws_account_id: "AwsAccountId", # required
|
2040
|
+
# folder_id: "RestrictiveResourceId", # required
|
2041
|
+
# name: "FolderName",
|
2042
|
+
# folder_type: "SHARED", # accepts SHARED
|
2043
|
+
# parent_folder_arn: "Arn",
|
2044
|
+
# permissions: [
|
2045
|
+
# {
|
2046
|
+
# principal: "Principal", # required
|
2047
|
+
# actions: ["String"], # required
|
2048
|
+
# },
|
2049
|
+
# ],
|
2050
|
+
# tags: [
|
2051
|
+
# {
|
2052
|
+
# key: "TagKey", # required
|
2053
|
+
# value: "TagValue", # required
|
2054
|
+
# },
|
2055
|
+
# ],
|
2056
|
+
# }
|
2057
|
+
#
|
2058
|
+
# @!attribute [rw] aws_account_id
|
2059
|
+
# The AWS Account ID.
|
2060
|
+
# @return [String]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] folder_id
|
2063
|
+
# The folder ID.
|
2064
|
+
# @return [String]
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] name
|
2067
|
+
# The name of the folder.
|
2068
|
+
# @return [String]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] folder_type
|
2071
|
+
# The type of folder. By default, `folderType` is `SHARED`.
|
2072
|
+
# @return [String]
|
2073
|
+
#
|
2074
|
+
# @!attribute [rw] parent_folder_arn
|
2075
|
+
# The Amazon Resource Name (ARN) for the parent folder.
|
2076
|
+
#
|
2077
|
+
# `ParentFolderArn` can be null. An empty `parentFolderArn` creates a
|
2078
|
+
# root-level folder.
|
2079
|
+
# @return [String]
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] permissions
|
2082
|
+
# A structure that describes the principals and the resource-level
|
2083
|
+
# permissions of a folder.
|
2084
|
+
#
|
2085
|
+
# To specify no permissions, omit `Permissions`.
|
2086
|
+
# @return [Array<Types::ResourcePermission>]
|
2087
|
+
#
|
2088
|
+
# @!attribute [rw] tags
|
2089
|
+
# Tags for the folder.
|
2090
|
+
# @return [Array<Types::Tag>]
|
2091
|
+
#
|
2092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderRequest AWS API Documentation
|
2093
|
+
#
|
2094
|
+
class CreateFolderRequest < Struct.new(
|
2095
|
+
:aws_account_id,
|
2096
|
+
:folder_id,
|
2097
|
+
:name,
|
2098
|
+
:folder_type,
|
2099
|
+
:parent_folder_arn,
|
2100
|
+
:permissions,
|
2101
|
+
:tags)
|
2102
|
+
SENSITIVE = []
|
2103
|
+
include Aws::Structure
|
2104
|
+
end
|
2105
|
+
|
2106
|
+
# @!attribute [rw] status
|
2107
|
+
# The status of the newly created folder. If succeeded, the status is
|
2108
|
+
# `SC_OK (200)`.
|
2109
|
+
# @return [Integer]
|
2110
|
+
#
|
2111
|
+
# @!attribute [rw] arn
|
2112
|
+
# The Amazon Resource Name (ARN) for the newly created folder.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] folder_id
|
2116
|
+
# The folder ID for the newly created folder.
|
2117
|
+
# @return [String]
|
2118
|
+
#
|
2119
|
+
# @!attribute [rw] request_id
|
2120
|
+
# The request ID for the newly created folder.
|
2121
|
+
# @return [String]
|
2122
|
+
#
|
2123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderResponse AWS API Documentation
|
2124
|
+
#
|
2125
|
+
class CreateFolderResponse < Struct.new(
|
2126
|
+
:status,
|
2127
|
+
:arn,
|
2128
|
+
:folder_id,
|
2129
|
+
:request_id)
|
2130
|
+
SENSITIVE = []
|
2131
|
+
include Aws::Structure
|
2132
|
+
end
|
2133
|
+
|
1898
2134
|
# @note When making an API call, you may pass CreateGroupMembershipRequest
|
1899
2135
|
# data as a hash:
|
1900
2136
|
#
|
@@ -1914,9 +2150,9 @@ module Aws::QuickSight
|
|
1914
2150
|
# @return [String]
|
1915
2151
|
#
|
1916
2152
|
# @!attribute [rw] aws_account_id
|
1917
|
-
# The ID for the
|
1918
|
-
# the ID for the
|
1919
|
-
# account.
|
2153
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
2154
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2155
|
+
# contains your Amazon QuickSight account.
|
1920
2156
|
# @return [String]
|
1921
2157
|
#
|
1922
2158
|
# @!attribute [rw] namespace
|
@@ -1939,7 +2175,7 @@ module Aws::QuickSight
|
|
1939
2175
|
# @return [Types::GroupMember]
|
1940
2176
|
#
|
1941
2177
|
# @!attribute [rw] request_id
|
1942
|
-
# The
|
2178
|
+
# The Amazon Web Services request ID for this operation.
|
1943
2179
|
# @return [String]
|
1944
2180
|
#
|
1945
2181
|
# @!attribute [rw] status
|
@@ -1977,9 +2213,9 @@ module Aws::QuickSight
|
|
1977
2213
|
# @return [String]
|
1978
2214
|
#
|
1979
2215
|
# @!attribute [rw] aws_account_id
|
1980
|
-
# The ID for the
|
1981
|
-
# the ID for the
|
1982
|
-
# account.
|
2216
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
2217
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2218
|
+
# contains your Amazon QuickSight account.
|
1983
2219
|
# @return [String]
|
1984
2220
|
#
|
1985
2221
|
# @!attribute [rw] namespace
|
@@ -2004,7 +2240,7 @@ module Aws::QuickSight
|
|
2004
2240
|
# @return [Types::Group]
|
2005
2241
|
#
|
2006
2242
|
# @!attribute [rw] request_id
|
2007
|
-
# The
|
2243
|
+
# The Amazon Web Services request ID for this operation.
|
2008
2244
|
# @return [String]
|
2009
2245
|
#
|
2010
2246
|
# @!attribute [rw] status
|
@@ -2036,13 +2272,13 @@ module Aws::QuickSight
|
|
2036
2272
|
# }
|
2037
2273
|
#
|
2038
2274
|
# @!attribute [rw] aws_account_id
|
2039
|
-
# The ID of the
|
2040
|
-
# QuickSight users or groups.
|
2275
|
+
# The ID of the Amazon Web Services account; where you want to assign
|
2276
|
+
# an IAM policy to QuickSight users or groups.
|
2041
2277
|
# @return [String]
|
2042
2278
|
#
|
2043
2279
|
# @!attribute [rw] assignment_name
|
2044
2280
|
# The name of the assignment, also called a rule. It must be unique
|
2045
|
-
# within an
|
2281
|
+
# within an Amazon Web Services account;.
|
2046
2282
|
# @return [String]
|
2047
2283
|
#
|
2048
2284
|
# @!attribute [rw] assignment_status
|
@@ -2086,8 +2322,8 @@ module Aws::QuickSight
|
|
2086
2322
|
end
|
2087
2323
|
|
2088
2324
|
# @!attribute [rw] assignment_name
|
2089
|
-
# The name of the assignment. This name must be unique within the
|
2090
|
-
# account
|
2325
|
+
# The name of the assignment. This name must be unique within the
|
2326
|
+
# Amazon Web Services account;.
|
2091
2327
|
# @return [String]
|
2092
2328
|
#
|
2093
2329
|
# @!attribute [rw] assignment_id
|
@@ -2118,7 +2354,7 @@ module Aws::QuickSight
|
|
2118
2354
|
# @return [Hash<String,Array<String>>]
|
2119
2355
|
#
|
2120
2356
|
# @!attribute [rw] request_id
|
2121
|
-
# The
|
2357
|
+
# The Amazon Web Services request ID for this operation.
|
2122
2358
|
# @return [String]
|
2123
2359
|
#
|
2124
2360
|
# @!attribute [rw] status
|
@@ -2157,7 +2393,7 @@ module Aws::QuickSight
|
|
2157
2393
|
# @return [String]
|
2158
2394
|
#
|
2159
2395
|
# @!attribute [rw] aws_account_id
|
2160
|
-
# The
|
2396
|
+
# The Amazon Web Services account; ID.
|
2161
2397
|
# @return [String]
|
2162
2398
|
#
|
2163
2399
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
@@ -2183,7 +2419,7 @@ module Aws::QuickSight
|
|
2183
2419
|
# @return [String]
|
2184
2420
|
#
|
2185
2421
|
# @!attribute [rw] request_id
|
2186
|
-
# The
|
2422
|
+
# The Amazon Web Services request ID for this operation.
|
2187
2423
|
# @return [String]
|
2188
2424
|
#
|
2189
2425
|
# @!attribute [rw] status
|
@@ -2218,8 +2454,8 @@ module Aws::QuickSight
|
|
2218
2454
|
# }
|
2219
2455
|
#
|
2220
2456
|
# @!attribute [rw] aws_account_id
|
2221
|
-
# The ID for the
|
2222
|
-
# namespace in.
|
2457
|
+
# The ID for the Amazon Web Services account; that you want to create
|
2458
|
+
# the QuickSight namespace in.
|
2223
2459
|
# @return [String]
|
2224
2460
|
#
|
2225
2461
|
# @!attribute [rw] namespace
|
@@ -2256,8 +2492,8 @@ module Aws::QuickSight
|
|
2256
2492
|
# @return [String]
|
2257
2493
|
#
|
2258
2494
|
# @!attribute [rw] capacity_region
|
2259
|
-
# The
|
2260
|
-
#
|
2495
|
+
# The Region; that you want to use for the free SPICE capacity for the
|
2496
|
+
# new namespace. This is set to the region that you run
|
2261
2497
|
# CreateNamespace in.
|
2262
2498
|
# @return [String]
|
2263
2499
|
#
|
@@ -2275,7 +2511,7 @@ module Aws::QuickSight
|
|
2275
2511
|
# @return [String]
|
2276
2512
|
#
|
2277
2513
|
# @!attribute [rw] request_id
|
2278
|
-
# The
|
2514
|
+
# The Amazon Web Services request ID for this operation.
|
2279
2515
|
# @return [String]
|
2280
2516
|
#
|
2281
2517
|
# @!attribute [rw] status
|
@@ -2307,8 +2543,8 @@ module Aws::QuickSight
|
|
2307
2543
|
# }
|
2308
2544
|
#
|
2309
2545
|
# @!attribute [rw] aws_account_id
|
2310
|
-
# The ID of the
|
2311
|
-
# creating an alias for.
|
2546
|
+
# The ID of the Amazon Web Services account; that contains the
|
2547
|
+
# template that you creating an alias for.
|
2312
2548
|
# @return [String]
|
2313
2549
|
#
|
2314
2550
|
# @!attribute [rw] template_id
|
@@ -2318,7 +2554,7 @@ module Aws::QuickSight
|
|
2318
2554
|
# @!attribute [rw] alias_name
|
2319
2555
|
# The name that you want to give to the template alias that you're
|
2320
2556
|
# creating. Don't start the alias name with the `$` character. Alias
|
2321
|
-
# names that start with `$` are reserved by QuickSight.
|
2557
|
+
# names that start with `$` are reserved by Amazon QuickSight.
|
2322
2558
|
# @return [String]
|
2323
2559
|
#
|
2324
2560
|
# @!attribute [rw] template_version_number
|
@@ -2345,7 +2581,7 @@ module Aws::QuickSight
|
|
2345
2581
|
# @return [Integer]
|
2346
2582
|
#
|
2347
2583
|
# @!attribute [rw] request_id
|
2348
|
-
# The
|
2584
|
+
# The Amazon Web Services request ID for this operation.
|
2349
2585
|
# @return [String]
|
2350
2586
|
#
|
2351
2587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateAliasResponse AWS API Documentation
|
@@ -2395,14 +2631,14 @@ module Aws::QuickSight
|
|
2395
2631
|
# }
|
2396
2632
|
#
|
2397
2633
|
# @!attribute [rw] aws_account_id
|
2398
|
-
# The ID for the
|
2399
|
-
# the ID for the
|
2400
|
-
# account.
|
2634
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
2635
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2636
|
+
# contains your Amazon QuickSight account.
|
2401
2637
|
# @return [String]
|
2402
2638
|
#
|
2403
2639
|
# @!attribute [rw] template_id
|
2404
2640
|
# An ID for the template that you want to create. This template is
|
2405
|
-
# unique per
|
2641
|
+
# unique per Region; in each Amazon Web Services account;.
|
2406
2642
|
# @return [String]
|
2407
2643
|
#
|
2408
2644
|
# @!attribute [rw] name
|
@@ -2420,8 +2656,8 @@ module Aws::QuickSight
|
|
2420
2656
|
# for an analysis. Both of these require an Amazon Resource Name
|
2421
2657
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2422
2658
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2423
|
-
# `SourceTemplate` ARN can contain any
|
2424
|
-
# QuickSight-supported
|
2659
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account;
|
2660
|
+
# and any QuickSight-supported Region;.
|
2425
2661
|
#
|
2426
2662
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2427
2663
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -2478,7 +2714,7 @@ module Aws::QuickSight
|
|
2478
2714
|
# @return [Integer]
|
2479
2715
|
#
|
2480
2716
|
# @!attribute [rw] request_id
|
2481
|
-
# The
|
2717
|
+
# The Amazon Web Services request ID for this operation.
|
2482
2718
|
# @return [String]
|
2483
2719
|
#
|
2484
2720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateResponse AWS API Documentation
|
@@ -2505,8 +2741,8 @@ module Aws::QuickSight
|
|
2505
2741
|
# }
|
2506
2742
|
#
|
2507
2743
|
# @!attribute [rw] aws_account_id
|
2508
|
-
# The ID of the
|
2509
|
-
# alias.
|
2744
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
2745
|
+
# for the new theme alias.
|
2510
2746
|
# @return [String]
|
2511
2747
|
#
|
2512
2748
|
# @!attribute [rw] theme_id
|
@@ -2543,7 +2779,7 @@ module Aws::QuickSight
|
|
2543
2779
|
# @return [Integer]
|
2544
2780
|
#
|
2545
2781
|
# @!attribute [rw] request_id
|
2546
|
-
# The
|
2782
|
+
# The Amazon Web Services request ID for this operation.
|
2547
2783
|
# @return [String]
|
2548
2784
|
#
|
2549
2785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAliasResponse AWS API Documentation
|
@@ -2620,12 +2856,13 @@ module Aws::QuickSight
|
|
2620
2856
|
# }
|
2621
2857
|
#
|
2622
2858
|
# @!attribute [rw] aws_account_id
|
2623
|
-
# The ID of the
|
2859
|
+
# The ID of the Amazon Web Services account; where you want to store
|
2860
|
+
# the new theme.
|
2624
2861
|
# @return [String]
|
2625
2862
|
#
|
2626
2863
|
# @!attribute [rw] theme_id
|
2627
2864
|
# An ID for the theme that you want to create. The theme ID is unique
|
2628
|
-
# per
|
2865
|
+
# per Region; in each Amazon Web Services account;.
|
2629
2866
|
# @return [String]
|
2630
2867
|
#
|
2631
2868
|
# @!attribute [rw] name
|
@@ -2696,7 +2933,7 @@ module Aws::QuickSight
|
|
2696
2933
|
# @return [Integer]
|
2697
2934
|
#
|
2698
2935
|
# @!attribute [rw] request_id
|
2699
|
-
# The
|
2936
|
+
# The Amazon Web Services request ID for this operation.
|
2700
2937
|
# @return [String]
|
2701
2938
|
#
|
2702
2939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeResponse AWS API Documentation
|
@@ -3334,6 +3571,10 @@ module Aws::QuickSight
|
|
3334
3571
|
# The row-level security configuration for the dataset.
|
3335
3572
|
# @return [Types::RowLevelPermissionDataSet]
|
3336
3573
|
#
|
3574
|
+
# @!attribute [rw] row_level_permission_tag_configuration
|
3575
|
+
# The element you can use to define tags for row-level security.
|
3576
|
+
# @return [Types::RowLevelPermissionTagConfiguration]
|
3577
|
+
#
|
3337
3578
|
# @!attribute [rw] column_level_permission_rules
|
3338
3579
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3339
3580
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
@@ -3354,6 +3595,7 @@ module Aws::QuickSight
|
|
3354
3595
|
:column_groups,
|
3355
3596
|
:field_folders,
|
3356
3597
|
:row_level_permission_data_set,
|
3598
|
+
:row_level_permission_tag_configuration,
|
3357
3599
|
:column_level_permission_rules)
|
3358
3600
|
SENSITIVE = []
|
3359
3601
|
include Aws::Structure
|
@@ -3455,6 +3697,10 @@ module Aws::QuickSight
|
|
3455
3697
|
# The row-level security configuration for the dataset.
|
3456
3698
|
# @return [Types::RowLevelPermissionDataSet]
|
3457
3699
|
#
|
3700
|
+
# @!attribute [rw] row_level_permission_tag_configuration_applied
|
3701
|
+
# Whether or not the row level permission tags are applied.
|
3702
|
+
# @return [Boolean]
|
3703
|
+
#
|
3458
3704
|
# @!attribute [rw] column_level_permission_rules_applied
|
3459
3705
|
# A value that indicates if the dataset has column level permission
|
3460
3706
|
# configured.
|
@@ -3470,6 +3716,7 @@ module Aws::QuickSight
|
|
3470
3716
|
:last_updated_time,
|
3471
3717
|
:import_mode,
|
3472
3718
|
:row_level_permission_data_set,
|
3719
|
+
:row_level_permission_tag_configuration_applied,
|
3473
3720
|
:column_level_permission_rules_applied)
|
3474
3721
|
SENSITIVE = []
|
3475
3722
|
include Aws::Structure
|
@@ -3482,8 +3729,8 @@ module Aws::QuickSight
|
|
3482
3729
|
# @return [String]
|
3483
3730
|
#
|
3484
3731
|
# @!attribute [rw] data_source_id
|
3485
|
-
# The ID of the data source. This ID is unique per
|
3486
|
-
#
|
3732
|
+
# The ID of the data source. This ID is unique per Region; for each
|
3733
|
+
# Amazon Web Services account;.
|
3487
3734
|
# @return [String]
|
3488
3735
|
#
|
3489
3736
|
# @!attribute [rw] name
|
@@ -3824,7 +4071,7 @@ module Aws::QuickSight
|
|
3824
4071
|
# @return [Types::AuroraPostgreSqlParameters]
|
3825
4072
|
#
|
3826
4073
|
# @!attribute [rw] aws_iot_analytics_parameters
|
3827
|
-
#
|
4074
|
+
# Amazon Web Services IoT Analytics parameters.
|
3828
4075
|
# @return [Types::AwsIotAnalyticsParameters]
|
3829
4076
|
#
|
3830
4077
|
# @!attribute [rw] jira_parameters
|
@@ -3977,8 +4224,8 @@ module Aws::QuickSight
|
|
3977
4224
|
# }
|
3978
4225
|
#
|
3979
4226
|
# @!attribute [rw] aws_account_id
|
3980
|
-
# The ID for the
|
3981
|
-
# customizations from in this
|
4227
|
+
# The ID for the Amazon Web Services account; that you want to delete
|
4228
|
+
# QuickSight customizations from in this Region;.
|
3982
4229
|
# @return [String]
|
3983
4230
|
#
|
3984
4231
|
# @!attribute [rw] namespace
|
@@ -3996,7 +4243,7 @@ module Aws::QuickSight
|
|
3996
4243
|
end
|
3997
4244
|
|
3998
4245
|
# @!attribute [rw] request_id
|
3999
|
-
# The
|
4246
|
+
# The Amazon Web Services request ID for this operation.
|
4000
4247
|
# @return [String]
|
4001
4248
|
#
|
4002
4249
|
# @!attribute [rw] status
|
@@ -4023,7 +4270,8 @@ module Aws::QuickSight
|
|
4023
4270
|
# }
|
4024
4271
|
#
|
4025
4272
|
# @!attribute [rw] aws_account_id
|
4026
|
-
# The ID of the
|
4273
|
+
# The ID of the Amazon Web Services account; where you want to delete
|
4274
|
+
# an analysis.
|
4027
4275
|
# @return [String]
|
4028
4276
|
#
|
4029
4277
|
# @!attribute [rw] analysis_id
|
@@ -4072,7 +4320,7 @@ module Aws::QuickSight
|
|
4072
4320
|
# @return [Time]
|
4073
4321
|
#
|
4074
4322
|
# @!attribute [rw] request_id
|
4075
|
-
# The
|
4323
|
+
# The Amazon Web Services request ID for this operation.
|
4076
4324
|
# @return [String]
|
4077
4325
|
#
|
4078
4326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisResponse AWS API Documentation
|
@@ -4097,8 +4345,8 @@ module Aws::QuickSight
|
|
4097
4345
|
# }
|
4098
4346
|
#
|
4099
4347
|
# @!attribute [rw] aws_account_id
|
4100
|
-
# The ID of the
|
4101
|
-
# deleting.
|
4348
|
+
# The ID of the Amazon Web Services account; that contains the
|
4349
|
+
# dashboard that you're deleting.
|
4102
4350
|
# @return [String]
|
4103
4351
|
#
|
4104
4352
|
# @!attribute [rw] dashboard_id
|
@@ -4134,7 +4382,7 @@ module Aws::QuickSight
|
|
4134
4382
|
# @return [String]
|
4135
4383
|
#
|
4136
4384
|
# @!attribute [rw] request_id
|
4137
|
-
# The
|
4385
|
+
# The Amazon Web Services request ID for this operation.
|
4138
4386
|
# @return [String]
|
4139
4387
|
#
|
4140
4388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboardResponse AWS API Documentation
|
@@ -4157,12 +4405,12 @@ module Aws::QuickSight
|
|
4157
4405
|
# }
|
4158
4406
|
#
|
4159
4407
|
# @!attribute [rw] aws_account_id
|
4160
|
-
# The
|
4408
|
+
# The Amazon Web Services account; ID.
|
4161
4409
|
# @return [String]
|
4162
4410
|
#
|
4163
4411
|
# @!attribute [rw] data_set_id
|
4164
4412
|
# The ID for the dataset that you want to create. This ID is unique
|
4165
|
-
# per
|
4413
|
+
# per Region; for each Amazon Web Services account;.
|
4166
4414
|
# @return [String]
|
4167
4415
|
#
|
4168
4416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4180,11 +4428,11 @@ module Aws::QuickSight
|
|
4180
4428
|
#
|
4181
4429
|
# @!attribute [rw] data_set_id
|
4182
4430
|
# The ID for the dataset that you want to create. This ID is unique
|
4183
|
-
# per
|
4431
|
+
# per Region; for each Amazon Web Services account;.
|
4184
4432
|
# @return [String]
|
4185
4433
|
#
|
4186
4434
|
# @!attribute [rw] request_id
|
4187
|
-
# The
|
4435
|
+
# The Amazon Web Services request ID for this operation.
|
4188
4436
|
# @return [String]
|
4189
4437
|
#
|
4190
4438
|
# @!attribute [rw] status
|
@@ -4211,12 +4459,12 @@ module Aws::QuickSight
|
|
4211
4459
|
# }
|
4212
4460
|
#
|
4213
4461
|
# @!attribute [rw] aws_account_id
|
4214
|
-
# The
|
4462
|
+
# The Amazon Web Services account; ID.
|
4215
4463
|
# @return [String]
|
4216
4464
|
#
|
4217
4465
|
# @!attribute [rw] data_source_id
|
4218
|
-
# The ID of the data source. This ID is unique per
|
4219
|
-
#
|
4466
|
+
# The ID of the data source. This ID is unique per Region; for each
|
4467
|
+
# Amazon Web Services account;.
|
4220
4468
|
# @return [String]
|
4221
4469
|
#
|
4222
4470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4233,12 +4481,12 @@ module Aws::QuickSight
|
|
4233
4481
|
# @return [String]
|
4234
4482
|
#
|
4235
4483
|
# @!attribute [rw] data_source_id
|
4236
|
-
# The ID of the data source. This ID is unique per
|
4237
|
-
#
|
4484
|
+
# The ID of the data source. This ID is unique per Region; for each
|
4485
|
+
# Amazon Web Services account;.
|
4238
4486
|
# @return [String]
|
4239
4487
|
#
|
4240
4488
|
# @!attribute [rw] request_id
|
4241
|
-
# The
|
4489
|
+
# The Amazon Web Services request ID for this operation.
|
4242
4490
|
# @return [String]
|
4243
4491
|
#
|
4244
4492
|
# @!attribute [rw] status
|
@@ -4256,6 +4504,116 @@ module Aws::QuickSight
|
|
4256
4504
|
include Aws::Structure
|
4257
4505
|
end
|
4258
4506
|
|
4507
|
+
# @note When making an API call, you may pass DeleteFolderMembershipRequest
|
4508
|
+
# data as a hash:
|
4509
|
+
#
|
4510
|
+
# {
|
4511
|
+
# aws_account_id: "AwsAccountId", # required
|
4512
|
+
# folder_id: "RestrictiveResourceId", # required
|
4513
|
+
# member_id: "RestrictiveResourceId", # required
|
4514
|
+
# member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
|
4515
|
+
# }
|
4516
|
+
#
|
4517
|
+
# @!attribute [rw] aws_account_id
|
4518
|
+
# The AWS Account ID.
|
4519
|
+
# @return [String]
|
4520
|
+
#
|
4521
|
+
# @!attribute [rw] folder_id
|
4522
|
+
# The Folder ID.
|
4523
|
+
# @return [String]
|
4524
|
+
#
|
4525
|
+
# @!attribute [rw] member_id
|
4526
|
+
# The ID of the asset (the dashboard, analysis, or dataset) that you
|
4527
|
+
# want to delete.
|
4528
|
+
# @return [String]
|
4529
|
+
#
|
4530
|
+
# @!attribute [rw] member_type
|
4531
|
+
# The type of the member, including `DASHBOARD`, `ANALYSIS`, and
|
4532
|
+
# `DATASET`
|
4533
|
+
# @return [String]
|
4534
|
+
#
|
4535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembershipRequest AWS API Documentation
|
4536
|
+
#
|
4537
|
+
class DeleteFolderMembershipRequest < Struct.new(
|
4538
|
+
:aws_account_id,
|
4539
|
+
:folder_id,
|
4540
|
+
:member_id,
|
4541
|
+
:member_type)
|
4542
|
+
SENSITIVE = []
|
4543
|
+
include Aws::Structure
|
4544
|
+
end
|
4545
|
+
|
4546
|
+
# @!attribute [rw] status
|
4547
|
+
# The status of deleting the asset. If succeeded, the status is `SC_OK
|
4548
|
+
# (200)`.
|
4549
|
+
# @return [Integer]
|
4550
|
+
#
|
4551
|
+
# @!attribute [rw] request_id
|
4552
|
+
# The request ID.
|
4553
|
+
# @return [String]
|
4554
|
+
#
|
4555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembershipResponse AWS API Documentation
|
4556
|
+
#
|
4557
|
+
class DeleteFolderMembershipResponse < Struct.new(
|
4558
|
+
:status,
|
4559
|
+
:request_id)
|
4560
|
+
SENSITIVE = []
|
4561
|
+
include Aws::Structure
|
4562
|
+
end
|
4563
|
+
|
4564
|
+
# @note When making an API call, you may pass DeleteFolderRequest
|
4565
|
+
# data as a hash:
|
4566
|
+
#
|
4567
|
+
# {
|
4568
|
+
# aws_account_id: "AwsAccountId", # required
|
4569
|
+
# folder_id: "RestrictiveResourceId", # required
|
4570
|
+
# }
|
4571
|
+
#
|
4572
|
+
# @!attribute [rw] aws_account_id
|
4573
|
+
# The AWS Account ID for the folder.
|
4574
|
+
# @return [String]
|
4575
|
+
#
|
4576
|
+
# @!attribute [rw] folder_id
|
4577
|
+
# The folder ID.
|
4578
|
+
# @return [String]
|
4579
|
+
#
|
4580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderRequest AWS API Documentation
|
4581
|
+
#
|
4582
|
+
class DeleteFolderRequest < Struct.new(
|
4583
|
+
:aws_account_id,
|
4584
|
+
:folder_id)
|
4585
|
+
SENSITIVE = []
|
4586
|
+
include Aws::Structure
|
4587
|
+
end
|
4588
|
+
|
4589
|
+
# @!attribute [rw] status
|
4590
|
+
# The status of deleting the folder. If succeeded, the status is
|
4591
|
+
# `SC_OK (200)`.
|
4592
|
+
# @return [Integer]
|
4593
|
+
#
|
4594
|
+
# @!attribute [rw] arn
|
4595
|
+
# The Amazon Resource Name of the deleted folder.
|
4596
|
+
# @return [String]
|
4597
|
+
#
|
4598
|
+
# @!attribute [rw] folder_id
|
4599
|
+
# The folder ID.
|
4600
|
+
# @return [String]
|
4601
|
+
#
|
4602
|
+
# @!attribute [rw] request_id
|
4603
|
+
# The request ID.
|
4604
|
+
# @return [String]
|
4605
|
+
#
|
4606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderResponse AWS API Documentation
|
4607
|
+
#
|
4608
|
+
class DeleteFolderResponse < Struct.new(
|
4609
|
+
:status,
|
4610
|
+
:arn,
|
4611
|
+
:folder_id,
|
4612
|
+
:request_id)
|
4613
|
+
SENSITIVE = []
|
4614
|
+
include Aws::Structure
|
4615
|
+
end
|
4616
|
+
|
4259
4617
|
# @note When making an API call, you may pass DeleteGroupMembershipRequest
|
4260
4618
|
# data as a hash:
|
4261
4619
|
#
|
@@ -4276,9 +4634,9 @@ module Aws::QuickSight
|
|
4276
4634
|
# @return [String]
|
4277
4635
|
#
|
4278
4636
|
# @!attribute [rw] aws_account_id
|
4279
|
-
# The ID for the
|
4280
|
-
# the ID for the
|
4281
|
-
# account.
|
4637
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
4638
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
4639
|
+
# contains your Amazon QuickSight account.
|
4282
4640
|
# @return [String]
|
4283
4641
|
#
|
4284
4642
|
# @!attribute [rw] namespace
|
@@ -4297,7 +4655,7 @@ module Aws::QuickSight
|
|
4297
4655
|
end
|
4298
4656
|
|
4299
4657
|
# @!attribute [rw] request_id
|
4300
|
-
# The
|
4658
|
+
# The Amazon Web Services request ID for this operation.
|
4301
4659
|
# @return [String]
|
4302
4660
|
#
|
4303
4661
|
# @!attribute [rw] status
|
@@ -4327,9 +4685,9 @@ module Aws::QuickSight
|
|
4327
4685
|
# @return [String]
|
4328
4686
|
#
|
4329
4687
|
# @!attribute [rw] aws_account_id
|
4330
|
-
# The ID for the
|
4331
|
-
# the ID for the
|
4332
|
-
# account.
|
4688
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
4689
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
4690
|
+
# contains your Amazon QuickSight account.
|
4333
4691
|
# @return [String]
|
4334
4692
|
#
|
4335
4693
|
# @!attribute [rw] namespace
|
@@ -4347,7 +4705,7 @@ module Aws::QuickSight
|
|
4347
4705
|
end
|
4348
4706
|
|
4349
4707
|
# @!attribute [rw] request_id
|
4350
|
-
# The
|
4708
|
+
# The Amazon Web Services request ID for this operation.
|
4351
4709
|
# @return [String]
|
4352
4710
|
#
|
4353
4711
|
# @!attribute [rw] status
|
@@ -4373,8 +4731,8 @@ module Aws::QuickSight
|
|
4373
4731
|
# }
|
4374
4732
|
#
|
4375
4733
|
# @!attribute [rw] aws_account_id
|
4376
|
-
# The
|
4377
|
-
# assignment.
|
4734
|
+
# The Amazon Web Services account; ID where you want to delete the IAM
|
4735
|
+
# policy assignment.
|
4378
4736
|
# @return [String]
|
4379
4737
|
#
|
4380
4738
|
# @!attribute [rw] assignment_name
|
@@ -4400,7 +4758,7 @@ module Aws::QuickSight
|
|
4400
4758
|
# @return [String]
|
4401
4759
|
#
|
4402
4760
|
# @!attribute [rw] request_id
|
4403
|
-
# The
|
4761
|
+
# The Amazon Web Services request ID for this operation.
|
4404
4762
|
# @return [String]
|
4405
4763
|
#
|
4406
4764
|
# @!attribute [rw] status
|
@@ -4426,8 +4784,8 @@ module Aws::QuickSight
|
|
4426
4784
|
# }
|
4427
4785
|
#
|
4428
4786
|
# @!attribute [rw] aws_account_id
|
4429
|
-
# The ID for the
|
4430
|
-
# namespace from.
|
4787
|
+
# The ID for the Amazon Web Services account; that you want to delete
|
4788
|
+
# the QuickSight namespace from.
|
4431
4789
|
# @return [String]
|
4432
4790
|
#
|
4433
4791
|
# @!attribute [rw] namespace
|
@@ -4444,7 +4802,7 @@ module Aws::QuickSight
|
|
4444
4802
|
end
|
4445
4803
|
|
4446
4804
|
# @!attribute [rw] request_id
|
4447
|
-
# The
|
4805
|
+
# The Amazon Web Services request ID for this operation.
|
4448
4806
|
# @return [String]
|
4449
4807
|
#
|
4450
4808
|
# @!attribute [rw] status
|
@@ -4470,7 +4828,8 @@ module Aws::QuickSight
|
|
4470
4828
|
# }
|
4471
4829
|
#
|
4472
4830
|
# @!attribute [rw] aws_account_id
|
4473
|
-
# The ID of the
|
4831
|
+
# The ID of the Amazon Web Services account; that contains the item to
|
4832
|
+
# delete.
|
4474
4833
|
# @return [String]
|
4475
4834
|
#
|
4476
4835
|
# @!attribute [rw] template_id
|
@@ -4511,7 +4870,7 @@ module Aws::QuickSight
|
|
4511
4870
|
# @return [String]
|
4512
4871
|
#
|
4513
4872
|
# @!attribute [rw] request_id
|
4514
|
-
# The
|
4873
|
+
# The Amazon Web Services request ID for this operation.
|
4515
4874
|
# @return [String]
|
4516
4875
|
#
|
4517
4876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplateAliasResponse AWS API Documentation
|
@@ -4536,8 +4895,8 @@ module Aws::QuickSight
|
|
4536
4895
|
# }
|
4537
4896
|
#
|
4538
4897
|
# @!attribute [rw] aws_account_id
|
4539
|
-
# The ID of the
|
4540
|
-
# deleting.
|
4898
|
+
# The ID of the Amazon Web Services account; that contains the
|
4899
|
+
# template that you're deleting.
|
4541
4900
|
# @return [String]
|
4542
4901
|
#
|
4543
4902
|
# @!attribute [rw] template_id
|
@@ -4561,7 +4920,7 @@ module Aws::QuickSight
|
|
4561
4920
|
end
|
4562
4921
|
|
4563
4922
|
# @!attribute [rw] request_id
|
4564
|
-
# The
|
4923
|
+
# The Amazon Web Services request ID for this operation.
|
4565
4924
|
# @return [String]
|
4566
4925
|
#
|
4567
4926
|
# @!attribute [rw] arn
|
@@ -4597,7 +4956,8 @@ module Aws::QuickSight
|
|
4597
4956
|
# }
|
4598
4957
|
#
|
4599
4958
|
# @!attribute [rw] aws_account_id
|
4600
|
-
# The ID of the
|
4959
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
4960
|
+
# alias to delete.
|
4601
4961
|
# @return [String]
|
4602
4962
|
#
|
4603
4963
|
# @!attribute [rw] theme_id
|
@@ -4628,7 +4988,7 @@ module Aws::QuickSight
|
|
4628
4988
|
# @return [String]
|
4629
4989
|
#
|
4630
4990
|
# @!attribute [rw] request_id
|
4631
|
-
# The
|
4991
|
+
# The Amazon Web Services request ID for this operation.
|
4632
4992
|
# @return [String]
|
4633
4993
|
#
|
4634
4994
|
# @!attribute [rw] status
|
@@ -4661,8 +5021,8 @@ module Aws::QuickSight
|
|
4661
5021
|
# }
|
4662
5022
|
#
|
4663
5023
|
# @!attribute [rw] aws_account_id
|
4664
|
-
# The ID of the
|
4665
|
-
# deleting.
|
5024
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
5025
|
+
# that you're deleting.
|
4666
5026
|
# @return [String]
|
4667
5027
|
#
|
4668
5028
|
# @!attribute [rw] theme_id
|
@@ -4691,7 +5051,7 @@ module Aws::QuickSight
|
|
4691
5051
|
# @return [String]
|
4692
5052
|
#
|
4693
5053
|
# @!attribute [rw] request_id
|
4694
|
-
# The
|
5054
|
+
# The Amazon Web Services request ID for this operation.
|
4695
5055
|
# @return [String]
|
4696
5056
|
#
|
4697
5057
|
# @!attribute [rw] status
|
@@ -4727,9 +5087,9 @@ module Aws::QuickSight
|
|
4727
5087
|
# @return [String]
|
4728
5088
|
#
|
4729
5089
|
# @!attribute [rw] aws_account_id
|
4730
|
-
# The ID for the
|
4731
|
-
# the ID for the
|
4732
|
-
# account.
|
5090
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
5091
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
5092
|
+
# contains your Amazon QuickSight account.
|
4733
5093
|
# @return [String]
|
4734
5094
|
#
|
4735
5095
|
# @!attribute [rw] namespace
|
@@ -4747,7 +5107,7 @@ module Aws::QuickSight
|
|
4747
5107
|
end
|
4748
5108
|
|
4749
5109
|
# @!attribute [rw] request_id
|
4750
|
-
# The
|
5110
|
+
# The Amazon Web Services request ID for this operation.
|
4751
5111
|
# @return [String]
|
4752
5112
|
#
|
4753
5113
|
# @!attribute [rw] status
|
@@ -4777,9 +5137,9 @@ module Aws::QuickSight
|
|
4777
5137
|
# @return [String]
|
4778
5138
|
#
|
4779
5139
|
# @!attribute [rw] aws_account_id
|
4780
|
-
# The ID for the
|
4781
|
-
# the ID for the
|
4782
|
-
# account.
|
5140
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
5141
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
5142
|
+
# contains your Amazon QuickSight account.
|
4783
5143
|
# @return [String]
|
4784
5144
|
#
|
4785
5145
|
# @!attribute [rw] namespace
|
@@ -4797,7 +5157,7 @@ module Aws::QuickSight
|
|
4797
5157
|
end
|
4798
5158
|
|
4799
5159
|
# @!attribute [rw] request_id
|
4800
|
-
# The
|
5160
|
+
# The Amazon Web Services request ID for this operation.
|
4801
5161
|
# @return [String]
|
4802
5162
|
#
|
4803
5163
|
# @!attribute [rw] status
|
@@ -4823,8 +5183,8 @@ module Aws::QuickSight
|
|
4823
5183
|
# }
|
4824
5184
|
#
|
4825
5185
|
# @!attribute [rw] aws_account_id
|
4826
|
-
# The ID for the
|
4827
|
-
# customizations for.
|
5186
|
+
# The ID for the Amazon Web Services account; that you want to
|
5187
|
+
# describe QuickSight customizations for.
|
4828
5188
|
# @return [String]
|
4829
5189
|
#
|
4830
5190
|
# @!attribute [rw] namespace
|
@@ -4853,11 +5213,11 @@ module Aws::QuickSight
|
|
4853
5213
|
|
4854
5214
|
# @!attribute [rw] arn
|
4855
5215
|
# The Amazon Resource Name (ARN) of the customization that's
|
4856
|
-
# associated with this
|
5216
|
+
# associated with this Amazon Web Services account;.
|
4857
5217
|
# @return [String]
|
4858
5218
|
#
|
4859
5219
|
# @!attribute [rw] aws_account_id
|
4860
|
-
# The ID for the
|
5220
|
+
# The ID for the Amazon Web Services account; that you're describing.
|
4861
5221
|
# @return [String]
|
4862
5222
|
#
|
4863
5223
|
# @!attribute [rw] namespace
|
@@ -4865,11 +5225,11 @@ module Aws::QuickSight
|
|
4865
5225
|
# @return [String]
|
4866
5226
|
#
|
4867
5227
|
# @!attribute [rw] account_customization
|
4868
|
-
# The QuickSight customizations that exist in the current
|
5228
|
+
# The QuickSight customizations that exist in the current Region;.
|
4869
5229
|
# @return [Types::AccountCustomization]
|
4870
5230
|
#
|
4871
5231
|
# @!attribute [rw] request_id
|
4872
|
-
# The
|
5232
|
+
# The Amazon Web Services request ID for this operation.
|
4873
5233
|
# @return [String]
|
4874
5234
|
#
|
4875
5235
|
# @!attribute [rw] status
|
@@ -4897,8 +5257,8 @@ module Aws::QuickSight
|
|
4897
5257
|
# }
|
4898
5258
|
#
|
4899
5259
|
# @!attribute [rw] aws_account_id
|
4900
|
-
# The ID for the
|
4901
|
-
# to list.
|
5260
|
+
# The ID for the Amazon Web Services account; that contains the
|
5261
|
+
# settings that you want to list.
|
4902
5262
|
# @return [String]
|
4903
5263
|
#
|
4904
5264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsRequest AWS API Documentation
|
@@ -4910,19 +5270,19 @@ module Aws::QuickSight
|
|
4910
5270
|
end
|
4911
5271
|
|
4912
5272
|
# @!attribute [rw] account_settings
|
4913
|
-
# The QuickSight settings for this
|
4914
|
-
# includes the edition of Amazon QuickSight that you
|
4915
|
-
# (Standard or Enterprise) and the notification email
|
4916
|
-
# QuickSight subscription. In the QuickSight console, the
|
4917
|
-
# subscription is sometimes referred to as a QuickSight
|
4918
|
-
# even though it's technically not an account by itself.
|
4919
|
-
# it's a subscription to the QuickSight service for your
|
4920
|
-
# The edition that you subscribe to
|
4921
|
-
# Region where you use it.
|
5273
|
+
# The QuickSight settings for this Amazon Web Services account;. This
|
5274
|
+
# information includes the edition of Amazon QuickSight that you
|
5275
|
+
# subscribed to (Standard or Enterprise) and the notification email
|
5276
|
+
# for the QuickSight subscription. In the QuickSight console, the
|
5277
|
+
# QuickSight subscription is sometimes referred to as a QuickSight
|
5278
|
+
# "account" even though it's technically not an account by itself.
|
5279
|
+
# Instead, it's a subscription to the QuickSight service for your
|
5280
|
+
# Amazon Web Services account;. The edition that you subscribe to
|
5281
|
+
# applies to QuickSight in every Region; where you use it.
|
4922
5282
|
# @return [Types::AccountSettings]
|
4923
5283
|
#
|
4924
5284
|
# @!attribute [rw] request_id
|
4925
|
-
# The
|
5285
|
+
# The Amazon Web Services request ID for this operation.
|
4926
5286
|
# @return [String]
|
4927
5287
|
#
|
4928
5288
|
# @!attribute [rw] status
|
@@ -4948,9 +5308,9 @@ module Aws::QuickSight
|
|
4948
5308
|
# }
|
4949
5309
|
#
|
4950
5310
|
# @!attribute [rw] aws_account_id
|
4951
|
-
# The ID of the
|
4952
|
-
# permissions you're describing. You must be using the
|
4953
|
-
# that the analysis is in.
|
5311
|
+
# The ID of the Amazon Web Services account; that contains the
|
5312
|
+
# analysis whose permissions you're describing. You must be using the
|
5313
|
+
# Amazon Web Services account; that the analysis is in.
|
4954
5314
|
# @return [String]
|
4955
5315
|
#
|
4956
5316
|
# @!attribute [rw] analysis_id
|
@@ -4986,7 +5346,7 @@ module Aws::QuickSight
|
|
4986
5346
|
# @return [Integer]
|
4987
5347
|
#
|
4988
5348
|
# @!attribute [rw] request_id
|
4989
|
-
# The
|
5349
|
+
# The Amazon Web Services request ID for this operation.
|
4990
5350
|
# @return [String]
|
4991
5351
|
#
|
4992
5352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsResponse AWS API Documentation
|
@@ -5010,8 +5370,9 @@ module Aws::QuickSight
|
|
5010
5370
|
# }
|
5011
5371
|
#
|
5012
5372
|
# @!attribute [rw] aws_account_id
|
5013
|
-
# The ID of the
|
5014
|
-
#
|
5373
|
+
# The ID of the Amazon Web Services account; that contains the
|
5374
|
+
# analysis. You must be using the Amazon Web Services account; that
|
5375
|
+
# the analysis is in.
|
5015
5376
|
# @return [String]
|
5016
5377
|
#
|
5017
5378
|
# @!attribute [rw] analysis_id
|
@@ -5038,7 +5399,7 @@ module Aws::QuickSight
|
|
5038
5399
|
# @return [Integer]
|
5039
5400
|
#
|
5040
5401
|
# @!attribute [rw] request_id
|
5041
|
-
# The
|
5402
|
+
# The Amazon Web Services request ID for this operation.
|
5042
5403
|
# @return [String]
|
5043
5404
|
#
|
5044
5405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
|
@@ -5060,8 +5421,8 @@ module Aws::QuickSight
|
|
5060
5421
|
# }
|
5061
5422
|
#
|
5062
5423
|
# @!attribute [rw] aws_account_id
|
5063
|
-
# The ID of the
|
5064
|
-
# describing permissions for.
|
5424
|
+
# The ID of the Amazon Web Services account; that contains the
|
5425
|
+
# dashboard that you're describing permissions for.
|
5065
5426
|
# @return [String]
|
5066
5427
|
#
|
5067
5428
|
# @!attribute [rw] dashboard_id
|
@@ -5094,7 +5455,7 @@ module Aws::QuickSight
|
|
5094
5455
|
# @return [Integer]
|
5095
5456
|
#
|
5096
5457
|
# @!attribute [rw] request_id
|
5097
|
-
# The
|
5458
|
+
# The Amazon Web Services request ID for this operation.
|
5098
5459
|
# @return [String]
|
5099
5460
|
#
|
5100
5461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsResponse AWS API Documentation
|
@@ -5120,8 +5481,8 @@ module Aws::QuickSight
|
|
5120
5481
|
# }
|
5121
5482
|
#
|
5122
5483
|
# @!attribute [rw] aws_account_id
|
5123
|
-
# The ID of the
|
5124
|
-
# describing.
|
5484
|
+
# The ID of the Amazon Web Services account; that contains the
|
5485
|
+
# dashboard that you're describing.
|
5125
5486
|
# @return [String]
|
5126
5487
|
#
|
5127
5488
|
# @!attribute [rw] dashboard_id
|
@@ -5157,7 +5518,7 @@ module Aws::QuickSight
|
|
5157
5518
|
# @return [Integer]
|
5158
5519
|
#
|
5159
5520
|
# @!attribute [rw] request_id
|
5160
|
-
# The
|
5521
|
+
# The Amazon Web Services request ID for this operation.
|
5161
5522
|
# @return [String]
|
5162
5523
|
#
|
5163
5524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardResponse AWS API Documentation
|
@@ -5179,12 +5540,12 @@ module Aws::QuickSight
|
|
5179
5540
|
# }
|
5180
5541
|
#
|
5181
5542
|
# @!attribute [rw] aws_account_id
|
5182
|
-
# The
|
5543
|
+
# The Amazon Web Services account; ID.
|
5183
5544
|
# @return [String]
|
5184
5545
|
#
|
5185
5546
|
# @!attribute [rw] data_set_id
|
5186
5547
|
# The ID for the dataset that you want to create. This ID is unique
|
5187
|
-
# per
|
5548
|
+
# per Region; for each Amazon Web Services account;.
|
5188
5549
|
# @return [String]
|
5189
5550
|
#
|
5190
5551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5202,7 +5563,7 @@ module Aws::QuickSight
|
|
5202
5563
|
#
|
5203
5564
|
# @!attribute [rw] data_set_id
|
5204
5565
|
# The ID for the dataset that you want to create. This ID is unique
|
5205
|
-
# per
|
5566
|
+
# per Region; for each Amazon Web Services account;.
|
5206
5567
|
# @return [String]
|
5207
5568
|
#
|
5208
5569
|
# @!attribute [rw] permissions
|
@@ -5210,7 +5571,7 @@ module Aws::QuickSight
|
|
5210
5571
|
# @return [Array<Types::ResourcePermission>]
|
5211
5572
|
#
|
5212
5573
|
# @!attribute [rw] request_id
|
5213
|
-
# The
|
5574
|
+
# The Amazon Web Services request ID for this operation.
|
5214
5575
|
# @return [String]
|
5215
5576
|
#
|
5216
5577
|
# @!attribute [rw] status
|
@@ -5238,12 +5599,12 @@ module Aws::QuickSight
|
|
5238
5599
|
# }
|
5239
5600
|
#
|
5240
5601
|
# @!attribute [rw] aws_account_id
|
5241
|
-
# The
|
5602
|
+
# The Amazon Web Services account; ID.
|
5242
5603
|
# @return [String]
|
5243
5604
|
#
|
5244
5605
|
# @!attribute [rw] data_set_id
|
5245
5606
|
# The ID for the dataset that you want to create. This ID is unique
|
5246
|
-
# per
|
5607
|
+
# per Region; for each Amazon Web Services account;.
|
5247
5608
|
# @return [String]
|
5248
5609
|
#
|
5249
5610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5260,7 +5621,7 @@ module Aws::QuickSight
|
|
5260
5621
|
# @return [Types::DataSet]
|
5261
5622
|
#
|
5262
5623
|
# @!attribute [rw] request_id
|
5263
|
-
# The
|
5624
|
+
# The Amazon Web Services request ID for this operation.
|
5264
5625
|
# @return [String]
|
5265
5626
|
#
|
5266
5627
|
# @!attribute [rw] status
|
@@ -5286,12 +5647,12 @@ module Aws::QuickSight
|
|
5286
5647
|
# }
|
5287
5648
|
#
|
5288
5649
|
# @!attribute [rw] aws_account_id
|
5289
|
-
# The
|
5650
|
+
# The Amazon Web Services account; ID.
|
5290
5651
|
# @return [String]
|
5291
5652
|
#
|
5292
5653
|
# @!attribute [rw] data_source_id
|
5293
|
-
# The ID of the data source. This ID is unique per
|
5294
|
-
#
|
5654
|
+
# The ID of the data source. This ID is unique per Region; for each
|
5655
|
+
# Amazon Web Services account;.
|
5295
5656
|
# @return [String]
|
5296
5657
|
#
|
5297
5658
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5308,8 +5669,8 @@ module Aws::QuickSight
|
|
5308
5669
|
# @return [String]
|
5309
5670
|
#
|
5310
5671
|
# @!attribute [rw] data_source_id
|
5311
|
-
# The ID of the data source. This ID is unique per
|
5312
|
-
#
|
5672
|
+
# The ID of the data source. This ID is unique per Region; for each
|
5673
|
+
# Amazon Web Services account;.
|
5313
5674
|
# @return [String]
|
5314
5675
|
#
|
5315
5676
|
# @!attribute [rw] permissions
|
@@ -5317,7 +5678,7 @@ module Aws::QuickSight
|
|
5317
5678
|
# @return [Array<Types::ResourcePermission>]
|
5318
5679
|
#
|
5319
5680
|
# @!attribute [rw] request_id
|
5320
|
-
# The
|
5681
|
+
# The Amazon Web Services request ID for this operation.
|
5321
5682
|
# @return [String]
|
5322
5683
|
#
|
5323
5684
|
# @!attribute [rw] status
|
@@ -5345,12 +5706,12 @@ module Aws::QuickSight
|
|
5345
5706
|
# }
|
5346
5707
|
#
|
5347
5708
|
# @!attribute [rw] aws_account_id
|
5348
|
-
# The
|
5709
|
+
# The Amazon Web Services account; ID.
|
5349
5710
|
# @return [String]
|
5350
5711
|
#
|
5351
5712
|
# @!attribute [rw] data_source_id
|
5352
|
-
# The ID of the data source. This ID is unique per
|
5353
|
-
#
|
5713
|
+
# The ID of the data source. This ID is unique per Region; for each
|
5714
|
+
# Amazon Web Services account;.
|
5354
5715
|
# @return [String]
|
5355
5716
|
#
|
5356
5717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -5367,7 +5728,7 @@ module Aws::QuickSight
|
|
5367
5728
|
# @return [Types::DataSource]
|
5368
5729
|
#
|
5369
5730
|
# @!attribute [rw] request_id
|
5370
|
-
# The
|
5731
|
+
# The Amazon Web Services request ID for this operation.
|
5371
5732
|
# @return [String]
|
5372
5733
|
#
|
5373
5734
|
# @!attribute [rw] status
|
@@ -5384,58 +5745,219 @@ module Aws::QuickSight
|
|
5384
5745
|
include Aws::Structure
|
5385
5746
|
end
|
5386
5747
|
|
5387
|
-
# @note When making an API call, you may pass
|
5748
|
+
# @note When making an API call, you may pass DescribeFolderPermissionsRequest
|
5388
5749
|
# data as a hash:
|
5389
5750
|
#
|
5390
5751
|
# {
|
5391
|
-
# group_name: "GroupName", # required
|
5392
5752
|
# aws_account_id: "AwsAccountId", # required
|
5393
|
-
#
|
5753
|
+
# folder_id: "RestrictiveResourceId", # required
|
5394
5754
|
# }
|
5395
5755
|
#
|
5396
|
-
# @!attribute [rw] group_name
|
5397
|
-
# The name of the group that you want to describe.
|
5398
|
-
# @return [String]
|
5399
|
-
#
|
5400
5756
|
# @!attribute [rw] aws_account_id
|
5401
|
-
# The
|
5402
|
-
# the ID for the AWS account that contains your Amazon QuickSight
|
5403
|
-
# account.
|
5757
|
+
# The AWS Account ID.
|
5404
5758
|
# @return [String]
|
5405
5759
|
#
|
5406
|
-
# @!attribute [rw]
|
5407
|
-
# The
|
5760
|
+
# @!attribute [rw] folder_id
|
5761
|
+
# The folder ID.
|
5408
5762
|
# @return [String]
|
5409
5763
|
#
|
5410
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
5764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissionsRequest AWS API Documentation
|
5411
5765
|
#
|
5412
|
-
class
|
5413
|
-
:group_name,
|
5766
|
+
class DescribeFolderPermissionsRequest < Struct.new(
|
5414
5767
|
:aws_account_id,
|
5415
|
-
:
|
5768
|
+
:folder_id)
|
5416
5769
|
SENSITIVE = []
|
5417
5770
|
include Aws::Structure
|
5418
5771
|
end
|
5419
5772
|
|
5420
|
-
# @!attribute [rw]
|
5421
|
-
# The
|
5422
|
-
# @return [
|
5773
|
+
# @!attribute [rw] status
|
5774
|
+
# The status. If succeeded, the status is `SC_OK`.
|
5775
|
+
# @return [Integer]
|
5423
5776
|
#
|
5424
|
-
# @!attribute [rw]
|
5425
|
-
# The
|
5777
|
+
# @!attribute [rw] folder_id
|
5778
|
+
# The folder ID.
|
5426
5779
|
# @return [String]
|
5427
5780
|
#
|
5428
|
-
# @!attribute [rw]
|
5429
|
-
# The
|
5430
|
-
# @return [
|
5781
|
+
# @!attribute [rw] arn
|
5782
|
+
# The Amazon Resource Name (ARN) for the folder.
|
5783
|
+
# @return [String]
|
5431
5784
|
#
|
5432
|
-
#
|
5785
|
+
# @!attribute [rw] permissions
|
5786
|
+
# Information about the permissions on the folder.
|
5787
|
+
# @return [Array<Types::ResourcePermission>]
|
5433
5788
|
#
|
5434
|
-
|
5435
|
-
|
5436
|
-
|
5437
|
-
|
5438
|
-
|
5789
|
+
# @!attribute [rw] request_id
|
5790
|
+
# The request ID.
|
5791
|
+
# @return [String]
|
5792
|
+
#
|
5793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissionsResponse AWS API Documentation
|
5794
|
+
#
|
5795
|
+
class DescribeFolderPermissionsResponse < Struct.new(
|
5796
|
+
:status,
|
5797
|
+
:folder_id,
|
5798
|
+
:arn,
|
5799
|
+
:permissions,
|
5800
|
+
:request_id)
|
5801
|
+
SENSITIVE = []
|
5802
|
+
include Aws::Structure
|
5803
|
+
end
|
5804
|
+
|
5805
|
+
# @note When making an API call, you may pass DescribeFolderRequest
|
5806
|
+
# data as a hash:
|
5807
|
+
#
|
5808
|
+
# {
|
5809
|
+
# aws_account_id: "AwsAccountId", # required
|
5810
|
+
# folder_id: "RestrictiveResourceId", # required
|
5811
|
+
# }
|
5812
|
+
#
|
5813
|
+
# @!attribute [rw] aws_account_id
|
5814
|
+
# The AWS account ID.
|
5815
|
+
# @return [String]
|
5816
|
+
#
|
5817
|
+
# @!attribute [rw] folder_id
|
5818
|
+
# The folder ID.
|
5819
|
+
# @return [String]
|
5820
|
+
#
|
5821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderRequest AWS API Documentation
|
5822
|
+
#
|
5823
|
+
class DescribeFolderRequest < Struct.new(
|
5824
|
+
:aws_account_id,
|
5825
|
+
:folder_id)
|
5826
|
+
SENSITIVE = []
|
5827
|
+
include Aws::Structure
|
5828
|
+
end
|
5829
|
+
|
5830
|
+
# @note When making an API call, you may pass DescribeFolderResolvedPermissionsRequest
|
5831
|
+
# data as a hash:
|
5832
|
+
#
|
5833
|
+
# {
|
5834
|
+
# aws_account_id: "AwsAccountId", # required
|
5835
|
+
# folder_id: "RestrictiveResourceId", # required
|
5836
|
+
# }
|
5837
|
+
#
|
5838
|
+
# @!attribute [rw] aws_account_id
|
5839
|
+
# The AWS account ID.
|
5840
|
+
# @return [String]
|
5841
|
+
#
|
5842
|
+
# @!attribute [rw] folder_id
|
5843
|
+
# The folder ID.
|
5844
|
+
# @return [String]
|
5845
|
+
#
|
5846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissionsRequest AWS API Documentation
|
5847
|
+
#
|
5848
|
+
class DescribeFolderResolvedPermissionsRequest < Struct.new(
|
5849
|
+
:aws_account_id,
|
5850
|
+
:folder_id)
|
5851
|
+
SENSITIVE = []
|
5852
|
+
include Aws::Structure
|
5853
|
+
end
|
5854
|
+
|
5855
|
+
# @!attribute [rw] status
|
5856
|
+
# The status. If succeeded, the status is `SC_OK`
|
5857
|
+
# @return [Integer]
|
5858
|
+
#
|
5859
|
+
# @!attribute [rw] folder_id
|
5860
|
+
# The folder ID.
|
5861
|
+
# @return [String]
|
5862
|
+
#
|
5863
|
+
# @!attribute [rw] arn
|
5864
|
+
# The Amazon Resource Name (ARN).
|
5865
|
+
# @return [String]
|
5866
|
+
#
|
5867
|
+
# @!attribute [rw] permissions
|
5868
|
+
# Information about the permissions on the dashboard.
|
5869
|
+
# @return [Array<Types::ResourcePermission>]
|
5870
|
+
#
|
5871
|
+
# @!attribute [rw] request_id
|
5872
|
+
# The request ID.
|
5873
|
+
# @return [String]
|
5874
|
+
#
|
5875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissionsResponse AWS API Documentation
|
5876
|
+
#
|
5877
|
+
class DescribeFolderResolvedPermissionsResponse < Struct.new(
|
5878
|
+
:status,
|
5879
|
+
:folder_id,
|
5880
|
+
:arn,
|
5881
|
+
:permissions,
|
5882
|
+
:request_id)
|
5883
|
+
SENSITIVE = []
|
5884
|
+
include Aws::Structure
|
5885
|
+
end
|
5886
|
+
|
5887
|
+
# @!attribute [rw] status
|
5888
|
+
# The status. If succeeded, the status is `SC_OK (200)`.
|
5889
|
+
# @return [Integer]
|
5890
|
+
#
|
5891
|
+
# @!attribute [rw] folder
|
5892
|
+
# Information about the folder.
|
5893
|
+
# @return [Types::Folder]
|
5894
|
+
#
|
5895
|
+
# @!attribute [rw] request_id
|
5896
|
+
# The request ID.
|
5897
|
+
# @return [String]
|
5898
|
+
#
|
5899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResponse AWS API Documentation
|
5900
|
+
#
|
5901
|
+
class DescribeFolderResponse < Struct.new(
|
5902
|
+
:status,
|
5903
|
+
:folder,
|
5904
|
+
:request_id)
|
5905
|
+
SENSITIVE = []
|
5906
|
+
include Aws::Structure
|
5907
|
+
end
|
5908
|
+
|
5909
|
+
# @note When making an API call, you may pass DescribeGroupRequest
|
5910
|
+
# data as a hash:
|
5911
|
+
#
|
5912
|
+
# {
|
5913
|
+
# group_name: "GroupName", # required
|
5914
|
+
# aws_account_id: "AwsAccountId", # required
|
5915
|
+
# namespace: "Namespace", # required
|
5916
|
+
# }
|
5917
|
+
#
|
5918
|
+
# @!attribute [rw] group_name
|
5919
|
+
# The name of the group that you want to describe.
|
5920
|
+
# @return [String]
|
5921
|
+
#
|
5922
|
+
# @!attribute [rw] aws_account_id
|
5923
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
5924
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
5925
|
+
# contains your Amazon QuickSight account.
|
5926
|
+
# @return [String]
|
5927
|
+
#
|
5928
|
+
# @!attribute [rw] namespace
|
5929
|
+
# The namespace. Currently, you should set this to `default`.
|
5930
|
+
# @return [String]
|
5931
|
+
#
|
5932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupRequest AWS API Documentation
|
5933
|
+
#
|
5934
|
+
class DescribeGroupRequest < Struct.new(
|
5935
|
+
:group_name,
|
5936
|
+
:aws_account_id,
|
5937
|
+
:namespace)
|
5938
|
+
SENSITIVE = []
|
5939
|
+
include Aws::Structure
|
5940
|
+
end
|
5941
|
+
|
5942
|
+
# @!attribute [rw] group
|
5943
|
+
# The name of the group.
|
5944
|
+
# @return [Types::Group]
|
5945
|
+
#
|
5946
|
+
# @!attribute [rw] request_id
|
5947
|
+
# The Amazon Web Services request ID for this operation.
|
5948
|
+
# @return [String]
|
5949
|
+
#
|
5950
|
+
# @!attribute [rw] status
|
5951
|
+
# The HTTP status of the request.
|
5952
|
+
# @return [Integer]
|
5953
|
+
#
|
5954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupResponse AWS API Documentation
|
5955
|
+
#
|
5956
|
+
class DescribeGroupResponse < Struct.new(
|
5957
|
+
:group,
|
5958
|
+
:request_id,
|
5959
|
+
:status)
|
5960
|
+
SENSITIVE = []
|
5439
5961
|
include Aws::Structure
|
5440
5962
|
end
|
5441
5963
|
|
@@ -5449,8 +5971,8 @@ module Aws::QuickSight
|
|
5449
5971
|
# }
|
5450
5972
|
#
|
5451
5973
|
# @!attribute [rw] aws_account_id
|
5452
|
-
# The ID of the
|
5453
|
-
# to describe.
|
5974
|
+
# The ID of the Amazon Web Services account; that contains the
|
5975
|
+
# assignment that you want to describe.
|
5454
5976
|
# @return [String]
|
5455
5977
|
#
|
5456
5978
|
# @!attribute [rw] assignment_name
|
@@ -5476,7 +5998,7 @@ module Aws::QuickSight
|
|
5476
5998
|
# @return [Types::IAMPolicyAssignment]
|
5477
5999
|
#
|
5478
6000
|
# @!attribute [rw] request_id
|
5479
|
-
# The
|
6001
|
+
# The Amazon Web Services request ID for this operation.
|
5480
6002
|
# @return [String]
|
5481
6003
|
#
|
5482
6004
|
# @!attribute [rw] status
|
@@ -5503,7 +6025,7 @@ module Aws::QuickSight
|
|
5503
6025
|
# }
|
5504
6026
|
#
|
5505
6027
|
# @!attribute [rw] aws_account_id
|
5506
|
-
# The
|
6028
|
+
# The Amazon Web Services account; ID.
|
5507
6029
|
# @return [String]
|
5508
6030
|
#
|
5509
6031
|
# @!attribute [rw] data_set_id
|
@@ -5529,7 +6051,7 @@ module Aws::QuickSight
|
|
5529
6051
|
# @return [Types::Ingestion]
|
5530
6052
|
#
|
5531
6053
|
# @!attribute [rw] request_id
|
5532
|
-
# The
|
6054
|
+
# The Amazon Web Services request ID for this operation.
|
5533
6055
|
# @return [String]
|
5534
6056
|
#
|
5535
6057
|
# @!attribute [rw] status
|
@@ -5555,8 +6077,8 @@ module Aws::QuickSight
|
|
5555
6077
|
# }
|
5556
6078
|
#
|
5557
6079
|
# @!attribute [rw] aws_account_id
|
5558
|
-
# The ID for the
|
5559
|
-
# that you want to describe.
|
6080
|
+
# The ID for the Amazon Web Services account; that contains the
|
6081
|
+
# QuickSight namespace that you want to describe.
|
5560
6082
|
# @return [String]
|
5561
6083
|
#
|
5562
6084
|
# @!attribute [rw] namespace
|
@@ -5574,15 +6096,15 @@ module Aws::QuickSight
|
|
5574
6096
|
|
5575
6097
|
# @!attribute [rw] namespace
|
5576
6098
|
# The information about the namespace that you're describing. The
|
5577
|
-
# response includes the namespace ARN, name,
|
5578
|
-
#
|
5579
|
-
#
|
5580
|
-
#
|
5581
|
-
#
|
6099
|
+
# response includes the namespace ARN, name, Region;, creation status,
|
6100
|
+
# and identity store. `DescribeNamespace` also works for namespaces
|
6101
|
+
# that are in the process of being created. For incomplete namespaces,
|
6102
|
+
# this API operation lists the namespace error types and messages
|
6103
|
+
# associated with the creation process.
|
5582
6104
|
# @return [Types::NamespaceInfoV2]
|
5583
6105
|
#
|
5584
6106
|
# @!attribute [rw] request_id
|
5585
|
-
# The
|
6107
|
+
# The Amazon Web Services request ID for this operation.
|
5586
6108
|
# @return [String]
|
5587
6109
|
#
|
5588
6110
|
# @!attribute [rw] status
|
@@ -5609,8 +6131,8 @@ module Aws::QuickSight
|
|
5609
6131
|
# }
|
5610
6132
|
#
|
5611
6133
|
# @!attribute [rw] aws_account_id
|
5612
|
-
# The ID of the
|
5613
|
-
# you're describing.
|
6134
|
+
# The ID of the Amazon Web Services account; that contains the
|
6135
|
+
# template alias that you're describing.
|
5614
6136
|
# @return [String]
|
5615
6137
|
#
|
5616
6138
|
# @!attribute [rw] template_id
|
@@ -5644,7 +6166,7 @@ module Aws::QuickSight
|
|
5644
6166
|
# @return [Integer]
|
5645
6167
|
#
|
5646
6168
|
# @!attribute [rw] request_id
|
5647
|
-
# The
|
6169
|
+
# The Amazon Web Services request ID for this operation.
|
5648
6170
|
# @return [String]
|
5649
6171
|
#
|
5650
6172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateAliasResponse AWS API Documentation
|
@@ -5666,8 +6188,8 @@ module Aws::QuickSight
|
|
5666
6188
|
# }
|
5667
6189
|
#
|
5668
6190
|
# @!attribute [rw] aws_account_id
|
5669
|
-
# The ID of the
|
5670
|
-
# describing.
|
6191
|
+
# The ID of the Amazon Web Services account; that contains the
|
6192
|
+
# template that you're describing.
|
5671
6193
|
# @return [String]
|
5672
6194
|
#
|
5673
6195
|
# @!attribute [rw] template_id
|
@@ -5696,7 +6218,7 @@ module Aws::QuickSight
|
|
5696
6218
|
# @return [Array<Types::ResourcePermission>]
|
5697
6219
|
#
|
5698
6220
|
# @!attribute [rw] request_id
|
5699
|
-
# The
|
6221
|
+
# The Amazon Web Services request ID for this operation.
|
5700
6222
|
# @return [String]
|
5701
6223
|
#
|
5702
6224
|
# @!attribute [rw] status
|
@@ -5726,8 +6248,8 @@ module Aws::QuickSight
|
|
5726
6248
|
# }
|
5727
6249
|
#
|
5728
6250
|
# @!attribute [rw] aws_account_id
|
5729
|
-
# The ID of the
|
5730
|
-
# describing.
|
6251
|
+
# The ID of the Amazon Web Services account; that contains the
|
6252
|
+
# template that you're describing.
|
5731
6253
|
# @return [String]
|
5732
6254
|
#
|
5733
6255
|
# @!attribute [rw] template_id
|
@@ -5768,7 +6290,7 @@ module Aws::QuickSight
|
|
5768
6290
|
# @return [Integer]
|
5769
6291
|
#
|
5770
6292
|
# @!attribute [rw] request_id
|
5771
|
-
# The
|
6293
|
+
# The Amazon Web Services request ID for this operation.
|
5772
6294
|
# @return [String]
|
5773
6295
|
#
|
5774
6296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateResponse AWS API Documentation
|
@@ -5791,8 +6313,8 @@ module Aws::QuickSight
|
|
5791
6313
|
# }
|
5792
6314
|
#
|
5793
6315
|
# @!attribute [rw] aws_account_id
|
5794
|
-
# The ID of the
|
5795
|
-
# describing.
|
6316
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
6317
|
+
# alias that you're describing.
|
5796
6318
|
# @return [String]
|
5797
6319
|
#
|
5798
6320
|
# @!attribute [rw] theme_id
|
@@ -5822,7 +6344,7 @@ module Aws::QuickSight
|
|
5822
6344
|
# @return [Integer]
|
5823
6345
|
#
|
5824
6346
|
# @!attribute [rw] request_id
|
5825
|
-
# The
|
6347
|
+
# The Amazon Web Services request ID for this operation.
|
5826
6348
|
# @return [String]
|
5827
6349
|
#
|
5828
6350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAliasResponse AWS API Documentation
|
@@ -5844,8 +6366,8 @@ module Aws::QuickSight
|
|
5844
6366
|
# }
|
5845
6367
|
#
|
5846
6368
|
# @!attribute [rw] aws_account_id
|
5847
|
-
# The ID of the
|
5848
|
-
# describing.
|
6369
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
6370
|
+
# that you're describing.
|
5849
6371
|
# @return [String]
|
5850
6372
|
#
|
5851
6373
|
# @!attribute [rw] theme_id
|
@@ -5874,7 +6396,7 @@ module Aws::QuickSight
|
|
5874
6396
|
# @return [Array<Types::ResourcePermission>]
|
5875
6397
|
#
|
5876
6398
|
# @!attribute [rw] request_id
|
5877
|
-
# The
|
6399
|
+
# The Amazon Web Services request ID for this operation.
|
5878
6400
|
# @return [String]
|
5879
6401
|
#
|
5880
6402
|
# @!attribute [rw] status
|
@@ -5904,8 +6426,8 @@ module Aws::QuickSight
|
|
5904
6426
|
# }
|
5905
6427
|
#
|
5906
6428
|
# @!attribute [rw] aws_account_id
|
5907
|
-
# The ID of the
|
5908
|
-
# describing.
|
6429
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
6430
|
+
# that you're describing.
|
5909
6431
|
# @return [String]
|
5910
6432
|
#
|
5911
6433
|
# @!attribute [rw] theme_id
|
@@ -5946,7 +6468,7 @@ module Aws::QuickSight
|
|
5946
6468
|
# @return [Integer]
|
5947
6469
|
#
|
5948
6470
|
# @!attribute [rw] request_id
|
5949
|
-
# The
|
6471
|
+
# The Amazon Web Services request ID for this operation.
|
5950
6472
|
# @return [String]
|
5951
6473
|
#
|
5952
6474
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeResponse AWS API Documentation
|
@@ -5973,9 +6495,9 @@ module Aws::QuickSight
|
|
5973
6495
|
# @return [String]
|
5974
6496
|
#
|
5975
6497
|
# @!attribute [rw] aws_account_id
|
5976
|
-
# The ID for the
|
5977
|
-
# the ID for the
|
5978
|
-
# account.
|
6498
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
6499
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
6500
|
+
# contains your Amazon QuickSight account.
|
5979
6501
|
# @return [String]
|
5980
6502
|
#
|
5981
6503
|
# @!attribute [rw] namespace
|
@@ -5997,7 +6519,7 @@ module Aws::QuickSight
|
|
5997
6519
|
# @return [Types::User]
|
5998
6520
|
#
|
5999
6521
|
# @!attribute [rw] request_id
|
6000
|
-
# The
|
6522
|
+
# The Amazon Web Services request ID for this operation.
|
6001
6523
|
# @return [String]
|
6002
6524
|
#
|
6003
6525
|
# @!attribute [rw] status
|
@@ -6022,7 +6544,7 @@ module Aws::QuickSight
|
|
6022
6544
|
# @return [String]
|
6023
6545
|
#
|
6024
6546
|
# @!attribute [rw] request_id
|
6025
|
-
# The
|
6547
|
+
# The Amazon Web Services request ID for this request.
|
6026
6548
|
# @return [String]
|
6027
6549
|
#
|
6028
6550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DomainNotWhitelistedException AWS API Documentation
|
@@ -6116,11 +6638,319 @@ module Aws::QuickSight
|
|
6116
6638
|
# the expression evaluates to true are kept in the dataset.
|
6117
6639
|
# @return [String]
|
6118
6640
|
#
|
6119
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperation AWS API Documentation
|
6641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperation AWS API Documentation
|
6642
|
+
#
|
6643
|
+
class FilterOperation < Struct.new(
|
6644
|
+
:condition_expression)
|
6645
|
+
SENSITIVE = []
|
6646
|
+
include Aws::Structure
|
6647
|
+
end
|
6648
|
+
|
6649
|
+
# A folder.
|
6650
|
+
#
|
6651
|
+
# @!attribute [rw] folder_id
|
6652
|
+
# The folder ID.
|
6653
|
+
# @return [String]
|
6654
|
+
#
|
6655
|
+
# @!attribute [rw] arn
|
6656
|
+
# The folder Amazon Resource Name (ARN).
|
6657
|
+
# @return [String]
|
6658
|
+
#
|
6659
|
+
# @!attribute [rw] name
|
6660
|
+
# A display name for the folder.
|
6661
|
+
# @return [String]
|
6662
|
+
#
|
6663
|
+
# @!attribute [rw] folder_type
|
6664
|
+
# The type of the folder.
|
6665
|
+
# @return [String]
|
6666
|
+
#
|
6667
|
+
# @!attribute [rw] folder_path
|
6668
|
+
# An array of ancestor folder ARN strings.
|
6669
|
+
# @return [Array<String>]
|
6670
|
+
#
|
6671
|
+
# @!attribute [rw] created_time
|
6672
|
+
# The time that the folder was created.
|
6673
|
+
# @return [Time]
|
6674
|
+
#
|
6675
|
+
# @!attribute [rw] last_updated_time
|
6676
|
+
# The time that the folder was last updated.
|
6677
|
+
# @return [Time]
|
6678
|
+
#
|
6679
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Folder AWS API Documentation
|
6680
|
+
#
|
6681
|
+
class Folder < Struct.new(
|
6682
|
+
:folder_id,
|
6683
|
+
:arn,
|
6684
|
+
:name,
|
6685
|
+
:folder_type,
|
6686
|
+
:folder_path,
|
6687
|
+
:created_time,
|
6688
|
+
:last_updated_time)
|
6689
|
+
SENSITIVE = []
|
6690
|
+
include Aws::Structure
|
6691
|
+
end
|
6692
|
+
|
6693
|
+
# An asset in a folder, such as a dashboard, analysis, or dataset.
|
6694
|
+
#
|
6695
|
+
# @!attribute [rw] member_id
|
6696
|
+
# The ID of the asset.
|
6697
|
+
# @return [String]
|
6698
|
+
#
|
6699
|
+
# @!attribute [rw] member_type
|
6700
|
+
# The type of the asset.
|
6701
|
+
# @return [String]
|
6702
|
+
#
|
6703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderMember AWS API Documentation
|
6704
|
+
#
|
6705
|
+
class FolderMember < Struct.new(
|
6706
|
+
:member_id,
|
6707
|
+
:member_type)
|
6708
|
+
SENSITIVE = []
|
6709
|
+
include Aws::Structure
|
6710
|
+
end
|
6711
|
+
|
6712
|
+
# Searches a folder by a filter.
|
6713
|
+
#
|
6714
|
+
# @note When making an API call, you may pass FolderSearchFilter
|
6715
|
+
# data as a hash:
|
6716
|
+
#
|
6717
|
+
# {
|
6718
|
+
# operator: "StringEquals", # accepts StringEquals
|
6719
|
+
# name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
|
6720
|
+
# value: "String",
|
6721
|
+
# }
|
6722
|
+
#
|
6723
|
+
# @!attribute [rw] operator
|
6724
|
+
# The comparison operator that you want to use as a filter. For
|
6725
|
+
# example, `"Operator": "StringEquals"`.
|
6726
|
+
# @return [String]
|
6727
|
+
#
|
6728
|
+
# @!attribute [rw] name
|
6729
|
+
# The name of the value that you want to use as a filter. For example,
|
6730
|
+
# `"Name": "PARENT_FOLDER_ARN"`.
|
6731
|
+
# @return [String]
|
6732
|
+
#
|
6733
|
+
# @!attribute [rw] value
|
6734
|
+
# The value of the named item (in this example, `PARENT_FOLDER_ARN`),
|
6735
|
+
# that you want to use as a filter. For example, `"Value":
|
6736
|
+
# "arn:aws:quicksight:us-east-1:1:folder/folderId"`.
|
6737
|
+
# @return [String]
|
6738
|
+
#
|
6739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderSearchFilter AWS API Documentation
|
6740
|
+
#
|
6741
|
+
class FolderSearchFilter < Struct.new(
|
6742
|
+
:operator,
|
6743
|
+
:name,
|
6744
|
+
:value)
|
6745
|
+
SENSITIVE = []
|
6746
|
+
include Aws::Structure
|
6747
|
+
end
|
6748
|
+
|
6749
|
+
# A summary of the folder.
|
6750
|
+
#
|
6751
|
+
# @!attribute [rw] arn
|
6752
|
+
# The Amazon Resource Name (ARN).
|
6753
|
+
# @return [String]
|
6754
|
+
#
|
6755
|
+
# @!attribute [rw] folder_id
|
6756
|
+
# The folder ID.
|
6757
|
+
# @return [String]
|
6758
|
+
#
|
6759
|
+
# @!attribute [rw] name
|
6760
|
+
# The display name of the folder.
|
6761
|
+
# @return [String]
|
6762
|
+
#
|
6763
|
+
# @!attribute [rw] folder_type
|
6764
|
+
# The type of folder.
|
6765
|
+
# @return [String]
|
6766
|
+
#
|
6767
|
+
# @!attribute [rw] created_time
|
6768
|
+
# The time that the folder was created.
|
6769
|
+
# @return [Time]
|
6770
|
+
#
|
6771
|
+
# @!attribute [rw] last_updated_time
|
6772
|
+
# The time that the folder was last updated.
|
6773
|
+
# @return [Time]
|
6774
|
+
#
|
6775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderSummary AWS API Documentation
|
6776
|
+
#
|
6777
|
+
class FolderSummary < Struct.new(
|
6778
|
+
:arn,
|
6779
|
+
:folder_id,
|
6780
|
+
:name,
|
6781
|
+
:folder_type,
|
6782
|
+
:created_time,
|
6783
|
+
:last_updated_time)
|
6784
|
+
SENSITIVE = []
|
6785
|
+
include Aws::Structure
|
6786
|
+
end
|
6787
|
+
|
6788
|
+
# @note When making an API call, you may pass GenerateEmbedUrlForAnonymousUserRequest
|
6789
|
+
# data as a hash:
|
6790
|
+
#
|
6791
|
+
# {
|
6792
|
+
# aws_account_id: "AwsAccountId", # required
|
6793
|
+
# session_lifetime_in_minutes: 1,
|
6794
|
+
# namespace: "Namespace", # required
|
6795
|
+
# session_tags: [
|
6796
|
+
# {
|
6797
|
+
# key: "SessionTagKey", # required
|
6798
|
+
# value: "SessionTagValue", # required
|
6799
|
+
# },
|
6800
|
+
# ],
|
6801
|
+
# authorized_resource_arns: ["Arn"], # required
|
6802
|
+
# experience_configuration: { # required
|
6803
|
+
# dashboard: {
|
6804
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
6805
|
+
# },
|
6806
|
+
# },
|
6807
|
+
# }
|
6808
|
+
#
|
6809
|
+
# @!attribute [rw] aws_account_id
|
6810
|
+
# The ID for the Amazon Web Services account that contains the
|
6811
|
+
# dashboard that you're embedding.
|
6812
|
+
# @return [String]
|
6813
|
+
#
|
6814
|
+
# @!attribute [rw] session_lifetime_in_minutes
|
6815
|
+
# How many minutes the session is valid. The session lifetime must be
|
6816
|
+
# in \[15-600\] minutes range.
|
6817
|
+
# @return [Integer]
|
6818
|
+
#
|
6819
|
+
# @!attribute [rw] namespace
|
6820
|
+
# The Amazon QuickSight namespace that the anonymous user virtually
|
6821
|
+
# belongs to. If you are not using an Amazon QuickSight custom
|
6822
|
+
# namespace, set this to `default`.
|
6823
|
+
# @return [String]
|
6824
|
+
#
|
6825
|
+
# @!attribute [rw] session_tags
|
6826
|
+
# The session tags used for row-level security. Before you use this
|
6827
|
+
# parameter, make sure that you have configured the relevant datasets
|
6828
|
+
# using the `DataSet$RowLevelPermissionTagConfiguration` parameter so
|
6829
|
+
# that session tags can be used to provide row-level security.
|
6830
|
+
#
|
6831
|
+
# These are not the tags used for the Amazon Web Services resource
|
6832
|
+
# tagging feature. For more information, see [Using Row-Level Security
|
6833
|
+
# (RLS) with Tags][1].
|
6834
|
+
#
|
6835
|
+
#
|
6836
|
+
#
|
6837
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
6838
|
+
# @return [Array<Types::SessionTag>]
|
6839
|
+
#
|
6840
|
+
# @!attribute [rw] authorized_resource_arns
|
6841
|
+
# The Amazon Resource Names for the Amazon QuickSight resources that
|
6842
|
+
# the user is authorized to access during the lifetime of the session.
|
6843
|
+
# If you choose `Dashboard` embedding experience, pass the list of
|
6844
|
+
# dashboard ARNs in the account that you want the user to be able to
|
6845
|
+
# view.
|
6846
|
+
# @return [Array<String>]
|
6847
|
+
#
|
6848
|
+
# @!attribute [rw] experience_configuration
|
6849
|
+
# The configuration of the experience you are embedding.
|
6850
|
+
# @return [Types::AnonymousUserEmbeddingExperienceConfiguration]
|
6851
|
+
#
|
6852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserRequest AWS API Documentation
|
6853
|
+
#
|
6854
|
+
class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
|
6855
|
+
:aws_account_id,
|
6856
|
+
:session_lifetime_in_minutes,
|
6857
|
+
:namespace,
|
6858
|
+
:session_tags,
|
6859
|
+
:authorized_resource_arns,
|
6860
|
+
:experience_configuration)
|
6861
|
+
SENSITIVE = []
|
6862
|
+
include Aws::Structure
|
6863
|
+
end
|
6864
|
+
|
6865
|
+
# @!attribute [rw] embed_url
|
6866
|
+
# The embed URL for the dashboard.
|
6867
|
+
# @return [String]
|
6868
|
+
#
|
6869
|
+
# @!attribute [rw] status
|
6870
|
+
# The HTTP status of the request.
|
6871
|
+
# @return [Integer]
|
6872
|
+
#
|
6873
|
+
# @!attribute [rw] request_id
|
6874
|
+
# The Amazon Web Services request ID for this operation.
|
6875
|
+
# @return [String]
|
6876
|
+
#
|
6877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserResponse AWS API Documentation
|
6878
|
+
#
|
6879
|
+
class GenerateEmbedUrlForAnonymousUserResponse < Struct.new(
|
6880
|
+
:embed_url,
|
6881
|
+
:status,
|
6882
|
+
:request_id)
|
6883
|
+
SENSITIVE = [:embed_url]
|
6884
|
+
include Aws::Structure
|
6885
|
+
end
|
6886
|
+
|
6887
|
+
# @note When making an API call, you may pass GenerateEmbedUrlForRegisteredUserRequest
|
6888
|
+
# data as a hash:
|
6889
|
+
#
|
6890
|
+
# {
|
6891
|
+
# aws_account_id: "AwsAccountId", # required
|
6892
|
+
# session_lifetime_in_minutes: 1,
|
6893
|
+
# user_arn: "Arn", # required
|
6894
|
+
# experience_configuration: { # required
|
6895
|
+
# dashboard: {
|
6896
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
6897
|
+
# },
|
6898
|
+
# quick_sight_console: {
|
6899
|
+
# initial_path: "EntryPath",
|
6900
|
+
# },
|
6901
|
+
# },
|
6902
|
+
# }
|
6903
|
+
#
|
6904
|
+
# @!attribute [rw] aws_account_id
|
6905
|
+
# The ID for the Amazon Web Services account that contains the
|
6906
|
+
# dashboard that you're embedding.
|
6907
|
+
# @return [String]
|
6908
|
+
#
|
6909
|
+
# @!attribute [rw] session_lifetime_in_minutes
|
6910
|
+
# How many minutes the session is valid. The session lifetime must be
|
6911
|
+
# in \[15-600\] minutes range.
|
6912
|
+
# @return [Integer]
|
6913
|
+
#
|
6914
|
+
# @!attribute [rw] user_arn
|
6915
|
+
# The Amazon Resource Name for the registered user.
|
6916
|
+
# @return [String]
|
6917
|
+
#
|
6918
|
+
# @!attribute [rw] experience_configuration
|
6919
|
+
# The experience you are embedding. For registered users, you can
|
6920
|
+
# embed Amazon QuickSight dashboards or the entire Amazon QuickSight
|
6921
|
+
# console.
|
6922
|
+
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
6923
|
+
#
|
6924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
6925
|
+
#
|
6926
|
+
class GenerateEmbedUrlForRegisteredUserRequest < Struct.new(
|
6927
|
+
:aws_account_id,
|
6928
|
+
:session_lifetime_in_minutes,
|
6929
|
+
:user_arn,
|
6930
|
+
:experience_configuration)
|
6931
|
+
SENSITIVE = []
|
6932
|
+
include Aws::Structure
|
6933
|
+
end
|
6934
|
+
|
6935
|
+
# @!attribute [rw] embed_url
|
6936
|
+
# The embed URL for the Amazon QuickSight dashboard or console.
|
6937
|
+
# @return [String]
|
6938
|
+
#
|
6939
|
+
# @!attribute [rw] status
|
6940
|
+
# The HTTP status of the request.
|
6941
|
+
# @return [Integer]
|
6942
|
+
#
|
6943
|
+
# @!attribute [rw] request_id
|
6944
|
+
# The Amazon Web Services request ID for this operation.
|
6945
|
+
# @return [String]
|
6946
|
+
#
|
6947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserResponse AWS API Documentation
|
6120
6948
|
#
|
6121
|
-
class
|
6122
|
-
:
|
6123
|
-
|
6949
|
+
class GenerateEmbedUrlForRegisteredUserResponse < Struct.new(
|
6950
|
+
:embed_url,
|
6951
|
+
:status,
|
6952
|
+
:request_id)
|
6953
|
+
SENSITIVE = [:embed_url]
|
6124
6954
|
include Aws::Structure
|
6125
6955
|
end
|
6126
6956
|
|
@@ -6174,12 +7004,12 @@ module Aws::QuickSight
|
|
6174
7004
|
# }
|
6175
7005
|
#
|
6176
7006
|
# @!attribute [rw] aws_account_id
|
6177
|
-
# The ID for the
|
6178
|
-
# embedding.
|
7007
|
+
# The ID for the Amazon Web Services account; that contains the
|
7008
|
+
# dashboard that you're embedding.
|
6179
7009
|
# @return [String]
|
6180
7010
|
#
|
6181
7011
|
# @!attribute [rw] dashboard_id
|
6182
|
-
# The ID for the dashboard, also added to the
|
7012
|
+
# The ID for the dashboard, also added to the Identity and Access
|
6183
7013
|
# Management (IAM) policy.
|
6184
7014
|
# @return [String]
|
6185
7015
|
#
|
@@ -6232,9 +7062,9 @@ module Aws::QuickSight
|
|
6232
7062
|
# @return [String]
|
6233
7063
|
#
|
6234
7064
|
# @!attribute [rw] namespace
|
6235
|
-
# The QuickSight namespace that
|
6236
|
-
#
|
6237
|
-
#
|
7065
|
+
# The Amazon QuickSight namespace that the user virtually belongs to.
|
7066
|
+
# If you are not using an Amazon QuickSight custom namespace, set this
|
7067
|
+
# to `default`.
|
6238
7068
|
# @return [String]
|
6239
7069
|
#
|
6240
7070
|
# @!attribute [rw] additional_dashboard_ids
|
@@ -6279,7 +7109,7 @@ module Aws::QuickSight
|
|
6279
7109
|
# @return [Integer]
|
6280
7110
|
#
|
6281
7111
|
# @!attribute [rw] request_id
|
6282
|
-
# The
|
7112
|
+
# The Amazon Web Services request ID for this operation.
|
6283
7113
|
# @return [String]
|
6284
7114
|
#
|
6285
7115
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlResponse AWS API Documentation
|
@@ -6303,8 +7133,8 @@ module Aws::QuickSight
|
|
6303
7133
|
# }
|
6304
7134
|
#
|
6305
7135
|
# @!attribute [rw] aws_account_id
|
6306
|
-
# The ID for the
|
6307
|
-
# subscription.
|
7136
|
+
# The ID for the Amazon Web Services account; associated with your
|
7137
|
+
# QuickSight subscription.
|
6308
7138
|
# @return [String]
|
6309
7139
|
#
|
6310
7140
|
# @!attribute [rw] entry_point
|
@@ -6341,9 +7171,9 @@ module Aws::QuickSight
|
|
6341
7171
|
#
|
6342
7172
|
# 2. Invited nonfederated users
|
6343
7173
|
#
|
6344
|
-
# 3.
|
6345
|
-
#
|
6346
|
-
#
|
7174
|
+
# 3. Identity and Access Management (IAM) users and IAM role-based
|
7175
|
+
# sessions authenticated through Federated Single Sign-On using
|
7176
|
+
# SAML, OpenID Connect, or IAM federation
|
6347
7177
|
#
|
6348
7178
|
# Omit this parameter for users in the third group, IAM users and IAM
|
6349
7179
|
# role-based sessions.
|
@@ -6373,7 +7203,7 @@ module Aws::QuickSight
|
|
6373
7203
|
# @return [Integer]
|
6374
7204
|
#
|
6375
7205
|
# @!attribute [rw] request_id
|
6376
|
-
# The
|
7206
|
+
# The Amazon Web Services request ID for this operation.
|
6377
7207
|
# @return [String]
|
6378
7208
|
#
|
6379
7209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlResponse AWS API Documentation
|
@@ -6458,10 +7288,10 @@ module Aws::QuickSight
|
|
6458
7288
|
include Aws::Structure
|
6459
7289
|
end
|
6460
7290
|
|
6461
|
-
# An
|
7291
|
+
# An Identity and Access Management (IAM) policy assignment.
|
6462
7292
|
#
|
6463
7293
|
# @!attribute [rw] aws_account_id
|
6464
|
-
# The
|
7294
|
+
# The Amazon Web Services account; ID.
|
6465
7295
|
# @return [String]
|
6466
7296
|
#
|
6467
7297
|
# @!attribute [rw] assignment_id
|
@@ -6523,7 +7353,7 @@ module Aws::QuickSight
|
|
6523
7353
|
# @return [String]
|
6524
7354
|
#
|
6525
7355
|
# @!attribute [rw] request_id
|
6526
|
-
# The
|
7356
|
+
# The Amazon Web Services request ID for this request.
|
6527
7357
|
# @return [String]
|
6528
7358
|
#
|
6529
7359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IdentityTypeNotSupportedException AWS API Documentation
|
@@ -6660,7 +7490,7 @@ module Aws::QuickSight
|
|
6660
7490
|
# @return [String]
|
6661
7491
|
#
|
6662
7492
|
# @!attribute [rw] request_id
|
6663
|
-
# The
|
7493
|
+
# The Amazon Web Services request ID for this request.
|
6664
7494
|
# @return [String]
|
6665
7495
|
#
|
6666
7496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InternalFailureException AWS API Documentation
|
@@ -6678,7 +7508,7 @@ module Aws::QuickSight
|
|
6678
7508
|
# @return [String]
|
6679
7509
|
#
|
6680
7510
|
# @!attribute [rw] request_id
|
6681
|
-
# The
|
7511
|
+
# The Amazon Web Services request ID for this request.
|
6682
7512
|
# @return [String]
|
6683
7513
|
#
|
6684
7514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidNextTokenException AWS API Documentation
|
@@ -6696,7 +7526,7 @@ module Aws::QuickSight
|
|
6696
7526
|
# @return [String]
|
6697
7527
|
#
|
6698
7528
|
# @!attribute [rw] request_id
|
6699
|
-
# The
|
7529
|
+
# The Amazon Web Services request ID for this request.
|
6700
7530
|
# @return [String]
|
6701
7531
|
#
|
6702
7532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidParameterValueException AWS API Documentation
|
@@ -6817,7 +7647,7 @@ module Aws::QuickSight
|
|
6817
7647
|
# @return [String]
|
6818
7648
|
#
|
6819
7649
|
# @!attribute [rw] request_id
|
6820
|
-
# The
|
7650
|
+
# The Amazon Web Services request ID for this request.
|
6821
7651
|
# @return [String]
|
6822
7652
|
#
|
6823
7653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LimitExceededException AWS API Documentation
|
@@ -6840,7 +7670,8 @@ module Aws::QuickSight
|
|
6840
7670
|
# }
|
6841
7671
|
#
|
6842
7672
|
# @!attribute [rw] aws_account_id
|
6843
|
-
# The ID of the
|
7673
|
+
# The ID of the Amazon Web Services account; that contains the
|
7674
|
+
# analyses.
|
6844
7675
|
# @return [String]
|
6845
7676
|
#
|
6846
7677
|
# @!attribute [rw] next_token
|
@@ -6874,7 +7705,7 @@ module Aws::QuickSight
|
|
6874
7705
|
# @return [Integer]
|
6875
7706
|
#
|
6876
7707
|
# @!attribute [rw] request_id
|
6877
|
-
# The
|
7708
|
+
# The Amazon Web Services request ID for this operation.
|
6878
7709
|
# @return [String]
|
6879
7710
|
#
|
6880
7711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesResponse AWS API Documentation
|
@@ -6899,8 +7730,8 @@ module Aws::QuickSight
|
|
6899
7730
|
# }
|
6900
7731
|
#
|
6901
7732
|
# @!attribute [rw] aws_account_id
|
6902
|
-
# The ID of the
|
6903
|
-
# listing versions for.
|
7733
|
+
# The ID of the Amazon Web Services account; that contains the
|
7734
|
+
# dashboard that you're listing versions for.
|
6904
7735
|
# @return [String]
|
6905
7736
|
#
|
6906
7737
|
# @!attribute [rw] dashboard_id
|
@@ -6942,7 +7773,7 @@ module Aws::QuickSight
|
|
6942
7773
|
# @return [Integer]
|
6943
7774
|
#
|
6944
7775
|
# @!attribute [rw] request_id
|
6945
|
-
# The
|
7776
|
+
# The Amazon Web Services request ID for this operation.
|
6946
7777
|
# @return [String]
|
6947
7778
|
#
|
6948
7779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersionsResponse AWS API Documentation
|
@@ -6966,8 +7797,8 @@ module Aws::QuickSight
|
|
6966
7797
|
# }
|
6967
7798
|
#
|
6968
7799
|
# @!attribute [rw] aws_account_id
|
6969
|
-
# The ID of the
|
6970
|
-
# listing.
|
7800
|
+
# The ID of the Amazon Web Services account; that contains the
|
7801
|
+
# dashboards that you're listing.
|
6971
7802
|
# @return [String]
|
6972
7803
|
#
|
6973
7804
|
# @!attribute [rw] next_token
|
@@ -6990,8 +7821,9 @@ module Aws::QuickSight
|
|
6990
7821
|
end
|
6991
7822
|
|
6992
7823
|
# @!attribute [rw] dashboard_summary_list
|
6993
|
-
# A structure that contains all of the dashboards in your
|
6994
|
-
# This structure provides basic information about
|
7824
|
+
# A structure that contains all of the dashboards in your Amazon Web
|
7825
|
+
# Services account;. This structure provides basic information about
|
7826
|
+
# the dashboards.
|
6995
7827
|
# @return [Array<Types::DashboardSummary>]
|
6996
7828
|
#
|
6997
7829
|
# @!attribute [rw] next_token
|
@@ -7004,7 +7836,7 @@ module Aws::QuickSight
|
|
7004
7836
|
# @return [Integer]
|
7005
7837
|
#
|
7006
7838
|
# @!attribute [rw] request_id
|
7007
|
-
# The
|
7839
|
+
# The Amazon Web Services request ID for this operation.
|
7008
7840
|
# @return [String]
|
7009
7841
|
#
|
7010
7842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardsResponse AWS API Documentation
|
@@ -7028,7 +7860,7 @@ module Aws::QuickSight
|
|
7028
7860
|
# }
|
7029
7861
|
#
|
7030
7862
|
# @!attribute [rw] aws_account_id
|
7031
|
-
# The
|
7863
|
+
# The Amazon Web Services account; ID.
|
7032
7864
|
# @return [String]
|
7033
7865
|
#
|
7034
7866
|
# @!attribute [rw] next_token
|
@@ -7060,7 +7892,7 @@ module Aws::QuickSight
|
|
7060
7892
|
# @return [String]
|
7061
7893
|
#
|
7062
7894
|
# @!attribute [rw] request_id
|
7063
|
-
# The
|
7895
|
+
# The Amazon Web Services request ID for this operation.
|
7064
7896
|
# @return [String]
|
7065
7897
|
#
|
7066
7898
|
# @!attribute [rw] status
|
@@ -7088,7 +7920,7 @@ module Aws::QuickSight
|
|
7088
7920
|
# }
|
7089
7921
|
#
|
7090
7922
|
# @!attribute [rw] aws_account_id
|
7091
|
-
# The
|
7923
|
+
# The Amazon Web Services account; ID.
|
7092
7924
|
# @return [String]
|
7093
7925
|
#
|
7094
7926
|
# @!attribute [rw] next_token
|
@@ -7120,7 +7952,7 @@ module Aws::QuickSight
|
|
7120
7952
|
# @return [String]
|
7121
7953
|
#
|
7122
7954
|
# @!attribute [rw] request_id
|
7123
|
-
# The
|
7955
|
+
# The Amazon Web Services request ID for this operation.
|
7124
7956
|
# @return [String]
|
7125
7957
|
#
|
7126
7958
|
# @!attribute [rw] status
|
@@ -7138,6 +7970,134 @@ module Aws::QuickSight
|
|
7138
7970
|
include Aws::Structure
|
7139
7971
|
end
|
7140
7972
|
|
7973
|
+
# @note When making an API call, you may pass ListFolderMembersRequest
|
7974
|
+
# data as a hash:
|
7975
|
+
#
|
7976
|
+
# {
|
7977
|
+
# aws_account_id: "AwsAccountId", # required
|
7978
|
+
# folder_id: "RestrictiveResourceId", # required
|
7979
|
+
# next_token: "String",
|
7980
|
+
# max_results: 1,
|
7981
|
+
# }
|
7982
|
+
#
|
7983
|
+
# @!attribute [rw] aws_account_id
|
7984
|
+
# The AWS account ID.
|
7985
|
+
# @return [String]
|
7986
|
+
#
|
7987
|
+
# @!attribute [rw] folder_id
|
7988
|
+
# The folder ID.
|
7989
|
+
# @return [String]
|
7990
|
+
#
|
7991
|
+
# @!attribute [rw] next_token
|
7992
|
+
# The token for the next set of results, or null if there are no more
|
7993
|
+
# results.
|
7994
|
+
# @return [String]
|
7995
|
+
#
|
7996
|
+
# @!attribute [rw] max_results
|
7997
|
+
# The maximum number of results to be returned per request.
|
7998
|
+
# @return [Integer]
|
7999
|
+
#
|
8000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembersRequest AWS API Documentation
|
8001
|
+
#
|
8002
|
+
class ListFolderMembersRequest < Struct.new(
|
8003
|
+
:aws_account_id,
|
8004
|
+
:folder_id,
|
8005
|
+
:next_token,
|
8006
|
+
:max_results)
|
8007
|
+
SENSITIVE = []
|
8008
|
+
include Aws::Structure
|
8009
|
+
end
|
8010
|
+
|
8011
|
+
# @!attribute [rw] status
|
8012
|
+
# The status. If succeeded, the status is `SC_OK`
|
8013
|
+
# @return [Integer]
|
8014
|
+
#
|
8015
|
+
# @!attribute [rw] folder_member_list
|
8016
|
+
# A structure that contains all of the folder members (dashboards,
|
8017
|
+
# analyses, and datasets) in the folder.
|
8018
|
+
# @return [Array<Types::MemberIdArnPair>]
|
8019
|
+
#
|
8020
|
+
# @!attribute [rw] next_token
|
8021
|
+
# The token for the next set of results, or null if there are no more
|
8022
|
+
# results.
|
8023
|
+
# @return [String]
|
8024
|
+
#
|
8025
|
+
# @!attribute [rw] request_id
|
8026
|
+
# The request ID.
|
8027
|
+
# @return [String]
|
8028
|
+
#
|
8029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembersResponse AWS API Documentation
|
8030
|
+
#
|
8031
|
+
class ListFolderMembersResponse < Struct.new(
|
8032
|
+
:status,
|
8033
|
+
:folder_member_list,
|
8034
|
+
:next_token,
|
8035
|
+
:request_id)
|
8036
|
+
SENSITIVE = []
|
8037
|
+
include Aws::Structure
|
8038
|
+
end
|
8039
|
+
|
8040
|
+
# @note When making an API call, you may pass ListFoldersRequest
|
8041
|
+
# data as a hash:
|
8042
|
+
#
|
8043
|
+
# {
|
8044
|
+
# aws_account_id: "AwsAccountId", # required
|
8045
|
+
# next_token: "String",
|
8046
|
+
# max_results: 1,
|
8047
|
+
# }
|
8048
|
+
#
|
8049
|
+
# @!attribute [rw] aws_account_id
|
8050
|
+
# The AWS account ID.
|
8051
|
+
# @return [String]
|
8052
|
+
#
|
8053
|
+
# @!attribute [rw] next_token
|
8054
|
+
# The token for the next set of results, or null if there are no more
|
8055
|
+
# results.
|
8056
|
+
# @return [String]
|
8057
|
+
#
|
8058
|
+
# @!attribute [rw] max_results
|
8059
|
+
# The maximum number of results to be returned per request.
|
8060
|
+
# @return [Integer]
|
8061
|
+
#
|
8062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFoldersRequest AWS API Documentation
|
8063
|
+
#
|
8064
|
+
class ListFoldersRequest < Struct.new(
|
8065
|
+
:aws_account_id,
|
8066
|
+
:next_token,
|
8067
|
+
:max_results)
|
8068
|
+
SENSITIVE = []
|
8069
|
+
include Aws::Structure
|
8070
|
+
end
|
8071
|
+
|
8072
|
+
# @!attribute [rw] status
|
8073
|
+
# The status. If succeeded, the status is `SC_OK`
|
8074
|
+
# @return [Integer]
|
8075
|
+
#
|
8076
|
+
# @!attribute [rw] folder_summary_list
|
8077
|
+
# A structure that contains all of the folders in your AWS account.
|
8078
|
+
# This structure provides basic information about the folders.
|
8079
|
+
# @return [Array<Types::FolderSummary>]
|
8080
|
+
#
|
8081
|
+
# @!attribute [rw] next_token
|
8082
|
+
# The token for the next set of results, or null if there are no more
|
8083
|
+
# results.
|
8084
|
+
# @return [String]
|
8085
|
+
#
|
8086
|
+
# @!attribute [rw] request_id
|
8087
|
+
# The request ID.
|
8088
|
+
# @return [String]
|
8089
|
+
#
|
8090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFoldersResponse AWS API Documentation
|
8091
|
+
#
|
8092
|
+
class ListFoldersResponse < Struct.new(
|
8093
|
+
:status,
|
8094
|
+
:folder_summary_list,
|
8095
|
+
:next_token,
|
8096
|
+
:request_id)
|
8097
|
+
SENSITIVE = []
|
8098
|
+
include Aws::Structure
|
8099
|
+
end
|
8100
|
+
|
7141
8101
|
# @note When making an API call, you may pass ListGroupMembershipsRequest
|
7142
8102
|
# data as a hash:
|
7143
8103
|
#
|
@@ -7162,9 +8122,9 @@ module Aws::QuickSight
|
|
7162
8122
|
# @return [Integer]
|
7163
8123
|
#
|
7164
8124
|
# @!attribute [rw] aws_account_id
|
7165
|
-
# The ID for the
|
7166
|
-
# the ID for the
|
7167
|
-
# account.
|
8125
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
8126
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
8127
|
+
# contains your Amazon QuickSight account.
|
7168
8128
|
# @return [String]
|
7169
8129
|
#
|
7170
8130
|
# @!attribute [rw] namespace
|
@@ -7192,7 +8152,7 @@ module Aws::QuickSight
|
|
7192
8152
|
# @return [String]
|
7193
8153
|
#
|
7194
8154
|
# @!attribute [rw] request_id
|
7195
|
-
# The
|
8155
|
+
# The Amazon Web Services request ID for this operation.
|
7196
8156
|
# @return [String]
|
7197
8157
|
#
|
7198
8158
|
# @!attribute [rw] status
|
@@ -7221,9 +8181,9 @@ module Aws::QuickSight
|
|
7221
8181
|
# }
|
7222
8182
|
#
|
7223
8183
|
# @!attribute [rw] aws_account_id
|
7224
|
-
# The ID for the
|
7225
|
-
# the ID for the
|
7226
|
-
# account.
|
8184
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
8185
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
8186
|
+
# contains your Amazon QuickSight account.
|
7227
8187
|
# @return [String]
|
7228
8188
|
#
|
7229
8189
|
# @!attribute [rw] next_token
|
@@ -7258,7 +8218,7 @@ module Aws::QuickSight
|
|
7258
8218
|
# @return [String]
|
7259
8219
|
#
|
7260
8220
|
# @!attribute [rw] request_id
|
7261
|
-
# The
|
8221
|
+
# The Amazon Web Services request ID for this operation.
|
7262
8222
|
# @return [String]
|
7263
8223
|
#
|
7264
8224
|
# @!attribute [rw] status
|
@@ -7288,7 +8248,8 @@ module Aws::QuickSight
|
|
7288
8248
|
# }
|
7289
8249
|
#
|
7290
8250
|
# @!attribute [rw] aws_account_id
|
7291
|
-
# The ID of the
|
8251
|
+
# The ID of the Amazon Web Services account; that contains the
|
8252
|
+
# assignments.
|
7292
8253
|
# @return [String]
|
7293
8254
|
#
|
7294
8255
|
# @!attribute [rw] user_name
|
@@ -7325,7 +8286,7 @@ module Aws::QuickSight
|
|
7325
8286
|
# @return [Array<Types::ActiveIAMPolicyAssignment>]
|
7326
8287
|
#
|
7327
8288
|
# @!attribute [rw] request_id
|
7328
|
-
# The
|
8289
|
+
# The Amazon Web Services request ID for this operation.
|
7329
8290
|
# @return [String]
|
7330
8291
|
#
|
7331
8292
|
# @!attribute [rw] next_token
|
@@ -7360,8 +8321,8 @@ module Aws::QuickSight
|
|
7360
8321
|
# }
|
7361
8322
|
#
|
7362
8323
|
# @!attribute [rw] aws_account_id
|
7363
|
-
# The ID of the
|
7364
|
-
# assignments.
|
8324
|
+
# The ID of the Amazon Web Services account; that contains these IAM
|
8325
|
+
# policy assignments.
|
7365
8326
|
# @return [String]
|
7366
8327
|
#
|
7367
8328
|
# @!attribute [rw] assignment_status
|
@@ -7403,7 +8364,7 @@ module Aws::QuickSight
|
|
7403
8364
|
# @return [String]
|
7404
8365
|
#
|
7405
8366
|
# @!attribute [rw] request_id
|
7406
|
-
# The
|
8367
|
+
# The Amazon Web Services request ID for this operation.
|
7407
8368
|
# @return [String]
|
7408
8369
|
#
|
7409
8370
|
# @!attribute [rw] status
|
@@ -7441,7 +8402,7 @@ module Aws::QuickSight
|
|
7441
8402
|
# @return [String]
|
7442
8403
|
#
|
7443
8404
|
# @!attribute [rw] aws_account_id
|
7444
|
-
# The
|
8405
|
+
# The Amazon Web Services account; ID.
|
7445
8406
|
# @return [String]
|
7446
8407
|
#
|
7447
8408
|
# @!attribute [rw] max_results
|
@@ -7469,7 +8430,7 @@ module Aws::QuickSight
|
|
7469
8430
|
# @return [String]
|
7470
8431
|
#
|
7471
8432
|
# @!attribute [rw] request_id
|
7472
|
-
# The
|
8433
|
+
# The Amazon Web Services request ID for this operation.
|
7473
8434
|
# @return [String]
|
7474
8435
|
#
|
7475
8436
|
# @!attribute [rw] status
|
@@ -7497,8 +8458,8 @@ module Aws::QuickSight
|
|
7497
8458
|
# }
|
7498
8459
|
#
|
7499
8460
|
# @!attribute [rw] aws_account_id
|
7500
|
-
# The ID for the
|
7501
|
-
# that you want to list.
|
8461
|
+
# The ID for the Amazon Web Services account; that contains the
|
8462
|
+
# QuickSight namespaces that you want to list.
|
7502
8463
|
# @return [String]
|
7503
8464
|
#
|
7504
8465
|
# @!attribute [rw] next_token
|
@@ -7520,9 +8481,9 @@ module Aws::QuickSight
|
|
7520
8481
|
end
|
7521
8482
|
|
7522
8483
|
# @!attribute [rw] namespaces
|
7523
|
-
# The information about the namespaces in this
|
7524
|
-
# response includes the namespace ARN, name,
|
7525
|
-
# email address, creation status, and identity store.
|
8484
|
+
# The information about the namespaces in this Amazon Web Services
|
8485
|
+
# account;. The response includes the namespace ARN, name, Region;,
|
8486
|
+
# notification email address, creation status, and identity store.
|
7526
8487
|
# @return [Array<Types::NamespaceInfoV2>]
|
7527
8488
|
#
|
7528
8489
|
# @!attribute [rw] next_token
|
@@ -7530,7 +8491,7 @@ module Aws::QuickSight
|
|
7530
8491
|
# @return [String]
|
7531
8492
|
#
|
7532
8493
|
# @!attribute [rw] request_id
|
7533
|
-
# The
|
8494
|
+
# The Amazon Web Services request ID for this operation.
|
7534
8495
|
# @return [String]
|
7535
8496
|
#
|
7536
8497
|
# @!attribute [rw] status
|
@@ -7574,7 +8535,7 @@ module Aws::QuickSight
|
|
7574
8535
|
# @return [Array<Types::Tag>]
|
7575
8536
|
#
|
7576
8537
|
# @!attribute [rw] request_id
|
7577
|
-
# The
|
8538
|
+
# The Amazon Web Services request ID for this operation.
|
7578
8539
|
# @return [String]
|
7579
8540
|
#
|
7580
8541
|
# @!attribute [rw] status
|
@@ -7602,8 +8563,8 @@ module Aws::QuickSight
|
|
7602
8563
|
# }
|
7603
8564
|
#
|
7604
8565
|
# @!attribute [rw] aws_account_id
|
7605
|
-
# The ID of the
|
7606
|
-
# you're listing.
|
8566
|
+
# The ID of the Amazon Web Services account; that contains the
|
8567
|
+
# template aliases that you're listing.
|
7607
8568
|
# @return [String]
|
7608
8569
|
#
|
7609
8570
|
# @!attribute [rw] template_id
|
@@ -7639,7 +8600,7 @@ module Aws::QuickSight
|
|
7639
8600
|
# @return [Integer]
|
7640
8601
|
#
|
7641
8602
|
# @!attribute [rw] request_id
|
7642
|
-
# The
|
8603
|
+
# The Amazon Web Services request ID for this operation.
|
7643
8604
|
# @return [String]
|
7644
8605
|
#
|
7645
8606
|
# @!attribute [rw] next_token
|
@@ -7669,8 +8630,8 @@ module Aws::QuickSight
|
|
7669
8630
|
# }
|
7670
8631
|
#
|
7671
8632
|
# @!attribute [rw] aws_account_id
|
7672
|
-
# The ID of the
|
7673
|
-
# listing.
|
8633
|
+
# The ID of the Amazon Web Services account; that contains the
|
8634
|
+
# templates that you're listing.
|
7674
8635
|
# @return [String]
|
7675
8636
|
#
|
7676
8637
|
# @!attribute [rw] template_id
|
@@ -7712,7 +8673,7 @@ module Aws::QuickSight
|
|
7712
8673
|
# @return [Integer]
|
7713
8674
|
#
|
7714
8675
|
# @!attribute [rw] request_id
|
7715
|
-
# The
|
8676
|
+
# The Amazon Web Services request ID for this operation.
|
7716
8677
|
# @return [String]
|
7717
8678
|
#
|
7718
8679
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersionsResponse AWS API Documentation
|
@@ -7736,8 +8697,8 @@ module Aws::QuickSight
|
|
7736
8697
|
# }
|
7737
8698
|
#
|
7738
8699
|
# @!attribute [rw] aws_account_id
|
7739
|
-
# The ID of the
|
7740
|
-
# listing.
|
8700
|
+
# The ID of the Amazon Web Services account; that contains the
|
8701
|
+
# templates that you're listing.
|
7741
8702
|
# @return [String]
|
7742
8703
|
#
|
7743
8704
|
# @!attribute [rw] next_token
|
@@ -7773,7 +8734,7 @@ module Aws::QuickSight
|
|
7773
8734
|
# @return [Integer]
|
7774
8735
|
#
|
7775
8736
|
# @!attribute [rw] request_id
|
7776
|
-
# The
|
8737
|
+
# The Amazon Web Services request ID for this operation.
|
7777
8738
|
# @return [String]
|
7778
8739
|
#
|
7779
8740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplatesResponse AWS API Documentation
|
@@ -7798,8 +8759,8 @@ module Aws::QuickSight
|
|
7798
8759
|
# }
|
7799
8760
|
#
|
7800
8761
|
# @!attribute [rw] aws_account_id
|
7801
|
-
# The ID of the
|
7802
|
-
# you're listing.
|
8762
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
8763
|
+
# aliases that you're listing.
|
7803
8764
|
# @return [String]
|
7804
8765
|
#
|
7805
8766
|
# @!attribute [rw] theme_id
|
@@ -7835,7 +8796,7 @@ module Aws::QuickSight
|
|
7835
8796
|
# @return [Integer]
|
7836
8797
|
#
|
7837
8798
|
# @!attribute [rw] request_id
|
7838
|
-
# The
|
8799
|
+
# The Amazon Web Services request ID for this operation.
|
7839
8800
|
# @return [String]
|
7840
8801
|
#
|
7841
8802
|
# @!attribute [rw] next_token
|
@@ -7865,8 +8826,8 @@ module Aws::QuickSight
|
|
7865
8826
|
# }
|
7866
8827
|
#
|
7867
8828
|
# @!attribute [rw] aws_account_id
|
7868
|
-
# The ID of the
|
7869
|
-
# listing.
|
8829
|
+
# The ID of the Amazon Web Services account; that contains the themes
|
8830
|
+
# that you're listing.
|
7870
8831
|
# @return [String]
|
7871
8832
|
#
|
7872
8833
|
# @!attribute [rw] theme_id
|
@@ -7908,7 +8869,7 @@ module Aws::QuickSight
|
|
7908
8869
|
# @return [Integer]
|
7909
8870
|
#
|
7910
8871
|
# @!attribute [rw] request_id
|
7911
|
-
# The
|
8872
|
+
# The Amazon Web Services request ID for this operation.
|
7912
8873
|
# @return [String]
|
7913
8874
|
#
|
7914
8875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersionsResponse AWS API Documentation
|
@@ -7933,8 +8894,8 @@ module Aws::QuickSight
|
|
7933
8894
|
# }
|
7934
8895
|
#
|
7935
8896
|
# @!attribute [rw] aws_account_id
|
7936
|
-
# The ID of the
|
7937
|
-
# listing.
|
8897
|
+
# The ID of the Amazon Web Services account; that contains the themes
|
8898
|
+
# that you're listing.
|
7938
8899
|
# @return [String]
|
7939
8900
|
#
|
7940
8901
|
# @!attribute [rw] next_token
|
@@ -7955,7 +8916,7 @@ module Aws::QuickSight
|
|
7955
8916
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
7956
8917
|
# QuickSight.
|
7957
8918
|
#
|
7958
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
8919
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by Amazon
|
7959
8920
|
# QuickSight.
|
7960
8921
|
# @return [String]
|
7961
8922
|
#
|
@@ -7984,7 +8945,7 @@ module Aws::QuickSight
|
|
7984
8945
|
# @return [Integer]
|
7985
8946
|
#
|
7986
8947
|
# @!attribute [rw] request_id
|
7987
|
-
# The
|
8948
|
+
# The Amazon Web Services request ID for this operation.
|
7988
8949
|
# @return [String]
|
7989
8950
|
#
|
7990
8951
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemesResponse AWS API Documentation
|
@@ -8015,8 +8976,9 @@ module Aws::QuickSight
|
|
8015
8976
|
# @return [String]
|
8016
8977
|
#
|
8017
8978
|
# @!attribute [rw] aws_account_id
|
8018
|
-
# The
|
8019
|
-
# for the
|
8979
|
+
# The Amazon Web Services account; ID that the user is in. Currently,
|
8980
|
+
# you use the ID for the Amazon Web Services account; that contains
|
8981
|
+
# your Amazon QuickSight account.
|
8020
8982
|
# @return [String]
|
8021
8983
|
#
|
8022
8984
|
# @!attribute [rw] namespace
|
@@ -8052,7 +9014,7 @@ module Aws::QuickSight
|
|
8052
9014
|
# @return [String]
|
8053
9015
|
#
|
8054
9016
|
# @!attribute [rw] request_id
|
8055
|
-
# The
|
9017
|
+
# The Amazon Web Services request ID for this operation.
|
8056
9018
|
# @return [String]
|
8057
9019
|
#
|
8058
9020
|
# @!attribute [rw] status
|
@@ -8081,9 +9043,9 @@ module Aws::QuickSight
|
|
8081
9043
|
# }
|
8082
9044
|
#
|
8083
9045
|
# @!attribute [rw] aws_account_id
|
8084
|
-
# The ID for the
|
8085
|
-
# the ID for the
|
8086
|
-
# account.
|
9046
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
9047
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
9048
|
+
# contains your Amazon QuickSight account.
|
8087
9049
|
# @return [String]
|
8088
9050
|
#
|
8089
9051
|
# @!attribute [rw] next_token
|
@@ -8118,7 +9080,7 @@ module Aws::QuickSight
|
|
8118
9080
|
# @return [String]
|
8119
9081
|
#
|
8120
9082
|
# @!attribute [rw] request_id
|
8121
|
-
# The
|
9083
|
+
# The Amazon Web Services request ID for this operation.
|
8122
9084
|
# @return [String]
|
8123
9085
|
#
|
8124
9086
|
# @!attribute [rw] status
|
@@ -8346,6 +9308,26 @@ module Aws::QuickSight
|
|
8346
9308
|
include Aws::Structure
|
8347
9309
|
end
|
8348
9310
|
|
9311
|
+
# An object that consists of the member Amazon Resource Name (ARN) and
|
9312
|
+
# member ID.
|
9313
|
+
#
|
9314
|
+
# @!attribute [rw] member_id
|
9315
|
+
# The ID of the member.
|
9316
|
+
# @return [String]
|
9317
|
+
#
|
9318
|
+
# @!attribute [rw] member_arn
|
9319
|
+
# The Amazon Resource Name (ARN) of the member.
|
9320
|
+
# @return [String]
|
9321
|
+
#
|
9322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/MemberIdArnPair AWS API Documentation
|
9323
|
+
#
|
9324
|
+
class MemberIdArnPair < Struct.new(
|
9325
|
+
:member_id,
|
9326
|
+
:member_arn)
|
9327
|
+
SENSITIVE = []
|
9328
|
+
include Aws::Structure
|
9329
|
+
end
|
9330
|
+
|
8349
9331
|
# MySQL parameters.
|
8350
9332
|
#
|
8351
9333
|
# @note When making an API call, you may pass MySqlParameters
|
@@ -8409,7 +9391,7 @@ module Aws::QuickSight
|
|
8409
9391
|
# @return [String]
|
8410
9392
|
#
|
8411
9393
|
# @!attribute [rw] capacity_region
|
8412
|
-
# The namespace
|
9394
|
+
# The namespace Region;.
|
8413
9395
|
# @return [String]
|
8414
9396
|
#
|
8415
9397
|
# @!attribute [rw] creation_status
|
@@ -8666,7 +9648,7 @@ module Aws::QuickSight
|
|
8666
9648
|
# @return [String]
|
8667
9649
|
#
|
8668
9650
|
# @!attribute [rw] request_id
|
8669
|
-
# The
|
9651
|
+
# The Amazon Web Services request ID for this request.
|
8670
9652
|
# @return [String]
|
8671
9653
|
#
|
8672
9654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PreconditionNotMetException AWS API Documentation
|
@@ -8761,7 +9743,7 @@ module Aws::QuickSight
|
|
8761
9743
|
# @return [String]
|
8762
9744
|
#
|
8763
9745
|
# @!attribute [rw] request_id
|
8764
|
-
# The
|
9746
|
+
# The Amazon Web Services request ID for this request.
|
8765
9747
|
# @return [String]
|
8766
9748
|
#
|
8767
9749
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/QuickSightUserNotFoundException AWS API Documentation
|
@@ -8855,6 +9837,9 @@ module Aws::QuickSight
|
|
8855
9837
|
# namespace: "Namespace", # required
|
8856
9838
|
# user_name: "UserName",
|
8857
9839
|
# custom_permissions_name: "RoleName",
|
9840
|
+
# external_login_federation_provider_type: "String",
|
9841
|
+
# custom_federation_provider_url: "String",
|
9842
|
+
# external_login_id: "String",
|
8858
9843
|
# }
|
8859
9844
|
#
|
8860
9845
|
# @!attribute [rw] identity_type
|
@@ -8911,9 +9896,9 @@ module Aws::QuickSight
|
|
8911
9896
|
# @return [String]
|
8912
9897
|
#
|
8913
9898
|
# @!attribute [rw] aws_account_id
|
8914
|
-
# The ID for the
|
8915
|
-
# the ID for the
|
8916
|
-
# account.
|
9899
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
9900
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
9901
|
+
# contains your Amazon QuickSight account.
|
8917
9902
|
# @return [String]
|
8918
9903
|
#
|
8919
9904
|
# @!attribute [rw] namespace
|
@@ -8954,8 +9939,36 @@ module Aws::QuickSight
|
|
8954
9939
|
# QuickSight (admin, author, reader).
|
8955
9940
|
#
|
8956
9941
|
# This feature is available only to QuickSight Enterprise edition
|
8957
|
-
# subscriptions
|
8958
|
-
#
|
9942
|
+
# subscriptions.
|
9943
|
+
# @return [String]
|
9944
|
+
#
|
9945
|
+
# @!attribute [rw] external_login_federation_provider_type
|
9946
|
+
# The type of supported external login provider that provides identity
|
9947
|
+
# to let a user federate into Amazon QuickSight with an associated AWS
|
9948
|
+
# Identity and Access Management (IAM) role. The type of supported
|
9949
|
+
# external login provider can be one of the following.
|
9950
|
+
#
|
9951
|
+
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
9952
|
+
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
9953
|
+
# provider type, don’t use the "CustomFederationProviderUrl"
|
9954
|
+
# parameter which is only needed when the external provider is
|
9955
|
+
# custom.
|
9956
|
+
#
|
9957
|
+
# * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
|
9958
|
+
# choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
|
9959
|
+
# parameter to provide the custom OIDC provider URL.
|
9960
|
+
# @return [String]
|
9961
|
+
#
|
9962
|
+
# @!attribute [rw] custom_federation_provider_url
|
9963
|
+
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
9964
|
+
# identity to let a user federate into QuickSight with an associated
|
9965
|
+
# AWS Identity and Access Management (IAM) role. This parameter should
|
9966
|
+
# only be used when `ExternalLoginFederationProviderType` parameter is
|
9967
|
+
# set to `CUSTOM_OIDC`.
|
9968
|
+
# @return [String]
|
9969
|
+
#
|
9970
|
+
# @!attribute [rw] external_login_id
|
9971
|
+
# The identity ID for a user in the external login provider.
|
8959
9972
|
# @return [String]
|
8960
9973
|
#
|
8961
9974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
|
@@ -8969,7 +9982,10 @@ module Aws::QuickSight
|
|
8969
9982
|
:aws_account_id,
|
8970
9983
|
:namespace,
|
8971
9984
|
:user_name,
|
8972
|
-
:custom_permissions_name
|
9985
|
+
:custom_permissions_name,
|
9986
|
+
:external_login_federation_provider_type,
|
9987
|
+
:custom_federation_provider_url,
|
9988
|
+
:external_login_id)
|
8973
9989
|
SENSITIVE = []
|
8974
9990
|
include Aws::Structure
|
8975
9991
|
end
|
@@ -8985,7 +10001,7 @@ module Aws::QuickSight
|
|
8985
10001
|
# @return [String]
|
8986
10002
|
#
|
8987
10003
|
# @!attribute [rw] request_id
|
8988
|
-
# The
|
10004
|
+
# The Amazon Web Services request ID for this operation.
|
8989
10005
|
# @return [String]
|
8990
10006
|
#
|
8991
10007
|
# @!attribute [rw] status
|
@@ -9003,6 +10019,142 @@ module Aws::QuickSight
|
|
9003
10019
|
include Aws::Structure
|
9004
10020
|
end
|
9005
10021
|
|
10022
|
+
# Information about the dashboard you want to embed.
|
10023
|
+
#
|
10024
|
+
# @note When making an API call, you may pass RegisteredUserDashboardEmbeddingConfiguration
|
10025
|
+
# data as a hash:
|
10026
|
+
#
|
10027
|
+
# {
|
10028
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
10029
|
+
# }
|
10030
|
+
#
|
10031
|
+
# @!attribute [rw] initial_dashboard_id
|
10032
|
+
# The dashboard ID for the dashboard that you want the user to see
|
10033
|
+
# first. This ID is included in the output URL. When the URL in
|
10034
|
+
# response is accessed, Amazon QuickSight renders this dashboard if
|
10035
|
+
# the user has permissions to view it.
|
10036
|
+
#
|
10037
|
+
# If the user does not have permission to view this dashboard, they
|
10038
|
+
# see a permissions error message.
|
10039
|
+
# @return [String]
|
10040
|
+
#
|
10041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardEmbeddingConfiguration AWS API Documentation
|
10042
|
+
#
|
10043
|
+
class RegisteredUserDashboardEmbeddingConfiguration < Struct.new(
|
10044
|
+
:initial_dashboard_id)
|
10045
|
+
SENSITIVE = []
|
10046
|
+
include Aws::Structure
|
10047
|
+
end
|
10048
|
+
|
10049
|
+
# The type of experience you want to embed. For registered users, you
|
10050
|
+
# can embed an Amazon QuickSight dashboard or the Amazon QuickSight
|
10051
|
+
# console.
|
10052
|
+
#
|
10053
|
+
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
10054
|
+
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
10055
|
+
# one experience configuraton.
|
10056
|
+
#
|
10057
|
+
# </note>
|
10058
|
+
#
|
10059
|
+
# @note When making an API call, you may pass RegisteredUserEmbeddingExperienceConfiguration
|
10060
|
+
# data as a hash:
|
10061
|
+
#
|
10062
|
+
# {
|
10063
|
+
# dashboard: {
|
10064
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
10065
|
+
# },
|
10066
|
+
# quick_sight_console: {
|
10067
|
+
# initial_path: "EntryPath",
|
10068
|
+
# },
|
10069
|
+
# }
|
10070
|
+
#
|
10071
|
+
# @!attribute [rw] dashboard
|
10072
|
+
# The configuration details for providing a dashboard embedding
|
10073
|
+
# experience.
|
10074
|
+
# @return [Types::RegisteredUserDashboardEmbeddingConfiguration]
|
10075
|
+
#
|
10076
|
+
# @!attribute [rw] quick_sight_console
|
10077
|
+
# The configuration details for providing an Amazon QuickSight console
|
10078
|
+
# embedding experience. This can be used along with custom permissions
|
10079
|
+
# to restrict access to certain features. For more information, see
|
10080
|
+
# [Customizing Access to the Amazon QuickSight Console][1] in the
|
10081
|
+
# *Amazon QuickSight User Guide*.
|
10082
|
+
#
|
10083
|
+
# Use `GenerateEmbedUrlForRegisteredUser` where you want to provide an
|
10084
|
+
# authoring portal that allows users to create data sources, datasets,
|
10085
|
+
# analyses, and dashboards. The users who accesses an embedded Amazon
|
10086
|
+
# QuickSight console needs to belong to the author or admin security
|
10087
|
+
# cohort. If you want to restrict permissions to some of these
|
10088
|
+
# features, add a custom permissions profile to the user with the `
|
10089
|
+
# UpdateUser ` API operation. Use ` RegisterUser ` API operation to
|
10090
|
+
# add a new user with a custom permission profile attached. For more
|
10091
|
+
# information, see the following sections in the *Amazon QuickSight
|
10092
|
+
# User Guide*\:
|
10093
|
+
#
|
10094
|
+
# * [Embedding the Full Functionality of the Amazon QuickSight Console
|
10095
|
+
# for Authenticated Users][2]
|
10096
|
+
#
|
10097
|
+
# * [Customizing Access to the Amazon QuickSight Console][1]
|
10098
|
+
#
|
10099
|
+
# For more information about the high-level steps for embedding and
|
10100
|
+
# for an interactive demo of the ways you can customize embedding,
|
10101
|
+
# visit the [Amazon QuickSight Developer Portal][3].
|
10102
|
+
#
|
10103
|
+
#
|
10104
|
+
#
|
10105
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
10106
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html
|
10107
|
+
# [3]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
10108
|
+
# @return [Types::RegisteredUserQuickSightConsoleEmbeddingConfiguration]
|
10109
|
+
#
|
10110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
|
10111
|
+
#
|
10112
|
+
class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
|
10113
|
+
:dashboard,
|
10114
|
+
:quick_sight_console)
|
10115
|
+
SENSITIVE = []
|
10116
|
+
include Aws::Structure
|
10117
|
+
end
|
10118
|
+
|
10119
|
+
# Information about the Amazon QuickSight console that you want to
|
10120
|
+
# embed.
|
10121
|
+
#
|
10122
|
+
# @note When making an API call, you may pass RegisteredUserQuickSightConsoleEmbeddingConfiguration
|
10123
|
+
# data as a hash:
|
10124
|
+
#
|
10125
|
+
# {
|
10126
|
+
# initial_path: "EntryPath",
|
10127
|
+
# }
|
10128
|
+
#
|
10129
|
+
# @!attribute [rw] initial_path
|
10130
|
+
# The initial URL path for the Amazon QuickSight console.
|
10131
|
+
# `InitialPath` is required.
|
10132
|
+
#
|
10133
|
+
# The entry point URL is constrained to the following paths:
|
10134
|
+
#
|
10135
|
+
# * `/start`
|
10136
|
+
#
|
10137
|
+
# * `/start/analyses`
|
10138
|
+
#
|
10139
|
+
# * `/start/dashboards`
|
10140
|
+
#
|
10141
|
+
# * `/start/favorites`
|
10142
|
+
#
|
10143
|
+
# * `/dashboards/DashboardId`. *DashboardId* is the actual ID key from
|
10144
|
+
# the Amazon QuickSight console URL of the dashboard.
|
10145
|
+
#
|
10146
|
+
# * `/analyses/AnalysisId`. *AnalysisId* is the actual ID key from the
|
10147
|
+
# Amazon QuickSight console URL of the analysis.
|
10148
|
+
# @return [String]
|
10149
|
+
#
|
10150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQuickSightConsoleEmbeddingConfiguration AWS API Documentation
|
10151
|
+
#
|
10152
|
+
class RegisteredUserQuickSightConsoleEmbeddingConfiguration < Struct.new(
|
10153
|
+
:initial_path)
|
10154
|
+
SENSITIVE = []
|
10155
|
+
include Aws::Structure
|
10156
|
+
end
|
10157
|
+
|
9006
10158
|
# A physical table type for relational data sources.
|
9007
10159
|
#
|
9008
10160
|
# @note When making an API call, you may pass RelationalTable
|
@@ -9091,7 +10243,7 @@ module Aws::QuickSight
|
|
9091
10243
|
# @return [String]
|
9092
10244
|
#
|
9093
10245
|
# @!attribute [rw] request_id
|
9094
|
-
# The
|
10246
|
+
# The Amazon Web Services request ID for this request.
|
9095
10247
|
# @return [String]
|
9096
10248
|
#
|
9097
10249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceExistsException AWS API Documentation
|
@@ -9114,7 +10266,7 @@ module Aws::QuickSight
|
|
9114
10266
|
# @return [String]
|
9115
10267
|
#
|
9116
10268
|
# @!attribute [rw] request_id
|
9117
|
-
# The
|
10269
|
+
# The Amazon Web Services request ID for this request.
|
9118
10270
|
# @return [String]
|
9119
10271
|
#
|
9120
10272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceNotFoundException AWS API Documentation
|
@@ -9148,9 +10300,10 @@ module Aws::QuickSight
|
|
9148
10300
|
# associated with an analysis, dashboard, template, or theme. (This
|
9149
10301
|
# is common.)
|
9150
10302
|
#
|
9151
|
-
# * The ARN of an
|
9152
|
-
# QuickSight ARN. Use this option only to share
|
9153
|
-
# (templates) across
|
10303
|
+
# * The ARN of an Amazon Web Services account; root: This is an IAM
|
10304
|
+
# ARN rather than a QuickSight ARN. Use this option only to share
|
10305
|
+
# resources (templates) across Amazon Web Services accounts. (This
|
10306
|
+
# is less common.)
|
9154
10307
|
# @return [String]
|
9155
10308
|
#
|
9156
10309
|
# @!attribute [rw] actions
|
@@ -9176,7 +10329,7 @@ module Aws::QuickSight
|
|
9176
10329
|
# @return [String]
|
9177
10330
|
#
|
9178
10331
|
# @!attribute [rw] request_id
|
9179
|
-
# The
|
10332
|
+
# The Amazon Web Services request ID for this request.
|
9180
10333
|
# @return [String]
|
9181
10334
|
#
|
9182
10335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceUnavailableException AWS API Documentation
|
@@ -9198,7 +10351,8 @@ module Aws::QuickSight
|
|
9198
10351
|
# }
|
9199
10352
|
#
|
9200
10353
|
# @!attribute [rw] aws_account_id
|
9201
|
-
# The ID of the
|
10354
|
+
# The ID of the Amazon Web Services account; that contains the
|
10355
|
+
# analysis.
|
9202
10356
|
# @return [String]
|
9203
10357
|
#
|
9204
10358
|
# @!attribute [rw] analysis_id
|
@@ -9228,7 +10382,7 @@ module Aws::QuickSight
|
|
9228
10382
|
# @return [String]
|
9229
10383
|
#
|
9230
10384
|
# @!attribute [rw] request_id
|
9231
|
-
# The
|
10385
|
+
# The Amazon Web Services request ID for this operation.
|
9232
10386
|
# @return [String]
|
9233
10387
|
#
|
9234
10388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisResponse AWS API Documentation
|
@@ -9267,44 +10421,142 @@ module Aws::QuickSight
|
|
9267
10421
|
# Restrict Access to a Dataset][1] in the *Amazon QuickSight User
|
9268
10422
|
# Guide*.
|
9269
10423
|
#
|
9270
|
-
# The option to deny permissions by setting `PermissionPolicy` to
|
9271
|
-
# `DENY_ACCESS` is not supported for new RLS datasets.
|
10424
|
+
# The option to deny permissions by setting `PermissionPolicy` to
|
10425
|
+
# `DENY_ACCESS` is not supported for new RLS datasets.
|
10426
|
+
#
|
10427
|
+
#
|
10428
|
+
#
|
10429
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html
|
10430
|
+
#
|
10431
|
+
# @note When making an API call, you may pass RowLevelPermissionDataSet
|
10432
|
+
# data as a hash:
|
10433
|
+
#
|
10434
|
+
# {
|
10435
|
+
# namespace: "Namespace",
|
10436
|
+
# arn: "Arn", # required
|
10437
|
+
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
10438
|
+
# format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
|
10439
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
10440
|
+
# }
|
10441
|
+
#
|
10442
|
+
# @!attribute [rw] namespace
|
10443
|
+
# The namespace associated with the dataset that contains permissions
|
10444
|
+
# for RLS.
|
10445
|
+
# @return [String]
|
10446
|
+
#
|
10447
|
+
# @!attribute [rw] arn
|
10448
|
+
# The Amazon Resource Name (ARN) of the dataset that contains
|
10449
|
+
# permissions for RLS.
|
10450
|
+
# @return [String]
|
10451
|
+
#
|
10452
|
+
# @!attribute [rw] permission_policy
|
10453
|
+
# The type of permissions to use when interpretting the permissions
|
10454
|
+
# for RLS. `DENY_ACCESS` is included for backward compatibility only.
|
10455
|
+
# @return [String]
|
10456
|
+
#
|
10457
|
+
# @!attribute [rw] format_version
|
10458
|
+
# The user or group rules associated with the dataset that contains
|
10459
|
+
# permissions for RLS.
|
10460
|
+
#
|
10461
|
+
# By default, `FormatVersion` is `VERSION_1`. When `FormatVersion` is
|
10462
|
+
# `VERSION_1`, `UserName` and `GroupName` are required. When
|
10463
|
+
# `FormatVersion` is `VERSION_2`, `UserARN` and `GroupARN` are
|
10464
|
+
# required, and `Namespace` must not exist.
|
10465
|
+
# @return [String]
|
10466
|
+
#
|
10467
|
+
# @!attribute [rw] status
|
10468
|
+
# The status of the row-level security permission dataset. If enabled,
|
10469
|
+
# the status is `ENABLED`. If disabled, the status is `DISABLED`.
|
10470
|
+
# @return [String]
|
10471
|
+
#
|
10472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionDataSet AWS API Documentation
|
10473
|
+
#
|
10474
|
+
class RowLevelPermissionDataSet < Struct.new(
|
10475
|
+
:namespace,
|
10476
|
+
:arn,
|
10477
|
+
:permission_policy,
|
10478
|
+
:format_version,
|
10479
|
+
:status)
|
10480
|
+
SENSITIVE = []
|
10481
|
+
include Aws::Structure
|
10482
|
+
end
|
10483
|
+
|
10484
|
+
# The configuration of tags on a dataset to set row-level security.
|
10485
|
+
#
|
10486
|
+
# @note When making an API call, you may pass RowLevelPermissionTagConfiguration
|
10487
|
+
# data as a hash:
|
10488
|
+
#
|
10489
|
+
# {
|
10490
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
10491
|
+
# tag_rules: [ # required
|
10492
|
+
# {
|
10493
|
+
# tag_key: "SessionTagKey", # required
|
10494
|
+
# column_name: "String", # required
|
10495
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
10496
|
+
# match_all_value: "SessionTagValue",
|
10497
|
+
# },
|
10498
|
+
# ],
|
10499
|
+
# }
|
10500
|
+
#
|
10501
|
+
# @!attribute [rw] status
|
10502
|
+
# The status of row-level security tags. If enabled, the status is
|
10503
|
+
# `ENABLED`. If disabled, the status is `DISABLED`.
|
10504
|
+
# @return [String]
|
9272
10505
|
#
|
10506
|
+
# @!attribute [rw] tag_rules
|
10507
|
+
# A set of rules associated with row-level security, such as the tag
|
10508
|
+
# names and columns that they are assigned to.
|
10509
|
+
# @return [Array<Types::RowLevelPermissionTagRule>]
|
9273
10510
|
#
|
10511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagConfiguration AWS API Documentation
|
9274
10512
|
#
|
9275
|
-
|
10513
|
+
class RowLevelPermissionTagConfiguration < Struct.new(
|
10514
|
+
:status,
|
10515
|
+
:tag_rules)
|
10516
|
+
SENSITIVE = []
|
10517
|
+
include Aws::Structure
|
10518
|
+
end
|
10519
|
+
|
10520
|
+
# A set of rules associated with a tag.
|
9276
10521
|
#
|
9277
|
-
# @note When making an API call, you may pass
|
10522
|
+
# @note When making an API call, you may pass RowLevelPermissionTagRule
|
9278
10523
|
# data as a hash:
|
9279
10524
|
#
|
9280
10525
|
# {
|
9281
|
-
#
|
9282
|
-
#
|
9283
|
-
#
|
10526
|
+
# tag_key: "SessionTagKey", # required
|
10527
|
+
# column_name: "String", # required
|
10528
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
10529
|
+
# match_all_value: "SessionTagValue",
|
9284
10530
|
# }
|
9285
10531
|
#
|
9286
|
-
# @!attribute [rw]
|
9287
|
-
# The
|
9288
|
-
# for RLS.
|
10532
|
+
# @!attribute [rw] tag_key
|
10533
|
+
# The unique key for a tag.
|
9289
10534
|
# @return [String]
|
9290
10535
|
#
|
9291
|
-
# @!attribute [rw]
|
9292
|
-
# The
|
9293
|
-
# permissions for RLS.
|
10536
|
+
# @!attribute [rw] column_name
|
10537
|
+
# The column name that a tag key is assigned to.
|
9294
10538
|
# @return [String]
|
9295
10539
|
#
|
9296
|
-
# @!attribute [rw]
|
9297
|
-
#
|
9298
|
-
#
|
10540
|
+
# @!attribute [rw] tag_multi_value_delimiter
|
10541
|
+
# A string that you want to use to delimit the values when you pass
|
10542
|
+
# the values at run time. For example, you can delimit the values with
|
10543
|
+
# a comma.
|
9299
10544
|
# @return [String]
|
9300
10545
|
#
|
9301
|
-
#
|
10546
|
+
# @!attribute [rw] match_all_value
|
10547
|
+
# A string that you want to use to filter by all the values in a
|
10548
|
+
# column in the dataset and don’t want to list the values one by one.
|
10549
|
+
# For example, you can use an asterisk as your match all value.
|
10550
|
+
# @return [String]
|
9302
10551
|
#
|
9303
|
-
|
9304
|
-
|
9305
|
-
|
9306
|
-
:
|
9307
|
-
|
10552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagRule AWS API Documentation
|
10553
|
+
#
|
10554
|
+
class RowLevelPermissionTagRule < Struct.new(
|
10555
|
+
:tag_key,
|
10556
|
+
:column_name,
|
10557
|
+
:tag_multi_value_delimiter,
|
10558
|
+
:match_all_value)
|
10559
|
+
SENSITIVE = [:match_all_value]
|
9308
10560
|
include Aws::Structure
|
9309
10561
|
end
|
9310
10562
|
|
@@ -9322,7 +10574,7 @@ module Aws::QuickSight
|
|
9322
10574
|
#
|
9323
10575
|
# @!attribute [rw] manifest_file_location
|
9324
10576
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
9325
|
-
# manifest file was uploaded
|
10577
|
+
# manifest file was uploaded into QuickSight.
|
9326
10578
|
# @return [Types::ManifestFileLocation]
|
9327
10579
|
#
|
9328
10580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
@@ -9333,7 +10585,7 @@ module Aws::QuickSight
|
|
9333
10585
|
include Aws::Structure
|
9334
10586
|
end
|
9335
10587
|
|
9336
|
-
# A physical table type for
|
10588
|
+
# A physical table type for an S3 data source.
|
9337
10589
|
#
|
9338
10590
|
# @note When making an API call, you may pass S3Source
|
9339
10591
|
# data as a hash:
|
@@ -9364,7 +10616,12 @@ module Aws::QuickSight
|
|
9364
10616
|
# @return [Types::UploadSettings]
|
9365
10617
|
#
|
9366
10618
|
# @!attribute [rw] input_columns
|
9367
|
-
# A physical table type for
|
10619
|
+
# A physical table type for an S3 data source.
|
10620
|
+
#
|
10621
|
+
# <note markdown="1"> For non-JSON files, only `STRING` data types are supported in input
|
10622
|
+
# columns.
|
10623
|
+
#
|
10624
|
+
# </note>
|
9368
10625
|
# @return [Array<Types::InputColumn>]
|
9369
10626
|
#
|
9370
10627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Source AWS API Documentation
|
@@ -9394,8 +10651,8 @@ module Aws::QuickSight
|
|
9394
10651
|
# }
|
9395
10652
|
#
|
9396
10653
|
# @!attribute [rw] aws_account_id
|
9397
|
-
# The ID of the
|
9398
|
-
# searching for.
|
10654
|
+
# The ID of the Amazon Web Services account; that contains the
|
10655
|
+
# analyses that you're searching for.
|
9399
10656
|
# @return [String]
|
9400
10657
|
#
|
9401
10658
|
# @!attribute [rw] filters
|
@@ -9435,7 +10692,7 @@ module Aws::QuickSight
|
|
9435
10692
|
# @return [Integer]
|
9436
10693
|
#
|
9437
10694
|
# @!attribute [rw] request_id
|
9438
|
-
# The
|
10695
|
+
# The Amazon Web Services request ID for this operation.
|
9439
10696
|
# @return [String]
|
9440
10697
|
#
|
9441
10698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesResponse AWS API Documentation
|
@@ -9466,8 +10723,8 @@ module Aws::QuickSight
|
|
9466
10723
|
# }
|
9467
10724
|
#
|
9468
10725
|
# @!attribute [rw] aws_account_id
|
9469
|
-
# The ID of the
|
9470
|
-
# you're searching for.
|
10726
|
+
# The ID of the Amazon Web Services account; that contains the user
|
10727
|
+
# whose dashboards you're searching for.
|
9471
10728
|
# @return [String]
|
9472
10729
|
#
|
9473
10730
|
# @!attribute [rw] filters
|
@@ -9512,7 +10769,7 @@ module Aws::QuickSight
|
|
9512
10769
|
# @return [Integer]
|
9513
10770
|
#
|
9514
10771
|
# @!attribute [rw] request_id
|
9515
|
-
# The
|
10772
|
+
# The Amazon Web Services request ID for this operation.
|
9516
10773
|
# @return [String]
|
9517
10774
|
#
|
9518
10775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboardsResponse AWS API Documentation
|
@@ -9526,6 +10783,82 @@ module Aws::QuickSight
|
|
9526
10783
|
include Aws::Structure
|
9527
10784
|
end
|
9528
10785
|
|
10786
|
+
# @note When making an API call, you may pass SearchFoldersRequest
|
10787
|
+
# data as a hash:
|
10788
|
+
#
|
10789
|
+
# {
|
10790
|
+
# aws_account_id: "AwsAccountId", # required
|
10791
|
+
# filters: [ # required
|
10792
|
+
# {
|
10793
|
+
# operator: "StringEquals", # accepts StringEquals
|
10794
|
+
# name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
|
10795
|
+
# value: "String",
|
10796
|
+
# },
|
10797
|
+
# ],
|
10798
|
+
# next_token: "String",
|
10799
|
+
# max_results: 1,
|
10800
|
+
# }
|
10801
|
+
#
|
10802
|
+
# @!attribute [rw] aws_account_id
|
10803
|
+
# The AWS account ID.
|
10804
|
+
# @return [String]
|
10805
|
+
#
|
10806
|
+
# @!attribute [rw] filters
|
10807
|
+
# The filters to apply to the search. Currently, you can search only
|
10808
|
+
# by the parent folder ARN. For example, `"Filters": [ \{ "Name":
|
10809
|
+
# "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value":
|
10810
|
+
# "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ]`.
|
10811
|
+
# @return [Array<Types::FolderSearchFilter>]
|
10812
|
+
#
|
10813
|
+
# @!attribute [rw] next_token
|
10814
|
+
# The token for the next set of results, or null if there are no more
|
10815
|
+
# results.
|
10816
|
+
# @return [String]
|
10817
|
+
#
|
10818
|
+
# @!attribute [rw] max_results
|
10819
|
+
# The maximum number of results to be returned per request.
|
10820
|
+
# @return [Integer]
|
10821
|
+
#
|
10822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFoldersRequest AWS API Documentation
|
10823
|
+
#
|
10824
|
+
class SearchFoldersRequest < Struct.new(
|
10825
|
+
:aws_account_id,
|
10826
|
+
:filters,
|
10827
|
+
:next_token,
|
10828
|
+
:max_results)
|
10829
|
+
SENSITIVE = []
|
10830
|
+
include Aws::Structure
|
10831
|
+
end
|
10832
|
+
|
10833
|
+
# @!attribute [rw] status
|
10834
|
+
# The status. If succeeded, the status is `SC_OK`.
|
10835
|
+
# @return [Integer]
|
10836
|
+
#
|
10837
|
+
# @!attribute [rw] folder_summary_list
|
10838
|
+
# A structure that contains all of the folders in your AWS account.
|
10839
|
+
# This structure provides basic information about the folders.
|
10840
|
+
# @return [Array<Types::FolderSummary>]
|
10841
|
+
#
|
10842
|
+
# @!attribute [rw] next_token
|
10843
|
+
# The token for the next set of results, or null if there are no more
|
10844
|
+
# results.
|
10845
|
+
# @return [String]
|
10846
|
+
#
|
10847
|
+
# @!attribute [rw] request_id
|
10848
|
+
# The request ID.
|
10849
|
+
# @return [String]
|
10850
|
+
#
|
10851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFoldersResponse AWS API Documentation
|
10852
|
+
#
|
10853
|
+
class SearchFoldersResponse < Struct.new(
|
10854
|
+
:status,
|
10855
|
+
:folder_summary_list,
|
10856
|
+
:next_token,
|
10857
|
+
:request_id)
|
10858
|
+
SENSITIVE = []
|
10859
|
+
include Aws::Structure
|
10860
|
+
end
|
10861
|
+
|
9529
10862
|
# ServiceNow parameters.
|
9530
10863
|
#
|
9531
10864
|
# @note When making an API call, you may pass ServiceNowParameters
|
@@ -9554,7 +10887,7 @@ module Aws::QuickSight
|
|
9554
10887
|
# @return [String]
|
9555
10888
|
#
|
9556
10889
|
# @!attribute [rw] request_id
|
9557
|
-
# The
|
10890
|
+
# The Amazon Web Services request ID for this request.
|
9558
10891
|
# @return [String]
|
9559
10892
|
#
|
9560
10893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SessionLifetimeInMinutesInvalidException AWS API Documentation
|
@@ -9566,12 +10899,39 @@ module Aws::QuickSight
|
|
9566
10899
|
include Aws::Structure
|
9567
10900
|
end
|
9568
10901
|
|
10902
|
+
# The key-value pair used for the row-level security tags feature.
|
10903
|
+
#
|
10904
|
+
# @note When making an API call, you may pass SessionTag
|
10905
|
+
# data as a hash:
|
10906
|
+
#
|
10907
|
+
# {
|
10908
|
+
# key: "SessionTagKey", # required
|
10909
|
+
# value: "SessionTagValue", # required
|
10910
|
+
# }
|
10911
|
+
#
|
10912
|
+
# @!attribute [rw] key
|
10913
|
+
# The key for the tag.
|
10914
|
+
# @return [String]
|
10915
|
+
#
|
10916
|
+
# @!attribute [rw] value
|
10917
|
+
# The value that you want to assign the tag.
|
10918
|
+
# @return [String]
|
10919
|
+
#
|
10920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SessionTag AWS API Documentation
|
10921
|
+
#
|
10922
|
+
class SessionTag < Struct.new(
|
10923
|
+
:key,
|
10924
|
+
:value)
|
10925
|
+
SENSITIVE = [:value]
|
10926
|
+
include Aws::Structure
|
10927
|
+
end
|
10928
|
+
|
9569
10929
|
# A *sheet*, which is an object that contains a set of visuals that are
|
9570
|
-
# viewed together on one page in
|
9571
|
-
#
|
9572
|
-
#
|
9573
|
-
#
|
9574
|
-
#
|
10930
|
+
# viewed together on one page in Amazon QuickSight. Every analysis and
|
10931
|
+
# dashboard contains at least one sheet. Each sheet contains at least
|
10932
|
+
# one visualization widget, for example a chart, pivot table, or
|
10933
|
+
# narrative insight. Sheets can be associated with other components,
|
10934
|
+
# such as controls, filters, and so on.
|
9575
10935
|
#
|
9576
10936
|
# @!attribute [rw] sheet_id
|
9577
10937
|
# The unique identifier associated with a sheet.
|
@@ -9843,9 +11203,9 @@ module Aws::QuickSight
|
|
9843
11203
|
#
|
9844
11204
|
# @!attribute [rw] tags
|
9845
11205
|
# The dataset column tag, currently only used for geospatial type
|
9846
|
-
# tagging.
|
11206
|
+
# tagging.
|
9847
11207
|
#
|
9848
|
-
# <note markdown="1"> This is not tags for the
|
11208
|
+
# <note markdown="1"> This is not tags for the Amazon Web Services tagging feature.
|
9849
11209
|
#
|
9850
11210
|
# </note>
|
9851
11211
|
# @return [Array<Types::ColumnTag>]
|
@@ -9891,7 +11251,7 @@ module Aws::QuickSight
|
|
9891
11251
|
end
|
9892
11252
|
|
9893
11253
|
# @!attribute [rw] request_id
|
9894
|
-
# The
|
11254
|
+
# The Amazon Web Services request ID for this operation.
|
9895
11255
|
# @return [String]
|
9896
11256
|
#
|
9897
11257
|
# @!attribute [rw] status
|
@@ -9915,9 +11275,9 @@ module Aws::QuickSight
|
|
9915
11275
|
# dataset placeholders with datasets that follow the same schema that
|
9916
11276
|
# was used to create the source analysis and template.
|
9917
11277
|
#
|
9918
|
-
# You can share templates across
|
9919
|
-
#
|
9920
|
-
# template.
|
11278
|
+
# You can share templates across Amazon Web Services accounts by
|
11279
|
+
# allowing users in other Amazon Web Services accounts to create a
|
11280
|
+
# template or a dashboard from an existing template.
|
9921
11281
|
#
|
9922
11282
|
# @!attribute [rw] arn
|
9923
11283
|
# The Amazon Resource Name (ARN) of the template.
|
@@ -9932,8 +11292,8 @@ module Aws::QuickSight
|
|
9932
11292
|
# @return [Types::TemplateVersion]
|
9933
11293
|
#
|
9934
11294
|
# @!attribute [rw] template_id
|
9935
|
-
# The ID for the template. This is unique per
|
9936
|
-
# account
|
11295
|
+
# The ID for the template. This is unique per Region; for each Amazon
|
11296
|
+
# Web Services account;.
|
9937
11297
|
# @return [String]
|
9938
11298
|
#
|
9939
11299
|
# @!attribute [rw] last_updated_time
|
@@ -10099,8 +11459,8 @@ module Aws::QuickSight
|
|
10099
11459
|
# @return [String]
|
10100
11460
|
#
|
10101
11461
|
# @!attribute [rw] template_id
|
10102
|
-
# The ID of the template. This ID is unique per
|
10103
|
-
#
|
11462
|
+
# The ID of the template. This ID is unique per Region; for each
|
11463
|
+
# Amazon Web Services account;.
|
10104
11464
|
# @return [String]
|
10105
11465
|
#
|
10106
11466
|
# @!attribute [rw] name
|
@@ -10427,8 +11787,8 @@ module Aws::QuickSight
|
|
10427
11787
|
# @return [String]
|
10428
11788
|
#
|
10429
11789
|
# @!attribute [rw] theme_id
|
10430
|
-
# The ID of the theme. This ID is unique per
|
10431
|
-
# account
|
11790
|
+
# The ID of the theme. This ID is unique per Region; for each Amazon
|
11791
|
+
# Web Services account;.
|
10432
11792
|
# @return [String]
|
10433
11793
|
#
|
10434
11794
|
# @!attribute [rw] latest_version_number
|
@@ -10548,7 +11908,7 @@ module Aws::QuickSight
|
|
10548
11908
|
# @return [String]
|
10549
11909
|
#
|
10550
11910
|
# @!attribute [rw] request_id
|
10551
|
-
# The
|
11911
|
+
# The Amazon Web Services request ID for this request.
|
10552
11912
|
# @return [String]
|
10553
11913
|
#
|
10554
11914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThrottlingException AWS API Documentation
|
@@ -10859,8 +12219,8 @@ module Aws::QuickSight
|
|
10859
12219
|
end
|
10860
12220
|
|
10861
12221
|
# This error indicates that you are calling an embedding operation in
|
10862
|
-
# Amazon QuickSight without the required pricing plan on your
|
10863
|
-
# account
|
12222
|
+
# Amazon QuickSight without the required pricing plan on your Amazon Web
|
12223
|
+
# Services account;. Before you can use embedding for anonymous users, a
|
10864
12224
|
# QuickSight administrator needs to add capacity pricing to QuickSight.
|
10865
12225
|
# You can do this on the **Manage QuickSight** page.
|
10866
12226
|
#
|
@@ -10871,7 +12231,7 @@ module Aws::QuickSight
|
|
10871
12231
|
# @return [String]
|
10872
12232
|
#
|
10873
12233
|
# @!attribute [rw] request_id
|
10874
|
-
# The
|
12234
|
+
# The Amazon Web Services request ID for this request.
|
10875
12235
|
# @return [String]
|
10876
12236
|
#
|
10877
12237
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedPricingPlanException AWS API Documentation
|
@@ -10893,7 +12253,7 @@ module Aws::QuickSight
|
|
10893
12253
|
# @return [String]
|
10894
12254
|
#
|
10895
12255
|
# @!attribute [rw] request_id
|
10896
|
-
# The
|
12256
|
+
# The Amazon Web Services request ID for this request.
|
10897
12257
|
# @return [String]
|
10898
12258
|
#
|
10899
12259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedUserEditionException AWS API Documentation
|
@@ -10933,7 +12293,7 @@ module Aws::QuickSight
|
|
10933
12293
|
end
|
10934
12294
|
|
10935
12295
|
# @!attribute [rw] request_id
|
10936
|
-
# The
|
12296
|
+
# The Amazon Web Services request ID for this operation.
|
10937
12297
|
# @return [String]
|
10938
12298
|
#
|
10939
12299
|
# @!attribute [rw] status
|
@@ -10961,8 +12321,8 @@ module Aws::QuickSight
|
|
10961
12321
|
# }
|
10962
12322
|
#
|
10963
12323
|
# @!attribute [rw] aws_account_id
|
10964
|
-
# The ID for the
|
10965
|
-
# customizations for.
|
12324
|
+
# The ID for the Amazon Web Services account; that you want to update
|
12325
|
+
# QuickSight customizations for.
|
10966
12326
|
# @return [String]
|
10967
12327
|
#
|
10968
12328
|
# @!attribute [rw] namespace
|
@@ -10970,8 +12330,8 @@ module Aws::QuickSight
|
|
10970
12330
|
# @return [String]
|
10971
12331
|
#
|
10972
12332
|
# @!attribute [rw] account_customization
|
10973
|
-
# The QuickSight customizations you're updating in the current
|
10974
|
-
# Region
|
12333
|
+
# The QuickSight customizations you're updating in the current
|
12334
|
+
# Region;.
|
10975
12335
|
# @return [Types::AccountCustomization]
|
10976
12336
|
#
|
10977
12337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -10986,12 +12346,12 @@ module Aws::QuickSight
|
|
10986
12346
|
|
10987
12347
|
# @!attribute [rw] arn
|
10988
12348
|
# The Amazon Resource Name (ARN) for the updated customization for
|
10989
|
-
# this
|
12349
|
+
# this Amazon Web Services account;.
|
10990
12350
|
# @return [String]
|
10991
12351
|
#
|
10992
12352
|
# @!attribute [rw] aws_account_id
|
10993
|
-
# The ID for the
|
10994
|
-
# customizations for.
|
12353
|
+
# The ID for the Amazon Web Services account; that you want to update
|
12354
|
+
# QuickSight customizations for.
|
10995
12355
|
# @return [String]
|
10996
12356
|
#
|
10997
12357
|
# @!attribute [rw] namespace
|
@@ -11000,12 +12360,12 @@ module Aws::QuickSight
|
|
11000
12360
|
# @return [String]
|
11001
12361
|
#
|
11002
12362
|
# @!attribute [rw] account_customization
|
11003
|
-
# The QuickSight customizations you're updating in the current
|
11004
|
-
# Region
|
12363
|
+
# The QuickSight customizations you're updating in the current
|
12364
|
+
# Region;.
|
11005
12365
|
# @return [Types::AccountCustomization]
|
11006
12366
|
#
|
11007
12367
|
# @!attribute [rw] request_id
|
11008
|
-
# The
|
12368
|
+
# The Amazon Web Services request ID for this operation.
|
11009
12369
|
# @return [String]
|
11010
12370
|
#
|
11011
12371
|
# @!attribute [rw] status
|
@@ -11035,20 +12395,21 @@ module Aws::QuickSight
|
|
11035
12395
|
# }
|
11036
12396
|
#
|
11037
12397
|
# @!attribute [rw] aws_account_id
|
11038
|
-
# The ID for the
|
11039
|
-
# that you want to list.
|
12398
|
+
# The ID for the Amazon Web Services account; that contains the
|
12399
|
+
# QuickSight settings that you want to list.
|
11040
12400
|
# @return [String]
|
11041
12401
|
#
|
11042
12402
|
# @!attribute [rw] default_namespace
|
11043
|
-
# The default namespace for this
|
11044
|
-
# is `default`.
|
11045
|
-
# register for the first time with QuickSight provide
|
11046
|
-
# becomes associated with the default namespace.
|
12403
|
+
# The default namespace for this Amazon Web Services account;.
|
12404
|
+
# Currently, the default is `default`. Identity and Access Management
|
12405
|
+
# (IAM) users that register for the first time with QuickSight provide
|
12406
|
+
# an email that becomes associated with the default namespace.
|
11047
12407
|
# @return [String]
|
11048
12408
|
#
|
11049
12409
|
# @!attribute [rw] notification_email
|
11050
12410
|
# The email address that you want QuickSight to send notifications to
|
11051
|
-
# regarding your
|
12411
|
+
# regarding your Amazon Web Services account; or QuickSight
|
12412
|
+
# subscription.
|
11052
12413
|
# @return [String]
|
11053
12414
|
#
|
11054
12415
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -11062,7 +12423,7 @@ module Aws::QuickSight
|
|
11062
12423
|
end
|
11063
12424
|
|
11064
12425
|
# @!attribute [rw] request_id
|
11065
|
-
# The
|
12426
|
+
# The Amazon Web Services request ID for this operation.
|
11066
12427
|
# @return [String]
|
11067
12428
|
#
|
11068
12429
|
# @!attribute [rw] status
|
@@ -11099,9 +12460,9 @@ module Aws::QuickSight
|
|
11099
12460
|
# }
|
11100
12461
|
#
|
11101
12462
|
# @!attribute [rw] aws_account_id
|
11102
|
-
# The ID of the
|
11103
|
-
# permissions you're updating. You must be using the
|
11104
|
-
# the analysis is in.
|
12463
|
+
# The ID of the Amazon Web Services account; that contains the
|
12464
|
+
# analysis whose permissions you're updating. You must be using the
|
12465
|
+
# Amazon Web Services account; that the analysis is in.
|
11105
12466
|
# @return [String]
|
11106
12467
|
#
|
11107
12468
|
# @!attribute [rw] analysis_id
|
@@ -11144,7 +12505,7 @@ module Aws::QuickSight
|
|
11144
12505
|
# @return [Array<Types::ResourcePermission>]
|
11145
12506
|
#
|
11146
12507
|
# @!attribute [rw] request_id
|
11147
|
-
# The
|
12508
|
+
# The Amazon Web Services request ID for this operation.
|
11148
12509
|
# @return [String]
|
11149
12510
|
#
|
11150
12511
|
# @!attribute [rw] status
|
@@ -11211,8 +12572,8 @@ module Aws::QuickSight
|
|
11211
12572
|
# }
|
11212
12573
|
#
|
11213
12574
|
# @!attribute [rw] aws_account_id
|
11214
|
-
# The ID of the
|
11215
|
-
# updating.
|
12575
|
+
# The ID of the Amazon Web Services account; that contains the
|
12576
|
+
# analysis that you're updating.
|
11216
12577
|
# @return [String]
|
11217
12578
|
#
|
11218
12579
|
# @!attribute [rw] analysis_id
|
@@ -11273,7 +12634,7 @@ module Aws::QuickSight
|
|
11273
12634
|
# @return [Integer]
|
11274
12635
|
#
|
11275
12636
|
# @!attribute [rw] request_id
|
11276
|
-
# The
|
12637
|
+
# The Amazon Web Services request ID for this operation.
|
11277
12638
|
# @return [String]
|
11278
12639
|
#
|
11279
12640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisResponse AWS API Documentation
|
@@ -11309,8 +12670,8 @@ module Aws::QuickSight
|
|
11309
12670
|
# }
|
11310
12671
|
#
|
11311
12672
|
# @!attribute [rw] aws_account_id
|
11312
|
-
# The ID of the
|
11313
|
-
# permissions you're updating.
|
12673
|
+
# The ID of the Amazon Web Services account; that contains the
|
12674
|
+
# dashboard whose permissions you're updating.
|
11314
12675
|
# @return [String]
|
11315
12676
|
#
|
11316
12677
|
# @!attribute [rw] dashboard_id
|
@@ -11349,7 +12710,7 @@ module Aws::QuickSight
|
|
11349
12710
|
# @return [Array<Types::ResourcePermission>]
|
11350
12711
|
#
|
11351
12712
|
# @!attribute [rw] request_id
|
11352
|
-
# The
|
12713
|
+
# The Amazon Web Services request ID for this operation.
|
11353
12714
|
# @return [String]
|
11354
12715
|
#
|
11355
12716
|
# @!attribute [rw] status
|
@@ -11378,8 +12739,8 @@ module Aws::QuickSight
|
|
11378
12739
|
# }
|
11379
12740
|
#
|
11380
12741
|
# @!attribute [rw] aws_account_id
|
11381
|
-
# The ID of the
|
11382
|
-
# updating.
|
12742
|
+
# The ID of the Amazon Web Services account; that contains the
|
12743
|
+
# dashboard that you're updating.
|
11383
12744
|
# @return [String]
|
11384
12745
|
#
|
11385
12746
|
# @!attribute [rw] dashboard_id
|
@@ -11413,7 +12774,7 @@ module Aws::QuickSight
|
|
11413
12774
|
# @return [Integer]
|
11414
12775
|
#
|
11415
12776
|
# @!attribute [rw] request_id
|
11416
|
-
# The
|
12777
|
+
# The Amazon Web Services request ID for this operation.
|
11417
12778
|
# @return [String]
|
11418
12779
|
#
|
11419
12780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPublishedVersionResponse AWS API Documentation
|
@@ -11487,8 +12848,8 @@ module Aws::QuickSight
|
|
11487
12848
|
# }
|
11488
12849
|
#
|
11489
12850
|
# @!attribute [rw] aws_account_id
|
11490
|
-
# The ID of the
|
11491
|
-
# updating.
|
12851
|
+
# The ID of the Amazon Web Services account; that contains the
|
12852
|
+
# dashboard that you're updating.
|
11492
12853
|
# @return [String]
|
11493
12854
|
#
|
11494
12855
|
# @!attribute [rw] dashboard_id
|
@@ -11507,8 +12868,8 @@ module Aws::QuickSight
|
|
11507
12868
|
# from an analysis, first convert the analysis to a template by using
|
11508
12869
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
11509
12870
|
# Amazon Resource Name (ARN) of the source template. The
|
11510
|
-
# `SourceTemplate` ARN can contain any
|
11511
|
-
# QuickSight-supported
|
12871
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account;
|
12872
|
+
# and any QuickSight-supported Region;.
|
11512
12873
|
#
|
11513
12874
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
11514
12875
|
# the replacement datasets for the placeholders listed in the
|
@@ -11548,7 +12909,8 @@ module Aws::QuickSight
|
|
11548
12909
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
11549
12910
|
# this dashboard. If you add a value for this field, it overrides the
|
11550
12911
|
# value that was originally associated with the entity. The theme ARN
|
11551
|
-
# must exist in the same
|
12912
|
+
# must exist in the same Amazon Web Services account; where you create
|
12913
|
+
# the dashboard.
|
11552
12914
|
# @return [String]
|
11553
12915
|
#
|
11554
12916
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardRequest AWS API Documentation
|
@@ -11587,7 +12949,7 @@ module Aws::QuickSight
|
|
11587
12949
|
# @return [Integer]
|
11588
12950
|
#
|
11589
12951
|
# @!attribute [rw] request_id
|
11590
|
-
# The
|
12952
|
+
# The Amazon Web Services request ID for this operation.
|
11591
12953
|
# @return [String]
|
11592
12954
|
#
|
11593
12955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardResponse AWS API Documentation
|
@@ -11624,12 +12986,12 @@ module Aws::QuickSight
|
|
11624
12986
|
# }
|
11625
12987
|
#
|
11626
12988
|
# @!attribute [rw] aws_account_id
|
11627
|
-
# The
|
12989
|
+
# The Amazon Web Services account; ID.
|
11628
12990
|
# @return [String]
|
11629
12991
|
#
|
11630
12992
|
# @!attribute [rw] data_set_id
|
11631
12993
|
# The ID for the dataset whose permissions you want to update. This ID
|
11632
|
-
# is unique per
|
12994
|
+
# is unique per Region; for each Amazon Web Services account;.
|
11633
12995
|
# @return [String]
|
11634
12996
|
#
|
11635
12997
|
# @!attribute [rw] grant_permissions
|
@@ -11657,11 +13019,11 @@ module Aws::QuickSight
|
|
11657
13019
|
#
|
11658
13020
|
# @!attribute [rw] data_set_id
|
11659
13021
|
# The ID for the dataset whose permissions you want to update. This ID
|
11660
|
-
# is unique per
|
13022
|
+
# is unique per Region; for each Amazon Web Services account;.
|
11661
13023
|
# @return [String]
|
11662
13024
|
#
|
11663
13025
|
# @!attribute [rw] request_id
|
11664
|
-
# The
|
13026
|
+
# The Amazon Web Services request ID for this operation.
|
11665
13027
|
# @return [String]
|
11666
13028
|
#
|
11667
13029
|
# @!attribute [rw] status
|
@@ -11808,6 +13170,19 @@ module Aws::QuickSight
|
|
11808
13170
|
# namespace: "Namespace",
|
11809
13171
|
# arn: "Arn", # required
|
11810
13172
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
13173
|
+
# format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
|
13174
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
13175
|
+
# },
|
13176
|
+
# row_level_permission_tag_configuration: {
|
13177
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
13178
|
+
# tag_rules: [ # required
|
13179
|
+
# {
|
13180
|
+
# tag_key: "SessionTagKey", # required
|
13181
|
+
# column_name: "String", # required
|
13182
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
13183
|
+
# match_all_value: "SessionTagValue",
|
13184
|
+
# },
|
13185
|
+
# ],
|
11811
13186
|
# },
|
11812
13187
|
# column_level_permission_rules: [
|
11813
13188
|
# {
|
@@ -11818,12 +13193,12 @@ module Aws::QuickSight
|
|
11818
13193
|
# }
|
11819
13194
|
#
|
11820
13195
|
# @!attribute [rw] aws_account_id
|
11821
|
-
# The
|
13196
|
+
# The Amazon Web Services account; ID.
|
11822
13197
|
# @return [String]
|
11823
13198
|
#
|
11824
13199
|
# @!attribute [rw] data_set_id
|
11825
13200
|
# The ID for the dataset that you want to update. This ID is unique
|
11826
|
-
# per
|
13201
|
+
# per Region; for each Amazon Web Services account;.
|
11827
13202
|
# @return [String]
|
11828
13203
|
#
|
11829
13204
|
# @!attribute [rw] name
|
@@ -11859,6 +13234,12 @@ module Aws::QuickSight
|
|
11859
13234
|
# create.
|
11860
13235
|
# @return [Types::RowLevelPermissionDataSet]
|
11861
13236
|
#
|
13237
|
+
# @!attribute [rw] row_level_permission_tag_configuration
|
13238
|
+
# The configuration of tags on a dataset to set row-level security.
|
13239
|
+
# Row-level security tags are currently supported for anonymous
|
13240
|
+
# embedding only.
|
13241
|
+
# @return [Types::RowLevelPermissionTagConfiguration]
|
13242
|
+
#
|
11862
13243
|
# @!attribute [rw] column_level_permission_rules
|
11863
13244
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
11864
13245
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
@@ -11875,6 +13256,7 @@ module Aws::QuickSight
|
|
11875
13256
|
:column_groups,
|
11876
13257
|
:field_folders,
|
11877
13258
|
:row_level_permission_data_set,
|
13259
|
+
:row_level_permission_tag_configuration,
|
11878
13260
|
:column_level_permission_rules)
|
11879
13261
|
SENSITIVE = []
|
11880
13262
|
include Aws::Structure
|
@@ -11886,7 +13268,7 @@ module Aws::QuickSight
|
|
11886
13268
|
#
|
11887
13269
|
# @!attribute [rw] data_set_id
|
11888
13270
|
# The ID for the dataset that you want to create. This ID is unique
|
11889
|
-
# per
|
13271
|
+
# per Region; for each Amazon Web Services account;.
|
11890
13272
|
# @return [String]
|
11891
13273
|
#
|
11892
13274
|
# @!attribute [rw] ingestion_arn
|
@@ -11900,7 +13282,7 @@ module Aws::QuickSight
|
|
11900
13282
|
# @return [String]
|
11901
13283
|
#
|
11902
13284
|
# @!attribute [rw] request_id
|
11903
|
-
# The
|
13285
|
+
# The Amazon Web Services request ID for this operation.
|
11904
13286
|
# @return [String]
|
11905
13287
|
#
|
11906
13288
|
# @!attribute [rw] status
|
@@ -11941,12 +13323,12 @@ module Aws::QuickSight
|
|
11941
13323
|
# }
|
11942
13324
|
#
|
11943
13325
|
# @!attribute [rw] aws_account_id
|
11944
|
-
# The
|
13326
|
+
# The Amazon Web Services account; ID.
|
11945
13327
|
# @return [String]
|
11946
13328
|
#
|
11947
13329
|
# @!attribute [rw] data_source_id
|
11948
|
-
# The ID of the data source. This ID is unique per
|
11949
|
-
#
|
13330
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13331
|
+
# Amazon Web Services account;.
|
11950
13332
|
# @return [String]
|
11951
13333
|
#
|
11952
13334
|
# @!attribute [rw] grant_permissions
|
@@ -11975,12 +13357,12 @@ module Aws::QuickSight
|
|
11975
13357
|
# @return [String]
|
11976
13358
|
#
|
11977
13359
|
# @!attribute [rw] data_source_id
|
11978
|
-
# The ID of the data source. This ID is unique per
|
11979
|
-
#
|
13360
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13361
|
+
# Amazon Web Services account;.
|
11980
13362
|
# @return [String]
|
11981
13363
|
#
|
11982
13364
|
# @!attribute [rw] request_id
|
11983
|
-
# The
|
13365
|
+
# The Amazon Web Services request ID for this operation.
|
11984
13366
|
# @return [String]
|
11985
13367
|
#
|
11986
13368
|
# @!attribute [rw] status
|
@@ -12205,12 +13587,12 @@ module Aws::QuickSight
|
|
12205
13587
|
# }
|
12206
13588
|
#
|
12207
13589
|
# @!attribute [rw] aws_account_id
|
12208
|
-
# The
|
13590
|
+
# The Amazon Web Services account; ID.
|
12209
13591
|
# @return [String]
|
12210
13592
|
#
|
12211
13593
|
# @!attribute [rw] data_source_id
|
12212
|
-
# The ID of the data source. This ID is unique per
|
12213
|
-
#
|
13594
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13595
|
+
# Amazon Web Services account;.
|
12214
13596
|
# @return [String]
|
12215
13597
|
#
|
12216
13598
|
# @!attribute [rw] name
|
@@ -12257,8 +13639,8 @@ module Aws::QuickSight
|
|
12257
13639
|
# @return [String]
|
12258
13640
|
#
|
12259
13641
|
# @!attribute [rw] data_source_id
|
12260
|
-
# The ID of the data source. This ID is unique per
|
12261
|
-
#
|
13642
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13643
|
+
# Amazon Web Services account;.
|
12262
13644
|
# @return [String]
|
12263
13645
|
#
|
12264
13646
|
# @!attribute [rw] update_status
|
@@ -12266,7 +13648,7 @@ module Aws::QuickSight
|
|
12266
13648
|
# @return [String]
|
12267
13649
|
#
|
12268
13650
|
# @!attribute [rw] request_id
|
12269
|
-
# The
|
13651
|
+
# The Amazon Web Services request ID for this operation.
|
12270
13652
|
# @return [String]
|
12271
13653
|
#
|
12272
13654
|
# @!attribute [rw] status
|
@@ -12285,6 +13667,143 @@ module Aws::QuickSight
|
|
12285
13667
|
include Aws::Structure
|
12286
13668
|
end
|
12287
13669
|
|
13670
|
+
# @note When making an API call, you may pass UpdateFolderPermissionsRequest
|
13671
|
+
# data as a hash:
|
13672
|
+
#
|
13673
|
+
# {
|
13674
|
+
# aws_account_id: "AwsAccountId", # required
|
13675
|
+
# folder_id: "RestrictiveResourceId", # required
|
13676
|
+
# grant_permissions: [
|
13677
|
+
# {
|
13678
|
+
# principal: "Principal", # required
|
13679
|
+
# actions: ["String"], # required
|
13680
|
+
# },
|
13681
|
+
# ],
|
13682
|
+
# revoke_permissions: [
|
13683
|
+
# {
|
13684
|
+
# principal: "Principal", # required
|
13685
|
+
# actions: ["String"], # required
|
13686
|
+
# },
|
13687
|
+
# ],
|
13688
|
+
# }
|
13689
|
+
#
|
13690
|
+
# @!attribute [rw] aws_account_id
|
13691
|
+
# The AWS account ID.
|
13692
|
+
# @return [String]
|
13693
|
+
#
|
13694
|
+
# @!attribute [rw] folder_id
|
13695
|
+
# The folder ID.
|
13696
|
+
# @return [String]
|
13697
|
+
#
|
13698
|
+
# @!attribute [rw] grant_permissions
|
13699
|
+
# The permissions that you want to grant on a resource.
|
13700
|
+
# @return [Array<Types::ResourcePermission>]
|
13701
|
+
#
|
13702
|
+
# @!attribute [rw] revoke_permissions
|
13703
|
+
# The permissions that you want to revoke from a resource.
|
13704
|
+
# @return [Array<Types::ResourcePermission>]
|
13705
|
+
#
|
13706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissionsRequest AWS API Documentation
|
13707
|
+
#
|
13708
|
+
class UpdateFolderPermissionsRequest < Struct.new(
|
13709
|
+
:aws_account_id,
|
13710
|
+
:folder_id,
|
13711
|
+
:grant_permissions,
|
13712
|
+
:revoke_permissions)
|
13713
|
+
SENSITIVE = []
|
13714
|
+
include Aws::Structure
|
13715
|
+
end
|
13716
|
+
|
13717
|
+
# @!attribute [rw] status
|
13718
|
+
# The status. If succeeded, the status is `SC_OK`.
|
13719
|
+
# @return [Integer]
|
13720
|
+
#
|
13721
|
+
# @!attribute [rw] arn
|
13722
|
+
# The Amazon Resource Name (ARN).
|
13723
|
+
# @return [String]
|
13724
|
+
#
|
13725
|
+
# @!attribute [rw] folder_id
|
13726
|
+
# The folder ID.
|
13727
|
+
# @return [String]
|
13728
|
+
#
|
13729
|
+
# @!attribute [rw] permissions
|
13730
|
+
# Information about the permissions on the dashboard.
|
13731
|
+
# @return [Array<Types::ResourcePermission>]
|
13732
|
+
#
|
13733
|
+
# @!attribute [rw] request_id
|
13734
|
+
# The request ID.
|
13735
|
+
# @return [String]
|
13736
|
+
#
|
13737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissionsResponse AWS API Documentation
|
13738
|
+
#
|
13739
|
+
class UpdateFolderPermissionsResponse < Struct.new(
|
13740
|
+
:status,
|
13741
|
+
:arn,
|
13742
|
+
:folder_id,
|
13743
|
+
:permissions,
|
13744
|
+
:request_id)
|
13745
|
+
SENSITIVE = []
|
13746
|
+
include Aws::Structure
|
13747
|
+
end
|
13748
|
+
|
13749
|
+
# @note When making an API call, you may pass UpdateFolderRequest
|
13750
|
+
# data as a hash:
|
13751
|
+
#
|
13752
|
+
# {
|
13753
|
+
# aws_account_id: "AwsAccountId", # required
|
13754
|
+
# folder_id: "RestrictiveResourceId", # required
|
13755
|
+
# name: "FolderName", # required
|
13756
|
+
# }
|
13757
|
+
#
|
13758
|
+
# @!attribute [rw] aws_account_id
|
13759
|
+
# The AWS account ID.
|
13760
|
+
# @return [String]
|
13761
|
+
#
|
13762
|
+
# @!attribute [rw] folder_id
|
13763
|
+
# The folder ID.
|
13764
|
+
# @return [String]
|
13765
|
+
#
|
13766
|
+
# @!attribute [rw] name
|
13767
|
+
# The name of the folder.
|
13768
|
+
# @return [String]
|
13769
|
+
#
|
13770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderRequest AWS API Documentation
|
13771
|
+
#
|
13772
|
+
class UpdateFolderRequest < Struct.new(
|
13773
|
+
:aws_account_id,
|
13774
|
+
:folder_id,
|
13775
|
+
:name)
|
13776
|
+
SENSITIVE = []
|
13777
|
+
include Aws::Structure
|
13778
|
+
end
|
13779
|
+
|
13780
|
+
# @!attribute [rw] status
|
13781
|
+
# The status. If succeeded, the status is `SC_OK`.
|
13782
|
+
# @return [Integer]
|
13783
|
+
#
|
13784
|
+
# @!attribute [rw] arn
|
13785
|
+
# The Amazon Resource Name (ARN).
|
13786
|
+
# @return [String]
|
13787
|
+
#
|
13788
|
+
# @!attribute [rw] folder_id
|
13789
|
+
# The folder ID.
|
13790
|
+
# @return [String]
|
13791
|
+
#
|
13792
|
+
# @!attribute [rw] request_id
|
13793
|
+
# The request ID.
|
13794
|
+
# @return [String]
|
13795
|
+
#
|
13796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderResponse AWS API Documentation
|
13797
|
+
#
|
13798
|
+
class UpdateFolderResponse < Struct.new(
|
13799
|
+
:status,
|
13800
|
+
:arn,
|
13801
|
+
:folder_id,
|
13802
|
+
:request_id)
|
13803
|
+
SENSITIVE = []
|
13804
|
+
include Aws::Structure
|
13805
|
+
end
|
13806
|
+
|
12288
13807
|
# @note When making an API call, you may pass UpdateGroupRequest
|
12289
13808
|
# data as a hash:
|
12290
13809
|
#
|
@@ -12304,9 +13823,9 @@ module Aws::QuickSight
|
|
12304
13823
|
# @return [String]
|
12305
13824
|
#
|
12306
13825
|
# @!attribute [rw] aws_account_id
|
12307
|
-
# The ID for the
|
12308
|
-
# the ID for the
|
12309
|
-
# account.
|
13826
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
13827
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
13828
|
+
# contains your Amazon QuickSight account.
|
12310
13829
|
# @return [String]
|
12311
13830
|
#
|
12312
13831
|
# @!attribute [rw] namespace
|
@@ -12329,7 +13848,7 @@ module Aws::QuickSight
|
|
12329
13848
|
# @return [Types::Group]
|
12330
13849
|
#
|
12331
13850
|
# @!attribute [rw] request_id
|
12332
|
-
# The
|
13851
|
+
# The Amazon Web Services request ID for this operation.
|
12333
13852
|
# @return [String]
|
12334
13853
|
#
|
12335
13854
|
# @!attribute [rw] status
|
@@ -12361,12 +13880,13 @@ module Aws::QuickSight
|
|
12361
13880
|
# }
|
12362
13881
|
#
|
12363
13882
|
# @!attribute [rw] aws_account_id
|
12364
|
-
# The ID of the
|
13883
|
+
# The ID of the Amazon Web Services account; that contains the IAM
|
13884
|
+
# policy assignment.
|
12365
13885
|
# @return [String]
|
12366
13886
|
#
|
12367
13887
|
# @!attribute [rw] assignment_name
|
12368
13888
|
# The name of the assignment, also called a rule. This name must be
|
12369
|
-
# unique within an
|
13889
|
+
# unique within an Amazon Web Services account;.
|
12370
13890
|
# @return [String]
|
12371
13891
|
#
|
12372
13892
|
# @!attribute [rw] namespace
|
@@ -12441,7 +13961,7 @@ module Aws::QuickSight
|
|
12441
13961
|
# @return [String]
|
12442
13962
|
#
|
12443
13963
|
# @!attribute [rw] request_id
|
12444
|
-
# The
|
13964
|
+
# The Amazon Web Services request ID for this operation.
|
12445
13965
|
# @return [String]
|
12446
13966
|
#
|
12447
13967
|
# @!attribute [rw] status
|
@@ -12473,8 +13993,8 @@ module Aws::QuickSight
|
|
12473
13993
|
# }
|
12474
13994
|
#
|
12475
13995
|
# @!attribute [rw] aws_account_id
|
12476
|
-
# The ID of the
|
12477
|
-
# you're updating.
|
13996
|
+
# The ID of the Amazon Web Services account; that contains the
|
13997
|
+
# template alias that you're updating.
|
12478
13998
|
# @return [String]
|
12479
13999
|
#
|
12480
14000
|
# @!attribute [rw] template_id
|
@@ -12513,7 +14033,7 @@ module Aws::QuickSight
|
|
12513
14033
|
# @return [Integer]
|
12514
14034
|
#
|
12515
14035
|
# @!attribute [rw] request_id
|
12516
|
-
# The
|
14036
|
+
# The Amazon Web Services request ID for this operation.
|
12517
14037
|
# @return [String]
|
12518
14038
|
#
|
12519
14039
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplateAliasResponse AWS API Documentation
|
@@ -12547,7 +14067,8 @@ module Aws::QuickSight
|
|
12547
14067
|
# }
|
12548
14068
|
#
|
12549
14069
|
# @!attribute [rw] aws_account_id
|
12550
|
-
# The ID of the
|
14070
|
+
# The ID of the Amazon Web Services account; that contains the
|
14071
|
+
# template.
|
12551
14072
|
# @return [String]
|
12552
14073
|
#
|
12553
14074
|
# @!attribute [rw] template_id
|
@@ -12586,7 +14107,7 @@ module Aws::QuickSight
|
|
12586
14107
|
# @return [Array<Types::ResourcePermission>]
|
12587
14108
|
#
|
12588
14109
|
# @!attribute [rw] request_id
|
12589
|
-
# The
|
14110
|
+
# The Amazon Web Services request ID for this operation.
|
12590
14111
|
# @return [String]
|
12591
14112
|
#
|
12592
14113
|
# @!attribute [rw] status
|
@@ -12630,8 +14151,8 @@ module Aws::QuickSight
|
|
12630
14151
|
# }
|
12631
14152
|
#
|
12632
14153
|
# @!attribute [rw] aws_account_id
|
12633
|
-
# The ID of the
|
12634
|
-
# updating.
|
14154
|
+
# The ID of the Amazon Web Services account; that contains the
|
14155
|
+
# template that you're updating.
|
12635
14156
|
# @return [String]
|
12636
14157
|
#
|
12637
14158
|
# @!attribute [rw] template_id
|
@@ -12645,8 +14166,8 @@ module Aws::QuickSight
|
|
12645
14166
|
# for an analysis. Both of these require an Amazon Resource Name
|
12646
14167
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
12647
14168
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
12648
|
-
# `SourceTemplate` ARN can contain any
|
12649
|
-
# QuickSight-supported
|
14169
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account;
|
14170
|
+
# and any QuickSight-supported Region;.
|
12650
14171
|
#
|
12651
14172
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
12652
14173
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -12699,7 +14220,7 @@ module Aws::QuickSight
|
|
12699
14220
|
# @return [Integer]
|
12700
14221
|
#
|
12701
14222
|
# @!attribute [rw] request_id
|
12702
|
-
# The
|
14223
|
+
# The Amazon Web Services request ID for this operation.
|
12703
14224
|
# @return [String]
|
12704
14225
|
#
|
12705
14226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplateResponse AWS API Documentation
|
@@ -12726,8 +14247,8 @@ module Aws::QuickSight
|
|
12726
14247
|
# }
|
12727
14248
|
#
|
12728
14249
|
# @!attribute [rw] aws_account_id
|
12729
|
-
# The ID of the
|
12730
|
-
# updating.
|
14250
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
14251
|
+
# alias that you're updating.
|
12731
14252
|
# @return [String]
|
12732
14253
|
#
|
12733
14254
|
# @!attribute [rw] theme_id
|
@@ -12762,7 +14283,7 @@ module Aws::QuickSight
|
|
12762
14283
|
# @return [Integer]
|
12763
14284
|
#
|
12764
14285
|
# @!attribute [rw] request_id
|
12765
|
-
# The
|
14286
|
+
# The Amazon Web Services request ID for this operation.
|
12766
14287
|
# @return [String]
|
12767
14288
|
#
|
12768
14289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAliasResponse AWS API Documentation
|
@@ -12796,7 +14317,7 @@ module Aws::QuickSight
|
|
12796
14317
|
# }
|
12797
14318
|
#
|
12798
14319
|
# @!attribute [rw] aws_account_id
|
12799
|
-
# The ID of the
|
14320
|
+
# The ID of the Amazon Web Services account; that contains the theme.
|
12800
14321
|
# @return [String]
|
12801
14322
|
#
|
12802
14323
|
# @!attribute [rw] theme_id
|
@@ -12835,7 +14356,7 @@ module Aws::QuickSight
|
|
12835
14356
|
# @return [Array<Types::ResourcePermission>]
|
12836
14357
|
#
|
12837
14358
|
# @!attribute [rw] request_id
|
12838
|
-
# The
|
14359
|
+
# The Amazon Web Services request ID for this operation.
|
12839
14360
|
# @return [String]
|
12840
14361
|
#
|
12841
14362
|
# @!attribute [rw] status
|
@@ -12906,8 +14427,8 @@ module Aws::QuickSight
|
|
12906
14427
|
# }
|
12907
14428
|
#
|
12908
14429
|
# @!attribute [rw] aws_account_id
|
12909
|
-
# The ID of the
|
12910
|
-
# updating.
|
14430
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
14431
|
+
# that you're updating.
|
12911
14432
|
# @return [String]
|
12912
14433
|
#
|
12913
14434
|
# @!attribute [rw] theme_id
|
@@ -12920,7 +14441,7 @@ module Aws::QuickSight
|
|
12920
14441
|
#
|
12921
14442
|
# @!attribute [rw] base_theme_id
|
12922
14443
|
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
12923
|
-
# inherits from. All themes initially inherit from a default
|
14444
|
+
# inherits from. All themes initially inherit from a default Amazon
|
12924
14445
|
# QuickSight theme.
|
12925
14446
|
# @return [String]
|
12926
14447
|
#
|
@@ -12970,7 +14491,7 @@ module Aws::QuickSight
|
|
12970
14491
|
# @return [Integer]
|
12971
14492
|
#
|
12972
14493
|
# @!attribute [rw] request_id
|
12973
|
-
# The
|
14494
|
+
# The Amazon Web Services request ID for this operation.
|
12974
14495
|
# @return [String]
|
12975
14496
|
#
|
12976
14497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeResponse AWS API Documentation
|
@@ -12997,6 +14518,9 @@ module Aws::QuickSight
|
|
12997
14518
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
12998
14519
|
# custom_permissions_name: "RoleName",
|
12999
14520
|
# unapply_custom_permissions: false,
|
14521
|
+
# external_login_federation_provider_type: "String",
|
14522
|
+
# custom_federation_provider_url: "String",
|
14523
|
+
# external_login_id: "String",
|
13000
14524
|
# }
|
13001
14525
|
#
|
13002
14526
|
# @!attribute [rw] user_name
|
@@ -13004,9 +14528,9 @@ module Aws::QuickSight
|
|
13004
14528
|
# @return [String]
|
13005
14529
|
#
|
13006
14530
|
# @!attribute [rw] aws_account_id
|
13007
|
-
# The ID for the
|
13008
|
-
# the ID for the
|
13009
|
-
# account.
|
14531
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
14532
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
14533
|
+
# contains your Amazon QuickSight account.
|
13010
14534
|
# @return [String]
|
13011
14535
|
#
|
13012
14536
|
# @!attribute [rw] namespace
|
@@ -13059,8 +14583,7 @@ module Aws::QuickSight
|
|
13059
14583
|
# QuickSight (admin, author, reader).
|
13060
14584
|
#
|
13061
14585
|
# This feature is available only to QuickSight Enterprise edition
|
13062
|
-
# subscriptions
|
13063
|
-
# (SSO).
|
14586
|
+
# subscriptions.
|
13064
14587
|
# @return [String]
|
13065
14588
|
#
|
13066
14589
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -13071,6 +14594,39 @@ module Aws::QuickSight
|
|
13071
14594
|
# value.
|
13072
14595
|
# @return [Boolean]
|
13073
14596
|
#
|
14597
|
+
# @!attribute [rw] external_login_federation_provider_type
|
14598
|
+
# The type of supported external login provider that provides identity
|
14599
|
+
# to let a user federate into QuickSight with an associated AWS
|
14600
|
+
# Identity and Access Management (IAM) role. The type of supported
|
14601
|
+
# external login provider can be one of the following.
|
14602
|
+
#
|
14603
|
+
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
14604
|
+
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
14605
|
+
# provider type, don’t use the "CustomFederationProviderUrl"
|
14606
|
+
# parameter which is only needed when the external provider is
|
14607
|
+
# custom.
|
14608
|
+
#
|
14609
|
+
# * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
|
14610
|
+
# choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
|
14611
|
+
# parameter to provide the custom OIDC provider URL.
|
14612
|
+
#
|
14613
|
+
# * `NONE`\: This clears all the previously saved external login
|
14614
|
+
# information for a user. Use ` DescribeUser ` API to check the
|
14615
|
+
# external login information.
|
14616
|
+
# @return [String]
|
14617
|
+
#
|
14618
|
+
# @!attribute [rw] custom_federation_provider_url
|
14619
|
+
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
14620
|
+
# identity to let a user federate into QuickSight with an associated
|
14621
|
+
# AWS Identity and Access Management (IAM) role. This parameter should
|
14622
|
+
# only be used when `ExternalLoginFederationProviderType` parameter is
|
14623
|
+
# set to `CUSTOM_OIDC`.
|
14624
|
+
# @return [String]
|
14625
|
+
#
|
14626
|
+
# @!attribute [rw] external_login_id
|
14627
|
+
# The identity ID for a user in the external login provider.
|
14628
|
+
# @return [String]
|
14629
|
+
#
|
13074
14630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
|
13075
14631
|
#
|
13076
14632
|
class UpdateUserRequest < Struct.new(
|
@@ -13080,7 +14636,10 @@ module Aws::QuickSight
|
|
13080
14636
|
:email,
|
13081
14637
|
:role,
|
13082
14638
|
:custom_permissions_name,
|
13083
|
-
:unapply_custom_permissions
|
14639
|
+
:unapply_custom_permissions,
|
14640
|
+
:external_login_federation_provider_type,
|
14641
|
+
:custom_federation_provider_url,
|
14642
|
+
:external_login_id)
|
13084
14643
|
SENSITIVE = []
|
13085
14644
|
include Aws::Structure
|
13086
14645
|
end
|
@@ -13090,7 +14649,7 @@ module Aws::QuickSight
|
|
13090
14649
|
# @return [Types::User]
|
13091
14650
|
#
|
13092
14651
|
# @!attribute [rw] request_id
|
13093
|
-
# The
|
14652
|
+
# The Amazon Web Services request ID for this operation.
|
13094
14653
|
# @return [String]
|
13095
14654
|
#
|
13096
14655
|
# @!attribute [rw] status
|
@@ -13204,6 +14763,25 @@ module Aws::QuickSight
|
|
13204
14763
|
# The custom permissions profile associated with this user.
|
13205
14764
|
# @return [String]
|
13206
14765
|
#
|
14766
|
+
# @!attribute [rw] external_login_federation_provider_type
|
14767
|
+
# The type of supported external login provider that provides identity
|
14768
|
+
# to let the user federate into Amazon QuickSight with an associated
|
14769
|
+
# IAM role. The type can be one of the following.
|
14770
|
+
#
|
14771
|
+
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
14772
|
+
# cognito-identity.amazonaws.com.
|
14773
|
+
#
|
14774
|
+
# * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider.
|
14775
|
+
# @return [String]
|
14776
|
+
#
|
14777
|
+
# @!attribute [rw] external_login_federation_provider_url
|
14778
|
+
# The URL of the external login provider.
|
14779
|
+
# @return [String]
|
14780
|
+
#
|
14781
|
+
# @!attribute [rw] external_login_id
|
14782
|
+
# The identity ID for the user in the external login provider.
|
14783
|
+
# @return [String]
|
14784
|
+
#
|
13207
14785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
|
13208
14786
|
#
|
13209
14787
|
class User < Struct.new(
|
@@ -13214,7 +14792,10 @@ module Aws::QuickSight
|
|
13214
14792
|
:identity_type,
|
13215
14793
|
:active,
|
13216
14794
|
:principal_id,
|
13217
|
-
:custom_permissions_name
|
14795
|
+
:custom_permissions_name,
|
14796
|
+
:external_login_federation_provider_type,
|
14797
|
+
:external_login_federation_provider_url,
|
14798
|
+
:external_login_id)
|
13218
14799
|
SENSITIVE = []
|
13219
14800
|
include Aws::Structure
|
13220
14801
|
end
|