aws-sdk-quicksight 1.45.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1279 -321
- data/lib/aws-sdk-quicksight/client_api.rb +519 -0
- data/lib/aws-sdk-quicksight/types.rb +2067 -500
- metadata +4 -4
@@ -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
|
@@ -1445,6 +1501,18 @@ module Aws::QuickSight
|
|
1445
1501
|
# arn: "Arn", # required
|
1446
1502
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
1447
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
|
+
# ],
|
1448
1516
|
# },
|
1449
1517
|
# column_level_permission_rules: [
|
1450
1518
|
# {
|
@@ -1461,12 +1529,12 @@ module Aws::QuickSight
|
|
1461
1529
|
# }
|
1462
1530
|
#
|
1463
1531
|
# @!attribute [rw] aws_account_id
|
1464
|
-
# The
|
1532
|
+
# The Amazon Web Services account; ID.
|
1465
1533
|
# @return [String]
|
1466
1534
|
#
|
1467
1535
|
# @!attribute [rw] data_set_id
|
1468
1536
|
# An ID for the dataset that you want to create. This ID is unique per
|
1469
|
-
#
|
1537
|
+
# Region; for each Amazon Web Services account;.
|
1470
1538
|
# @return [String]
|
1471
1539
|
#
|
1472
1540
|
# @!attribute [rw] name
|
@@ -1506,6 +1574,12 @@ module Aws::QuickSight
|
|
1506
1574
|
# create.
|
1507
1575
|
# @return [Types::RowLevelPermissionDataSet]
|
1508
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
|
+
#
|
1509
1583
|
# @!attribute [rw] column_level_permission_rules
|
1510
1584
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
1511
1585
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
@@ -1528,6 +1602,7 @@ module Aws::QuickSight
|
|
1528
1602
|
:field_folders,
|
1529
1603
|
:permissions,
|
1530
1604
|
:row_level_permission_data_set,
|
1605
|
+
:row_level_permission_tag_configuration,
|
1531
1606
|
:column_level_permission_rules,
|
1532
1607
|
:tags)
|
1533
1608
|
SENSITIVE = []
|
@@ -1540,7 +1615,7 @@ module Aws::QuickSight
|
|
1540
1615
|
#
|
1541
1616
|
# @!attribute [rw] data_set_id
|
1542
1617
|
# The ID for the dataset that you want to create. This ID is unique
|
1543
|
-
# per
|
1618
|
+
# per Region; for each Amazon Web Services account;.
|
1544
1619
|
# @return [String]
|
1545
1620
|
#
|
1546
1621
|
# @!attribute [rw] ingestion_arn
|
@@ -1554,7 +1629,7 @@ module Aws::QuickSight
|
|
1554
1629
|
# @return [String]
|
1555
1630
|
#
|
1556
1631
|
# @!attribute [rw] request_id
|
1557
|
-
# The
|
1632
|
+
# The Amazon Web Services request ID for this operation.
|
1558
1633
|
# @return [String]
|
1559
1634
|
#
|
1560
1635
|
# @!attribute [rw] status
|
@@ -1794,12 +1869,12 @@ module Aws::QuickSight
|
|
1794
1869
|
# }
|
1795
1870
|
#
|
1796
1871
|
# @!attribute [rw] aws_account_id
|
1797
|
-
# The
|
1872
|
+
# The Amazon Web Services account; ID.
|
1798
1873
|
# @return [String]
|
1799
1874
|
#
|
1800
1875
|
# @!attribute [rw] data_source_id
|
1801
|
-
# An ID for the data source. This ID is unique per
|
1802
|
-
#
|
1876
|
+
# An ID for the data source. This ID is unique per Region; for each
|
1877
|
+
# Amazon Web Services account;.
|
1803
1878
|
# @return [String]
|
1804
1879
|
#
|
1805
1880
|
# @!attribute [rw] name
|
@@ -1868,8 +1943,8 @@ module Aws::QuickSight
|
|
1868
1943
|
# @return [String]
|
1869
1944
|
#
|
1870
1945
|
# @!attribute [rw] data_source_id
|
1871
|
-
# The ID of the data source. This ID is unique per
|
1872
|
-
#
|
1946
|
+
# The ID of the data source. This ID is unique per Region; for each
|
1947
|
+
# Amazon Web Services account;.
|
1873
1948
|
# @return [String]
|
1874
1949
|
#
|
1875
1950
|
# @!attribute [rw] creation_status
|
@@ -1877,7 +1952,7 @@ module Aws::QuickSight
|
|
1877
1952
|
# @return [String]
|
1878
1953
|
#
|
1879
1954
|
# @!attribute [rw] request_id
|
1880
|
-
# The
|
1955
|
+
# The Amazon Web Services request ID for this operation.
|
1881
1956
|
# @return [String]
|
1882
1957
|
#
|
1883
1958
|
# @!attribute [rw] status
|
@@ -1896,6 +1971,166 @@ module Aws::QuickSight
|
|
1896
1971
|
include Aws::Structure
|
1897
1972
|
end
|
1898
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
|
+
|
1899
2134
|
# @note When making an API call, you may pass CreateGroupMembershipRequest
|
1900
2135
|
# data as a hash:
|
1901
2136
|
#
|
@@ -1915,9 +2150,9 @@ module Aws::QuickSight
|
|
1915
2150
|
# @return [String]
|
1916
2151
|
#
|
1917
2152
|
# @!attribute [rw] aws_account_id
|
1918
|
-
# The ID for the
|
1919
|
-
# the ID for the
|
1920
|
-
# 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.
|
1921
2156
|
# @return [String]
|
1922
2157
|
#
|
1923
2158
|
# @!attribute [rw] namespace
|
@@ -1940,7 +2175,7 @@ module Aws::QuickSight
|
|
1940
2175
|
# @return [Types::GroupMember]
|
1941
2176
|
#
|
1942
2177
|
# @!attribute [rw] request_id
|
1943
|
-
# The
|
2178
|
+
# The Amazon Web Services request ID for this operation.
|
1944
2179
|
# @return [String]
|
1945
2180
|
#
|
1946
2181
|
# @!attribute [rw] status
|
@@ -1978,9 +2213,9 @@ module Aws::QuickSight
|
|
1978
2213
|
# @return [String]
|
1979
2214
|
#
|
1980
2215
|
# @!attribute [rw] aws_account_id
|
1981
|
-
# The ID for the
|
1982
|
-
# the ID for the
|
1983
|
-
# 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.
|
1984
2219
|
# @return [String]
|
1985
2220
|
#
|
1986
2221
|
# @!attribute [rw] namespace
|
@@ -2005,7 +2240,7 @@ module Aws::QuickSight
|
|
2005
2240
|
# @return [Types::Group]
|
2006
2241
|
#
|
2007
2242
|
# @!attribute [rw] request_id
|
2008
|
-
# The
|
2243
|
+
# The Amazon Web Services request ID for this operation.
|
2009
2244
|
# @return [String]
|
2010
2245
|
#
|
2011
2246
|
# @!attribute [rw] status
|
@@ -2037,13 +2272,13 @@ module Aws::QuickSight
|
|
2037
2272
|
# }
|
2038
2273
|
#
|
2039
2274
|
# @!attribute [rw] aws_account_id
|
2040
|
-
# The ID of the
|
2041
|
-
# 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.
|
2042
2277
|
# @return [String]
|
2043
2278
|
#
|
2044
2279
|
# @!attribute [rw] assignment_name
|
2045
2280
|
# The name of the assignment, also called a rule. It must be unique
|
2046
|
-
# within an
|
2281
|
+
# within an Amazon Web Services account;.
|
2047
2282
|
# @return [String]
|
2048
2283
|
#
|
2049
2284
|
# @!attribute [rw] assignment_status
|
@@ -2087,8 +2322,8 @@ module Aws::QuickSight
|
|
2087
2322
|
end
|
2088
2323
|
|
2089
2324
|
# @!attribute [rw] assignment_name
|
2090
|
-
# The name of the assignment. This name must be unique within the
|
2091
|
-
# account
|
2325
|
+
# The name of the assignment. This name must be unique within the
|
2326
|
+
# Amazon Web Services account;.
|
2092
2327
|
# @return [String]
|
2093
2328
|
#
|
2094
2329
|
# @!attribute [rw] assignment_id
|
@@ -2119,7 +2354,7 @@ module Aws::QuickSight
|
|
2119
2354
|
# @return [Hash<String,Array<String>>]
|
2120
2355
|
#
|
2121
2356
|
# @!attribute [rw] request_id
|
2122
|
-
# The
|
2357
|
+
# The Amazon Web Services request ID for this operation.
|
2123
2358
|
# @return [String]
|
2124
2359
|
#
|
2125
2360
|
# @!attribute [rw] status
|
@@ -2158,7 +2393,7 @@ module Aws::QuickSight
|
|
2158
2393
|
# @return [String]
|
2159
2394
|
#
|
2160
2395
|
# @!attribute [rw] aws_account_id
|
2161
|
-
# The
|
2396
|
+
# The Amazon Web Services account; ID.
|
2162
2397
|
# @return [String]
|
2163
2398
|
#
|
2164
2399
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
@@ -2184,7 +2419,7 @@ module Aws::QuickSight
|
|
2184
2419
|
# @return [String]
|
2185
2420
|
#
|
2186
2421
|
# @!attribute [rw] request_id
|
2187
|
-
# The
|
2422
|
+
# The Amazon Web Services request ID for this operation.
|
2188
2423
|
# @return [String]
|
2189
2424
|
#
|
2190
2425
|
# @!attribute [rw] status
|
@@ -2219,8 +2454,8 @@ module Aws::QuickSight
|
|
2219
2454
|
# }
|
2220
2455
|
#
|
2221
2456
|
# @!attribute [rw] aws_account_id
|
2222
|
-
# The ID for the
|
2223
|
-
# namespace in.
|
2457
|
+
# The ID for the Amazon Web Services account; that you want to create
|
2458
|
+
# the QuickSight namespace in.
|
2224
2459
|
# @return [String]
|
2225
2460
|
#
|
2226
2461
|
# @!attribute [rw] namespace
|
@@ -2257,8 +2492,8 @@ module Aws::QuickSight
|
|
2257
2492
|
# @return [String]
|
2258
2493
|
#
|
2259
2494
|
# @!attribute [rw] capacity_region
|
2260
|
-
# The
|
2261
|
-
#
|
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
|
2262
2497
|
# CreateNamespace in.
|
2263
2498
|
# @return [String]
|
2264
2499
|
#
|
@@ -2276,7 +2511,7 @@ module Aws::QuickSight
|
|
2276
2511
|
# @return [String]
|
2277
2512
|
#
|
2278
2513
|
# @!attribute [rw] request_id
|
2279
|
-
# The
|
2514
|
+
# The Amazon Web Services request ID for this operation.
|
2280
2515
|
# @return [String]
|
2281
2516
|
#
|
2282
2517
|
# @!attribute [rw] status
|
@@ -2308,8 +2543,8 @@ module Aws::QuickSight
|
|
2308
2543
|
# }
|
2309
2544
|
#
|
2310
2545
|
# @!attribute [rw] aws_account_id
|
2311
|
-
# The ID of the
|
2312
|
-
# creating an alias for.
|
2546
|
+
# The ID of the Amazon Web Services account; that contains the
|
2547
|
+
# template that you creating an alias for.
|
2313
2548
|
# @return [String]
|
2314
2549
|
#
|
2315
2550
|
# @!attribute [rw] template_id
|
@@ -2319,7 +2554,7 @@ module Aws::QuickSight
|
|
2319
2554
|
# @!attribute [rw] alias_name
|
2320
2555
|
# The name that you want to give to the template alias that you're
|
2321
2556
|
# creating. Don't start the alias name with the `$` character. Alias
|
2322
|
-
# names that start with `$` are reserved by QuickSight.
|
2557
|
+
# names that start with `$` are reserved by Amazon QuickSight.
|
2323
2558
|
# @return [String]
|
2324
2559
|
#
|
2325
2560
|
# @!attribute [rw] template_version_number
|
@@ -2346,7 +2581,7 @@ module Aws::QuickSight
|
|
2346
2581
|
# @return [Integer]
|
2347
2582
|
#
|
2348
2583
|
# @!attribute [rw] request_id
|
2349
|
-
# The
|
2584
|
+
# The Amazon Web Services request ID for this operation.
|
2350
2585
|
# @return [String]
|
2351
2586
|
#
|
2352
2587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateAliasResponse AWS API Documentation
|
@@ -2396,14 +2631,14 @@ module Aws::QuickSight
|
|
2396
2631
|
# }
|
2397
2632
|
#
|
2398
2633
|
# @!attribute [rw] aws_account_id
|
2399
|
-
# The ID for the
|
2400
|
-
# the ID for the
|
2401
|
-
# 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.
|
2402
2637
|
# @return [String]
|
2403
2638
|
#
|
2404
2639
|
# @!attribute [rw] template_id
|
2405
2640
|
# An ID for the template that you want to create. This template is
|
2406
|
-
# unique per
|
2641
|
+
# unique per Region; in each Amazon Web Services account;.
|
2407
2642
|
# @return [String]
|
2408
2643
|
#
|
2409
2644
|
# @!attribute [rw] name
|
@@ -2421,8 +2656,8 @@ module Aws::QuickSight
|
|
2421
2656
|
# for an analysis. Both of these require an Amazon Resource Name
|
2422
2657
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2423
2658
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2424
|
-
# `SourceTemplate` ARN can contain any
|
2425
|
-
# QuickSight-supported
|
2659
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account;
|
2660
|
+
# and any QuickSight-supported Region;.
|
2426
2661
|
#
|
2427
2662
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2428
2663
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -2479,7 +2714,7 @@ module Aws::QuickSight
|
|
2479
2714
|
# @return [Integer]
|
2480
2715
|
#
|
2481
2716
|
# @!attribute [rw] request_id
|
2482
|
-
# The
|
2717
|
+
# The Amazon Web Services request ID for this operation.
|
2483
2718
|
# @return [String]
|
2484
2719
|
#
|
2485
2720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateResponse AWS API Documentation
|
@@ -2506,8 +2741,8 @@ module Aws::QuickSight
|
|
2506
2741
|
# }
|
2507
2742
|
#
|
2508
2743
|
# @!attribute [rw] aws_account_id
|
2509
|
-
# The ID of the
|
2510
|
-
# alias.
|
2744
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
2745
|
+
# for the new theme alias.
|
2511
2746
|
# @return [String]
|
2512
2747
|
#
|
2513
2748
|
# @!attribute [rw] theme_id
|
@@ -2544,7 +2779,7 @@ module Aws::QuickSight
|
|
2544
2779
|
# @return [Integer]
|
2545
2780
|
#
|
2546
2781
|
# @!attribute [rw] request_id
|
2547
|
-
# The
|
2782
|
+
# The Amazon Web Services request ID for this operation.
|
2548
2783
|
# @return [String]
|
2549
2784
|
#
|
2550
2785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAliasResponse AWS API Documentation
|
@@ -2621,12 +2856,13 @@ module Aws::QuickSight
|
|
2621
2856
|
# }
|
2622
2857
|
#
|
2623
2858
|
# @!attribute [rw] aws_account_id
|
2624
|
-
# The ID of the
|
2859
|
+
# The ID of the Amazon Web Services account; where you want to store
|
2860
|
+
# the new theme.
|
2625
2861
|
# @return [String]
|
2626
2862
|
#
|
2627
2863
|
# @!attribute [rw] theme_id
|
2628
2864
|
# An ID for the theme that you want to create. The theme ID is unique
|
2629
|
-
# per
|
2865
|
+
# per Region; in each Amazon Web Services account;.
|
2630
2866
|
# @return [String]
|
2631
2867
|
#
|
2632
2868
|
# @!attribute [rw] name
|
@@ -2697,7 +2933,7 @@ module Aws::QuickSight
|
|
2697
2933
|
# @return [Integer]
|
2698
2934
|
#
|
2699
2935
|
# @!attribute [rw] request_id
|
2700
|
-
# The
|
2936
|
+
# The Amazon Web Services request ID for this operation.
|
2701
2937
|
# @return [String]
|
2702
2938
|
#
|
2703
2939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeResponse AWS API Documentation
|
@@ -3335,6 +3571,10 @@ module Aws::QuickSight
|
|
3335
3571
|
# The row-level security configuration for the dataset.
|
3336
3572
|
# @return [Types::RowLevelPermissionDataSet]
|
3337
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
|
+
#
|
3338
3578
|
# @!attribute [rw] column_level_permission_rules
|
3339
3579
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
3340
3580
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
@@ -3355,6 +3595,7 @@ module Aws::QuickSight
|
|
3355
3595
|
:column_groups,
|
3356
3596
|
:field_folders,
|
3357
3597
|
:row_level_permission_data_set,
|
3598
|
+
:row_level_permission_tag_configuration,
|
3358
3599
|
:column_level_permission_rules)
|
3359
3600
|
SENSITIVE = []
|
3360
3601
|
include Aws::Structure
|
@@ -3456,6 +3697,10 @@ module Aws::QuickSight
|
|
3456
3697
|
# The row-level security configuration for the dataset.
|
3457
3698
|
# @return [Types::RowLevelPermissionDataSet]
|
3458
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
|
+
#
|
3459
3704
|
# @!attribute [rw] column_level_permission_rules_applied
|
3460
3705
|
# A value that indicates if the dataset has column level permission
|
3461
3706
|
# configured.
|
@@ -3471,6 +3716,7 @@ module Aws::QuickSight
|
|
3471
3716
|
:last_updated_time,
|
3472
3717
|
:import_mode,
|
3473
3718
|
:row_level_permission_data_set,
|
3719
|
+
:row_level_permission_tag_configuration_applied,
|
3474
3720
|
:column_level_permission_rules_applied)
|
3475
3721
|
SENSITIVE = []
|
3476
3722
|
include Aws::Structure
|
@@ -3483,8 +3729,8 @@ module Aws::QuickSight
|
|
3483
3729
|
# @return [String]
|
3484
3730
|
#
|
3485
3731
|
# @!attribute [rw] data_source_id
|
3486
|
-
# The ID of the data source. This ID is unique per
|
3487
|
-
#
|
3732
|
+
# The ID of the data source. This ID is unique per Region; for each
|
3733
|
+
# Amazon Web Services account;.
|
3488
3734
|
# @return [String]
|
3489
3735
|
#
|
3490
3736
|
# @!attribute [rw] name
|
@@ -3825,7 +4071,7 @@ module Aws::QuickSight
|
|
3825
4071
|
# @return [Types::AuroraPostgreSqlParameters]
|
3826
4072
|
#
|
3827
4073
|
# @!attribute [rw] aws_iot_analytics_parameters
|
3828
|
-
#
|
4074
|
+
# Amazon Web Services IoT Analytics parameters.
|
3829
4075
|
# @return [Types::AwsIotAnalyticsParameters]
|
3830
4076
|
#
|
3831
4077
|
# @!attribute [rw] jira_parameters
|
@@ -3978,8 +4224,8 @@ module Aws::QuickSight
|
|
3978
4224
|
# }
|
3979
4225
|
#
|
3980
4226
|
# @!attribute [rw] aws_account_id
|
3981
|
-
# The ID for the
|
3982
|
-
# 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;.
|
3983
4229
|
# @return [String]
|
3984
4230
|
#
|
3985
4231
|
# @!attribute [rw] namespace
|
@@ -3997,7 +4243,7 @@ module Aws::QuickSight
|
|
3997
4243
|
end
|
3998
4244
|
|
3999
4245
|
# @!attribute [rw] request_id
|
4000
|
-
# The
|
4246
|
+
# The Amazon Web Services request ID for this operation.
|
4001
4247
|
# @return [String]
|
4002
4248
|
#
|
4003
4249
|
# @!attribute [rw] status
|
@@ -4024,7 +4270,8 @@ module Aws::QuickSight
|
|
4024
4270
|
# }
|
4025
4271
|
#
|
4026
4272
|
# @!attribute [rw] aws_account_id
|
4027
|
-
# The ID of the
|
4273
|
+
# The ID of the Amazon Web Services account; where you want to delete
|
4274
|
+
# an analysis.
|
4028
4275
|
# @return [String]
|
4029
4276
|
#
|
4030
4277
|
# @!attribute [rw] analysis_id
|
@@ -4073,7 +4320,7 @@ module Aws::QuickSight
|
|
4073
4320
|
# @return [Time]
|
4074
4321
|
#
|
4075
4322
|
# @!attribute [rw] request_id
|
4076
|
-
# The
|
4323
|
+
# The Amazon Web Services request ID for this operation.
|
4077
4324
|
# @return [String]
|
4078
4325
|
#
|
4079
4326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisResponse AWS API Documentation
|
@@ -4098,8 +4345,8 @@ module Aws::QuickSight
|
|
4098
4345
|
# }
|
4099
4346
|
#
|
4100
4347
|
# @!attribute [rw] aws_account_id
|
4101
|
-
# The ID of the
|
4102
|
-
# deleting.
|
4348
|
+
# The ID of the Amazon Web Services account; that contains the
|
4349
|
+
# dashboard that you're deleting.
|
4103
4350
|
# @return [String]
|
4104
4351
|
#
|
4105
4352
|
# @!attribute [rw] dashboard_id
|
@@ -4135,7 +4382,7 @@ module Aws::QuickSight
|
|
4135
4382
|
# @return [String]
|
4136
4383
|
#
|
4137
4384
|
# @!attribute [rw] request_id
|
4138
|
-
# The
|
4385
|
+
# The Amazon Web Services request ID for this operation.
|
4139
4386
|
# @return [String]
|
4140
4387
|
#
|
4141
4388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboardResponse AWS API Documentation
|
@@ -4158,12 +4405,12 @@ module Aws::QuickSight
|
|
4158
4405
|
# }
|
4159
4406
|
#
|
4160
4407
|
# @!attribute [rw] aws_account_id
|
4161
|
-
# The
|
4408
|
+
# The Amazon Web Services account; ID.
|
4162
4409
|
# @return [String]
|
4163
4410
|
#
|
4164
4411
|
# @!attribute [rw] data_set_id
|
4165
4412
|
# The ID for the dataset that you want to create. This ID is unique
|
4166
|
-
# per
|
4413
|
+
# per Region; for each Amazon Web Services account;.
|
4167
4414
|
# @return [String]
|
4168
4415
|
#
|
4169
4416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4181,11 +4428,11 @@ module Aws::QuickSight
|
|
4181
4428
|
#
|
4182
4429
|
# @!attribute [rw] data_set_id
|
4183
4430
|
# The ID for the dataset that you want to create. This ID is unique
|
4184
|
-
# per
|
4431
|
+
# per Region; for each Amazon Web Services account;.
|
4185
4432
|
# @return [String]
|
4186
4433
|
#
|
4187
4434
|
# @!attribute [rw] request_id
|
4188
|
-
# The
|
4435
|
+
# The Amazon Web Services request ID for this operation.
|
4189
4436
|
# @return [String]
|
4190
4437
|
#
|
4191
4438
|
# @!attribute [rw] status
|
@@ -4212,12 +4459,12 @@ module Aws::QuickSight
|
|
4212
4459
|
# }
|
4213
4460
|
#
|
4214
4461
|
# @!attribute [rw] aws_account_id
|
4215
|
-
# The
|
4462
|
+
# The Amazon Web Services account; ID.
|
4216
4463
|
# @return [String]
|
4217
4464
|
#
|
4218
4465
|
# @!attribute [rw] data_source_id
|
4219
|
-
# The ID of the data source. This ID is unique per
|
4220
|
-
#
|
4466
|
+
# The ID of the data source. This ID is unique per Region; for each
|
4467
|
+
# Amazon Web Services account;.
|
4221
4468
|
# @return [String]
|
4222
4469
|
#
|
4223
4470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4234,12 +4481,12 @@ module Aws::QuickSight
|
|
4234
4481
|
# @return [String]
|
4235
4482
|
#
|
4236
4483
|
# @!attribute [rw] data_source_id
|
4237
|
-
# The ID of the data source. This ID is unique per
|
4238
|
-
#
|
4484
|
+
# The ID of the data source. This ID is unique per Region; for each
|
4485
|
+
# Amazon Web Services account;.
|
4239
4486
|
# @return [String]
|
4240
4487
|
#
|
4241
4488
|
# @!attribute [rw] request_id
|
4242
|
-
# The
|
4489
|
+
# The Amazon Web Services request ID for this operation.
|
4243
4490
|
# @return [String]
|
4244
4491
|
#
|
4245
4492
|
# @!attribute [rw] status
|
@@ -4257,6 +4504,116 @@ module Aws::QuickSight
|
|
4257
4504
|
include Aws::Structure
|
4258
4505
|
end
|
4259
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
|
+
|
4260
4617
|
# @note When making an API call, you may pass DeleteGroupMembershipRequest
|
4261
4618
|
# data as a hash:
|
4262
4619
|
#
|
@@ -4277,9 +4634,9 @@ module Aws::QuickSight
|
|
4277
4634
|
# @return [String]
|
4278
4635
|
#
|
4279
4636
|
# @!attribute [rw] aws_account_id
|
4280
|
-
# The ID for the
|
4281
|
-
# the ID for the
|
4282
|
-
# 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.
|
4283
4640
|
# @return [String]
|
4284
4641
|
#
|
4285
4642
|
# @!attribute [rw] namespace
|
@@ -4298,7 +4655,7 @@ module Aws::QuickSight
|
|
4298
4655
|
end
|
4299
4656
|
|
4300
4657
|
# @!attribute [rw] request_id
|
4301
|
-
# The
|
4658
|
+
# The Amazon Web Services request ID for this operation.
|
4302
4659
|
# @return [String]
|
4303
4660
|
#
|
4304
4661
|
# @!attribute [rw] status
|
@@ -4328,9 +4685,9 @@ module Aws::QuickSight
|
|
4328
4685
|
# @return [String]
|
4329
4686
|
#
|
4330
4687
|
# @!attribute [rw] aws_account_id
|
4331
|
-
# The ID for the
|
4332
|
-
# the ID for the
|
4333
|
-
# 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.
|
4334
4691
|
# @return [String]
|
4335
4692
|
#
|
4336
4693
|
# @!attribute [rw] namespace
|
@@ -4348,7 +4705,7 @@ module Aws::QuickSight
|
|
4348
4705
|
end
|
4349
4706
|
|
4350
4707
|
# @!attribute [rw] request_id
|
4351
|
-
# The
|
4708
|
+
# The Amazon Web Services request ID for this operation.
|
4352
4709
|
# @return [String]
|
4353
4710
|
#
|
4354
4711
|
# @!attribute [rw] status
|
@@ -4374,8 +4731,8 @@ module Aws::QuickSight
|
|
4374
4731
|
# }
|
4375
4732
|
#
|
4376
4733
|
# @!attribute [rw] aws_account_id
|
4377
|
-
# The
|
4378
|
-
# assignment.
|
4734
|
+
# The Amazon Web Services account; ID where you want to delete the IAM
|
4735
|
+
# policy assignment.
|
4379
4736
|
# @return [String]
|
4380
4737
|
#
|
4381
4738
|
# @!attribute [rw] assignment_name
|
@@ -4401,7 +4758,7 @@ module Aws::QuickSight
|
|
4401
4758
|
# @return [String]
|
4402
4759
|
#
|
4403
4760
|
# @!attribute [rw] request_id
|
4404
|
-
# The
|
4761
|
+
# The Amazon Web Services request ID for this operation.
|
4405
4762
|
# @return [String]
|
4406
4763
|
#
|
4407
4764
|
# @!attribute [rw] status
|
@@ -4427,8 +4784,8 @@ module Aws::QuickSight
|
|
4427
4784
|
# }
|
4428
4785
|
#
|
4429
4786
|
# @!attribute [rw] aws_account_id
|
4430
|
-
# The ID for the
|
4431
|
-
# namespace from.
|
4787
|
+
# The ID for the Amazon Web Services account; that you want to delete
|
4788
|
+
# the QuickSight namespace from.
|
4432
4789
|
# @return [String]
|
4433
4790
|
#
|
4434
4791
|
# @!attribute [rw] namespace
|
@@ -4445,7 +4802,7 @@ module Aws::QuickSight
|
|
4445
4802
|
end
|
4446
4803
|
|
4447
4804
|
# @!attribute [rw] request_id
|
4448
|
-
# The
|
4805
|
+
# The Amazon Web Services request ID for this operation.
|
4449
4806
|
# @return [String]
|
4450
4807
|
#
|
4451
4808
|
# @!attribute [rw] status
|
@@ -4471,7 +4828,8 @@ module Aws::QuickSight
|
|
4471
4828
|
# }
|
4472
4829
|
#
|
4473
4830
|
# @!attribute [rw] aws_account_id
|
4474
|
-
# The ID of the
|
4831
|
+
# The ID of the Amazon Web Services account; that contains the item to
|
4832
|
+
# delete.
|
4475
4833
|
# @return [String]
|
4476
4834
|
#
|
4477
4835
|
# @!attribute [rw] template_id
|
@@ -4512,7 +4870,7 @@ module Aws::QuickSight
|
|
4512
4870
|
# @return [String]
|
4513
4871
|
#
|
4514
4872
|
# @!attribute [rw] request_id
|
4515
|
-
# The
|
4873
|
+
# The Amazon Web Services request ID for this operation.
|
4516
4874
|
# @return [String]
|
4517
4875
|
#
|
4518
4876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplateAliasResponse AWS API Documentation
|
@@ -4537,8 +4895,8 @@ module Aws::QuickSight
|
|
4537
4895
|
# }
|
4538
4896
|
#
|
4539
4897
|
# @!attribute [rw] aws_account_id
|
4540
|
-
# The ID of the
|
4541
|
-
# deleting.
|
4898
|
+
# The ID of the Amazon Web Services account; that contains the
|
4899
|
+
# template that you're deleting.
|
4542
4900
|
# @return [String]
|
4543
4901
|
#
|
4544
4902
|
# @!attribute [rw] template_id
|
@@ -4562,7 +4920,7 @@ module Aws::QuickSight
|
|
4562
4920
|
end
|
4563
4921
|
|
4564
4922
|
# @!attribute [rw] request_id
|
4565
|
-
# The
|
4923
|
+
# The Amazon Web Services request ID for this operation.
|
4566
4924
|
# @return [String]
|
4567
4925
|
#
|
4568
4926
|
# @!attribute [rw] arn
|
@@ -4598,7 +4956,8 @@ module Aws::QuickSight
|
|
4598
4956
|
# }
|
4599
4957
|
#
|
4600
4958
|
# @!attribute [rw] aws_account_id
|
4601
|
-
# The ID of the
|
4959
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
4960
|
+
# alias to delete.
|
4602
4961
|
# @return [String]
|
4603
4962
|
#
|
4604
4963
|
# @!attribute [rw] theme_id
|
@@ -4629,7 +4988,7 @@ module Aws::QuickSight
|
|
4629
4988
|
# @return [String]
|
4630
4989
|
#
|
4631
4990
|
# @!attribute [rw] request_id
|
4632
|
-
# The
|
4991
|
+
# The Amazon Web Services request ID for this operation.
|
4633
4992
|
# @return [String]
|
4634
4993
|
#
|
4635
4994
|
# @!attribute [rw] status
|
@@ -4662,8 +5021,8 @@ module Aws::QuickSight
|
|
4662
5021
|
# }
|
4663
5022
|
#
|
4664
5023
|
# @!attribute [rw] aws_account_id
|
4665
|
-
# The ID of the
|
4666
|
-
# deleting.
|
5024
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
5025
|
+
# that you're deleting.
|
4667
5026
|
# @return [String]
|
4668
5027
|
#
|
4669
5028
|
# @!attribute [rw] theme_id
|
@@ -4692,7 +5051,7 @@ module Aws::QuickSight
|
|
4692
5051
|
# @return [String]
|
4693
5052
|
#
|
4694
5053
|
# @!attribute [rw] request_id
|
4695
|
-
# The
|
5054
|
+
# The Amazon Web Services request ID for this operation.
|
4696
5055
|
# @return [String]
|
4697
5056
|
#
|
4698
5057
|
# @!attribute [rw] status
|
@@ -4728,9 +5087,9 @@ module Aws::QuickSight
|
|
4728
5087
|
# @return [String]
|
4729
5088
|
#
|
4730
5089
|
# @!attribute [rw] aws_account_id
|
4731
|
-
# The ID for the
|
4732
|
-
# the ID for the
|
4733
|
-
# 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.
|
4734
5093
|
# @return [String]
|
4735
5094
|
#
|
4736
5095
|
# @!attribute [rw] namespace
|
@@ -4748,7 +5107,7 @@ module Aws::QuickSight
|
|
4748
5107
|
end
|
4749
5108
|
|
4750
5109
|
# @!attribute [rw] request_id
|
4751
|
-
# The
|
5110
|
+
# The Amazon Web Services request ID for this operation.
|
4752
5111
|
# @return [String]
|
4753
5112
|
#
|
4754
5113
|
# @!attribute [rw] status
|
@@ -4778,9 +5137,9 @@ module Aws::QuickSight
|
|
4778
5137
|
# @return [String]
|
4779
5138
|
#
|
4780
5139
|
# @!attribute [rw] aws_account_id
|
4781
|
-
# The ID for the
|
4782
|
-
# the ID for the
|
4783
|
-
# 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.
|
4784
5143
|
# @return [String]
|
4785
5144
|
#
|
4786
5145
|
# @!attribute [rw] namespace
|
@@ -4798,7 +5157,7 @@ module Aws::QuickSight
|
|
4798
5157
|
end
|
4799
5158
|
|
4800
5159
|
# @!attribute [rw] request_id
|
4801
|
-
# The
|
5160
|
+
# The Amazon Web Services request ID for this operation.
|
4802
5161
|
# @return [String]
|
4803
5162
|
#
|
4804
5163
|
# @!attribute [rw] status
|
@@ -4824,8 +5183,8 @@ module Aws::QuickSight
|
|
4824
5183
|
# }
|
4825
5184
|
#
|
4826
5185
|
# @!attribute [rw] aws_account_id
|
4827
|
-
# The ID for the
|
4828
|
-
# customizations for.
|
5186
|
+
# The ID for the Amazon Web Services account; that you want to
|
5187
|
+
# describe QuickSight customizations for.
|
4829
5188
|
# @return [String]
|
4830
5189
|
#
|
4831
5190
|
# @!attribute [rw] namespace
|
@@ -4854,11 +5213,11 @@ module Aws::QuickSight
|
|
4854
5213
|
|
4855
5214
|
# @!attribute [rw] arn
|
4856
5215
|
# The Amazon Resource Name (ARN) of the customization that's
|
4857
|
-
# associated with this
|
5216
|
+
# associated with this Amazon Web Services account;.
|
4858
5217
|
# @return [String]
|
4859
5218
|
#
|
4860
5219
|
# @!attribute [rw] aws_account_id
|
4861
|
-
# The ID for the
|
5220
|
+
# The ID for the Amazon Web Services account; that you're describing.
|
4862
5221
|
# @return [String]
|
4863
5222
|
#
|
4864
5223
|
# @!attribute [rw] namespace
|
@@ -4866,11 +5225,11 @@ module Aws::QuickSight
|
|
4866
5225
|
# @return [String]
|
4867
5226
|
#
|
4868
5227
|
# @!attribute [rw] account_customization
|
4869
|
-
# The QuickSight customizations that exist in the current
|
5228
|
+
# The QuickSight customizations that exist in the current Region;.
|
4870
5229
|
# @return [Types::AccountCustomization]
|
4871
5230
|
#
|
4872
5231
|
# @!attribute [rw] request_id
|
4873
|
-
# The
|
5232
|
+
# The Amazon Web Services request ID for this operation.
|
4874
5233
|
# @return [String]
|
4875
5234
|
#
|
4876
5235
|
# @!attribute [rw] status
|
@@ -4898,8 +5257,8 @@ module Aws::QuickSight
|
|
4898
5257
|
# }
|
4899
5258
|
#
|
4900
5259
|
# @!attribute [rw] aws_account_id
|
4901
|
-
# The ID for the
|
4902
|
-
# to list.
|
5260
|
+
# The ID for the Amazon Web Services account; that contains the
|
5261
|
+
# settings that you want to list.
|
4903
5262
|
# @return [String]
|
4904
5263
|
#
|
4905
5264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsRequest AWS API Documentation
|
@@ -4911,19 +5270,19 @@ module Aws::QuickSight
|
|
4911
5270
|
end
|
4912
5271
|
|
4913
5272
|
# @!attribute [rw] account_settings
|
4914
|
-
# The QuickSight settings for this
|
4915
|
-
# includes the edition of Amazon QuickSight that you
|
4916
|
-
# (Standard or Enterprise) and the notification email
|
4917
|
-
# QuickSight subscription. In the QuickSight console, the
|
4918
|
-
# subscription is sometimes referred to as a QuickSight
|
4919
|
-
# even though it's technically not an account by itself.
|
4920
|
-
# it's a subscription to the QuickSight service for your
|
4921
|
-
# The edition that you subscribe to
|
4922
|
-
# 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.
|
4923
5282
|
# @return [Types::AccountSettings]
|
4924
5283
|
#
|
4925
5284
|
# @!attribute [rw] request_id
|
4926
|
-
# The
|
5285
|
+
# The Amazon Web Services request ID for this operation.
|
4927
5286
|
# @return [String]
|
4928
5287
|
#
|
4929
5288
|
# @!attribute [rw] status
|
@@ -4949,9 +5308,9 @@ module Aws::QuickSight
|
|
4949
5308
|
# }
|
4950
5309
|
#
|
4951
5310
|
# @!attribute [rw] aws_account_id
|
4952
|
-
# The ID of the
|
4953
|
-
# permissions you're describing. You must be using the
|
4954
|
-
# 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.
|
4955
5314
|
# @return [String]
|
4956
5315
|
#
|
4957
5316
|
# @!attribute [rw] analysis_id
|
@@ -4987,7 +5346,7 @@ module Aws::QuickSight
|
|
4987
5346
|
# @return [Integer]
|
4988
5347
|
#
|
4989
5348
|
# @!attribute [rw] request_id
|
4990
|
-
# The
|
5349
|
+
# The Amazon Web Services request ID for this operation.
|
4991
5350
|
# @return [String]
|
4992
5351
|
#
|
4993
5352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsResponse AWS API Documentation
|
@@ -5011,8 +5370,9 @@ module Aws::QuickSight
|
|
5011
5370
|
# }
|
5012
5371
|
#
|
5013
5372
|
# @!attribute [rw] aws_account_id
|
5014
|
-
# The ID of the
|
5015
|
-
#
|
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.
|
5016
5376
|
# @return [String]
|
5017
5377
|
#
|
5018
5378
|
# @!attribute [rw] analysis_id
|
@@ -5039,7 +5399,7 @@ module Aws::QuickSight
|
|
5039
5399
|
# @return [Integer]
|
5040
5400
|
#
|
5041
5401
|
# @!attribute [rw] request_id
|
5042
|
-
# The
|
5402
|
+
# The Amazon Web Services request ID for this operation.
|
5043
5403
|
# @return [String]
|
5044
5404
|
#
|
5045
5405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
|
@@ -5061,8 +5421,8 @@ module Aws::QuickSight
|
|
5061
5421
|
# }
|
5062
5422
|
#
|
5063
5423
|
# @!attribute [rw] aws_account_id
|
5064
|
-
# The ID of the
|
5065
|
-
# describing permissions for.
|
5424
|
+
# The ID of the Amazon Web Services account; that contains the
|
5425
|
+
# dashboard that you're describing permissions for.
|
5066
5426
|
# @return [String]
|
5067
5427
|
#
|
5068
5428
|
# @!attribute [rw] dashboard_id
|
@@ -5095,7 +5455,7 @@ module Aws::QuickSight
|
|
5095
5455
|
# @return [Integer]
|
5096
5456
|
#
|
5097
5457
|
# @!attribute [rw] request_id
|
5098
|
-
# The
|
5458
|
+
# The Amazon Web Services request ID for this operation.
|
5099
5459
|
# @return [String]
|
5100
5460
|
#
|
5101
5461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsResponse AWS API Documentation
|
@@ -5121,8 +5481,8 @@ module Aws::QuickSight
|
|
5121
5481
|
# }
|
5122
5482
|
#
|
5123
5483
|
# @!attribute [rw] aws_account_id
|
5124
|
-
# The ID of the
|
5125
|
-
# describing.
|
5484
|
+
# The ID of the Amazon Web Services account; that contains the
|
5485
|
+
# dashboard that you're describing.
|
5126
5486
|
# @return [String]
|
5127
5487
|
#
|
5128
5488
|
# @!attribute [rw] dashboard_id
|
@@ -5158,7 +5518,7 @@ module Aws::QuickSight
|
|
5158
5518
|
# @return [Integer]
|
5159
5519
|
#
|
5160
5520
|
# @!attribute [rw] request_id
|
5161
|
-
# The
|
5521
|
+
# The Amazon Web Services request ID for this operation.
|
5162
5522
|
# @return [String]
|
5163
5523
|
#
|
5164
5524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardResponse AWS API Documentation
|
@@ -5180,12 +5540,12 @@ module Aws::QuickSight
|
|
5180
5540
|
# }
|
5181
5541
|
#
|
5182
5542
|
# @!attribute [rw] aws_account_id
|
5183
|
-
# The
|
5543
|
+
# The Amazon Web Services account; ID.
|
5184
5544
|
# @return [String]
|
5185
5545
|
#
|
5186
5546
|
# @!attribute [rw] data_set_id
|
5187
5547
|
# The ID for the dataset that you want to create. This ID is unique
|
5188
|
-
# per
|
5548
|
+
# per Region; for each Amazon Web Services account;.
|
5189
5549
|
# @return [String]
|
5190
5550
|
#
|
5191
5551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5203,7 +5563,7 @@ module Aws::QuickSight
|
|
5203
5563
|
#
|
5204
5564
|
# @!attribute [rw] data_set_id
|
5205
5565
|
# The ID for the dataset that you want to create. This ID is unique
|
5206
|
-
# per
|
5566
|
+
# per Region; for each Amazon Web Services account;.
|
5207
5567
|
# @return [String]
|
5208
5568
|
#
|
5209
5569
|
# @!attribute [rw] permissions
|
@@ -5211,7 +5571,7 @@ module Aws::QuickSight
|
|
5211
5571
|
# @return [Array<Types::ResourcePermission>]
|
5212
5572
|
#
|
5213
5573
|
# @!attribute [rw] request_id
|
5214
|
-
# The
|
5574
|
+
# The Amazon Web Services request ID for this operation.
|
5215
5575
|
# @return [String]
|
5216
5576
|
#
|
5217
5577
|
# @!attribute [rw] status
|
@@ -5239,12 +5599,12 @@ module Aws::QuickSight
|
|
5239
5599
|
# }
|
5240
5600
|
#
|
5241
5601
|
# @!attribute [rw] aws_account_id
|
5242
|
-
# The
|
5602
|
+
# The Amazon Web Services account; ID.
|
5243
5603
|
# @return [String]
|
5244
5604
|
#
|
5245
5605
|
# @!attribute [rw] data_set_id
|
5246
5606
|
# The ID for the dataset that you want to create. This ID is unique
|
5247
|
-
# per
|
5607
|
+
# per Region; for each Amazon Web Services account;.
|
5248
5608
|
# @return [String]
|
5249
5609
|
#
|
5250
5610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5261,7 +5621,7 @@ module Aws::QuickSight
|
|
5261
5621
|
# @return [Types::DataSet]
|
5262
5622
|
#
|
5263
5623
|
# @!attribute [rw] request_id
|
5264
|
-
# The
|
5624
|
+
# The Amazon Web Services request ID for this operation.
|
5265
5625
|
# @return [String]
|
5266
5626
|
#
|
5267
5627
|
# @!attribute [rw] status
|
@@ -5287,12 +5647,12 @@ module Aws::QuickSight
|
|
5287
5647
|
# }
|
5288
5648
|
#
|
5289
5649
|
# @!attribute [rw] aws_account_id
|
5290
|
-
# The
|
5650
|
+
# The Amazon Web Services account; ID.
|
5291
5651
|
# @return [String]
|
5292
5652
|
#
|
5293
5653
|
# @!attribute [rw] data_source_id
|
5294
|
-
# The ID of the data source. This ID is unique per
|
5295
|
-
#
|
5654
|
+
# The ID of the data source. This ID is unique per Region; for each
|
5655
|
+
# Amazon Web Services account;.
|
5296
5656
|
# @return [String]
|
5297
5657
|
#
|
5298
5658
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5309,8 +5669,8 @@ module Aws::QuickSight
|
|
5309
5669
|
# @return [String]
|
5310
5670
|
#
|
5311
5671
|
# @!attribute [rw] data_source_id
|
5312
|
-
# The ID of the data source. This ID is unique per
|
5313
|
-
#
|
5672
|
+
# The ID of the data source. This ID is unique per Region; for each
|
5673
|
+
# Amazon Web Services account;.
|
5314
5674
|
# @return [String]
|
5315
5675
|
#
|
5316
5676
|
# @!attribute [rw] permissions
|
@@ -5318,7 +5678,7 @@ module Aws::QuickSight
|
|
5318
5678
|
# @return [Array<Types::ResourcePermission>]
|
5319
5679
|
#
|
5320
5680
|
# @!attribute [rw] request_id
|
5321
|
-
# The
|
5681
|
+
# The Amazon Web Services request ID for this operation.
|
5322
5682
|
# @return [String]
|
5323
5683
|
#
|
5324
5684
|
# @!attribute [rw] status
|
@@ -5346,12 +5706,12 @@ module Aws::QuickSight
|
|
5346
5706
|
# }
|
5347
5707
|
#
|
5348
5708
|
# @!attribute [rw] aws_account_id
|
5349
|
-
# The
|
5709
|
+
# The Amazon Web Services account; ID.
|
5350
5710
|
# @return [String]
|
5351
5711
|
#
|
5352
5712
|
# @!attribute [rw] data_source_id
|
5353
|
-
# The ID of the data source. This ID is unique per
|
5354
|
-
#
|
5713
|
+
# The ID of the data source. This ID is unique per Region; for each
|
5714
|
+
# Amazon Web Services account;.
|
5355
5715
|
# @return [String]
|
5356
5716
|
#
|
5357
5717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -5368,7 +5728,7 @@ module Aws::QuickSight
|
|
5368
5728
|
# @return [Types::DataSource]
|
5369
5729
|
#
|
5370
5730
|
# @!attribute [rw] request_id
|
5371
|
-
# The
|
5731
|
+
# The Amazon Web Services request ID for this operation.
|
5372
5732
|
# @return [String]
|
5373
5733
|
#
|
5374
5734
|
# @!attribute [rw] status
|
@@ -5385,58 +5745,219 @@ module Aws::QuickSight
|
|
5385
5745
|
include Aws::Structure
|
5386
5746
|
end
|
5387
5747
|
|
5388
|
-
# @note When making an API call, you may pass
|
5748
|
+
# @note When making an API call, you may pass DescribeFolderPermissionsRequest
|
5389
5749
|
# data as a hash:
|
5390
5750
|
#
|
5391
5751
|
# {
|
5392
|
-
# group_name: "GroupName", # required
|
5393
5752
|
# aws_account_id: "AwsAccountId", # required
|
5394
|
-
#
|
5753
|
+
# folder_id: "RestrictiveResourceId", # required
|
5395
5754
|
# }
|
5396
5755
|
#
|
5397
|
-
# @!attribute [rw] group_name
|
5398
|
-
# The name of the group that you want to describe.
|
5399
|
-
# @return [String]
|
5400
|
-
#
|
5401
5756
|
# @!attribute [rw] aws_account_id
|
5402
|
-
# The
|
5403
|
-
# the ID for the AWS account that contains your Amazon QuickSight
|
5404
|
-
# account.
|
5757
|
+
# The AWS Account ID.
|
5405
5758
|
# @return [String]
|
5406
5759
|
#
|
5407
|
-
# @!attribute [rw]
|
5408
|
-
# The
|
5760
|
+
# @!attribute [rw] folder_id
|
5761
|
+
# The folder ID.
|
5409
5762
|
# @return [String]
|
5410
5763
|
#
|
5411
|
-
# @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
|
5412
5765
|
#
|
5413
|
-
class
|
5414
|
-
:group_name,
|
5766
|
+
class DescribeFolderPermissionsRequest < Struct.new(
|
5415
5767
|
:aws_account_id,
|
5416
|
-
:
|
5768
|
+
:folder_id)
|
5417
5769
|
SENSITIVE = []
|
5418
5770
|
include Aws::Structure
|
5419
5771
|
end
|
5420
5772
|
|
5421
|
-
# @!attribute [rw]
|
5422
|
-
# The
|
5423
|
-
# @return [
|
5773
|
+
# @!attribute [rw] status
|
5774
|
+
# The status. If succeeded, the status is `SC_OK`.
|
5775
|
+
# @return [Integer]
|
5424
5776
|
#
|
5425
|
-
# @!attribute [rw]
|
5426
|
-
# The
|
5777
|
+
# @!attribute [rw] folder_id
|
5778
|
+
# The folder ID.
|
5427
5779
|
# @return [String]
|
5428
5780
|
#
|
5429
|
-
# @!attribute [rw]
|
5430
|
-
# The
|
5431
|
-
# @return [
|
5781
|
+
# @!attribute [rw] arn
|
5782
|
+
# The Amazon Resource Name (ARN) for the folder.
|
5783
|
+
# @return [String]
|
5432
5784
|
#
|
5433
|
-
#
|
5785
|
+
# @!attribute [rw] permissions
|
5786
|
+
# Information about the permissions on the folder.
|
5787
|
+
# @return [Array<Types::ResourcePermission>]
|
5434
5788
|
#
|
5435
|
-
|
5436
|
-
|
5437
|
-
|
5438
|
-
|
5439
|
-
|
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 = []
|
5440
5961
|
include Aws::Structure
|
5441
5962
|
end
|
5442
5963
|
|
@@ -5450,8 +5971,8 @@ module Aws::QuickSight
|
|
5450
5971
|
# }
|
5451
5972
|
#
|
5452
5973
|
# @!attribute [rw] aws_account_id
|
5453
|
-
# The ID of the
|
5454
|
-
# to describe.
|
5974
|
+
# The ID of the Amazon Web Services account; that contains the
|
5975
|
+
# assignment that you want to describe.
|
5455
5976
|
# @return [String]
|
5456
5977
|
#
|
5457
5978
|
# @!attribute [rw] assignment_name
|
@@ -5477,7 +5998,7 @@ module Aws::QuickSight
|
|
5477
5998
|
# @return [Types::IAMPolicyAssignment]
|
5478
5999
|
#
|
5479
6000
|
# @!attribute [rw] request_id
|
5480
|
-
# The
|
6001
|
+
# The Amazon Web Services request ID for this operation.
|
5481
6002
|
# @return [String]
|
5482
6003
|
#
|
5483
6004
|
# @!attribute [rw] status
|
@@ -5504,7 +6025,7 @@ module Aws::QuickSight
|
|
5504
6025
|
# }
|
5505
6026
|
#
|
5506
6027
|
# @!attribute [rw] aws_account_id
|
5507
|
-
# The
|
6028
|
+
# The Amazon Web Services account; ID.
|
5508
6029
|
# @return [String]
|
5509
6030
|
#
|
5510
6031
|
# @!attribute [rw] data_set_id
|
@@ -5530,7 +6051,7 @@ module Aws::QuickSight
|
|
5530
6051
|
# @return [Types::Ingestion]
|
5531
6052
|
#
|
5532
6053
|
# @!attribute [rw] request_id
|
5533
|
-
# The
|
6054
|
+
# The Amazon Web Services request ID for this operation.
|
5534
6055
|
# @return [String]
|
5535
6056
|
#
|
5536
6057
|
# @!attribute [rw] status
|
@@ -5556,8 +6077,8 @@ module Aws::QuickSight
|
|
5556
6077
|
# }
|
5557
6078
|
#
|
5558
6079
|
# @!attribute [rw] aws_account_id
|
5559
|
-
# The ID for the
|
5560
|
-
# 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.
|
5561
6082
|
# @return [String]
|
5562
6083
|
#
|
5563
6084
|
# @!attribute [rw] namespace
|
@@ -5575,15 +6096,15 @@ module Aws::QuickSight
|
|
5575
6096
|
|
5576
6097
|
# @!attribute [rw] namespace
|
5577
6098
|
# The information about the namespace that you're describing. The
|
5578
|
-
# response includes the namespace ARN, name,
|
5579
|
-
#
|
5580
|
-
#
|
5581
|
-
#
|
5582
|
-
#
|
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.
|
5583
6104
|
# @return [Types::NamespaceInfoV2]
|
5584
6105
|
#
|
5585
6106
|
# @!attribute [rw] request_id
|
5586
|
-
# The
|
6107
|
+
# The Amazon Web Services request ID for this operation.
|
5587
6108
|
# @return [String]
|
5588
6109
|
#
|
5589
6110
|
# @!attribute [rw] status
|
@@ -5610,8 +6131,8 @@ module Aws::QuickSight
|
|
5610
6131
|
# }
|
5611
6132
|
#
|
5612
6133
|
# @!attribute [rw] aws_account_id
|
5613
|
-
# The ID of the
|
5614
|
-
# you're describing.
|
6134
|
+
# The ID of the Amazon Web Services account; that contains the
|
6135
|
+
# template alias that you're describing.
|
5615
6136
|
# @return [String]
|
5616
6137
|
#
|
5617
6138
|
# @!attribute [rw] template_id
|
@@ -5645,7 +6166,7 @@ module Aws::QuickSight
|
|
5645
6166
|
# @return [Integer]
|
5646
6167
|
#
|
5647
6168
|
# @!attribute [rw] request_id
|
5648
|
-
# The
|
6169
|
+
# The Amazon Web Services request ID for this operation.
|
5649
6170
|
# @return [String]
|
5650
6171
|
#
|
5651
6172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateAliasResponse AWS API Documentation
|
@@ -5667,8 +6188,8 @@ module Aws::QuickSight
|
|
5667
6188
|
# }
|
5668
6189
|
#
|
5669
6190
|
# @!attribute [rw] aws_account_id
|
5670
|
-
# The ID of the
|
5671
|
-
# describing.
|
6191
|
+
# The ID of the Amazon Web Services account; that contains the
|
6192
|
+
# template that you're describing.
|
5672
6193
|
# @return [String]
|
5673
6194
|
#
|
5674
6195
|
# @!attribute [rw] template_id
|
@@ -5697,7 +6218,7 @@ module Aws::QuickSight
|
|
5697
6218
|
# @return [Array<Types::ResourcePermission>]
|
5698
6219
|
#
|
5699
6220
|
# @!attribute [rw] request_id
|
5700
|
-
# The
|
6221
|
+
# The Amazon Web Services request ID for this operation.
|
5701
6222
|
# @return [String]
|
5702
6223
|
#
|
5703
6224
|
# @!attribute [rw] status
|
@@ -5727,8 +6248,8 @@ module Aws::QuickSight
|
|
5727
6248
|
# }
|
5728
6249
|
#
|
5729
6250
|
# @!attribute [rw] aws_account_id
|
5730
|
-
# The ID of the
|
5731
|
-
# describing.
|
6251
|
+
# The ID of the Amazon Web Services account; that contains the
|
6252
|
+
# template that you're describing.
|
5732
6253
|
# @return [String]
|
5733
6254
|
#
|
5734
6255
|
# @!attribute [rw] template_id
|
@@ -5769,7 +6290,7 @@ module Aws::QuickSight
|
|
5769
6290
|
# @return [Integer]
|
5770
6291
|
#
|
5771
6292
|
# @!attribute [rw] request_id
|
5772
|
-
# The
|
6293
|
+
# The Amazon Web Services request ID for this operation.
|
5773
6294
|
# @return [String]
|
5774
6295
|
#
|
5775
6296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateResponse AWS API Documentation
|
@@ -5792,8 +6313,8 @@ module Aws::QuickSight
|
|
5792
6313
|
# }
|
5793
6314
|
#
|
5794
6315
|
# @!attribute [rw] aws_account_id
|
5795
|
-
# The ID of the
|
5796
|
-
# describing.
|
6316
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
6317
|
+
# alias that you're describing.
|
5797
6318
|
# @return [String]
|
5798
6319
|
#
|
5799
6320
|
# @!attribute [rw] theme_id
|
@@ -5823,7 +6344,7 @@ module Aws::QuickSight
|
|
5823
6344
|
# @return [Integer]
|
5824
6345
|
#
|
5825
6346
|
# @!attribute [rw] request_id
|
5826
|
-
# The
|
6347
|
+
# The Amazon Web Services request ID for this operation.
|
5827
6348
|
# @return [String]
|
5828
6349
|
#
|
5829
6350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAliasResponse AWS API Documentation
|
@@ -5845,8 +6366,8 @@ module Aws::QuickSight
|
|
5845
6366
|
# }
|
5846
6367
|
#
|
5847
6368
|
# @!attribute [rw] aws_account_id
|
5848
|
-
# The ID of the
|
5849
|
-
# describing.
|
6369
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
6370
|
+
# that you're describing.
|
5850
6371
|
# @return [String]
|
5851
6372
|
#
|
5852
6373
|
# @!attribute [rw] theme_id
|
@@ -5875,7 +6396,7 @@ module Aws::QuickSight
|
|
5875
6396
|
# @return [Array<Types::ResourcePermission>]
|
5876
6397
|
#
|
5877
6398
|
# @!attribute [rw] request_id
|
5878
|
-
# The
|
6399
|
+
# The Amazon Web Services request ID for this operation.
|
5879
6400
|
# @return [String]
|
5880
6401
|
#
|
5881
6402
|
# @!attribute [rw] status
|
@@ -5905,8 +6426,8 @@ module Aws::QuickSight
|
|
5905
6426
|
# }
|
5906
6427
|
#
|
5907
6428
|
# @!attribute [rw] aws_account_id
|
5908
|
-
# The ID of the
|
5909
|
-
# describing.
|
6429
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
6430
|
+
# that you're describing.
|
5910
6431
|
# @return [String]
|
5911
6432
|
#
|
5912
6433
|
# @!attribute [rw] theme_id
|
@@ -5947,7 +6468,7 @@ module Aws::QuickSight
|
|
5947
6468
|
# @return [Integer]
|
5948
6469
|
#
|
5949
6470
|
# @!attribute [rw] request_id
|
5950
|
-
# The
|
6471
|
+
# The Amazon Web Services request ID for this operation.
|
5951
6472
|
# @return [String]
|
5952
6473
|
#
|
5953
6474
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeResponse AWS API Documentation
|
@@ -5974,9 +6495,9 @@ module Aws::QuickSight
|
|
5974
6495
|
# @return [String]
|
5975
6496
|
#
|
5976
6497
|
# @!attribute [rw] aws_account_id
|
5977
|
-
# The ID for the
|
5978
|
-
# the ID for the
|
5979
|
-
# 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.
|
5980
6501
|
# @return [String]
|
5981
6502
|
#
|
5982
6503
|
# @!attribute [rw] namespace
|
@@ -5998,7 +6519,7 @@ module Aws::QuickSight
|
|
5998
6519
|
# @return [Types::User]
|
5999
6520
|
#
|
6000
6521
|
# @!attribute [rw] request_id
|
6001
|
-
# The
|
6522
|
+
# The Amazon Web Services request ID for this operation.
|
6002
6523
|
# @return [String]
|
6003
6524
|
#
|
6004
6525
|
# @!attribute [rw] status
|
@@ -6023,7 +6544,7 @@ module Aws::QuickSight
|
|
6023
6544
|
# @return [String]
|
6024
6545
|
#
|
6025
6546
|
# @!attribute [rw] request_id
|
6026
|
-
# The
|
6547
|
+
# The Amazon Web Services request ID for this request.
|
6027
6548
|
# @return [String]
|
6028
6549
|
#
|
6029
6550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DomainNotWhitelistedException AWS API Documentation
|
@@ -6125,6 +6646,314 @@ module Aws::QuickSight
|
|
6125
6646
|
include Aws::Structure
|
6126
6647
|
end
|
6127
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
|
6948
|
+
#
|
6949
|
+
class GenerateEmbedUrlForRegisteredUserResponse < Struct.new(
|
6950
|
+
:embed_url,
|
6951
|
+
:status,
|
6952
|
+
:request_id)
|
6953
|
+
SENSITIVE = [:embed_url]
|
6954
|
+
include Aws::Structure
|
6955
|
+
end
|
6956
|
+
|
6128
6957
|
# Geospatial column group that denotes a hierarchy.
|
6129
6958
|
#
|
6130
6959
|
# @note When making an API call, you may pass GeoSpatialColumnGroup
|
@@ -6175,12 +7004,12 @@ module Aws::QuickSight
|
|
6175
7004
|
# }
|
6176
7005
|
#
|
6177
7006
|
# @!attribute [rw] aws_account_id
|
6178
|
-
# The ID for the
|
6179
|
-
# embedding.
|
7007
|
+
# The ID for the Amazon Web Services account; that contains the
|
7008
|
+
# dashboard that you're embedding.
|
6180
7009
|
# @return [String]
|
6181
7010
|
#
|
6182
7011
|
# @!attribute [rw] dashboard_id
|
6183
|
-
# The ID for the dashboard, also added to the
|
7012
|
+
# The ID for the dashboard, also added to the Identity and Access
|
6184
7013
|
# Management (IAM) policy.
|
6185
7014
|
# @return [String]
|
6186
7015
|
#
|
@@ -6233,9 +7062,9 @@ module Aws::QuickSight
|
|
6233
7062
|
# @return [String]
|
6234
7063
|
#
|
6235
7064
|
# @!attribute [rw] namespace
|
6236
|
-
# The QuickSight namespace that
|
6237
|
-
#
|
6238
|
-
#
|
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`.
|
6239
7068
|
# @return [String]
|
6240
7069
|
#
|
6241
7070
|
# @!attribute [rw] additional_dashboard_ids
|
@@ -6280,7 +7109,7 @@ module Aws::QuickSight
|
|
6280
7109
|
# @return [Integer]
|
6281
7110
|
#
|
6282
7111
|
# @!attribute [rw] request_id
|
6283
|
-
# The
|
7112
|
+
# The Amazon Web Services request ID for this operation.
|
6284
7113
|
# @return [String]
|
6285
7114
|
#
|
6286
7115
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlResponse AWS API Documentation
|
@@ -6304,8 +7133,8 @@ module Aws::QuickSight
|
|
6304
7133
|
# }
|
6305
7134
|
#
|
6306
7135
|
# @!attribute [rw] aws_account_id
|
6307
|
-
# The ID for the
|
6308
|
-
# subscription.
|
7136
|
+
# The ID for the Amazon Web Services account; associated with your
|
7137
|
+
# QuickSight subscription.
|
6309
7138
|
# @return [String]
|
6310
7139
|
#
|
6311
7140
|
# @!attribute [rw] entry_point
|
@@ -6342,9 +7171,9 @@ module Aws::QuickSight
|
|
6342
7171
|
#
|
6343
7172
|
# 2. Invited nonfederated users
|
6344
7173
|
#
|
6345
|
-
# 3.
|
6346
|
-
#
|
6347
|
-
#
|
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
|
6348
7177
|
#
|
6349
7178
|
# Omit this parameter for users in the third group, IAM users and IAM
|
6350
7179
|
# role-based sessions.
|
@@ -6374,7 +7203,7 @@ module Aws::QuickSight
|
|
6374
7203
|
# @return [Integer]
|
6375
7204
|
#
|
6376
7205
|
# @!attribute [rw] request_id
|
6377
|
-
# The
|
7206
|
+
# The Amazon Web Services request ID for this operation.
|
6378
7207
|
# @return [String]
|
6379
7208
|
#
|
6380
7209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlResponse AWS API Documentation
|
@@ -6459,10 +7288,10 @@ module Aws::QuickSight
|
|
6459
7288
|
include Aws::Structure
|
6460
7289
|
end
|
6461
7290
|
|
6462
|
-
# An
|
7291
|
+
# An Identity and Access Management (IAM) policy assignment.
|
6463
7292
|
#
|
6464
7293
|
# @!attribute [rw] aws_account_id
|
6465
|
-
# The
|
7294
|
+
# The Amazon Web Services account; ID.
|
6466
7295
|
# @return [String]
|
6467
7296
|
#
|
6468
7297
|
# @!attribute [rw] assignment_id
|
@@ -6524,7 +7353,7 @@ module Aws::QuickSight
|
|
6524
7353
|
# @return [String]
|
6525
7354
|
#
|
6526
7355
|
# @!attribute [rw] request_id
|
6527
|
-
# The
|
7356
|
+
# The Amazon Web Services request ID for this request.
|
6528
7357
|
# @return [String]
|
6529
7358
|
#
|
6530
7359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IdentityTypeNotSupportedException AWS API Documentation
|
@@ -6661,7 +7490,7 @@ module Aws::QuickSight
|
|
6661
7490
|
# @return [String]
|
6662
7491
|
#
|
6663
7492
|
# @!attribute [rw] request_id
|
6664
|
-
# The
|
7493
|
+
# The Amazon Web Services request ID for this request.
|
6665
7494
|
# @return [String]
|
6666
7495
|
#
|
6667
7496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InternalFailureException AWS API Documentation
|
@@ -6679,7 +7508,7 @@ module Aws::QuickSight
|
|
6679
7508
|
# @return [String]
|
6680
7509
|
#
|
6681
7510
|
# @!attribute [rw] request_id
|
6682
|
-
# The
|
7511
|
+
# The Amazon Web Services request ID for this request.
|
6683
7512
|
# @return [String]
|
6684
7513
|
#
|
6685
7514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidNextTokenException AWS API Documentation
|
@@ -6697,7 +7526,7 @@ module Aws::QuickSight
|
|
6697
7526
|
# @return [String]
|
6698
7527
|
#
|
6699
7528
|
# @!attribute [rw] request_id
|
6700
|
-
# The
|
7529
|
+
# The Amazon Web Services request ID for this request.
|
6701
7530
|
# @return [String]
|
6702
7531
|
#
|
6703
7532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidParameterValueException AWS API Documentation
|
@@ -6818,7 +7647,7 @@ module Aws::QuickSight
|
|
6818
7647
|
# @return [String]
|
6819
7648
|
#
|
6820
7649
|
# @!attribute [rw] request_id
|
6821
|
-
# The
|
7650
|
+
# The Amazon Web Services request ID for this request.
|
6822
7651
|
# @return [String]
|
6823
7652
|
#
|
6824
7653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LimitExceededException AWS API Documentation
|
@@ -6841,7 +7670,8 @@ module Aws::QuickSight
|
|
6841
7670
|
# }
|
6842
7671
|
#
|
6843
7672
|
# @!attribute [rw] aws_account_id
|
6844
|
-
# The ID of the
|
7673
|
+
# The ID of the Amazon Web Services account; that contains the
|
7674
|
+
# analyses.
|
6845
7675
|
# @return [String]
|
6846
7676
|
#
|
6847
7677
|
# @!attribute [rw] next_token
|
@@ -6875,7 +7705,7 @@ module Aws::QuickSight
|
|
6875
7705
|
# @return [Integer]
|
6876
7706
|
#
|
6877
7707
|
# @!attribute [rw] request_id
|
6878
|
-
# The
|
7708
|
+
# The Amazon Web Services request ID for this operation.
|
6879
7709
|
# @return [String]
|
6880
7710
|
#
|
6881
7711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesResponse AWS API Documentation
|
@@ -6900,8 +7730,8 @@ module Aws::QuickSight
|
|
6900
7730
|
# }
|
6901
7731
|
#
|
6902
7732
|
# @!attribute [rw] aws_account_id
|
6903
|
-
# The ID of the
|
6904
|
-
# listing versions for.
|
7733
|
+
# The ID of the Amazon Web Services account; that contains the
|
7734
|
+
# dashboard that you're listing versions for.
|
6905
7735
|
# @return [String]
|
6906
7736
|
#
|
6907
7737
|
# @!attribute [rw] dashboard_id
|
@@ -6943,7 +7773,7 @@ module Aws::QuickSight
|
|
6943
7773
|
# @return [Integer]
|
6944
7774
|
#
|
6945
7775
|
# @!attribute [rw] request_id
|
6946
|
-
# The
|
7776
|
+
# The Amazon Web Services request ID for this operation.
|
6947
7777
|
# @return [String]
|
6948
7778
|
#
|
6949
7779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersionsResponse AWS API Documentation
|
@@ -6967,8 +7797,8 @@ module Aws::QuickSight
|
|
6967
7797
|
# }
|
6968
7798
|
#
|
6969
7799
|
# @!attribute [rw] aws_account_id
|
6970
|
-
# The ID of the
|
6971
|
-
# listing.
|
7800
|
+
# The ID of the Amazon Web Services account; that contains the
|
7801
|
+
# dashboards that you're listing.
|
6972
7802
|
# @return [String]
|
6973
7803
|
#
|
6974
7804
|
# @!attribute [rw] next_token
|
@@ -6991,8 +7821,9 @@ module Aws::QuickSight
|
|
6991
7821
|
end
|
6992
7822
|
|
6993
7823
|
# @!attribute [rw] dashboard_summary_list
|
6994
|
-
# A structure that contains all of the dashboards in your
|
6995
|
-
# 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.
|
6996
7827
|
# @return [Array<Types::DashboardSummary>]
|
6997
7828
|
#
|
6998
7829
|
# @!attribute [rw] next_token
|
@@ -7005,7 +7836,7 @@ module Aws::QuickSight
|
|
7005
7836
|
# @return [Integer]
|
7006
7837
|
#
|
7007
7838
|
# @!attribute [rw] request_id
|
7008
|
-
# The
|
7839
|
+
# The Amazon Web Services request ID for this operation.
|
7009
7840
|
# @return [String]
|
7010
7841
|
#
|
7011
7842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardsResponse AWS API Documentation
|
@@ -7029,7 +7860,7 @@ module Aws::QuickSight
|
|
7029
7860
|
# }
|
7030
7861
|
#
|
7031
7862
|
# @!attribute [rw] aws_account_id
|
7032
|
-
# The
|
7863
|
+
# The Amazon Web Services account; ID.
|
7033
7864
|
# @return [String]
|
7034
7865
|
#
|
7035
7866
|
# @!attribute [rw] next_token
|
@@ -7061,7 +7892,7 @@ module Aws::QuickSight
|
|
7061
7892
|
# @return [String]
|
7062
7893
|
#
|
7063
7894
|
# @!attribute [rw] request_id
|
7064
|
-
# The
|
7895
|
+
# The Amazon Web Services request ID for this operation.
|
7065
7896
|
# @return [String]
|
7066
7897
|
#
|
7067
7898
|
# @!attribute [rw] status
|
@@ -7089,7 +7920,7 @@ module Aws::QuickSight
|
|
7089
7920
|
# }
|
7090
7921
|
#
|
7091
7922
|
# @!attribute [rw] aws_account_id
|
7092
|
-
# The
|
7923
|
+
# The Amazon Web Services account; ID.
|
7093
7924
|
# @return [String]
|
7094
7925
|
#
|
7095
7926
|
# @!attribute [rw] next_token
|
@@ -7121,7 +7952,7 @@ module Aws::QuickSight
|
|
7121
7952
|
# @return [String]
|
7122
7953
|
#
|
7123
7954
|
# @!attribute [rw] request_id
|
7124
|
-
# The
|
7955
|
+
# The Amazon Web Services request ID for this operation.
|
7125
7956
|
# @return [String]
|
7126
7957
|
#
|
7127
7958
|
# @!attribute [rw] status
|
@@ -7139,6 +7970,134 @@ module Aws::QuickSight
|
|
7139
7970
|
include Aws::Structure
|
7140
7971
|
end
|
7141
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
|
+
|
7142
8101
|
# @note When making an API call, you may pass ListGroupMembershipsRequest
|
7143
8102
|
# data as a hash:
|
7144
8103
|
#
|
@@ -7163,9 +8122,9 @@ module Aws::QuickSight
|
|
7163
8122
|
# @return [Integer]
|
7164
8123
|
#
|
7165
8124
|
# @!attribute [rw] aws_account_id
|
7166
|
-
# The ID for the
|
7167
|
-
# the ID for the
|
7168
|
-
# 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.
|
7169
8128
|
# @return [String]
|
7170
8129
|
#
|
7171
8130
|
# @!attribute [rw] namespace
|
@@ -7193,7 +8152,7 @@ module Aws::QuickSight
|
|
7193
8152
|
# @return [String]
|
7194
8153
|
#
|
7195
8154
|
# @!attribute [rw] request_id
|
7196
|
-
# The
|
8155
|
+
# The Amazon Web Services request ID for this operation.
|
7197
8156
|
# @return [String]
|
7198
8157
|
#
|
7199
8158
|
# @!attribute [rw] status
|
@@ -7222,9 +8181,9 @@ module Aws::QuickSight
|
|
7222
8181
|
# }
|
7223
8182
|
#
|
7224
8183
|
# @!attribute [rw] aws_account_id
|
7225
|
-
# The ID for the
|
7226
|
-
# the ID for the
|
7227
|
-
# 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.
|
7228
8187
|
# @return [String]
|
7229
8188
|
#
|
7230
8189
|
# @!attribute [rw] next_token
|
@@ -7259,7 +8218,7 @@ module Aws::QuickSight
|
|
7259
8218
|
# @return [String]
|
7260
8219
|
#
|
7261
8220
|
# @!attribute [rw] request_id
|
7262
|
-
# The
|
8221
|
+
# The Amazon Web Services request ID for this operation.
|
7263
8222
|
# @return [String]
|
7264
8223
|
#
|
7265
8224
|
# @!attribute [rw] status
|
@@ -7289,7 +8248,8 @@ module Aws::QuickSight
|
|
7289
8248
|
# }
|
7290
8249
|
#
|
7291
8250
|
# @!attribute [rw] aws_account_id
|
7292
|
-
# The ID of the
|
8251
|
+
# The ID of the Amazon Web Services account; that contains the
|
8252
|
+
# assignments.
|
7293
8253
|
# @return [String]
|
7294
8254
|
#
|
7295
8255
|
# @!attribute [rw] user_name
|
@@ -7326,7 +8286,7 @@ module Aws::QuickSight
|
|
7326
8286
|
# @return [Array<Types::ActiveIAMPolicyAssignment>]
|
7327
8287
|
#
|
7328
8288
|
# @!attribute [rw] request_id
|
7329
|
-
# The
|
8289
|
+
# The Amazon Web Services request ID for this operation.
|
7330
8290
|
# @return [String]
|
7331
8291
|
#
|
7332
8292
|
# @!attribute [rw] next_token
|
@@ -7361,8 +8321,8 @@ module Aws::QuickSight
|
|
7361
8321
|
# }
|
7362
8322
|
#
|
7363
8323
|
# @!attribute [rw] aws_account_id
|
7364
|
-
# The ID of the
|
7365
|
-
# assignments.
|
8324
|
+
# The ID of the Amazon Web Services account; that contains these IAM
|
8325
|
+
# policy assignments.
|
7366
8326
|
# @return [String]
|
7367
8327
|
#
|
7368
8328
|
# @!attribute [rw] assignment_status
|
@@ -7404,7 +8364,7 @@ module Aws::QuickSight
|
|
7404
8364
|
# @return [String]
|
7405
8365
|
#
|
7406
8366
|
# @!attribute [rw] request_id
|
7407
|
-
# The
|
8367
|
+
# The Amazon Web Services request ID for this operation.
|
7408
8368
|
# @return [String]
|
7409
8369
|
#
|
7410
8370
|
# @!attribute [rw] status
|
@@ -7442,7 +8402,7 @@ module Aws::QuickSight
|
|
7442
8402
|
# @return [String]
|
7443
8403
|
#
|
7444
8404
|
# @!attribute [rw] aws_account_id
|
7445
|
-
# The
|
8405
|
+
# The Amazon Web Services account; ID.
|
7446
8406
|
# @return [String]
|
7447
8407
|
#
|
7448
8408
|
# @!attribute [rw] max_results
|
@@ -7470,7 +8430,7 @@ module Aws::QuickSight
|
|
7470
8430
|
# @return [String]
|
7471
8431
|
#
|
7472
8432
|
# @!attribute [rw] request_id
|
7473
|
-
# The
|
8433
|
+
# The Amazon Web Services request ID for this operation.
|
7474
8434
|
# @return [String]
|
7475
8435
|
#
|
7476
8436
|
# @!attribute [rw] status
|
@@ -7498,8 +8458,8 @@ module Aws::QuickSight
|
|
7498
8458
|
# }
|
7499
8459
|
#
|
7500
8460
|
# @!attribute [rw] aws_account_id
|
7501
|
-
# The ID for the
|
7502
|
-
# 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.
|
7503
8463
|
# @return [String]
|
7504
8464
|
#
|
7505
8465
|
# @!attribute [rw] next_token
|
@@ -7521,9 +8481,9 @@ module Aws::QuickSight
|
|
7521
8481
|
end
|
7522
8482
|
|
7523
8483
|
# @!attribute [rw] namespaces
|
7524
|
-
# The information about the namespaces in this
|
7525
|
-
# response includes the namespace ARN, name,
|
7526
|
-
# 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.
|
7527
8487
|
# @return [Array<Types::NamespaceInfoV2>]
|
7528
8488
|
#
|
7529
8489
|
# @!attribute [rw] next_token
|
@@ -7531,7 +8491,7 @@ module Aws::QuickSight
|
|
7531
8491
|
# @return [String]
|
7532
8492
|
#
|
7533
8493
|
# @!attribute [rw] request_id
|
7534
|
-
# The
|
8494
|
+
# The Amazon Web Services request ID for this operation.
|
7535
8495
|
# @return [String]
|
7536
8496
|
#
|
7537
8497
|
# @!attribute [rw] status
|
@@ -7575,7 +8535,7 @@ module Aws::QuickSight
|
|
7575
8535
|
# @return [Array<Types::Tag>]
|
7576
8536
|
#
|
7577
8537
|
# @!attribute [rw] request_id
|
7578
|
-
# The
|
8538
|
+
# The Amazon Web Services request ID for this operation.
|
7579
8539
|
# @return [String]
|
7580
8540
|
#
|
7581
8541
|
# @!attribute [rw] status
|
@@ -7603,8 +8563,8 @@ module Aws::QuickSight
|
|
7603
8563
|
# }
|
7604
8564
|
#
|
7605
8565
|
# @!attribute [rw] aws_account_id
|
7606
|
-
# The ID of the
|
7607
|
-
# you're listing.
|
8566
|
+
# The ID of the Amazon Web Services account; that contains the
|
8567
|
+
# template aliases that you're listing.
|
7608
8568
|
# @return [String]
|
7609
8569
|
#
|
7610
8570
|
# @!attribute [rw] template_id
|
@@ -7640,7 +8600,7 @@ module Aws::QuickSight
|
|
7640
8600
|
# @return [Integer]
|
7641
8601
|
#
|
7642
8602
|
# @!attribute [rw] request_id
|
7643
|
-
# The
|
8603
|
+
# The Amazon Web Services request ID for this operation.
|
7644
8604
|
# @return [String]
|
7645
8605
|
#
|
7646
8606
|
# @!attribute [rw] next_token
|
@@ -7670,8 +8630,8 @@ module Aws::QuickSight
|
|
7670
8630
|
# }
|
7671
8631
|
#
|
7672
8632
|
# @!attribute [rw] aws_account_id
|
7673
|
-
# The ID of the
|
7674
|
-
# listing.
|
8633
|
+
# The ID of the Amazon Web Services account; that contains the
|
8634
|
+
# templates that you're listing.
|
7675
8635
|
# @return [String]
|
7676
8636
|
#
|
7677
8637
|
# @!attribute [rw] template_id
|
@@ -7713,7 +8673,7 @@ module Aws::QuickSight
|
|
7713
8673
|
# @return [Integer]
|
7714
8674
|
#
|
7715
8675
|
# @!attribute [rw] request_id
|
7716
|
-
# The
|
8676
|
+
# The Amazon Web Services request ID for this operation.
|
7717
8677
|
# @return [String]
|
7718
8678
|
#
|
7719
8679
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersionsResponse AWS API Documentation
|
@@ -7737,8 +8697,8 @@ module Aws::QuickSight
|
|
7737
8697
|
# }
|
7738
8698
|
#
|
7739
8699
|
# @!attribute [rw] aws_account_id
|
7740
|
-
# The ID of the
|
7741
|
-
# listing.
|
8700
|
+
# The ID of the Amazon Web Services account; that contains the
|
8701
|
+
# templates that you're listing.
|
7742
8702
|
# @return [String]
|
7743
8703
|
#
|
7744
8704
|
# @!attribute [rw] next_token
|
@@ -7774,7 +8734,7 @@ module Aws::QuickSight
|
|
7774
8734
|
# @return [Integer]
|
7775
8735
|
#
|
7776
8736
|
# @!attribute [rw] request_id
|
7777
|
-
# The
|
8737
|
+
# The Amazon Web Services request ID for this operation.
|
7778
8738
|
# @return [String]
|
7779
8739
|
#
|
7780
8740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplatesResponse AWS API Documentation
|
@@ -7799,8 +8759,8 @@ module Aws::QuickSight
|
|
7799
8759
|
# }
|
7800
8760
|
#
|
7801
8761
|
# @!attribute [rw] aws_account_id
|
7802
|
-
# The ID of the
|
7803
|
-
# you're listing.
|
8762
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
8763
|
+
# aliases that you're listing.
|
7804
8764
|
# @return [String]
|
7805
8765
|
#
|
7806
8766
|
# @!attribute [rw] theme_id
|
@@ -7836,7 +8796,7 @@ module Aws::QuickSight
|
|
7836
8796
|
# @return [Integer]
|
7837
8797
|
#
|
7838
8798
|
# @!attribute [rw] request_id
|
7839
|
-
# The
|
8799
|
+
# The Amazon Web Services request ID for this operation.
|
7840
8800
|
# @return [String]
|
7841
8801
|
#
|
7842
8802
|
# @!attribute [rw] next_token
|
@@ -7866,8 +8826,8 @@ module Aws::QuickSight
|
|
7866
8826
|
# }
|
7867
8827
|
#
|
7868
8828
|
# @!attribute [rw] aws_account_id
|
7869
|
-
# The ID of the
|
7870
|
-
# listing.
|
8829
|
+
# The ID of the Amazon Web Services account; that contains the themes
|
8830
|
+
# that you're listing.
|
7871
8831
|
# @return [String]
|
7872
8832
|
#
|
7873
8833
|
# @!attribute [rw] theme_id
|
@@ -7909,7 +8869,7 @@ module Aws::QuickSight
|
|
7909
8869
|
# @return [Integer]
|
7910
8870
|
#
|
7911
8871
|
# @!attribute [rw] request_id
|
7912
|
-
# The
|
8872
|
+
# The Amazon Web Services request ID for this operation.
|
7913
8873
|
# @return [String]
|
7914
8874
|
#
|
7915
8875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersionsResponse AWS API Documentation
|
@@ -7934,8 +8894,8 @@ module Aws::QuickSight
|
|
7934
8894
|
# }
|
7935
8895
|
#
|
7936
8896
|
# @!attribute [rw] aws_account_id
|
7937
|
-
# The ID of the
|
7938
|
-
# listing.
|
8897
|
+
# The ID of the Amazon Web Services account; that contains the themes
|
8898
|
+
# that you're listing.
|
7939
8899
|
# @return [String]
|
7940
8900
|
#
|
7941
8901
|
# @!attribute [rw] next_token
|
@@ -7956,7 +8916,7 @@ module Aws::QuickSight
|
|
7956
8916
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
7957
8917
|
# QuickSight.
|
7958
8918
|
#
|
7959
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
8919
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by Amazon
|
7960
8920
|
# QuickSight.
|
7961
8921
|
# @return [String]
|
7962
8922
|
#
|
@@ -7985,7 +8945,7 @@ module Aws::QuickSight
|
|
7985
8945
|
# @return [Integer]
|
7986
8946
|
#
|
7987
8947
|
# @!attribute [rw] request_id
|
7988
|
-
# The
|
8948
|
+
# The Amazon Web Services request ID for this operation.
|
7989
8949
|
# @return [String]
|
7990
8950
|
#
|
7991
8951
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemesResponse AWS API Documentation
|
@@ -8016,8 +8976,9 @@ module Aws::QuickSight
|
|
8016
8976
|
# @return [String]
|
8017
8977
|
#
|
8018
8978
|
# @!attribute [rw] aws_account_id
|
8019
|
-
# The
|
8020
|
-
# 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.
|
8021
8982
|
# @return [String]
|
8022
8983
|
#
|
8023
8984
|
# @!attribute [rw] namespace
|
@@ -8053,7 +9014,7 @@ module Aws::QuickSight
|
|
8053
9014
|
# @return [String]
|
8054
9015
|
#
|
8055
9016
|
# @!attribute [rw] request_id
|
8056
|
-
# The
|
9017
|
+
# The Amazon Web Services request ID for this operation.
|
8057
9018
|
# @return [String]
|
8058
9019
|
#
|
8059
9020
|
# @!attribute [rw] status
|
@@ -8082,9 +9043,9 @@ module Aws::QuickSight
|
|
8082
9043
|
# }
|
8083
9044
|
#
|
8084
9045
|
# @!attribute [rw] aws_account_id
|
8085
|
-
# The ID for the
|
8086
|
-
# the ID for the
|
8087
|
-
# 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.
|
8088
9049
|
# @return [String]
|
8089
9050
|
#
|
8090
9051
|
# @!attribute [rw] next_token
|
@@ -8119,7 +9080,7 @@ module Aws::QuickSight
|
|
8119
9080
|
# @return [String]
|
8120
9081
|
#
|
8121
9082
|
# @!attribute [rw] request_id
|
8122
|
-
# The
|
9083
|
+
# The Amazon Web Services request ID for this operation.
|
8123
9084
|
# @return [String]
|
8124
9085
|
#
|
8125
9086
|
# @!attribute [rw] status
|
@@ -8347,6 +9308,26 @@ module Aws::QuickSight
|
|
8347
9308
|
include Aws::Structure
|
8348
9309
|
end
|
8349
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
|
+
|
8350
9331
|
# MySQL parameters.
|
8351
9332
|
#
|
8352
9333
|
# @note When making an API call, you may pass MySqlParameters
|
@@ -8410,7 +9391,7 @@ module Aws::QuickSight
|
|
8410
9391
|
# @return [String]
|
8411
9392
|
#
|
8412
9393
|
# @!attribute [rw] capacity_region
|
8413
|
-
# The namespace
|
9394
|
+
# The namespace Region;.
|
8414
9395
|
# @return [String]
|
8415
9396
|
#
|
8416
9397
|
# @!attribute [rw] creation_status
|
@@ -8667,7 +9648,7 @@ module Aws::QuickSight
|
|
8667
9648
|
# @return [String]
|
8668
9649
|
#
|
8669
9650
|
# @!attribute [rw] request_id
|
8670
|
-
# The
|
9651
|
+
# The Amazon Web Services request ID for this request.
|
8671
9652
|
# @return [String]
|
8672
9653
|
#
|
8673
9654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PreconditionNotMetException AWS API Documentation
|
@@ -8762,7 +9743,7 @@ module Aws::QuickSight
|
|
8762
9743
|
# @return [String]
|
8763
9744
|
#
|
8764
9745
|
# @!attribute [rw] request_id
|
8765
|
-
# The
|
9746
|
+
# The Amazon Web Services request ID for this request.
|
8766
9747
|
# @return [String]
|
8767
9748
|
#
|
8768
9749
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/QuickSightUserNotFoundException AWS API Documentation
|
@@ -8856,6 +9837,9 @@ module Aws::QuickSight
|
|
8856
9837
|
# namespace: "Namespace", # required
|
8857
9838
|
# user_name: "UserName",
|
8858
9839
|
# custom_permissions_name: "RoleName",
|
9840
|
+
# external_login_federation_provider_type: "String",
|
9841
|
+
# custom_federation_provider_url: "String",
|
9842
|
+
# external_login_id: "String",
|
8859
9843
|
# }
|
8860
9844
|
#
|
8861
9845
|
# @!attribute [rw] identity_type
|
@@ -8912,9 +9896,9 @@ module Aws::QuickSight
|
|
8912
9896
|
# @return [String]
|
8913
9897
|
#
|
8914
9898
|
# @!attribute [rw] aws_account_id
|
8915
|
-
# The ID for the
|
8916
|
-
# the ID for the
|
8917
|
-
# 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.
|
8918
9902
|
# @return [String]
|
8919
9903
|
#
|
8920
9904
|
# @!attribute [rw] namespace
|
@@ -8955,8 +9939,36 @@ module Aws::QuickSight
|
|
8955
9939
|
# QuickSight (admin, author, reader).
|
8956
9940
|
#
|
8957
9941
|
# This feature is available only to QuickSight Enterprise edition
|
8958
|
-
# subscriptions
|
8959
|
-
#
|
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.
|
8960
9972
|
# @return [String]
|
8961
9973
|
#
|
8962
9974
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
|
@@ -8970,7 +9982,10 @@ module Aws::QuickSight
|
|
8970
9982
|
:aws_account_id,
|
8971
9983
|
:namespace,
|
8972
9984
|
:user_name,
|
8973
|
-
:custom_permissions_name
|
9985
|
+
:custom_permissions_name,
|
9986
|
+
:external_login_federation_provider_type,
|
9987
|
+
:custom_federation_provider_url,
|
9988
|
+
:external_login_id)
|
8974
9989
|
SENSITIVE = []
|
8975
9990
|
include Aws::Structure
|
8976
9991
|
end
|
@@ -8986,7 +10001,7 @@ module Aws::QuickSight
|
|
8986
10001
|
# @return [String]
|
8987
10002
|
#
|
8988
10003
|
# @!attribute [rw] request_id
|
8989
|
-
# The
|
10004
|
+
# The Amazon Web Services request ID for this operation.
|
8990
10005
|
# @return [String]
|
8991
10006
|
#
|
8992
10007
|
# @!attribute [rw] status
|
@@ -9004,6 +10019,142 @@ module Aws::QuickSight
|
|
9004
10019
|
include Aws::Structure
|
9005
10020
|
end
|
9006
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
|
+
|
9007
10158
|
# A physical table type for relational data sources.
|
9008
10159
|
#
|
9009
10160
|
# @note When making an API call, you may pass RelationalTable
|
@@ -9092,7 +10243,7 @@ module Aws::QuickSight
|
|
9092
10243
|
# @return [String]
|
9093
10244
|
#
|
9094
10245
|
# @!attribute [rw] request_id
|
9095
|
-
# The
|
10246
|
+
# The Amazon Web Services request ID for this request.
|
9096
10247
|
# @return [String]
|
9097
10248
|
#
|
9098
10249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceExistsException AWS API Documentation
|
@@ -9115,7 +10266,7 @@ module Aws::QuickSight
|
|
9115
10266
|
# @return [String]
|
9116
10267
|
#
|
9117
10268
|
# @!attribute [rw] request_id
|
9118
|
-
# The
|
10269
|
+
# The Amazon Web Services request ID for this request.
|
9119
10270
|
# @return [String]
|
9120
10271
|
#
|
9121
10272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceNotFoundException AWS API Documentation
|
@@ -9149,9 +10300,10 @@ module Aws::QuickSight
|
|
9149
10300
|
# associated with an analysis, dashboard, template, or theme. (This
|
9150
10301
|
# is common.)
|
9151
10302
|
#
|
9152
|
-
# * The ARN of an
|
9153
|
-
# QuickSight ARN. Use this option only to share
|
9154
|
-
# (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.)
|
9155
10307
|
# @return [String]
|
9156
10308
|
#
|
9157
10309
|
# @!attribute [rw] actions
|
@@ -9177,7 +10329,7 @@ module Aws::QuickSight
|
|
9177
10329
|
# @return [String]
|
9178
10330
|
#
|
9179
10331
|
# @!attribute [rw] request_id
|
9180
|
-
# The
|
10332
|
+
# The Amazon Web Services request ID for this request.
|
9181
10333
|
# @return [String]
|
9182
10334
|
#
|
9183
10335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceUnavailableException AWS API Documentation
|
@@ -9199,7 +10351,8 @@ module Aws::QuickSight
|
|
9199
10351
|
# }
|
9200
10352
|
#
|
9201
10353
|
# @!attribute [rw] aws_account_id
|
9202
|
-
# The ID of the
|
10354
|
+
# The ID of the Amazon Web Services account; that contains the
|
10355
|
+
# analysis.
|
9203
10356
|
# @return [String]
|
9204
10357
|
#
|
9205
10358
|
# @!attribute [rw] analysis_id
|
@@ -9229,7 +10382,7 @@ module Aws::QuickSight
|
|
9229
10382
|
# @return [String]
|
9230
10383
|
#
|
9231
10384
|
# @!attribute [rw] request_id
|
9232
|
-
# The
|
10385
|
+
# The Amazon Web Services request ID for this operation.
|
9233
10386
|
# @return [String]
|
9234
10387
|
#
|
9235
10388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisResponse AWS API Documentation
|
@@ -9275,49 +10428,135 @@ module Aws::QuickSight
|
|
9275
10428
|
#
|
9276
10429
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html
|
9277
10430
|
#
|
9278
|
-
# @note When making an API call, you may pass RowLevelPermissionDataSet
|
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]
|
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>]
|
10510
|
+
#
|
10511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagConfiguration AWS API Documentation
|
10512
|
+
#
|
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.
|
10521
|
+
#
|
10522
|
+
# @note When making an API call, you may pass RowLevelPermissionTagRule
|
9279
10523
|
# data as a hash:
|
9280
10524
|
#
|
9281
10525
|
# {
|
9282
|
-
#
|
9283
|
-
#
|
9284
|
-
#
|
9285
|
-
#
|
10526
|
+
# tag_key: "SessionTagKey", # required
|
10527
|
+
# column_name: "String", # required
|
10528
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
10529
|
+
# match_all_value: "SessionTagValue",
|
9286
10530
|
# }
|
9287
10531
|
#
|
9288
|
-
# @!attribute [rw]
|
9289
|
-
# The
|
9290
|
-
# for RLS.
|
10532
|
+
# @!attribute [rw] tag_key
|
10533
|
+
# The unique key for a tag.
|
9291
10534
|
# @return [String]
|
9292
10535
|
#
|
9293
|
-
# @!attribute [rw]
|
9294
|
-
# The
|
9295
|
-
# permissions for RLS.
|
10536
|
+
# @!attribute [rw] column_name
|
10537
|
+
# The column name that a tag key is assigned to.
|
9296
10538
|
# @return [String]
|
9297
10539
|
#
|
9298
|
-
# @!attribute [rw]
|
9299
|
-
#
|
9300
|
-
#
|
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.
|
9301
10544
|
# @return [String]
|
9302
10545
|
#
|
9303
|
-
# @!attribute [rw]
|
9304
|
-
#
|
9305
|
-
#
|
9306
|
-
#
|
9307
|
-
# By default, `FormatVersion` is `VERSION_1`. When `FormatVersion` is
|
9308
|
-
# `VERSION_1`, `UserName` and `GroupName` are required. When
|
9309
|
-
# `FormatVersion` is `VERSION_2`, `UserARN` and `GroupARN` are
|
9310
|
-
# required, and `Namespace` must not exist.
|
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.
|
9311
10550
|
# @return [String]
|
9312
10551
|
#
|
9313
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
10552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagRule AWS API Documentation
|
9314
10553
|
#
|
9315
|
-
class
|
9316
|
-
:
|
9317
|
-
:
|
9318
|
-
:
|
9319
|
-
:
|
9320
|
-
SENSITIVE = []
|
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]
|
9321
10560
|
include Aws::Structure
|
9322
10561
|
end
|
9323
10562
|
|
@@ -9335,7 +10574,7 @@ module Aws::QuickSight
|
|
9335
10574
|
#
|
9336
10575
|
# @!attribute [rw] manifest_file_location
|
9337
10576
|
# Location of the Amazon S3 manifest file. This is NULL if the
|
9338
|
-
# manifest file was uploaded
|
10577
|
+
# manifest file was uploaded into QuickSight.
|
9339
10578
|
# @return [Types::ManifestFileLocation]
|
9340
10579
|
#
|
9341
10580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Parameters AWS API Documentation
|
@@ -9346,7 +10585,7 @@ module Aws::QuickSight
|
|
9346
10585
|
include Aws::Structure
|
9347
10586
|
end
|
9348
10587
|
|
9349
|
-
# A physical table type for
|
10588
|
+
# A physical table type for an S3 data source.
|
9350
10589
|
#
|
9351
10590
|
# @note When making an API call, you may pass S3Source
|
9352
10591
|
# data as a hash:
|
@@ -9377,7 +10616,12 @@ module Aws::QuickSight
|
|
9377
10616
|
# @return [Types::UploadSettings]
|
9378
10617
|
#
|
9379
10618
|
# @!attribute [rw] input_columns
|
9380
|
-
# 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>
|
9381
10625
|
# @return [Array<Types::InputColumn>]
|
9382
10626
|
#
|
9383
10627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Source AWS API Documentation
|
@@ -9407,8 +10651,8 @@ module Aws::QuickSight
|
|
9407
10651
|
# }
|
9408
10652
|
#
|
9409
10653
|
# @!attribute [rw] aws_account_id
|
9410
|
-
# The ID of the
|
9411
|
-
# searching for.
|
10654
|
+
# The ID of the Amazon Web Services account; that contains the
|
10655
|
+
# analyses that you're searching for.
|
9412
10656
|
# @return [String]
|
9413
10657
|
#
|
9414
10658
|
# @!attribute [rw] filters
|
@@ -9448,7 +10692,7 @@ module Aws::QuickSight
|
|
9448
10692
|
# @return [Integer]
|
9449
10693
|
#
|
9450
10694
|
# @!attribute [rw] request_id
|
9451
|
-
# The
|
10695
|
+
# The Amazon Web Services request ID for this operation.
|
9452
10696
|
# @return [String]
|
9453
10697
|
#
|
9454
10698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesResponse AWS API Documentation
|
@@ -9479,8 +10723,8 @@ module Aws::QuickSight
|
|
9479
10723
|
# }
|
9480
10724
|
#
|
9481
10725
|
# @!attribute [rw] aws_account_id
|
9482
|
-
# The ID of the
|
9483
|
-
# you're searching for.
|
10726
|
+
# The ID of the Amazon Web Services account; that contains the user
|
10727
|
+
# whose dashboards you're searching for.
|
9484
10728
|
# @return [String]
|
9485
10729
|
#
|
9486
10730
|
# @!attribute [rw] filters
|
@@ -9525,7 +10769,7 @@ module Aws::QuickSight
|
|
9525
10769
|
# @return [Integer]
|
9526
10770
|
#
|
9527
10771
|
# @!attribute [rw] request_id
|
9528
|
-
# The
|
10772
|
+
# The Amazon Web Services request ID for this operation.
|
9529
10773
|
# @return [String]
|
9530
10774
|
#
|
9531
10775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboardsResponse AWS API Documentation
|
@@ -9539,6 +10783,82 @@ module Aws::QuickSight
|
|
9539
10783
|
include Aws::Structure
|
9540
10784
|
end
|
9541
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
|
+
|
9542
10862
|
# ServiceNow parameters.
|
9543
10863
|
#
|
9544
10864
|
# @note When making an API call, you may pass ServiceNowParameters
|
@@ -9567,7 +10887,7 @@ module Aws::QuickSight
|
|
9567
10887
|
# @return [String]
|
9568
10888
|
#
|
9569
10889
|
# @!attribute [rw] request_id
|
9570
|
-
# The
|
10890
|
+
# The Amazon Web Services request ID for this request.
|
9571
10891
|
# @return [String]
|
9572
10892
|
#
|
9573
10893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SessionLifetimeInMinutesInvalidException AWS API Documentation
|
@@ -9579,12 +10899,39 @@ module Aws::QuickSight
|
|
9579
10899
|
include Aws::Structure
|
9580
10900
|
end
|
9581
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
|
+
|
9582
10929
|
# A *sheet*, which is an object that contains a set of visuals that are
|
9583
|
-
# viewed together on one page in
|
9584
|
-
#
|
9585
|
-
#
|
9586
|
-
#
|
9587
|
-
#
|
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.
|
9588
10935
|
#
|
9589
10936
|
# @!attribute [rw] sheet_id
|
9590
10937
|
# The unique identifier associated with a sheet.
|
@@ -9856,9 +11203,9 @@ module Aws::QuickSight
|
|
9856
11203
|
#
|
9857
11204
|
# @!attribute [rw] tags
|
9858
11205
|
# The dataset column tag, currently only used for geospatial type
|
9859
|
-
# tagging.
|
11206
|
+
# tagging.
|
9860
11207
|
#
|
9861
|
-
# <note markdown="1"> This is not tags for the
|
11208
|
+
# <note markdown="1"> This is not tags for the Amazon Web Services tagging feature.
|
9862
11209
|
#
|
9863
11210
|
# </note>
|
9864
11211
|
# @return [Array<Types::ColumnTag>]
|
@@ -9904,7 +11251,7 @@ module Aws::QuickSight
|
|
9904
11251
|
end
|
9905
11252
|
|
9906
11253
|
# @!attribute [rw] request_id
|
9907
|
-
# The
|
11254
|
+
# The Amazon Web Services request ID for this operation.
|
9908
11255
|
# @return [String]
|
9909
11256
|
#
|
9910
11257
|
# @!attribute [rw] status
|
@@ -9928,9 +11275,9 @@ module Aws::QuickSight
|
|
9928
11275
|
# dataset placeholders with datasets that follow the same schema that
|
9929
11276
|
# was used to create the source analysis and template.
|
9930
11277
|
#
|
9931
|
-
# You can share templates across
|
9932
|
-
#
|
9933
|
-
# 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.
|
9934
11281
|
#
|
9935
11282
|
# @!attribute [rw] arn
|
9936
11283
|
# The Amazon Resource Name (ARN) of the template.
|
@@ -9945,8 +11292,8 @@ module Aws::QuickSight
|
|
9945
11292
|
# @return [Types::TemplateVersion]
|
9946
11293
|
#
|
9947
11294
|
# @!attribute [rw] template_id
|
9948
|
-
# The ID for the template. This is unique per
|
9949
|
-
# account
|
11295
|
+
# The ID for the template. This is unique per Region; for each Amazon
|
11296
|
+
# Web Services account;.
|
9950
11297
|
# @return [String]
|
9951
11298
|
#
|
9952
11299
|
# @!attribute [rw] last_updated_time
|
@@ -10112,8 +11459,8 @@ module Aws::QuickSight
|
|
10112
11459
|
# @return [String]
|
10113
11460
|
#
|
10114
11461
|
# @!attribute [rw] template_id
|
10115
|
-
# The ID of the template. This ID is unique per
|
10116
|
-
#
|
11462
|
+
# The ID of the template. This ID is unique per Region; for each
|
11463
|
+
# Amazon Web Services account;.
|
10117
11464
|
# @return [String]
|
10118
11465
|
#
|
10119
11466
|
# @!attribute [rw] name
|
@@ -10440,8 +11787,8 @@ module Aws::QuickSight
|
|
10440
11787
|
# @return [String]
|
10441
11788
|
#
|
10442
11789
|
# @!attribute [rw] theme_id
|
10443
|
-
# The ID of the theme. This ID is unique per
|
10444
|
-
# account
|
11790
|
+
# The ID of the theme. This ID is unique per Region; for each Amazon
|
11791
|
+
# Web Services account;.
|
10445
11792
|
# @return [String]
|
10446
11793
|
#
|
10447
11794
|
# @!attribute [rw] latest_version_number
|
@@ -10561,7 +11908,7 @@ module Aws::QuickSight
|
|
10561
11908
|
# @return [String]
|
10562
11909
|
#
|
10563
11910
|
# @!attribute [rw] request_id
|
10564
|
-
# The
|
11911
|
+
# The Amazon Web Services request ID for this request.
|
10565
11912
|
# @return [String]
|
10566
11913
|
#
|
10567
11914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThrottlingException AWS API Documentation
|
@@ -10872,8 +12219,8 @@ module Aws::QuickSight
|
|
10872
12219
|
end
|
10873
12220
|
|
10874
12221
|
# This error indicates that you are calling an embedding operation in
|
10875
|
-
# Amazon QuickSight without the required pricing plan on your
|
10876
|
-
# 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
|
10877
12224
|
# QuickSight administrator needs to add capacity pricing to QuickSight.
|
10878
12225
|
# You can do this on the **Manage QuickSight** page.
|
10879
12226
|
#
|
@@ -10884,7 +12231,7 @@ module Aws::QuickSight
|
|
10884
12231
|
# @return [String]
|
10885
12232
|
#
|
10886
12233
|
# @!attribute [rw] request_id
|
10887
|
-
# The
|
12234
|
+
# The Amazon Web Services request ID for this request.
|
10888
12235
|
# @return [String]
|
10889
12236
|
#
|
10890
12237
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedPricingPlanException AWS API Documentation
|
@@ -10906,7 +12253,7 @@ module Aws::QuickSight
|
|
10906
12253
|
# @return [String]
|
10907
12254
|
#
|
10908
12255
|
# @!attribute [rw] request_id
|
10909
|
-
# The
|
12256
|
+
# The Amazon Web Services request ID for this request.
|
10910
12257
|
# @return [String]
|
10911
12258
|
#
|
10912
12259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UnsupportedUserEditionException AWS API Documentation
|
@@ -10946,7 +12293,7 @@ module Aws::QuickSight
|
|
10946
12293
|
end
|
10947
12294
|
|
10948
12295
|
# @!attribute [rw] request_id
|
10949
|
-
# The
|
12296
|
+
# The Amazon Web Services request ID for this operation.
|
10950
12297
|
# @return [String]
|
10951
12298
|
#
|
10952
12299
|
# @!attribute [rw] status
|
@@ -10974,8 +12321,8 @@ module Aws::QuickSight
|
|
10974
12321
|
# }
|
10975
12322
|
#
|
10976
12323
|
# @!attribute [rw] aws_account_id
|
10977
|
-
# The ID for the
|
10978
|
-
# customizations for.
|
12324
|
+
# The ID for the Amazon Web Services account; that you want to update
|
12325
|
+
# QuickSight customizations for.
|
10979
12326
|
# @return [String]
|
10980
12327
|
#
|
10981
12328
|
# @!attribute [rw] namespace
|
@@ -10983,8 +12330,8 @@ module Aws::QuickSight
|
|
10983
12330
|
# @return [String]
|
10984
12331
|
#
|
10985
12332
|
# @!attribute [rw] account_customization
|
10986
|
-
# The QuickSight customizations you're updating in the current
|
10987
|
-
# Region
|
12333
|
+
# The QuickSight customizations you're updating in the current
|
12334
|
+
# Region;.
|
10988
12335
|
# @return [Types::AccountCustomization]
|
10989
12336
|
#
|
10990
12337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -10999,12 +12346,12 @@ module Aws::QuickSight
|
|
10999
12346
|
|
11000
12347
|
# @!attribute [rw] arn
|
11001
12348
|
# The Amazon Resource Name (ARN) for the updated customization for
|
11002
|
-
# this
|
12349
|
+
# this Amazon Web Services account;.
|
11003
12350
|
# @return [String]
|
11004
12351
|
#
|
11005
12352
|
# @!attribute [rw] aws_account_id
|
11006
|
-
# The ID for the
|
11007
|
-
# customizations for.
|
12353
|
+
# The ID for the Amazon Web Services account; that you want to update
|
12354
|
+
# QuickSight customizations for.
|
11008
12355
|
# @return [String]
|
11009
12356
|
#
|
11010
12357
|
# @!attribute [rw] namespace
|
@@ -11013,12 +12360,12 @@ module Aws::QuickSight
|
|
11013
12360
|
# @return [String]
|
11014
12361
|
#
|
11015
12362
|
# @!attribute [rw] account_customization
|
11016
|
-
# The QuickSight customizations you're updating in the current
|
11017
|
-
# Region
|
12363
|
+
# The QuickSight customizations you're updating in the current
|
12364
|
+
# Region;.
|
11018
12365
|
# @return [Types::AccountCustomization]
|
11019
12366
|
#
|
11020
12367
|
# @!attribute [rw] request_id
|
11021
|
-
# The
|
12368
|
+
# The Amazon Web Services request ID for this operation.
|
11022
12369
|
# @return [String]
|
11023
12370
|
#
|
11024
12371
|
# @!attribute [rw] status
|
@@ -11048,20 +12395,21 @@ module Aws::QuickSight
|
|
11048
12395
|
# }
|
11049
12396
|
#
|
11050
12397
|
# @!attribute [rw] aws_account_id
|
11051
|
-
# The ID for the
|
11052
|
-
# 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.
|
11053
12400
|
# @return [String]
|
11054
12401
|
#
|
11055
12402
|
# @!attribute [rw] default_namespace
|
11056
|
-
# The default namespace for this
|
11057
|
-
# is `default`.
|
11058
|
-
# register for the first time with QuickSight provide
|
11059
|
-
# 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.
|
11060
12407
|
# @return [String]
|
11061
12408
|
#
|
11062
12409
|
# @!attribute [rw] notification_email
|
11063
12410
|
# The email address that you want QuickSight to send notifications to
|
11064
|
-
# regarding your
|
12411
|
+
# regarding your Amazon Web Services account; or QuickSight
|
12412
|
+
# subscription.
|
11065
12413
|
# @return [String]
|
11066
12414
|
#
|
11067
12415
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
@@ -11075,7 +12423,7 @@ module Aws::QuickSight
|
|
11075
12423
|
end
|
11076
12424
|
|
11077
12425
|
# @!attribute [rw] request_id
|
11078
|
-
# The
|
12426
|
+
# The Amazon Web Services request ID for this operation.
|
11079
12427
|
# @return [String]
|
11080
12428
|
#
|
11081
12429
|
# @!attribute [rw] status
|
@@ -11112,9 +12460,9 @@ module Aws::QuickSight
|
|
11112
12460
|
# }
|
11113
12461
|
#
|
11114
12462
|
# @!attribute [rw] aws_account_id
|
11115
|
-
# The ID of the
|
11116
|
-
# permissions you're updating. You must be using the
|
11117
|
-
# 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.
|
11118
12466
|
# @return [String]
|
11119
12467
|
#
|
11120
12468
|
# @!attribute [rw] analysis_id
|
@@ -11157,7 +12505,7 @@ module Aws::QuickSight
|
|
11157
12505
|
# @return [Array<Types::ResourcePermission>]
|
11158
12506
|
#
|
11159
12507
|
# @!attribute [rw] request_id
|
11160
|
-
# The
|
12508
|
+
# The Amazon Web Services request ID for this operation.
|
11161
12509
|
# @return [String]
|
11162
12510
|
#
|
11163
12511
|
# @!attribute [rw] status
|
@@ -11224,8 +12572,8 @@ module Aws::QuickSight
|
|
11224
12572
|
# }
|
11225
12573
|
#
|
11226
12574
|
# @!attribute [rw] aws_account_id
|
11227
|
-
# The ID of the
|
11228
|
-
# updating.
|
12575
|
+
# The ID of the Amazon Web Services account; that contains the
|
12576
|
+
# analysis that you're updating.
|
11229
12577
|
# @return [String]
|
11230
12578
|
#
|
11231
12579
|
# @!attribute [rw] analysis_id
|
@@ -11286,7 +12634,7 @@ module Aws::QuickSight
|
|
11286
12634
|
# @return [Integer]
|
11287
12635
|
#
|
11288
12636
|
# @!attribute [rw] request_id
|
11289
|
-
# The
|
12637
|
+
# The Amazon Web Services request ID for this operation.
|
11290
12638
|
# @return [String]
|
11291
12639
|
#
|
11292
12640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisResponse AWS API Documentation
|
@@ -11322,8 +12670,8 @@ module Aws::QuickSight
|
|
11322
12670
|
# }
|
11323
12671
|
#
|
11324
12672
|
# @!attribute [rw] aws_account_id
|
11325
|
-
# The ID of the
|
11326
|
-
# permissions you're updating.
|
12673
|
+
# The ID of the Amazon Web Services account; that contains the
|
12674
|
+
# dashboard whose permissions you're updating.
|
11327
12675
|
# @return [String]
|
11328
12676
|
#
|
11329
12677
|
# @!attribute [rw] dashboard_id
|
@@ -11362,7 +12710,7 @@ module Aws::QuickSight
|
|
11362
12710
|
# @return [Array<Types::ResourcePermission>]
|
11363
12711
|
#
|
11364
12712
|
# @!attribute [rw] request_id
|
11365
|
-
# The
|
12713
|
+
# The Amazon Web Services request ID for this operation.
|
11366
12714
|
# @return [String]
|
11367
12715
|
#
|
11368
12716
|
# @!attribute [rw] status
|
@@ -11391,8 +12739,8 @@ module Aws::QuickSight
|
|
11391
12739
|
# }
|
11392
12740
|
#
|
11393
12741
|
# @!attribute [rw] aws_account_id
|
11394
|
-
# The ID of the
|
11395
|
-
# updating.
|
12742
|
+
# The ID of the Amazon Web Services account; that contains the
|
12743
|
+
# dashboard that you're updating.
|
11396
12744
|
# @return [String]
|
11397
12745
|
#
|
11398
12746
|
# @!attribute [rw] dashboard_id
|
@@ -11426,7 +12774,7 @@ module Aws::QuickSight
|
|
11426
12774
|
# @return [Integer]
|
11427
12775
|
#
|
11428
12776
|
# @!attribute [rw] request_id
|
11429
|
-
# The
|
12777
|
+
# The Amazon Web Services request ID for this operation.
|
11430
12778
|
# @return [String]
|
11431
12779
|
#
|
11432
12780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPublishedVersionResponse AWS API Documentation
|
@@ -11500,8 +12848,8 @@ module Aws::QuickSight
|
|
11500
12848
|
# }
|
11501
12849
|
#
|
11502
12850
|
# @!attribute [rw] aws_account_id
|
11503
|
-
# The ID of the
|
11504
|
-
# updating.
|
12851
|
+
# The ID of the Amazon Web Services account; that contains the
|
12852
|
+
# dashboard that you're updating.
|
11505
12853
|
# @return [String]
|
11506
12854
|
#
|
11507
12855
|
# @!attribute [rw] dashboard_id
|
@@ -11520,8 +12868,8 @@ module Aws::QuickSight
|
|
11520
12868
|
# from an analysis, first convert the analysis to a template by using
|
11521
12869
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
11522
12870
|
# Amazon Resource Name (ARN) of the source template. The
|
11523
|
-
# `SourceTemplate` ARN can contain any
|
11524
|
-
# QuickSight-supported
|
12871
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account;
|
12872
|
+
# and any QuickSight-supported Region;.
|
11525
12873
|
#
|
11526
12874
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
11527
12875
|
# the replacement datasets for the placeholders listed in the
|
@@ -11561,7 +12909,8 @@ module Aws::QuickSight
|
|
11561
12909
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
11562
12910
|
# this dashboard. If you add a value for this field, it overrides the
|
11563
12911
|
# value that was originally associated with the entity. The theme ARN
|
11564
|
-
# must exist in the same
|
12912
|
+
# must exist in the same Amazon Web Services account; where you create
|
12913
|
+
# the dashboard.
|
11565
12914
|
# @return [String]
|
11566
12915
|
#
|
11567
12916
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardRequest AWS API Documentation
|
@@ -11600,7 +12949,7 @@ module Aws::QuickSight
|
|
11600
12949
|
# @return [Integer]
|
11601
12950
|
#
|
11602
12951
|
# @!attribute [rw] request_id
|
11603
|
-
# The
|
12952
|
+
# The Amazon Web Services request ID for this operation.
|
11604
12953
|
# @return [String]
|
11605
12954
|
#
|
11606
12955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardResponse AWS API Documentation
|
@@ -11637,12 +12986,12 @@ module Aws::QuickSight
|
|
11637
12986
|
# }
|
11638
12987
|
#
|
11639
12988
|
# @!attribute [rw] aws_account_id
|
11640
|
-
# The
|
12989
|
+
# The Amazon Web Services account; ID.
|
11641
12990
|
# @return [String]
|
11642
12991
|
#
|
11643
12992
|
# @!attribute [rw] data_set_id
|
11644
12993
|
# The ID for the dataset whose permissions you want to update. This ID
|
11645
|
-
# is unique per
|
12994
|
+
# is unique per Region; for each Amazon Web Services account;.
|
11646
12995
|
# @return [String]
|
11647
12996
|
#
|
11648
12997
|
# @!attribute [rw] grant_permissions
|
@@ -11670,11 +13019,11 @@ module Aws::QuickSight
|
|
11670
13019
|
#
|
11671
13020
|
# @!attribute [rw] data_set_id
|
11672
13021
|
# The ID for the dataset whose permissions you want to update. This ID
|
11673
|
-
# is unique per
|
13022
|
+
# is unique per Region; for each Amazon Web Services account;.
|
11674
13023
|
# @return [String]
|
11675
13024
|
#
|
11676
13025
|
# @!attribute [rw] request_id
|
11677
|
-
# The
|
13026
|
+
# The Amazon Web Services request ID for this operation.
|
11678
13027
|
# @return [String]
|
11679
13028
|
#
|
11680
13029
|
# @!attribute [rw] status
|
@@ -11822,6 +13171,18 @@ module Aws::QuickSight
|
|
11822
13171
|
# arn: "Arn", # required
|
11823
13172
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
11824
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
|
+
# ],
|
11825
13186
|
# },
|
11826
13187
|
# column_level_permission_rules: [
|
11827
13188
|
# {
|
@@ -11832,12 +13193,12 @@ module Aws::QuickSight
|
|
11832
13193
|
# }
|
11833
13194
|
#
|
11834
13195
|
# @!attribute [rw] aws_account_id
|
11835
|
-
# The
|
13196
|
+
# The Amazon Web Services account; ID.
|
11836
13197
|
# @return [String]
|
11837
13198
|
#
|
11838
13199
|
# @!attribute [rw] data_set_id
|
11839
13200
|
# The ID for the dataset that you want to update. This ID is unique
|
11840
|
-
# per
|
13201
|
+
# per Region; for each Amazon Web Services account;.
|
11841
13202
|
# @return [String]
|
11842
13203
|
#
|
11843
13204
|
# @!attribute [rw] name
|
@@ -11873,6 +13234,12 @@ module Aws::QuickSight
|
|
11873
13234
|
# create.
|
11874
13235
|
# @return [Types::RowLevelPermissionDataSet]
|
11875
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
|
+
#
|
11876
13243
|
# @!attribute [rw] column_level_permission_rules
|
11877
13244
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
11878
13245
|
# @return [Array<Types::ColumnLevelPermissionRule>]
|
@@ -11889,6 +13256,7 @@ module Aws::QuickSight
|
|
11889
13256
|
:column_groups,
|
11890
13257
|
:field_folders,
|
11891
13258
|
:row_level_permission_data_set,
|
13259
|
+
:row_level_permission_tag_configuration,
|
11892
13260
|
:column_level_permission_rules)
|
11893
13261
|
SENSITIVE = []
|
11894
13262
|
include Aws::Structure
|
@@ -11900,7 +13268,7 @@ module Aws::QuickSight
|
|
11900
13268
|
#
|
11901
13269
|
# @!attribute [rw] data_set_id
|
11902
13270
|
# The ID for the dataset that you want to create. This ID is unique
|
11903
|
-
# per
|
13271
|
+
# per Region; for each Amazon Web Services account;.
|
11904
13272
|
# @return [String]
|
11905
13273
|
#
|
11906
13274
|
# @!attribute [rw] ingestion_arn
|
@@ -11914,7 +13282,7 @@ module Aws::QuickSight
|
|
11914
13282
|
# @return [String]
|
11915
13283
|
#
|
11916
13284
|
# @!attribute [rw] request_id
|
11917
|
-
# The
|
13285
|
+
# The Amazon Web Services request ID for this operation.
|
11918
13286
|
# @return [String]
|
11919
13287
|
#
|
11920
13288
|
# @!attribute [rw] status
|
@@ -11955,12 +13323,12 @@ module Aws::QuickSight
|
|
11955
13323
|
# }
|
11956
13324
|
#
|
11957
13325
|
# @!attribute [rw] aws_account_id
|
11958
|
-
# The
|
13326
|
+
# The Amazon Web Services account; ID.
|
11959
13327
|
# @return [String]
|
11960
13328
|
#
|
11961
13329
|
# @!attribute [rw] data_source_id
|
11962
|
-
# The ID of the data source. This ID is unique per
|
11963
|
-
#
|
13330
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13331
|
+
# Amazon Web Services account;.
|
11964
13332
|
# @return [String]
|
11965
13333
|
#
|
11966
13334
|
# @!attribute [rw] grant_permissions
|
@@ -11989,12 +13357,12 @@ module Aws::QuickSight
|
|
11989
13357
|
# @return [String]
|
11990
13358
|
#
|
11991
13359
|
# @!attribute [rw] data_source_id
|
11992
|
-
# The ID of the data source. This ID is unique per
|
11993
|
-
#
|
13360
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13361
|
+
# Amazon Web Services account;.
|
11994
13362
|
# @return [String]
|
11995
13363
|
#
|
11996
13364
|
# @!attribute [rw] request_id
|
11997
|
-
# The
|
13365
|
+
# The Amazon Web Services request ID for this operation.
|
11998
13366
|
# @return [String]
|
11999
13367
|
#
|
12000
13368
|
# @!attribute [rw] status
|
@@ -12219,12 +13587,12 @@ module Aws::QuickSight
|
|
12219
13587
|
# }
|
12220
13588
|
#
|
12221
13589
|
# @!attribute [rw] aws_account_id
|
12222
|
-
# The
|
13590
|
+
# The Amazon Web Services account; ID.
|
12223
13591
|
# @return [String]
|
12224
13592
|
#
|
12225
13593
|
# @!attribute [rw] data_source_id
|
12226
|
-
# The ID of the data source. This ID is unique per
|
12227
|
-
#
|
13594
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13595
|
+
# Amazon Web Services account;.
|
12228
13596
|
# @return [String]
|
12229
13597
|
#
|
12230
13598
|
# @!attribute [rw] name
|
@@ -12271,8 +13639,8 @@ module Aws::QuickSight
|
|
12271
13639
|
# @return [String]
|
12272
13640
|
#
|
12273
13641
|
# @!attribute [rw] data_source_id
|
12274
|
-
# The ID of the data source. This ID is unique per
|
12275
|
-
#
|
13642
|
+
# The ID of the data source. This ID is unique per Region; for each
|
13643
|
+
# Amazon Web Services account;.
|
12276
13644
|
# @return [String]
|
12277
13645
|
#
|
12278
13646
|
# @!attribute [rw] update_status
|
@@ -12280,7 +13648,7 @@ module Aws::QuickSight
|
|
12280
13648
|
# @return [String]
|
12281
13649
|
#
|
12282
13650
|
# @!attribute [rw] request_id
|
12283
|
-
# The
|
13651
|
+
# The Amazon Web Services request ID for this operation.
|
12284
13652
|
# @return [String]
|
12285
13653
|
#
|
12286
13654
|
# @!attribute [rw] status
|
@@ -12299,6 +13667,143 @@ module Aws::QuickSight
|
|
12299
13667
|
include Aws::Structure
|
12300
13668
|
end
|
12301
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
|
+
|
12302
13807
|
# @note When making an API call, you may pass UpdateGroupRequest
|
12303
13808
|
# data as a hash:
|
12304
13809
|
#
|
@@ -12318,9 +13823,9 @@ module Aws::QuickSight
|
|
12318
13823
|
# @return [String]
|
12319
13824
|
#
|
12320
13825
|
# @!attribute [rw] aws_account_id
|
12321
|
-
# The ID for the
|
12322
|
-
# the ID for the
|
12323
|
-
# 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.
|
12324
13829
|
# @return [String]
|
12325
13830
|
#
|
12326
13831
|
# @!attribute [rw] namespace
|
@@ -12343,7 +13848,7 @@ module Aws::QuickSight
|
|
12343
13848
|
# @return [Types::Group]
|
12344
13849
|
#
|
12345
13850
|
# @!attribute [rw] request_id
|
12346
|
-
# The
|
13851
|
+
# The Amazon Web Services request ID for this operation.
|
12347
13852
|
# @return [String]
|
12348
13853
|
#
|
12349
13854
|
# @!attribute [rw] status
|
@@ -12375,12 +13880,13 @@ module Aws::QuickSight
|
|
12375
13880
|
# }
|
12376
13881
|
#
|
12377
13882
|
# @!attribute [rw] aws_account_id
|
12378
|
-
# The ID of the
|
13883
|
+
# The ID of the Amazon Web Services account; that contains the IAM
|
13884
|
+
# policy assignment.
|
12379
13885
|
# @return [String]
|
12380
13886
|
#
|
12381
13887
|
# @!attribute [rw] assignment_name
|
12382
13888
|
# The name of the assignment, also called a rule. This name must be
|
12383
|
-
# unique within an
|
13889
|
+
# unique within an Amazon Web Services account;.
|
12384
13890
|
# @return [String]
|
12385
13891
|
#
|
12386
13892
|
# @!attribute [rw] namespace
|
@@ -12455,7 +13961,7 @@ module Aws::QuickSight
|
|
12455
13961
|
# @return [String]
|
12456
13962
|
#
|
12457
13963
|
# @!attribute [rw] request_id
|
12458
|
-
# The
|
13964
|
+
# The Amazon Web Services request ID for this operation.
|
12459
13965
|
# @return [String]
|
12460
13966
|
#
|
12461
13967
|
# @!attribute [rw] status
|
@@ -12487,8 +13993,8 @@ module Aws::QuickSight
|
|
12487
13993
|
# }
|
12488
13994
|
#
|
12489
13995
|
# @!attribute [rw] aws_account_id
|
12490
|
-
# The ID of the
|
12491
|
-
# you're updating.
|
13996
|
+
# The ID of the Amazon Web Services account; that contains the
|
13997
|
+
# template alias that you're updating.
|
12492
13998
|
# @return [String]
|
12493
13999
|
#
|
12494
14000
|
# @!attribute [rw] template_id
|
@@ -12527,7 +14033,7 @@ module Aws::QuickSight
|
|
12527
14033
|
# @return [Integer]
|
12528
14034
|
#
|
12529
14035
|
# @!attribute [rw] request_id
|
12530
|
-
# The
|
14036
|
+
# The Amazon Web Services request ID for this operation.
|
12531
14037
|
# @return [String]
|
12532
14038
|
#
|
12533
14039
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplateAliasResponse AWS API Documentation
|
@@ -12561,7 +14067,8 @@ module Aws::QuickSight
|
|
12561
14067
|
# }
|
12562
14068
|
#
|
12563
14069
|
# @!attribute [rw] aws_account_id
|
12564
|
-
# The ID of the
|
14070
|
+
# The ID of the Amazon Web Services account; that contains the
|
14071
|
+
# template.
|
12565
14072
|
# @return [String]
|
12566
14073
|
#
|
12567
14074
|
# @!attribute [rw] template_id
|
@@ -12600,7 +14107,7 @@ module Aws::QuickSight
|
|
12600
14107
|
# @return [Array<Types::ResourcePermission>]
|
12601
14108
|
#
|
12602
14109
|
# @!attribute [rw] request_id
|
12603
|
-
# The
|
14110
|
+
# The Amazon Web Services request ID for this operation.
|
12604
14111
|
# @return [String]
|
12605
14112
|
#
|
12606
14113
|
# @!attribute [rw] status
|
@@ -12644,8 +14151,8 @@ module Aws::QuickSight
|
|
12644
14151
|
# }
|
12645
14152
|
#
|
12646
14153
|
# @!attribute [rw] aws_account_id
|
12647
|
-
# The ID of the
|
12648
|
-
# updating.
|
14154
|
+
# The ID of the Amazon Web Services account; that contains the
|
14155
|
+
# template that you're updating.
|
12649
14156
|
# @return [String]
|
12650
14157
|
#
|
12651
14158
|
# @!attribute [rw] template_id
|
@@ -12659,8 +14166,8 @@ module Aws::QuickSight
|
|
12659
14166
|
# for an analysis. Both of these require an Amazon Resource Name
|
12660
14167
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
12661
14168
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
12662
|
-
# `SourceTemplate` ARN can contain any
|
12663
|
-
# QuickSight-supported
|
14169
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account;
|
14170
|
+
# and any QuickSight-supported Region;.
|
12664
14171
|
#
|
12665
14172
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
12666
14173
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -12713,7 +14220,7 @@ module Aws::QuickSight
|
|
12713
14220
|
# @return [Integer]
|
12714
14221
|
#
|
12715
14222
|
# @!attribute [rw] request_id
|
12716
|
-
# The
|
14223
|
+
# The Amazon Web Services request ID for this operation.
|
12717
14224
|
# @return [String]
|
12718
14225
|
#
|
12719
14226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTemplateResponse AWS API Documentation
|
@@ -12740,8 +14247,8 @@ module Aws::QuickSight
|
|
12740
14247
|
# }
|
12741
14248
|
#
|
12742
14249
|
# @!attribute [rw] aws_account_id
|
12743
|
-
# The ID of the
|
12744
|
-
# updating.
|
14250
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
14251
|
+
# alias that you're updating.
|
12745
14252
|
# @return [String]
|
12746
14253
|
#
|
12747
14254
|
# @!attribute [rw] theme_id
|
@@ -12776,7 +14283,7 @@ module Aws::QuickSight
|
|
12776
14283
|
# @return [Integer]
|
12777
14284
|
#
|
12778
14285
|
# @!attribute [rw] request_id
|
12779
|
-
# The
|
14286
|
+
# The Amazon Web Services request ID for this operation.
|
12780
14287
|
# @return [String]
|
12781
14288
|
#
|
12782
14289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAliasResponse AWS API Documentation
|
@@ -12810,7 +14317,7 @@ module Aws::QuickSight
|
|
12810
14317
|
# }
|
12811
14318
|
#
|
12812
14319
|
# @!attribute [rw] aws_account_id
|
12813
|
-
# The ID of the
|
14320
|
+
# The ID of the Amazon Web Services account; that contains the theme.
|
12814
14321
|
# @return [String]
|
12815
14322
|
#
|
12816
14323
|
# @!attribute [rw] theme_id
|
@@ -12849,7 +14356,7 @@ module Aws::QuickSight
|
|
12849
14356
|
# @return [Array<Types::ResourcePermission>]
|
12850
14357
|
#
|
12851
14358
|
# @!attribute [rw] request_id
|
12852
|
-
# The
|
14359
|
+
# The Amazon Web Services request ID for this operation.
|
12853
14360
|
# @return [String]
|
12854
14361
|
#
|
12855
14362
|
# @!attribute [rw] status
|
@@ -12920,8 +14427,8 @@ module Aws::QuickSight
|
|
12920
14427
|
# }
|
12921
14428
|
#
|
12922
14429
|
# @!attribute [rw] aws_account_id
|
12923
|
-
# The ID of the
|
12924
|
-
# updating.
|
14430
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
14431
|
+
# that you're updating.
|
12925
14432
|
# @return [String]
|
12926
14433
|
#
|
12927
14434
|
# @!attribute [rw] theme_id
|
@@ -12934,7 +14441,7 @@ module Aws::QuickSight
|
|
12934
14441
|
#
|
12935
14442
|
# @!attribute [rw] base_theme_id
|
12936
14443
|
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
12937
|
-
# inherits from. All themes initially inherit from a default
|
14444
|
+
# inherits from. All themes initially inherit from a default Amazon
|
12938
14445
|
# QuickSight theme.
|
12939
14446
|
# @return [String]
|
12940
14447
|
#
|
@@ -12984,7 +14491,7 @@ module Aws::QuickSight
|
|
12984
14491
|
# @return [Integer]
|
12985
14492
|
#
|
12986
14493
|
# @!attribute [rw] request_id
|
12987
|
-
# The
|
14494
|
+
# The Amazon Web Services request ID for this operation.
|
12988
14495
|
# @return [String]
|
12989
14496
|
#
|
12990
14497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeResponse AWS API Documentation
|
@@ -13011,6 +14518,9 @@ module Aws::QuickSight
|
|
13011
14518
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
13012
14519
|
# custom_permissions_name: "RoleName",
|
13013
14520
|
# unapply_custom_permissions: false,
|
14521
|
+
# external_login_federation_provider_type: "String",
|
14522
|
+
# custom_federation_provider_url: "String",
|
14523
|
+
# external_login_id: "String",
|
13014
14524
|
# }
|
13015
14525
|
#
|
13016
14526
|
# @!attribute [rw] user_name
|
@@ -13018,9 +14528,9 @@ module Aws::QuickSight
|
|
13018
14528
|
# @return [String]
|
13019
14529
|
#
|
13020
14530
|
# @!attribute [rw] aws_account_id
|
13021
|
-
# The ID for the
|
13022
|
-
# the ID for the
|
13023
|
-
# 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.
|
13024
14534
|
# @return [String]
|
13025
14535
|
#
|
13026
14536
|
# @!attribute [rw] namespace
|
@@ -13073,8 +14583,7 @@ module Aws::QuickSight
|
|
13073
14583
|
# QuickSight (admin, author, reader).
|
13074
14584
|
#
|
13075
14585
|
# This feature is available only to QuickSight Enterprise edition
|
13076
|
-
# subscriptions
|
13077
|
-
# (SSO).
|
14586
|
+
# subscriptions.
|
13078
14587
|
# @return [String]
|
13079
14588
|
#
|
13080
14589
|
# @!attribute [rw] unapply_custom_permissions
|
@@ -13085,6 +14594,39 @@ module Aws::QuickSight
|
|
13085
14594
|
# value.
|
13086
14595
|
# @return [Boolean]
|
13087
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
|
+
#
|
13088
14630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
|
13089
14631
|
#
|
13090
14632
|
class UpdateUserRequest < Struct.new(
|
@@ -13094,7 +14636,10 @@ module Aws::QuickSight
|
|
13094
14636
|
:email,
|
13095
14637
|
:role,
|
13096
14638
|
:custom_permissions_name,
|
13097
|
-
:unapply_custom_permissions
|
14639
|
+
:unapply_custom_permissions,
|
14640
|
+
:external_login_federation_provider_type,
|
14641
|
+
:custom_federation_provider_url,
|
14642
|
+
:external_login_id)
|
13098
14643
|
SENSITIVE = []
|
13099
14644
|
include Aws::Structure
|
13100
14645
|
end
|
@@ -13104,7 +14649,7 @@ module Aws::QuickSight
|
|
13104
14649
|
# @return [Types::User]
|
13105
14650
|
#
|
13106
14651
|
# @!attribute [rw] request_id
|
13107
|
-
# The
|
14652
|
+
# The Amazon Web Services request ID for this operation.
|
13108
14653
|
# @return [String]
|
13109
14654
|
#
|
13110
14655
|
# @!attribute [rw] status
|
@@ -13218,6 +14763,25 @@ module Aws::QuickSight
|
|
13218
14763
|
# The custom permissions profile associated with this user.
|
13219
14764
|
# @return [String]
|
13220
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
|
+
#
|
13221
14785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
|
13222
14786
|
#
|
13223
14787
|
class User < Struct.new(
|
@@ -13228,7 +14792,10 @@ module Aws::QuickSight
|
|
13228
14792
|
:identity_type,
|
13229
14793
|
:active,
|
13230
14794
|
:principal_id,
|
13231
|
-
:custom_permissions_name
|
14795
|
+
:custom_permissions_name,
|
14796
|
+
:external_login_federation_provider_type,
|
14797
|
+
:external_login_federation_provider_url,
|
14798
|
+
:external_login_id)
|
13232
14799
|
SENSITIVE = []
|
13233
14800
|
include Aws::Structure
|
13234
14801
|
end
|