aws-sdk-quicksight 1.47.0 → 1.51.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +605 -307
- data/lib/aws-sdk-quicksight/client_api.rb +118 -0
- data/lib/aws-sdk-quicksight/types.rb +994 -442
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 25ca9c6523484a42c6c7511ad898e0fed8a7b1b00d50af9bcef2a9e6931a1704
|
4
|
+
data.tar.gz: 90a22ce6b4be3d0a0c381c744664e428aae67441daf0947be619f6b7a19acc1f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 304b611b0a45fadf478a1e11847355d537791fc7ce0dc0f49aa5429fad4e149c9c755d9fa996b2a7f504cad0e62b9f6c1980696e3dc2309252f6345192b6efa5
|
7
|
+
data.tar.gz: 8a664abb24015f37159693f2f69434697d016e84214fa208b7297b02b420f5caef3082df2da7290589b1e0db1efedc4ba50b894d3bbbe8ac1cc83f60a32d648a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.51.0 (2021-08-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for QuickSight.
|
8
|
+
|
9
|
+
1.50.0 (2021-07-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.49.0 (2021-07-28)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.48.0 (2021-07-27)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight
|
23
|
+
|
4
24
|
1.47.0 (2021-06-23)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.51.0
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -330,7 +330,7 @@ module Aws::QuickSight
|
|
330
330
|
# Cancels an ongoing ingestion of data into SPICE.
|
331
331
|
#
|
332
332
|
# @option params [required, String] :aws_account_id
|
333
|
-
# The
|
333
|
+
# The Amazon Web Services account; ID.
|
334
334
|
#
|
335
335
|
# @option params [required, String] :data_set_id
|
336
336
|
# The ID of the dataset used in the ingestion.
|
@@ -369,18 +369,19 @@ module Aws::QuickSight
|
|
369
369
|
req.send_request(options)
|
370
370
|
end
|
371
371
|
|
372
|
-
# Creates Amazon QuickSight customizations the current
|
373
|
-
# Currently, you can add a custom default theme by
|
374
|
-
# `CreateAccountCustomization` or `UpdateAccountCustomization`
|
375
|
-
# operation. To further customize QuickSight by removing QuickSight
|
372
|
+
# Creates Amazon QuickSight customizations the current Amazon Web
|
373
|
+
# Services Region;. Currently, you can add a custom default theme by
|
374
|
+
# using the `CreateAccountCustomization` or `UpdateAccountCustomization`
|
375
|
+
# API operation. To further customize QuickSight by removing QuickSight
|
376
376
|
# sample assets and videos for all new users, see [Customizing
|
377
377
|
# QuickSight][1] in the *Amazon QuickSight User Guide.*
|
378
378
|
#
|
379
|
-
# You can create customizations for your
|
380
|
-
# a namespace, for a QuickSight namespace instead.
|
381
|
-
# apply to a namespace always override
|
382
|
-
#
|
383
|
-
# `DescribeAccountCustomization`
|
379
|
+
# You can create customizations for your Amazon Web Services account;
|
380
|
+
# or, if you specify a namespace, for a QuickSight namespace instead.
|
381
|
+
# Customizations that apply to a namespace always override
|
382
|
+
# customizations that apply to an Amazon Web Services account;. To find
|
383
|
+
# out which customizations apply, use the `DescribeAccountCustomization`
|
384
|
+
# API operation.
|
384
385
|
#
|
385
386
|
# Before you use the `CreateAccountCustomization` API operation to add a
|
386
387
|
# theme as the namespace default, make sure that you first share the
|
@@ -396,15 +397,16 @@ module Aws::QuickSight
|
|
396
397
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
|
397
398
|
#
|
398
399
|
# @option params [required, String] :aws_account_id
|
399
|
-
# The ID for the
|
400
|
+
# The ID for the Amazon Web Services account; that you want to customize
|
401
|
+
# QuickSight for.
|
400
402
|
#
|
401
403
|
# @option params [String] :namespace
|
402
404
|
# The QuickSight namespace that you want to add customizations to.
|
403
405
|
#
|
404
406
|
# @option params [required, Types::AccountCustomization] :account_customization
|
405
|
-
# The QuickSight customizations you're adding in the current
|
406
|
-
# Region
|
407
|
-
# namespace.
|
407
|
+
# The QuickSight customizations you're adding in the current Amazon Web
|
408
|
+
# Services Region;. You can add these to an Amazon Web Services account;
|
409
|
+
# and a QuickSight namespace.
|
408
410
|
#
|
409
411
|
# For example, you can add a default theme by setting
|
410
412
|
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
@@ -463,7 +465,8 @@ module Aws::QuickSight
|
|
463
465
|
# Creates an analysis in Amazon QuickSight.
|
464
466
|
#
|
465
467
|
# @option params [required, String] :aws_account_id
|
466
|
-
# The ID of the
|
468
|
+
# The ID of the Amazon Web Services account; where you are creating an
|
469
|
+
# analysis.
|
467
470
|
#
|
468
471
|
# @option params [required, String] :analysis_id
|
469
472
|
# The ID for the analysis that you're creating. This ID displays in the
|
@@ -481,7 +484,7 @@ module Aws::QuickSight
|
|
481
484
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
482
485
|
# A structure that describes the principals and the resource-level
|
483
486
|
# permissions on an analysis. You can use the `Permissions` structure to
|
484
|
-
# grant permissions by providing a list of
|
487
|
+
# grant permissions by providing a list of Identity and Access
|
485
488
|
# Management (IAM) action information for each principal listed by
|
486
489
|
# Amazon Resource Name (ARN).
|
487
490
|
#
|
@@ -591,10 +594,12 @@ module Aws::QuickSight
|
|
591
594
|
# reports, created from analyses. You can share QuickSight dashboards.
|
592
595
|
# With the right permissions, you can create scheduled email reports
|
593
596
|
# from them. If you have the correct permissions, you can create a
|
594
|
-
# dashboard from a template that exists in a different
|
597
|
+
# dashboard from a template that exists in a different Amazon Web
|
598
|
+
# Services account;.
|
595
599
|
#
|
596
600
|
# @option params [required, String] :aws_account_id
|
597
|
-
# The ID of the
|
601
|
+
# The ID of the Amazon Web Services account; where you want to create
|
602
|
+
# the dashboard.
|
598
603
|
#
|
599
604
|
# @option params [required, String] :dashboard_id
|
600
605
|
# The ID for the dashboard, also added to the IAM policy.
|
@@ -622,8 +627,8 @@ module Aws::QuickSight
|
|
622
627
|
# from an analysis, first convert the analysis to a template by using
|
623
628
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
624
629
|
# Amazon Resource Name (ARN) of the source template. The
|
625
|
-
# `SourceTemplate`ARN can contain any
|
626
|
-
# QuickSight-supported
|
630
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account; and
|
631
|
+
# any QuickSight-supported Amazon Web Services Region;.
|
627
632
|
#
|
628
633
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
629
634
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -658,7 +663,7 @@ module Aws::QuickSight
|
|
658
663
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
659
664
|
# this dashboard. If you add a value for this field, it overrides the
|
660
665
|
# value that is used in the source entity. The theme ARN must exist in
|
661
|
-
# the same
|
666
|
+
# the same Amazon Web Services account; where you create the dashboard.
|
662
667
|
#
|
663
668
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
664
669
|
#
|
@@ -760,11 +765,11 @@ module Aws::QuickSight
|
|
760
765
|
# Creates a dataset.
|
761
766
|
#
|
762
767
|
# @option params [required, String] :aws_account_id
|
763
|
-
# The
|
768
|
+
# The Amazon Web Services account; ID.
|
764
769
|
#
|
765
770
|
# @option params [required, String] :data_set_id
|
766
771
|
# An ID for the dataset that you want to create. This ID is unique per
|
767
|
-
#
|
772
|
+
# Amazon Web Services Region; for each Amazon Web Services account;.
|
768
773
|
#
|
769
774
|
# @option params [required, String] :name
|
770
775
|
# The display name for the dataset.
|
@@ -795,6 +800,11 @@ module Aws::QuickSight
|
|
795
800
|
# The row-level security configuration for the data that you want to
|
796
801
|
# create.
|
797
802
|
#
|
803
|
+
# @option params [Types::RowLevelPermissionTagConfiguration] :row_level_permission_tag_configuration
|
804
|
+
# The configuration of tags on a dataset to set row-level security.
|
805
|
+
# Row-level security tags are currently supported for anonymous
|
806
|
+
# embedding only.
|
807
|
+
#
|
798
808
|
# @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
|
799
809
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
800
810
|
#
|
@@ -946,6 +956,18 @@ module Aws::QuickSight
|
|
946
956
|
# arn: "Arn", # required
|
947
957
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
948
958
|
# format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
|
959
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
960
|
+
# },
|
961
|
+
# row_level_permission_tag_configuration: {
|
962
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
963
|
+
# tag_rules: [ # required
|
964
|
+
# {
|
965
|
+
# tag_key: "SessionTagKey", # required
|
966
|
+
# column_name: "String", # required
|
967
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
968
|
+
# match_all_value: "SessionTagValue",
|
969
|
+
# },
|
970
|
+
# ],
|
949
971
|
# },
|
950
972
|
# column_level_permission_rules: [
|
951
973
|
# {
|
@@ -982,11 +1004,11 @@ module Aws::QuickSight
|
|
982
1004
|
# Creates a data source.
|
983
1005
|
#
|
984
1006
|
# @option params [required, String] :aws_account_id
|
985
|
-
# The
|
1007
|
+
# The Amazon Web Services account; ID.
|
986
1008
|
#
|
987
1009
|
# @option params [required, String] :data_source_id
|
988
|
-
# An ID for the data source. This ID is unique per
|
989
|
-
#
|
1010
|
+
# An ID for the data source. This ID is unique per Amazon Web Services
|
1011
|
+
# Region; for each Amazon Web Services account;.
|
990
1012
|
#
|
991
1013
|
# @option params [required, String] :name
|
992
1014
|
# A display name for the data source.
|
@@ -1403,9 +1425,9 @@ module Aws::QuickSight
|
|
1403
1425
|
# A description for the group that you want to create.
|
1404
1426
|
#
|
1405
1427
|
# @option params [required, String] :aws_account_id
|
1406
|
-
# The ID for the
|
1407
|
-
# the ID for the
|
1408
|
-
# account.
|
1428
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
1429
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
1430
|
+
# contains your Amazon QuickSight account.
|
1409
1431
|
#
|
1410
1432
|
# @option params [required, String] :namespace
|
1411
1433
|
# The namespace. Currently, you should set this to `default`.
|
@@ -1452,9 +1474,9 @@ module Aws::QuickSight
|
|
1452
1474
|
# The name of the group that you want to add the user to.
|
1453
1475
|
#
|
1454
1476
|
# @option params [required, String] :aws_account_id
|
1455
|
-
# The ID for the
|
1456
|
-
# the ID for the
|
1457
|
-
# account.
|
1477
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
1478
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
1479
|
+
# contains your Amazon QuickSight account.
|
1458
1480
|
#
|
1459
1481
|
# @option params [required, String] :namespace
|
1460
1482
|
# The namespace. Currently, you should set this to `default`.
|
@@ -1493,16 +1515,16 @@ module Aws::QuickSight
|
|
1493
1515
|
# Creates an assignment with one specified IAM policy, identified by its
|
1494
1516
|
# Amazon Resource Name (ARN). This policy assignment is attached to the
|
1495
1517
|
# specified groups or users of Amazon QuickSight. Assignment names are
|
1496
|
-
# unique per
|
1497
|
-
# namespaces, use assignment names that are unique.
|
1518
|
+
# unique per Amazon Web Services account;. To avoid overwriting rules in
|
1519
|
+
# other namespaces, use assignment names that are unique.
|
1498
1520
|
#
|
1499
1521
|
# @option params [required, String] :aws_account_id
|
1500
|
-
# The ID of the
|
1501
|
-
# QuickSight users or groups.
|
1522
|
+
# The ID of the Amazon Web Services account; where you want to assign an
|
1523
|
+
# IAM policy to QuickSight users or groups.
|
1502
1524
|
#
|
1503
1525
|
# @option params [required, String] :assignment_name
|
1504
1526
|
# The name of the assignment, also called a rule. It must be unique
|
1505
|
-
# within an
|
1527
|
+
# within an Amazon Web Services account;.
|
1506
1528
|
#
|
1507
1529
|
# @option params [required, String] :assignment_status
|
1508
1530
|
# The status of the assignment. Possible values are as follows:
|
@@ -1576,8 +1598,8 @@ module Aws::QuickSight
|
|
1576
1598
|
# Any ingestions operating on tagged datasets inherit the same tags
|
1577
1599
|
# automatically for use in access control. For an example, see [How do I
|
1578
1600
|
# create an IAM policy to control access to Amazon EC2 resources using
|
1579
|
-
# tags?][1] in the
|
1580
|
-
# dataset, but not on the ingestion resource.
|
1601
|
+
# tags?][1] in the Amazon Web Services Knowledge Center. Tags are
|
1602
|
+
# visible on the tagged dataset, but not on the ingestion resource.
|
1581
1603
|
#
|
1582
1604
|
#
|
1583
1605
|
#
|
@@ -1590,7 +1612,7 @@ module Aws::QuickSight
|
|
1590
1612
|
# An ID for the ingestion.
|
1591
1613
|
#
|
1592
1614
|
# @option params [required, String] :aws_account_id
|
1593
|
-
# The
|
1615
|
+
# The Amazon Web Services account; ID.
|
1594
1616
|
#
|
1595
1617
|
# @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1596
1618
|
#
|
@@ -1632,14 +1654,15 @@ module Aws::QuickSight
|
|
1632
1654
|
# are registered for that namespace. Users that access the namespace can
|
1633
1655
|
# share assets only with other users or groups in the same namespace.
|
1634
1656
|
# They can't see users and groups in other namespaces. You can create a
|
1635
|
-
# namespace after your
|
1636
|
-
# namespace must be unique within the
|
1637
|
-
# a limit of 100 namespaces per
|
1638
|
-
# create a ticket
|
1657
|
+
# namespace after your Amazon Web Services account; is subscribed to
|
1658
|
+
# QuickSight. The namespace must be unique within the Amazon Web
|
1659
|
+
# Services account;. By default, there is a limit of 100 namespaces per
|
1660
|
+
# Amazon Web Services account;. To increase your limit, create a ticket
|
1661
|
+
# with Amazon Web Services Support.
|
1639
1662
|
#
|
1640
1663
|
# @option params [required, String] :aws_account_id
|
1641
|
-
# The ID for the
|
1642
|
-
# namespace in.
|
1664
|
+
# The ID for the Amazon Web Services account; that you want to create
|
1665
|
+
# the QuickSight namespace in.
|
1643
1666
|
#
|
1644
1667
|
# @option params [required, String] :namespace
|
1645
1668
|
# The name that you want to use to describe the new namespace.
|
@@ -1695,8 +1718,8 @@ module Aws::QuickSight
|
|
1695
1718
|
req.send_request(options)
|
1696
1719
|
end
|
1697
1720
|
|
1698
|
-
# Creates a template from an existing QuickSight analysis or
|
1699
|
-
# You can use the resulting template to create a dashboard.
|
1721
|
+
# Creates a template from an existing Amazon QuickSight analysis or
|
1722
|
+
# template. You can use the resulting template to create a dashboard.
|
1700
1723
|
#
|
1701
1724
|
# A *template* is an entity in QuickSight that encapsulates the metadata
|
1702
1725
|
# required to create an analysis and that you can use to create s
|
@@ -1707,13 +1730,14 @@ module Aws::QuickSight
|
|
1707
1730
|
# to create the source analysis and template.
|
1708
1731
|
#
|
1709
1732
|
# @option params [required, String] :aws_account_id
|
1710
|
-
# The ID for the
|
1711
|
-
# the ID for the
|
1712
|
-
# account.
|
1733
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
1734
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
1735
|
+
# contains your Amazon QuickSight account.
|
1713
1736
|
#
|
1714
1737
|
# @option params [required, String] :template_id
|
1715
1738
|
# An ID for the template that you want to create. This template is
|
1716
|
-
# unique per
|
1739
|
+
# unique per Amazon Web Services Region; in each Amazon Web Services
|
1740
|
+
# account;.
|
1717
1741
|
#
|
1718
1742
|
# @option params [String] :name
|
1719
1743
|
# A display name for the template.
|
@@ -1728,8 +1752,8 @@ module Aws::QuickSight
|
|
1728
1752
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1729
1753
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
1730
1754
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1731
|
-
# `SourceTemplate` ARN can contain any
|
1732
|
-
# QuickSight-supported
|
1755
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account; and
|
1756
|
+
# any QuickSight-supported Amazon Web Services Region;.
|
1733
1757
|
#
|
1734
1758
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1735
1759
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -1812,8 +1836,8 @@ module Aws::QuickSight
|
|
1812
1836
|
# Creates a template alias for a template.
|
1813
1837
|
#
|
1814
1838
|
# @option params [required, String] :aws_account_id
|
1815
|
-
# The ID of the
|
1816
|
-
# an alias for.
|
1839
|
+
# The ID of the Amazon Web Services account; that contains the template
|
1840
|
+
# that you creating an alias for.
|
1817
1841
|
#
|
1818
1842
|
# @option params [required, String] :template_id
|
1819
1843
|
# An ID for the template.
|
@@ -1821,7 +1845,7 @@ module Aws::QuickSight
|
|
1821
1845
|
# @option params [required, String] :alias_name
|
1822
1846
|
# The name that you want to give to the template alias that you're
|
1823
1847
|
# creating. Don't start the alias name with the `$` character. Alias
|
1824
|
-
# names that start with `$` are reserved by QuickSight.
|
1848
|
+
# names that start with `$` are reserved by Amazon QuickSight.
|
1825
1849
|
#
|
1826
1850
|
# @option params [required, Integer] :template_version_number
|
1827
1851
|
# The version number of the template.
|
@@ -1869,11 +1893,12 @@ module Aws::QuickSight
|
|
1869
1893
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1870
1894
|
#
|
1871
1895
|
# @option params [required, String] :aws_account_id
|
1872
|
-
# The ID of the
|
1896
|
+
# The ID of the Amazon Web Services account; where you want to store the
|
1897
|
+
# new theme.
|
1873
1898
|
#
|
1874
1899
|
# @option params [required, String] :theme_id
|
1875
1900
|
# An ID for the theme that you want to create. The theme ID is unique
|
1876
|
-
# per
|
1901
|
+
# per Amazon Web Services Region; in each Amazon Web Services account;.
|
1877
1902
|
#
|
1878
1903
|
# @option params [required, String] :name
|
1879
1904
|
# A display name for the theme.
|
@@ -1992,8 +2017,8 @@ module Aws::QuickSight
|
|
1992
2017
|
# Creates a theme alias for a theme.
|
1993
2018
|
#
|
1994
2019
|
# @option params [required, String] :aws_account_id
|
1995
|
-
# The ID of the
|
1996
|
-
# alias.
|
2020
|
+
# The ID of the Amazon Web Services account; that contains the theme for
|
2021
|
+
# the new theme alias.
|
1997
2022
|
#
|
1998
2023
|
# @option params [required, String] :theme_id
|
1999
2024
|
# An ID for the theme alias.
|
@@ -2038,12 +2063,13 @@ module Aws::QuickSight
|
|
2038
2063
|
req.send_request(options)
|
2039
2064
|
end
|
2040
2065
|
|
2041
|
-
# Deletes all Amazon QuickSight customizations in this
|
2042
|
-
# the specified
|
2066
|
+
# Deletes all Amazon QuickSight customizations in this Amazon Web
|
2067
|
+
# Services Region; for the specified Amazon Web Services account; and
|
2068
|
+
# QuickSight namespace.
|
2043
2069
|
#
|
2044
2070
|
# @option params [required, String] :aws_account_id
|
2045
|
-
# The ID for the
|
2046
|
-
# customizations from in this
|
2071
|
+
# The ID for the Amazon Web Services account; that you want to delete
|
2072
|
+
# QuickSight customizations from in this Amazon Web Services Region;.
|
2047
2073
|
#
|
2048
2074
|
# @option params [String] :namespace
|
2049
2075
|
# The QuickSight namespace that you're deleting the customizations
|
@@ -2093,7 +2119,8 @@ module Aws::QuickSight
|
|
2093
2119
|
# an analysis doesn't delete the dashboards that you publish from it.
|
2094
2120
|
#
|
2095
2121
|
# @option params [required, String] :aws_account_id
|
2096
|
-
# The ID of the
|
2122
|
+
# The ID of the Amazon Web Services account; where you want to delete an
|
2123
|
+
# analysis.
|
2097
2124
|
#
|
2098
2125
|
# @option params [required, String] :analysis_id
|
2099
2126
|
# The ID of the analysis that you're deleting.
|
@@ -2146,8 +2173,8 @@ module Aws::QuickSight
|
|
2146
2173
|
# Deletes a dashboard.
|
2147
2174
|
#
|
2148
2175
|
# @option params [required, String] :aws_account_id
|
2149
|
-
# The ID of the
|
2150
|
-
# deleting.
|
2176
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
2177
|
+
# that you're deleting.
|
2151
2178
|
#
|
2152
2179
|
# @option params [required, String] :dashboard_id
|
2153
2180
|
# The ID for the dashboard.
|
@@ -2190,11 +2217,11 @@ module Aws::QuickSight
|
|
2190
2217
|
# Deletes a dataset.
|
2191
2218
|
#
|
2192
2219
|
# @option params [required, String] :aws_account_id
|
2193
|
-
# The
|
2220
|
+
# The Amazon Web Services account; ID.
|
2194
2221
|
#
|
2195
2222
|
# @option params [required, String] :data_set_id
|
2196
2223
|
# The ID for the dataset that you want to create. This ID is unique per
|
2197
|
-
#
|
2224
|
+
# Amazon Web Services Region; for each Amazon Web Services account;.
|
2198
2225
|
#
|
2199
2226
|
# @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2200
2227
|
#
|
@@ -2230,11 +2257,11 @@ module Aws::QuickSight
|
|
2230
2257
|
# datasets that reference the deleted data source.
|
2231
2258
|
#
|
2232
2259
|
# @option params [required, String] :aws_account_id
|
2233
|
-
# The
|
2260
|
+
# The Amazon Web Services account; ID.
|
2234
2261
|
#
|
2235
2262
|
# @option params [required, String] :data_source_id
|
2236
|
-
# The ID of the data source. This ID is unique per
|
2237
|
-
#
|
2263
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
2264
|
+
# Region; for each Amazon Web Services account;.
|
2238
2265
|
#
|
2239
2266
|
# @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2240
2267
|
#
|
@@ -2355,9 +2382,9 @@ module Aws::QuickSight
|
|
2355
2382
|
# The name of the group that you want to delete.
|
2356
2383
|
#
|
2357
2384
|
# @option params [required, String] :aws_account_id
|
2358
|
-
# The ID for the
|
2359
|
-
# the ID for the
|
2360
|
-
# account.
|
2385
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
2386
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2387
|
+
# contains your Amazon QuickSight account.
|
2361
2388
|
#
|
2362
2389
|
# @option params [required, String] :namespace
|
2363
2390
|
# The namespace. Currently, you should set this to `default`.
|
@@ -2400,9 +2427,9 @@ module Aws::QuickSight
|
|
2400
2427
|
# The name of the group that you want to delete the user from.
|
2401
2428
|
#
|
2402
2429
|
# @option params [required, String] :aws_account_id
|
2403
|
-
# The ID for the
|
2404
|
-
# the ID for the
|
2405
|
-
# account.
|
2430
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
2431
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2432
|
+
# contains your Amazon QuickSight account.
|
2406
2433
|
#
|
2407
2434
|
# @option params [required, String] :namespace
|
2408
2435
|
# The namespace. Currently, you should set this to `default`.
|
@@ -2438,7 +2465,8 @@ module Aws::QuickSight
|
|
2438
2465
|
# Deletes an existing IAM policy assignment.
|
2439
2466
|
#
|
2440
2467
|
# @option params [required, String] :aws_account_id
|
2441
|
-
# The
|
2468
|
+
# The Amazon Web Services account; ID where you want to delete the IAM
|
2469
|
+
# policy assignment.
|
2442
2470
|
#
|
2443
2471
|
# @option params [required, String] :assignment_name
|
2444
2472
|
# The name of the assignment.
|
@@ -2482,8 +2510,8 @@ module Aws::QuickSight
|
|
2482
2510
|
# asset.
|
2483
2511
|
#
|
2484
2512
|
# @option params [required, String] :aws_account_id
|
2485
|
-
# The ID for the
|
2486
|
-
# namespace from.
|
2513
|
+
# The ID for the Amazon Web Services account; that you want to delete
|
2514
|
+
# the QuickSight namespace from.
|
2487
2515
|
#
|
2488
2516
|
# @option params [required, String] :namespace
|
2489
2517
|
# The namespace that you want to delete.
|
@@ -2517,8 +2545,8 @@ module Aws::QuickSight
|
|
2517
2545
|
# Deletes a template.
|
2518
2546
|
#
|
2519
2547
|
# @option params [required, String] :aws_account_id
|
2520
|
-
# The ID of the
|
2521
|
-
# deleting.
|
2548
|
+
# The ID of the Amazon Web Services account; that contains the template
|
2549
|
+
# that you're deleting.
|
2522
2550
|
#
|
2523
2551
|
# @option params [required, String] :template_id
|
2524
2552
|
# An ID for the template you want to delete.
|
@@ -2564,7 +2592,8 @@ module Aws::QuickSight
|
|
2564
2592
|
# the alias points to.
|
2565
2593
|
#
|
2566
2594
|
# @option params [required, String] :aws_account_id
|
2567
|
-
# The ID of the
|
2595
|
+
# The ID of the Amazon Web Services account; that contains the item to
|
2596
|
+
# delete.
|
2568
2597
|
#
|
2569
2598
|
# @option params [required, String] :template_id
|
2570
2599
|
# The ID for the template that the specified alias is for.
|
@@ -2611,8 +2640,8 @@ module Aws::QuickSight
|
|
2611
2640
|
# Deletes a theme.
|
2612
2641
|
#
|
2613
2642
|
# @option params [required, String] :aws_account_id
|
2614
|
-
# The ID of the
|
2615
|
-
# deleting.
|
2643
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
2644
|
+
# that you're deleting.
|
2616
2645
|
#
|
2617
2646
|
# @option params [required, String] :theme_id
|
2618
2647
|
# An ID for the theme that you want to delete.
|
@@ -2659,7 +2688,8 @@ module Aws::QuickSight
|
|
2659
2688
|
# theme that the alias points to.
|
2660
2689
|
#
|
2661
2690
|
# @option params [required, String] :aws_account_id
|
2662
|
-
# The ID of the
|
2691
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
2692
|
+
# alias to delete.
|
2663
2693
|
#
|
2664
2694
|
# @option params [required, String] :theme_id
|
2665
2695
|
# The ID for the theme that the specified alias is for.
|
@@ -2701,7 +2731,7 @@ module Aws::QuickSight
|
|
2701
2731
|
end
|
2702
2732
|
|
2703
2733
|
# Deletes the Amazon QuickSight user that is associated with the
|
2704
|
-
# identity of the
|
2734
|
+
# identity of the Identity and Access Management (IAM) user or role
|
2705
2735
|
# that's making the call. The IAM user isn't deleted as a result of
|
2706
2736
|
# this call.
|
2707
2737
|
#
|
@@ -2709,8 +2739,9 @@ module Aws::QuickSight
|
|
2709
2739
|
# The name of the user that you want to delete.
|
2710
2740
|
#
|
2711
2741
|
# @option params [required, String] :aws_account_id
|
2712
|
-
# The ID for the
|
2713
|
-
#
|
2742
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
2743
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2744
|
+
# contains your Amazon QuickSight account.
|
2714
2745
|
#
|
2715
2746
|
# @option params [required, String] :namespace
|
2716
2747
|
# The namespace. Currently, you should set this to `default`.
|
@@ -2748,8 +2779,9 @@ module Aws::QuickSight
|
|
2748
2779
|
# The principal ID of the user.
|
2749
2780
|
#
|
2750
2781
|
# @option params [required, String] :aws_account_id
|
2751
|
-
# The ID for the
|
2752
|
-
#
|
2782
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
2783
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
2784
|
+
# contains your Amazon QuickSight account.
|
2753
2785
|
#
|
2754
2786
|
# @option params [required, String] :namespace
|
2755
2787
|
# The namespace. Currently, you should set this to `default`.
|
@@ -2781,53 +2813,59 @@ module Aws::QuickSight
|
|
2781
2813
|
req.send_request(options)
|
2782
2814
|
end
|
2783
2815
|
|
2784
|
-
# Describes the customizations associated with the provided
|
2785
|
-
# and Amazon QuickSight namespace in an
|
2786
|
-
#
|
2787
|
-
# operation with the
|
2816
|
+
# Describes the customizations associated with the provided Amazon Web
|
2817
|
+
# Services account; and Amazon QuickSight namespace in an Amazon Web
|
2818
|
+
# Services Region;. The QuickSight console evaluates which
|
2819
|
+
# customizations to apply by running this API operation with the
|
2820
|
+
# `Resolved` flag included.
|
2788
2821
|
#
|
2789
2822
|
# To determine what customizations display when you run this command, it
|
2790
2823
|
# can help to visualize the relationship of the entities involved.
|
2791
2824
|
#
|
2792
|
-
# * `
|
2793
|
-
#
|
2794
|
-
#
|
2795
|
-
#
|
2796
|
-
#
|
2797
|
-
#
|
2798
|
-
#
|
2799
|
-
#
|
2800
|
-
#
|
2801
|
-
#
|
2802
|
-
#
|
2803
|
-
#
|
2825
|
+
# * `Amazon Web Services account;` - The Amazon Web Services account;
|
2826
|
+
# exists at the top of the hierarchy. It has the potential to use all
|
2827
|
+
# of the Amazon Web Services Regions; and AWS Services. When you
|
2828
|
+
# subscribe to QuickSight, you choose one Amazon Web Services Region;
|
2829
|
+
# to use as your home Region. That's where your free SPICE capacity
|
2830
|
+
# is located. You can use QuickSight in any supported Amazon Web
|
2831
|
+
# Services Region;.
|
2832
|
+
#
|
2833
|
+
# * `Amazon Web Services Region;` - In each Amazon Web Services Region;
|
2834
|
+
# where you sign in to QuickSight at least once, QuickSight acts as a
|
2835
|
+
# separate instance of the same service. If you have a user directory,
|
2836
|
+
# it resides in us-east-1, which is the US East (N. Virginia).
|
2837
|
+
# Generally speaking, these users have access to QuickSight in any
|
2838
|
+
# Amazon Web Services Region;, unless they are constrained to a
|
2839
|
+
# namespace.
|
2804
2840
|
#
|
2805
|
-
# To run the command in a different
|
2806
|
-
# settings. If you're using the AWS CLI, you can
|
2807
|
-
# following options:
|
2841
|
+
# To run the command in a different Amazon Web Services Region;, you
|
2842
|
+
# change your Region settings. If you're using the AWS CLI, you can
|
2843
|
+
# use one of the following options:
|
2808
2844
|
#
|
2809
2845
|
# * Use [command line options][1].
|
2810
2846
|
#
|
2811
2847
|
# * Use [named profiles][2].
|
2812
2848
|
#
|
2813
|
-
# * Run `aws configure` to change your default
|
2814
|
-
# to key the same settings for your keys. For
|
2815
|
-
# [Configuring the AWS CLI][3].
|
2849
|
+
# * Run `aws configure` to change your default Amazon Web Services
|
2850
|
+
# Region;. Use Enter to key the same settings for your keys. For
|
2851
|
+
# more information, see [Configuring the AWS CLI][3].
|
2816
2852
|
#
|
2817
2853
|
# * `Namespace` - A QuickSight namespace is a partition that contains
|
2818
2854
|
# users and assets (data sources, datasets, dashboards, and so on). To
|
2819
2855
|
# access assets that are in a specific namespace, users and groups
|
2820
2856
|
# must also be part of the same namespace. People who share a
|
2821
2857
|
# namespace are completely isolated from users and assets in other
|
2822
|
-
# namespaces, even if they are in the same
|
2858
|
+
# namespaces, even if they are in the same Amazon Web Services
|
2859
|
+
# account; and Amazon Web Services Region;.
|
2823
2860
|
#
|
2824
|
-
# * `Applied customizations` - Within an
|
2825
|
-
# customizations can apply to an
|
2826
|
-
# Settings that you apply to a namespace
|
2827
|
-
#
|
2828
|
-
#
|
2829
|
-
#
|
2830
|
-
#
|
2861
|
+
# * `Applied customizations` - Within an Amazon Web Services Region;, a
|
2862
|
+
# set of QuickSight customizations can apply to an Amazon Web Services
|
2863
|
+
# account; or to a namespace. Settings that you apply to a namespace
|
2864
|
+
# override settings that you apply to an Amazon Web Services account;.
|
2865
|
+
# All settings are isolated to a single Amazon Web Services Region;.
|
2866
|
+
# To apply them in other Amazon Web Services Regions;, run the
|
2867
|
+
# `CreateAccountCustomization` command in each Amazon Web Services
|
2868
|
+
# Region; where you want to apply the same customizations.
|
2831
2869
|
#
|
2832
2870
|
#
|
2833
2871
|
#
|
@@ -2836,8 +2874,8 @@ module Aws::QuickSight
|
|
2836
2874
|
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
|
2837
2875
|
#
|
2838
2876
|
# @option params [required, String] :aws_account_id
|
2839
|
-
# The ID for the
|
2840
|
-
# customizations for.
|
2877
|
+
# The ID for the Amazon Web Services account; that you want to describe
|
2878
|
+
# QuickSight customizations for.
|
2841
2879
|
#
|
2842
2880
|
# @option params [String] :namespace
|
2843
2881
|
# The QuickSight namespace that you want to describe QuickSight
|
@@ -2887,11 +2925,11 @@ module Aws::QuickSight
|
|
2887
2925
|
end
|
2888
2926
|
|
2889
2927
|
# Describes the settings that were used when your QuickSight
|
2890
|
-
# subscription was first created in this
|
2928
|
+
# subscription was first created in this Amazon Web Services account;.
|
2891
2929
|
#
|
2892
2930
|
# @option params [required, String] :aws_account_id
|
2893
|
-
# The ID for the
|
2894
|
-
# list.
|
2931
|
+
# The ID for the Amazon Web Services account; that contains the settings
|
2932
|
+
# that you want to list.
|
2895
2933
|
#
|
2896
2934
|
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2897
2935
|
#
|
@@ -2926,8 +2964,9 @@ module Aws::QuickSight
|
|
2926
2964
|
# Provides a summary of the metadata for an analysis.
|
2927
2965
|
#
|
2928
2966
|
# @option params [required, String] :aws_account_id
|
2929
|
-
# The ID of the
|
2930
|
-
# using the
|
2967
|
+
# The ID of the Amazon Web Services account; that contains the analysis.
|
2968
|
+
# You must be using the Amazon Web Services account; that the analysis
|
2969
|
+
# is in.
|
2931
2970
|
#
|
2932
2971
|
# @option params [required, String] :analysis_id
|
2933
2972
|
# The ID of the analysis that you're describing. The ID is part of the
|
@@ -2978,9 +3017,9 @@ module Aws::QuickSight
|
|
2978
3017
|
# Provides the read and write permissions for an analysis.
|
2979
3018
|
#
|
2980
3019
|
# @option params [required, String] :aws_account_id
|
2981
|
-
# The ID of the
|
2982
|
-
# you're describing. You must be using the
|
2983
|
-
# analysis is in.
|
3020
|
+
# The ID of the Amazon Web Services account; that contains the analysis
|
3021
|
+
# whose permissions you're describing. You must be using the Amazon Web
|
3022
|
+
# Services account; that the analysis is in.
|
2984
3023
|
#
|
2985
3024
|
# @option params [required, String] :analysis_id
|
2986
3025
|
# The ID of the analysis whose permissions you're describing. The ID is
|
@@ -3024,8 +3063,8 @@ module Aws::QuickSight
|
|
3024
3063
|
# Provides a summary for a dashboard.
|
3025
3064
|
#
|
3026
3065
|
# @option params [required, String] :aws_account_id
|
3027
|
-
# The ID of the
|
3028
|
-
# describing.
|
3066
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
3067
|
+
# that you're describing.
|
3029
3068
|
#
|
3030
3069
|
# @option params [required, String] :dashboard_id
|
3031
3070
|
# The ID for the dashboard.
|
@@ -3090,8 +3129,8 @@ module Aws::QuickSight
|
|
3090
3129
|
# Describes read and write permissions for a dashboard.
|
3091
3130
|
#
|
3092
3131
|
# @option params [required, String] :aws_account_id
|
3093
|
-
# The ID of the
|
3094
|
-
# describing permissions for.
|
3132
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
3133
|
+
# that you're describing permissions for.
|
3095
3134
|
#
|
3096
3135
|
# @option params [required, String] :dashboard_id
|
3097
3136
|
# The ID for the dashboard, also added to the IAM policy.
|
@@ -3134,11 +3173,11 @@ module Aws::QuickSight
|
|
3134
3173
|
# Describes a dataset.
|
3135
3174
|
#
|
3136
3175
|
# @option params [required, String] :aws_account_id
|
3137
|
-
# The
|
3176
|
+
# The Amazon Web Services account; ID.
|
3138
3177
|
#
|
3139
3178
|
# @option params [required, String] :data_set_id
|
3140
3179
|
# The ID for the dataset that you want to create. This ID is unique per
|
3141
|
-
#
|
3180
|
+
# Amazon Web Services Region; for each Amazon Web Services account;.
|
3142
3181
|
#
|
3143
3182
|
# @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3144
3183
|
#
|
@@ -3228,6 +3267,13 @@ module Aws::QuickSight
|
|
3228
3267
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
3229
3268
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
3230
3269
|
# resp.data_set.row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
|
3270
|
+
# resp.data_set.row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
|
3271
|
+
# resp.data_set.row_level_permission_tag_configuration.status #=> String, one of "ENABLED", "DISABLED"
|
3272
|
+
# resp.data_set.row_level_permission_tag_configuration.tag_rules #=> Array
|
3273
|
+
# resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_key #=> String
|
3274
|
+
# resp.data_set.row_level_permission_tag_configuration.tag_rules[0].column_name #=> String
|
3275
|
+
# resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_multi_value_delimiter #=> String
|
3276
|
+
# resp.data_set.row_level_permission_tag_configuration.tag_rules[0].match_all_value #=> String
|
3231
3277
|
# resp.data_set.column_level_permission_rules #=> Array
|
3232
3278
|
# resp.data_set.column_level_permission_rules[0].principals #=> Array
|
3233
3279
|
# resp.data_set.column_level_permission_rules[0].principals[0] #=> String
|
@@ -3251,11 +3297,11 @@ module Aws::QuickSight
|
|
3251
3297
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
3252
3298
|
#
|
3253
3299
|
# @option params [required, String] :aws_account_id
|
3254
|
-
# The
|
3300
|
+
# The Amazon Web Services account; ID.
|
3255
3301
|
#
|
3256
3302
|
# @option params [required, String] :data_set_id
|
3257
3303
|
# The ID for the dataset that you want to create. This ID is unique per
|
3258
|
-
#
|
3304
|
+
# Amazon Web Services Region; for each Amazon Web Services account;.
|
3259
3305
|
#
|
3260
3306
|
# @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3261
3307
|
#
|
@@ -3295,11 +3341,11 @@ module Aws::QuickSight
|
|
3295
3341
|
# Describes a data source.
|
3296
3342
|
#
|
3297
3343
|
# @option params [required, String] :aws_account_id
|
3298
|
-
# The
|
3344
|
+
# The Amazon Web Services account; ID.
|
3299
3345
|
#
|
3300
3346
|
# @option params [required, String] :data_source_id
|
3301
|
-
# The ID of the data source. This ID is unique per
|
3302
|
-
#
|
3347
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
3348
|
+
# Region; for each Amazon Web Services account;.
|
3303
3349
|
#
|
3304
3350
|
# @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3305
3351
|
#
|
@@ -3437,11 +3483,11 @@ module Aws::QuickSight
|
|
3437
3483
|
# Describes the resource permissions for a data source.
|
3438
3484
|
#
|
3439
3485
|
# @option params [required, String] :aws_account_id
|
3440
|
-
# The
|
3486
|
+
# The Amazon Web Services account; ID.
|
3441
3487
|
#
|
3442
3488
|
# @option params [required, String] :data_source_id
|
3443
|
-
# The ID of the data source. This ID is unique per
|
3444
|
-
#
|
3489
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
3490
|
+
# Region; for each Amazon Web Services account;.
|
3445
3491
|
#
|
3446
3492
|
# @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3447
3493
|
#
|
@@ -3616,9 +3662,9 @@ module Aws::QuickSight
|
|
3616
3662
|
# The name of the group that you want to describe.
|
3617
3663
|
#
|
3618
3664
|
# @option params [required, String] :aws_account_id
|
3619
|
-
# The ID for the
|
3620
|
-
# the ID for the
|
3621
|
-
# account.
|
3665
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
3666
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
3667
|
+
# contains your Amazon QuickSight account.
|
3622
3668
|
#
|
3623
3669
|
# @option params [required, String] :namespace
|
3624
3670
|
# The namespace. Currently, you should set this to `default`.
|
@@ -3659,8 +3705,8 @@ module Aws::QuickSight
|
|
3659
3705
|
# assignment name.
|
3660
3706
|
#
|
3661
3707
|
# @option params [required, String] :aws_account_id
|
3662
|
-
# The ID of the
|
3663
|
-
# to describe.
|
3708
|
+
# The ID of the Amazon Web Services account; that contains the
|
3709
|
+
# assignment that you want to describe.
|
3664
3710
|
#
|
3665
3711
|
# @option params [required, String] :assignment_name
|
3666
3712
|
# The name of the assignment, also called a rule.
|
@@ -3707,7 +3753,7 @@ module Aws::QuickSight
|
|
3707
3753
|
# Describes a SPICE ingestion.
|
3708
3754
|
#
|
3709
3755
|
# @option params [required, String] :aws_account_id
|
3710
|
-
# The
|
3756
|
+
# The Amazon Web Services account; ID.
|
3711
3757
|
#
|
3712
3758
|
# @option params [required, String] :data_set_id
|
3713
3759
|
# The ID of the dataset used in the ingestion.
|
@@ -3760,8 +3806,8 @@ module Aws::QuickSight
|
|
3760
3806
|
# Describes the current namespace.
|
3761
3807
|
#
|
3762
3808
|
# @option params [required, String] :aws_account_id
|
3763
|
-
# The ID for the
|
3764
|
-
# you want to describe.
|
3809
|
+
# The ID for the Amazon Web Services account; that contains the
|
3810
|
+
# QuickSight namespace that you want to describe.
|
3765
3811
|
#
|
3766
3812
|
# @option params [required, String] :namespace
|
3767
3813
|
# The namespace that you want to describe.
|
@@ -3803,8 +3849,8 @@ module Aws::QuickSight
|
|
3803
3849
|
# Describes a template's metadata.
|
3804
3850
|
#
|
3805
3851
|
# @option params [required, String] :aws_account_id
|
3806
|
-
# The ID of the
|
3807
|
-
# describing.
|
3852
|
+
# The ID of the Amazon Web Services account; that contains the template
|
3853
|
+
# that you're describing.
|
3808
3854
|
#
|
3809
3855
|
# @option params [required, String] :template_id
|
3810
3856
|
# The ID for the template.
|
@@ -3880,8 +3926,8 @@ module Aws::QuickSight
|
|
3880
3926
|
# Describes the template alias for a template.
|
3881
3927
|
#
|
3882
3928
|
# @option params [required, String] :aws_account_id
|
3883
|
-
# The ID of the
|
3884
|
-
# you're describing.
|
3929
|
+
# The ID of the Amazon Web Services account; that contains the template
|
3930
|
+
# alias that you're describing.
|
3885
3931
|
#
|
3886
3932
|
# @option params [required, String] :template_id
|
3887
3933
|
# The ID for the template.
|
@@ -3927,8 +3973,8 @@ module Aws::QuickSight
|
|
3927
3973
|
# Describes read and write permissions on a template.
|
3928
3974
|
#
|
3929
3975
|
# @option params [required, String] :aws_account_id
|
3930
|
-
# The ID of the
|
3931
|
-
# describing.
|
3976
|
+
# The ID of the Amazon Web Services account; that contains the template
|
3977
|
+
# that you're describing.
|
3932
3978
|
#
|
3933
3979
|
# @option params [required, String] :template_id
|
3934
3980
|
# The ID for the template.
|
@@ -3971,8 +4017,8 @@ module Aws::QuickSight
|
|
3971
4017
|
# Describes a theme.
|
3972
4018
|
#
|
3973
4019
|
# @option params [required, String] :aws_account_id
|
3974
|
-
# The ID of the
|
3975
|
-
# describing.
|
4020
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
4021
|
+
# that you're describing.
|
3976
4022
|
#
|
3977
4023
|
# @option params [required, String] :theme_id
|
3978
4024
|
# The ID for the theme.
|
@@ -4060,8 +4106,8 @@ module Aws::QuickSight
|
|
4060
4106
|
# Describes the alias for a theme.
|
4061
4107
|
#
|
4062
4108
|
# @option params [required, String] :aws_account_id
|
4063
|
-
# The ID of the
|
4064
|
-
# describing.
|
4109
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
4110
|
+
# alias that you're describing.
|
4065
4111
|
#
|
4066
4112
|
# @option params [required, String] :theme_id
|
4067
4113
|
# The ID for the theme.
|
@@ -4103,8 +4149,8 @@ module Aws::QuickSight
|
|
4103
4149
|
# Describes the read and write permissions for a theme.
|
4104
4150
|
#
|
4105
4151
|
# @option params [required, String] :aws_account_id
|
4106
|
-
# The ID of the
|
4107
|
-
# describing.
|
4152
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
4153
|
+
# that you're describing.
|
4108
4154
|
#
|
4109
4155
|
# @option params [required, String] :theme_id
|
4110
4156
|
# The ID for the theme that you want to describe permissions for.
|
@@ -4150,8 +4196,9 @@ module Aws::QuickSight
|
|
4150
4196
|
# The name of the user that you want to describe.
|
4151
4197
|
#
|
4152
4198
|
# @option params [required, String] :aws_account_id
|
4153
|
-
# The ID for the
|
4154
|
-
#
|
4199
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
4200
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
4201
|
+
# contains your Amazon QuickSight account.
|
4155
4202
|
#
|
4156
4203
|
# @option params [required, String] :namespace
|
4157
4204
|
# The namespace. Currently, you should set this to `default`.
|
@@ -4195,6 +4242,203 @@ module Aws::QuickSight
|
|
4195
4242
|
req.send_request(options)
|
4196
4243
|
end
|
4197
4244
|
|
4245
|
+
# Generates an embed URL that you can use to embed an Amazon QuickSight
|
4246
|
+
# dashboard in your website, without having to register any reader
|
4247
|
+
# users. Before you use this action, make sure that you have configured
|
4248
|
+
# the dashboards and permissions.
|
4249
|
+
#
|
4250
|
+
# The following rules apply to the generated URL:
|
4251
|
+
#
|
4252
|
+
# * It contains a temporary bearer token. It is valid for 5 minutes
|
4253
|
+
# after it is generated. Once redeemed within this period, it cannot
|
4254
|
+
# be re-used again.
|
4255
|
+
#
|
4256
|
+
# * The URL validity period should not be confused with the actual
|
4257
|
+
# session lifetime that can be customized using the `
|
4258
|
+
# SessionLifetimeInMinutes ` parameter.
|
4259
|
+
#
|
4260
|
+
# The resulting user session is valid for 15 minutes (default) to 10
|
4261
|
+
# hours (maximum).
|
4262
|
+
#
|
4263
|
+
# * You are charged only when the URL is used or there is interaction
|
4264
|
+
# with Amazon QuickSight.
|
4265
|
+
#
|
4266
|
+
# For more information, see [Embedded Analytics][1] in the *Amazon
|
4267
|
+
# QuickSight User Guide*.
|
4268
|
+
#
|
4269
|
+
# For more information about the high-level steps for embedding and for
|
4270
|
+
# an interactive demo of the ways you can customize embedding, visit the
|
4271
|
+
# [Amazon QuickSight Developer Portal][2].
|
4272
|
+
#
|
4273
|
+
#
|
4274
|
+
#
|
4275
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
4276
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
4277
|
+
#
|
4278
|
+
# @option params [required, String] :aws_account_id
|
4279
|
+
# The ID for the Amazon Web Services account that contains the dashboard
|
4280
|
+
# that you're embedding.
|
4281
|
+
#
|
4282
|
+
# @option params [Integer] :session_lifetime_in_minutes
|
4283
|
+
# How many minutes the session is valid. The session lifetime must be in
|
4284
|
+
# \[15-600\] minutes range.
|
4285
|
+
#
|
4286
|
+
# @option params [required, String] :namespace
|
4287
|
+
# The Amazon QuickSight namespace that the anonymous user virtually
|
4288
|
+
# belongs to. If you are not using an Amazon QuickSight custom
|
4289
|
+
# namespace, set this to `default`.
|
4290
|
+
#
|
4291
|
+
# @option params [Array<Types::SessionTag>] :session_tags
|
4292
|
+
# The session tags used for row-level security. Before you use this
|
4293
|
+
# parameter, make sure that you have configured the relevant datasets
|
4294
|
+
# using the `DataSet$RowLevelPermissionTagConfiguration` parameter so
|
4295
|
+
# that session tags can be used to provide row-level security.
|
4296
|
+
#
|
4297
|
+
# These are not the tags used for the Amazon Web Services resource
|
4298
|
+
# tagging feature. For more information, see [Using Row-Level Security
|
4299
|
+
# (RLS) with Tags][1].
|
4300
|
+
#
|
4301
|
+
#
|
4302
|
+
#
|
4303
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
4304
|
+
#
|
4305
|
+
# @option params [required, Array<String>] :authorized_resource_arns
|
4306
|
+
# The Amazon Resource Names for the Amazon QuickSight resources that the
|
4307
|
+
# user is authorized to access during the lifetime of the session. If
|
4308
|
+
# you choose `Dashboard` embedding experience, pass the list of
|
4309
|
+
# dashboard ARNs in the account that you want the user to be able to
|
4310
|
+
# view.
|
4311
|
+
#
|
4312
|
+
# @option params [required, Types::AnonymousUserEmbeddingExperienceConfiguration] :experience_configuration
|
4313
|
+
# The configuration of the experience you are embedding.
|
4314
|
+
#
|
4315
|
+
# @return [Types::GenerateEmbedUrlForAnonymousUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4316
|
+
#
|
4317
|
+
# * {Types::GenerateEmbedUrlForAnonymousUserResponse#embed_url #embed_url} => String
|
4318
|
+
# * {Types::GenerateEmbedUrlForAnonymousUserResponse#status #status} => Integer
|
4319
|
+
# * {Types::GenerateEmbedUrlForAnonymousUserResponse#request_id #request_id} => String
|
4320
|
+
#
|
4321
|
+
# @example Request syntax with placeholder values
|
4322
|
+
#
|
4323
|
+
# resp = client.generate_embed_url_for_anonymous_user({
|
4324
|
+
# aws_account_id: "AwsAccountId", # required
|
4325
|
+
# session_lifetime_in_minutes: 1,
|
4326
|
+
# namespace: "Namespace", # required
|
4327
|
+
# session_tags: [
|
4328
|
+
# {
|
4329
|
+
# key: "SessionTagKey", # required
|
4330
|
+
# value: "SessionTagValue", # required
|
4331
|
+
# },
|
4332
|
+
# ],
|
4333
|
+
# authorized_resource_arns: ["Arn"], # required
|
4334
|
+
# experience_configuration: { # required
|
4335
|
+
# dashboard: {
|
4336
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
4337
|
+
# },
|
4338
|
+
# },
|
4339
|
+
# })
|
4340
|
+
#
|
4341
|
+
# @example Response structure
|
4342
|
+
#
|
4343
|
+
# resp.embed_url #=> String
|
4344
|
+
# resp.status #=> Integer
|
4345
|
+
# resp.request_id #=> String
|
4346
|
+
#
|
4347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUser AWS API Documentation
|
4348
|
+
#
|
4349
|
+
# @overload generate_embed_url_for_anonymous_user(params = {})
|
4350
|
+
# @param [Hash] params ({})
|
4351
|
+
def generate_embed_url_for_anonymous_user(params = {}, options = {})
|
4352
|
+
req = build_request(:generate_embed_url_for_anonymous_user, params)
|
4353
|
+
req.send_request(options)
|
4354
|
+
end
|
4355
|
+
|
4356
|
+
# Generates an embed URL that you can use to embed an Amazon QuickSight
|
4357
|
+
# experience in your website. This action can be used for any type of
|
4358
|
+
# user registered in an Amazon QuickSight account. Before you use this
|
4359
|
+
# action, make sure that you have configured the relevant Amazon
|
4360
|
+
# QuickSight resource and permissions.
|
4361
|
+
#
|
4362
|
+
# The following rules apply to the generated URL:
|
4363
|
+
#
|
4364
|
+
# * It contains a temporary bearer token. It is valid for 5 minutes
|
4365
|
+
# after it is generated. Once redeemed within this period, it cannot
|
4366
|
+
# be re-used again.
|
4367
|
+
#
|
4368
|
+
# * The URL validity period should not be confused with the actual
|
4369
|
+
# session lifetime that can be customized using the `
|
4370
|
+
# SessionLifetimeInMinutes ` parameter.
|
4371
|
+
#
|
4372
|
+
# The resulting user session is valid for 15 minutes (default) to 10
|
4373
|
+
# hours (maximum).
|
4374
|
+
#
|
4375
|
+
# * You are charged only when the URL is used or there is interaction
|
4376
|
+
# with Amazon QuickSight.
|
4377
|
+
#
|
4378
|
+
# For more information, see [Embedded Analytics][1] in the *Amazon
|
4379
|
+
# QuickSight User Guide*.
|
4380
|
+
#
|
4381
|
+
# For more information about the high-level steps for embedding and for
|
4382
|
+
# an interactive demo of the ways you can customize embedding, visit the
|
4383
|
+
# [Amazon QuickSight Developer Portal][2].
|
4384
|
+
#
|
4385
|
+
#
|
4386
|
+
#
|
4387
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
4388
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
4389
|
+
#
|
4390
|
+
# @option params [required, String] :aws_account_id
|
4391
|
+
# The ID for the Amazon Web Services account that contains the dashboard
|
4392
|
+
# that you're embedding.
|
4393
|
+
#
|
4394
|
+
# @option params [Integer] :session_lifetime_in_minutes
|
4395
|
+
# How many minutes the session is valid. The session lifetime must be in
|
4396
|
+
# \[15-600\] minutes range.
|
4397
|
+
#
|
4398
|
+
# @option params [required, String] :user_arn
|
4399
|
+
# The Amazon Resource Name for the registered user.
|
4400
|
+
#
|
4401
|
+
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
4402
|
+
# The experience you are embedding. For registered users, you can embed
|
4403
|
+
# Amazon QuickSight dashboards or the entire Amazon QuickSight console.
|
4404
|
+
#
|
4405
|
+
# @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4406
|
+
#
|
4407
|
+
# * {Types::GenerateEmbedUrlForRegisteredUserResponse#embed_url #embed_url} => String
|
4408
|
+
# * {Types::GenerateEmbedUrlForRegisteredUserResponse#status #status} => Integer
|
4409
|
+
# * {Types::GenerateEmbedUrlForRegisteredUserResponse#request_id #request_id} => String
|
4410
|
+
#
|
4411
|
+
# @example Request syntax with placeholder values
|
4412
|
+
#
|
4413
|
+
# resp = client.generate_embed_url_for_registered_user({
|
4414
|
+
# aws_account_id: "AwsAccountId", # required
|
4415
|
+
# session_lifetime_in_minutes: 1,
|
4416
|
+
# user_arn: "Arn", # required
|
4417
|
+
# experience_configuration: { # required
|
4418
|
+
# dashboard: {
|
4419
|
+
# initial_dashboard_id: "RestrictiveResourceId", # required
|
4420
|
+
# },
|
4421
|
+
# quick_sight_console: {
|
4422
|
+
# initial_path: "EntryPath",
|
4423
|
+
# },
|
4424
|
+
# },
|
4425
|
+
# })
|
4426
|
+
#
|
4427
|
+
# @example Response structure
|
4428
|
+
#
|
4429
|
+
# resp.embed_url #=> String
|
4430
|
+
# resp.status #=> Integer
|
4431
|
+
# resp.request_id #=> String
|
4432
|
+
#
|
4433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser AWS API Documentation
|
4434
|
+
#
|
4435
|
+
# @overload generate_embed_url_for_registered_user(params = {})
|
4436
|
+
# @param [Hash] params ({})
|
4437
|
+
def generate_embed_url_for_registered_user(params = {}, options = {})
|
4438
|
+
req = build_request(:generate_embed_url_for_registered_user, params)
|
4439
|
+
req.send_request(options)
|
4440
|
+
end
|
4441
|
+
|
4198
4442
|
# Generates a session URL and authorization code that you can use to
|
4199
4443
|
# embed an Amazon QuickSight read-only dashboard in your web server
|
4200
4444
|
# code. Before you use this command, make sure that you have configured
|
@@ -4212,19 +4456,24 @@ module Aws::QuickSight
|
|
4212
4456
|
#
|
4213
4457
|
# * The resulting user session is valid for 10 hours.
|
4214
4458
|
#
|
4215
|
-
# For more information, see [
|
4216
|
-
# QuickSight User Guide*.
|
4459
|
+
# For more information, see [Embedding Analytics Using
|
4460
|
+
# GetDashboardEmbedUrl][1] in the *Amazon QuickSight User Guide*.
|
4217
4461
|
#
|
4462
|
+
# For more information about the high-level steps for embedding and for
|
4463
|
+
# an interactive demo of the ways you can customize embedding, visit the
|
4464
|
+
# [Amazon QuickSight Developer Portal][2].
|
4218
4465
|
#
|
4219
4466
|
#
|
4220
|
-
#
|
4467
|
+
#
|
4468
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html
|
4469
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
4221
4470
|
#
|
4222
4471
|
# @option params [required, String] :aws_account_id
|
4223
|
-
# The ID for the
|
4224
|
-
# embedding.
|
4472
|
+
# The ID for the Amazon Web Services account; that contains the
|
4473
|
+
# dashboard that you're embedding.
|
4225
4474
|
#
|
4226
4475
|
# @option params [required, String] :dashboard_id
|
4227
|
-
# The ID for the dashboard, also added to the
|
4476
|
+
# The ID for the dashboard, also added to the Identity and Access
|
4228
4477
|
# Management (IAM) policy.
|
4229
4478
|
#
|
4230
4479
|
# @option params [required, String] :identity_type
|
@@ -4270,9 +4519,9 @@ module Aws::QuickSight
|
|
4270
4519
|
# role-based sessions.
|
4271
4520
|
#
|
4272
4521
|
# @option params [String] :namespace
|
4273
|
-
# The QuickSight namespace that
|
4274
|
-
#
|
4275
|
-
#
|
4522
|
+
# The Amazon QuickSight namespace that the user virtually belongs to. If
|
4523
|
+
# you are not using an Amazon QuickSight custom namespace, set this to
|
4524
|
+
# `default`.
|
4276
4525
|
#
|
4277
4526
|
# @option params [Array<String>] :additional_dashboard_ids
|
4278
4527
|
# A list of one or more dashboard IDs that you want to add to a session
|
@@ -4331,18 +4580,19 @@ module Aws::QuickSight
|
|
4331
4580
|
# permission profile attached. For more information, see the following
|
4332
4581
|
# sections in the *Amazon QuickSight User Guide*\:
|
4333
4582
|
#
|
4334
|
-
# * [Embedding the Amazon QuickSight Console
|
4583
|
+
# * [Embedding the Amazon QuickSight Console Using
|
4584
|
+
# GetSessionEmbedUrl][1]
|
4335
4585
|
#
|
4336
4586
|
# * [Customizing Access to the Amazon QuickSight Console][2]
|
4337
4587
|
#
|
4338
4588
|
#
|
4339
4589
|
#
|
4340
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/
|
4590
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users-get.html
|
4341
4591
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
4342
4592
|
#
|
4343
4593
|
# @option params [required, String] :aws_account_id
|
4344
|
-
# The ID for the
|
4345
|
-
# subscription.
|
4594
|
+
# The ID for the Amazon Web Services account; associated with your
|
4595
|
+
# QuickSight subscription.
|
4346
4596
|
#
|
4347
4597
|
# @option params [String] :entry_point
|
4348
4598
|
# The URL you use to access the embedded session. The entry point URL is
|
@@ -4376,7 +4626,7 @@ module Aws::QuickSight
|
|
4376
4626
|
#
|
4377
4627
|
# 2. Invited nonfederated users
|
4378
4628
|
#
|
4379
|
-
# 3.
|
4629
|
+
# 3. Identity and Access Management (IAM) users and IAM role-based
|
4380
4630
|
# sessions authenticated through Federated Single Sign-On using
|
4381
4631
|
# SAML, OpenID Connect, or IAM federation
|
4382
4632
|
#
|
@@ -4413,11 +4663,11 @@ module Aws::QuickSight
|
|
4413
4663
|
req.send_request(options)
|
4414
4664
|
end
|
4415
4665
|
|
4416
|
-
# Lists Amazon QuickSight analyses that exist in the specified
|
4417
|
-
# account
|
4666
|
+
# Lists Amazon QuickSight analyses that exist in the specified Amazon
|
4667
|
+
# Web Services account;.
|
4418
4668
|
#
|
4419
4669
|
# @option params [required, String] :aws_account_id
|
4420
|
-
# The ID of the
|
4670
|
+
# The ID of the Amazon Web Services account; that contains the analyses.
|
4421
4671
|
#
|
4422
4672
|
# @option params [String] :next_token
|
4423
4673
|
# A pagination token that can be used in a subsequent request.
|
@@ -4468,8 +4718,8 @@ module Aws::QuickSight
|
|
4468
4718
|
# subscription.
|
4469
4719
|
#
|
4470
4720
|
# @option params [required, String] :aws_account_id
|
4471
|
-
# The ID of the
|
4472
|
-
# listing versions for.
|
4721
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
4722
|
+
# that you're listing versions for.
|
4473
4723
|
#
|
4474
4724
|
# @option params [required, String] :dashboard_id
|
4475
4725
|
# The ID for the dashboard.
|
@@ -4521,11 +4771,11 @@ module Aws::QuickSight
|
|
4521
4771
|
req.send_request(options)
|
4522
4772
|
end
|
4523
4773
|
|
4524
|
-
# Lists dashboards in an
|
4774
|
+
# Lists dashboards in an Amazon Web Services account;.
|
4525
4775
|
#
|
4526
4776
|
# @option params [required, String] :aws_account_id
|
4527
|
-
# The ID of the
|
4528
|
-
# listing.
|
4777
|
+
# The ID of the Amazon Web Services account; that contains the
|
4778
|
+
# dashboards that you're listing.
|
4529
4779
|
#
|
4530
4780
|
# @option params [String] :next_token
|
4531
4781
|
# The token for the next set of results, or null if there are no more
|
@@ -4574,14 +4824,14 @@ module Aws::QuickSight
|
|
4574
4824
|
req.send_request(options)
|
4575
4825
|
end
|
4576
4826
|
|
4577
|
-
# Lists all of the datasets belonging to the current
|
4578
|
-
#
|
4827
|
+
# Lists all of the datasets belonging to the current Amazon Web Services
|
4828
|
+
# account; in an Amazon Web Services Region;.
|
4579
4829
|
#
|
4580
4830
|
# The permissions resource is
|
4581
4831
|
# `arn:aws:quicksight:region:aws-account-id:dataset/*`.
|
4582
4832
|
#
|
4583
4833
|
# @option params [required, String] :aws_account_id
|
4584
|
-
# The
|
4834
|
+
# The Amazon Web Services account; ID.
|
4585
4835
|
#
|
4586
4836
|
# @option params [String] :next_token
|
4587
4837
|
# The token for the next set of results, or null if there are no more
|
@@ -4620,6 +4870,8 @@ module Aws::QuickSight
|
|
4620
4870
|
# resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
|
4621
4871
|
# resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
4622
4872
|
# resp.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
|
4873
|
+
# resp.data_set_summaries[0].row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
|
4874
|
+
# resp.data_set_summaries[0].row_level_permission_tag_configuration_applied #=> Boolean
|
4623
4875
|
# resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
|
4624
4876
|
# resp.next_token #=> String
|
4625
4877
|
# resp.request_id #=> String
|
@@ -4634,11 +4886,11 @@ module Aws::QuickSight
|
|
4634
4886
|
req.send_request(options)
|
4635
4887
|
end
|
4636
4888
|
|
4637
|
-
# Lists data sources in current
|
4638
|
-
# account
|
4889
|
+
# Lists data sources in current Amazon Web Services Region; that belong
|
4890
|
+
# to this Amazon Web Services account;.
|
4639
4891
|
#
|
4640
4892
|
# @option params [required, String] :aws_account_id
|
4641
|
-
# The
|
4893
|
+
# The Amazon Web Services account; ID.
|
4642
4894
|
#
|
4643
4895
|
# @option params [String] :next_token
|
4644
4896
|
# The token for the next set of results, or null if there are no more
|
@@ -4896,9 +5148,9 @@ module Aws::QuickSight
|
|
4896
5148
|
# The maximum number of results to return from this request.
|
4897
5149
|
#
|
4898
5150
|
# @option params [required, String] :aws_account_id
|
4899
|
-
# The ID for the
|
4900
|
-
# the ID for the
|
4901
|
-
# account.
|
5151
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
5152
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
5153
|
+
# contains your Amazon QuickSight account.
|
4902
5154
|
#
|
4903
5155
|
# @option params [required, String] :namespace
|
4904
5156
|
# The namespace. Currently, you should set this to `default`.
|
@@ -4941,9 +5193,9 @@ module Aws::QuickSight
|
|
4941
5193
|
# Lists all user groups in Amazon QuickSight.
|
4942
5194
|
#
|
4943
5195
|
# @option params [required, String] :aws_account_id
|
4944
|
-
# The ID for the
|
4945
|
-
# the ID for the
|
4946
|
-
# account.
|
5196
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
5197
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
5198
|
+
# contains your Amazon QuickSight account.
|
4947
5199
|
#
|
4948
5200
|
# @option params [String] :next_token
|
4949
5201
|
# A pagination token that can be used in a subsequent request.
|
@@ -4993,7 +5245,8 @@ module Aws::QuickSight
|
|
4993
5245
|
# Lists IAM policy assignments in the current Amazon QuickSight account.
|
4994
5246
|
#
|
4995
5247
|
# @option params [required, String] :aws_account_id
|
4996
|
-
# The ID of the
|
5248
|
+
# The ID of the Amazon Web Services account; that contains these IAM
|
5249
|
+
# policy assignments.
|
4997
5250
|
#
|
4998
5251
|
# @option params [String] :assignment_status
|
4999
5252
|
# The status of the assignments.
|
@@ -5048,7 +5301,8 @@ module Aws::QuickSight
|
|
5048
5301
|
# group or groups that the user belongs to.
|
5049
5302
|
#
|
5050
5303
|
# @option params [required, String] :aws_account_id
|
5051
|
-
# The ID of the
|
5304
|
+
# The ID of the Amazon Web Services account; that contains the
|
5305
|
+
# assignments.
|
5052
5306
|
#
|
5053
5307
|
# @option params [required, String] :user_name
|
5054
5308
|
# The name of the user.
|
@@ -5108,7 +5362,7 @@ module Aws::QuickSight
|
|
5108
5362
|
# results.
|
5109
5363
|
#
|
5110
5364
|
# @option params [required, String] :aws_account_id
|
5111
|
-
# The
|
5365
|
+
# The Amazon Web Services account; ID.
|
5112
5366
|
#
|
5113
5367
|
# @option params [Integer] :max_results
|
5114
5368
|
# The maximum number of results to be returned per request.
|
@@ -5161,11 +5415,11 @@ module Aws::QuickSight
|
|
5161
5415
|
req.send_request(options)
|
5162
5416
|
end
|
5163
5417
|
|
5164
|
-
# Lists the namespaces for the specified
|
5418
|
+
# Lists the namespaces for the specified Amazon Web Services account;.
|
5165
5419
|
#
|
5166
5420
|
# @option params [required, String] :aws_account_id
|
5167
|
-
# The ID for the
|
5168
|
-
# that you want to list.
|
5421
|
+
# The ID for the Amazon Web Services account; that contains the
|
5422
|
+
# QuickSight namespaces that you want to list.
|
5169
5423
|
#
|
5170
5424
|
# @option params [String] :next_token
|
5171
5425
|
# A pagination token that can be used in a subsequent request.
|
@@ -5251,8 +5505,8 @@ module Aws::QuickSight
|
|
5251
5505
|
# Lists all the aliases of a template.
|
5252
5506
|
#
|
5253
5507
|
# @option params [required, String] :aws_account_id
|
5254
|
-
# The ID of the
|
5255
|
-
# you're listing.
|
5508
|
+
# The ID of the Amazon Web Services account; that contains the template
|
5509
|
+
# aliases that you're listing.
|
5256
5510
|
#
|
5257
5511
|
# @option params [required, String] :template_id
|
5258
5512
|
# The ID for the template.
|
@@ -5305,8 +5559,8 @@ module Aws::QuickSight
|
|
5305
5559
|
# QuickSight account.
|
5306
5560
|
#
|
5307
5561
|
# @option params [required, String] :aws_account_id
|
5308
|
-
# The ID of the
|
5309
|
-
# listing.
|
5562
|
+
# The ID of the Amazon Web Services account; that contains the templates
|
5563
|
+
# that you're listing.
|
5310
5564
|
#
|
5311
5565
|
# @option params [required, String] :template_id
|
5312
5566
|
# The ID for the template.
|
@@ -5360,8 +5614,8 @@ module Aws::QuickSight
|
|
5360
5614
|
# Lists all the templates in the current Amazon QuickSight account.
|
5361
5615
|
#
|
5362
5616
|
# @option params [required, String] :aws_account_id
|
5363
|
-
# The ID of the
|
5364
|
-
# listing.
|
5617
|
+
# The ID of the Amazon Web Services account; that contains the templates
|
5618
|
+
# that you're listing.
|
5365
5619
|
#
|
5366
5620
|
# @option params [String] :next_token
|
5367
5621
|
# The token for the next set of results, or null if there are no more
|
@@ -5412,8 +5666,8 @@ module Aws::QuickSight
|
|
5412
5666
|
# Lists all the aliases of a theme.
|
5413
5667
|
#
|
5414
5668
|
# @option params [required, String] :aws_account_id
|
5415
|
-
# The ID of the
|
5416
|
-
# listing.
|
5669
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
5670
|
+
# aliases that you're listing.
|
5417
5671
|
#
|
5418
5672
|
# @option params [required, String] :theme_id
|
5419
5673
|
# The ID for the theme.
|
@@ -5460,11 +5714,12 @@ module Aws::QuickSight
|
|
5460
5714
|
req.send_request(options)
|
5461
5715
|
end
|
5462
5716
|
|
5463
|
-
# Lists all the versions of the themes in the current
|
5717
|
+
# Lists all the versions of the themes in the current Amazon Web
|
5718
|
+
# Services account;.
|
5464
5719
|
#
|
5465
5720
|
# @option params [required, String] :aws_account_id
|
5466
|
-
# The ID of the
|
5467
|
-
# listing.
|
5721
|
+
# The ID of the Amazon Web Services account; that contains the themes
|
5722
|
+
# that you're listing.
|
5468
5723
|
#
|
5469
5724
|
# @option params [required, String] :theme_id
|
5470
5725
|
# The ID for the theme.
|
@@ -5515,11 +5770,11 @@ module Aws::QuickSight
|
|
5515
5770
|
req.send_request(options)
|
5516
5771
|
end
|
5517
5772
|
|
5518
|
-
# Lists all the themes in the current
|
5773
|
+
# Lists all the themes in the current Amazon Web Services account;.
|
5519
5774
|
#
|
5520
5775
|
# @option params [required, String] :aws_account_id
|
5521
|
-
# The ID of the
|
5522
|
-
# listing.
|
5776
|
+
# The ID of the Amazon Web Services account; that contains the themes
|
5777
|
+
# that you're listing.
|
5523
5778
|
#
|
5524
5779
|
# @option params [String] :next_token
|
5525
5780
|
# The token for the next set of results, or null if there are no more
|
@@ -5537,7 +5792,7 @@ module Aws::QuickSight
|
|
5537
5792
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
5538
5793
|
# QuickSight.
|
5539
5794
|
#
|
5540
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
5795
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by Amazon
|
5541
5796
|
# QuickSight.
|
5542
5797
|
#
|
5543
5798
|
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5588,8 +5843,9 @@ module Aws::QuickSight
|
|
5588
5843
|
# memberships for.
|
5589
5844
|
#
|
5590
5845
|
# @option params [required, String] :aws_account_id
|
5591
|
-
# The
|
5592
|
-
# the
|
5846
|
+
# The Amazon Web Services account; ID that the user is in. Currently,
|
5847
|
+
# you use the ID for the Amazon Web Services account; that contains your
|
5848
|
+
# Amazon QuickSight account.
|
5593
5849
|
#
|
5594
5850
|
# @option params [required, String] :namespace
|
5595
5851
|
# The namespace. Currently, you should set this to `default`.
|
@@ -5641,8 +5897,9 @@ module Aws::QuickSight
|
|
5641
5897
|
# account.
|
5642
5898
|
#
|
5643
5899
|
# @option params [required, String] :aws_account_id
|
5644
|
-
# The ID for the
|
5645
|
-
#
|
5900
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
5901
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
5902
|
+
# contains your Amazon QuickSight account.
|
5646
5903
|
#
|
5647
5904
|
# @option params [String] :next_token
|
5648
5905
|
# A pagination token that can be used in a subsequent request.
|
@@ -5746,8 +6003,9 @@ module Aws::QuickSight
|
|
5746
6003
|
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
5747
6004
|
#
|
5748
6005
|
# @option params [required, String] :aws_account_id
|
5749
|
-
# The ID for the
|
5750
|
-
#
|
6006
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
6007
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
6008
|
+
# contains your Amazon QuickSight account.
|
5751
6009
|
#
|
5752
6010
|
# @option params [required, String] :namespace
|
5753
6011
|
# The namespace. Currently, you should set this to `default`.
|
@@ -5785,8 +6043,7 @@ module Aws::QuickSight
|
|
5785
6043
|
# QuickSight (admin, author, reader).
|
5786
6044
|
#
|
5787
6045
|
# This feature is available only to QuickSight Enterprise edition
|
5788
|
-
# subscriptions
|
5789
|
-
# (SSO).
|
6046
|
+
# subscriptions.
|
5790
6047
|
#
|
5791
6048
|
# @option params [String] :external_login_federation_provider_type
|
5792
6049
|
# The type of supported external login provider that provides identity
|
@@ -5866,7 +6123,7 @@ module Aws::QuickSight
|
|
5866
6123
|
# Restores an analysis.
|
5867
6124
|
#
|
5868
6125
|
# @option params [required, String] :aws_account_id
|
5869
|
-
# The ID of the
|
6126
|
+
# The ID of the Amazon Web Services account; that contains the analysis.
|
5870
6127
|
#
|
5871
6128
|
# @option params [required, String] :analysis_id
|
5872
6129
|
# The ID of the analysis that you're restoring.
|
@@ -5903,9 +6160,14 @@ module Aws::QuickSight
|
|
5903
6160
|
|
5904
6161
|
# Searches for analyses that belong to the user specified in the filter.
|
5905
6162
|
#
|
6163
|
+
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
6164
|
+
# and may not reflect very recent updates and changes.
|
6165
|
+
#
|
6166
|
+
# </note>
|
6167
|
+
#
|
5906
6168
|
# @option params [required, String] :aws_account_id
|
5907
|
-
# The ID of the
|
5908
|
-
# searching for.
|
6169
|
+
# The ID of the Amazon Web Services account; that contains the analyses
|
6170
|
+
# that you're searching for.
|
5909
6171
|
#
|
5910
6172
|
# @option params [required, Array<Types::AnalysisSearchFilter>] :filters
|
5911
6173
|
# The structure for the search filters that you want to apply to your
|
@@ -5965,9 +6227,14 @@ module Aws::QuickSight
|
|
5965
6227
|
|
5966
6228
|
# Searches for dashboards that belong to a user.
|
5967
6229
|
#
|
6230
|
+
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
6231
|
+
# and may not reflect very recent updates and changes.
|
6232
|
+
#
|
6233
|
+
# </note>
|
6234
|
+
#
|
5968
6235
|
# @option params [required, String] :aws_account_id
|
5969
|
-
# The ID of the
|
5970
|
-
# you're searching for.
|
6236
|
+
# The ID of the Amazon Web Services account; that contains the user
|
6237
|
+
# whose dashboards you're searching for.
|
5971
6238
|
#
|
5972
6239
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
5973
6240
|
# The filters to apply to the search. Currently, you can search only by
|
@@ -6113,8 +6380,8 @@ module Aws::QuickSight
|
|
6113
6380
|
# restriction is because QuickSight costs are based on users and SPICE
|
6114
6381
|
# capacity, which aren't taggable resources.
|
6115
6382
|
#
|
6116
|
-
# * QuickSight doesn't currently support the Tag Editor for
|
6117
|
-
#
|
6383
|
+
# * QuickSight doesn't currently support the Tag Editor for Resource
|
6384
|
+
# Groups.
|
6118
6385
|
#
|
6119
6386
|
# @option params [required, String] :resource_arn
|
6120
6387
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
@@ -6189,25 +6456,27 @@ module Aws::QuickSight
|
|
6189
6456
|
req.send_request(options)
|
6190
6457
|
end
|
6191
6458
|
|
6192
|
-
# Updates Amazon QuickSight customizations the current
|
6193
|
-
# Currently, the only customization you can use is a
|
6459
|
+
# Updates Amazon QuickSight customizations the current Amazon Web
|
6460
|
+
# Services Region;. Currently, the only customization you can use is a
|
6461
|
+
# theme.
|
6194
6462
|
#
|
6195
|
-
# You can use customizations for your
|
6196
|
-
# namespace, for a QuickSight namespace instead.
|
6197
|
-
# apply to a namespace override customizations that
|
6198
|
-
# account
|
6199
|
-
# `DescribeAccountCustomization` API
|
6463
|
+
# You can use customizations for your Amazon Web Services account; or,
|
6464
|
+
# if you specify a namespace, for a QuickSight namespace instead.
|
6465
|
+
# Customizations that apply to a namespace override customizations that
|
6466
|
+
# apply to an Amazon Web Services account;. To find out which
|
6467
|
+
# customizations apply, use the `DescribeAccountCustomization` API
|
6468
|
+
# operation.
|
6200
6469
|
#
|
6201
6470
|
# @option params [required, String] :aws_account_id
|
6202
|
-
# The ID for the
|
6203
|
-
# customizations for.
|
6471
|
+
# The ID for the Amazon Web Services account; that you want to update
|
6472
|
+
# QuickSight customizations for.
|
6204
6473
|
#
|
6205
6474
|
# @option params [String] :namespace
|
6206
6475
|
# The namespace that you want to update QuickSight customizations for.
|
6207
6476
|
#
|
6208
6477
|
# @option params [required, Types::AccountCustomization] :account_customization
|
6209
|
-
# The QuickSight customizations you're updating in the current
|
6210
|
-
# Region
|
6478
|
+
# The QuickSight customizations you're updating in the current Amazon
|
6479
|
+
# Web Services Region;.
|
6211
6480
|
#
|
6212
6481
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6213
6482
|
#
|
@@ -6246,21 +6515,23 @@ module Aws::QuickSight
|
|
6246
6515
|
req.send_request(options)
|
6247
6516
|
end
|
6248
6517
|
|
6249
|
-
# Updates the Amazon QuickSight settings in your
|
6518
|
+
# Updates the Amazon QuickSight settings in your Amazon Web Services
|
6519
|
+
# account;.
|
6250
6520
|
#
|
6251
6521
|
# @option params [required, String] :aws_account_id
|
6252
|
-
# The ID for the
|
6253
|
-
# you want to list.
|
6522
|
+
# The ID for the Amazon Web Services account; that contains the
|
6523
|
+
# QuickSight settings that you want to list.
|
6254
6524
|
#
|
6255
6525
|
# @option params [required, String] :default_namespace
|
6256
|
-
# The default namespace for this
|
6257
|
-
# `default`.
|
6258
|
-
# register for the first time with QuickSight provide
|
6259
|
-
# becomes associated with the default namespace.
|
6526
|
+
# The default namespace for this Amazon Web Services account;.
|
6527
|
+
# Currently, the default is `default`. Identity and Access Management
|
6528
|
+
# (IAM) users that register for the first time with QuickSight provide
|
6529
|
+
# an email that becomes associated with the default namespace.
|
6260
6530
|
#
|
6261
6531
|
# @option params [String] :notification_email
|
6262
6532
|
# The email address that you want QuickSight to send notifications to
|
6263
|
-
# regarding your
|
6533
|
+
# regarding your Amazon Web Services account; or QuickSight
|
6534
|
+
# subscription.
|
6264
6535
|
#
|
6265
6536
|
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6266
6537
|
#
|
@@ -6292,8 +6563,8 @@ module Aws::QuickSight
|
|
6292
6563
|
# Updates an analysis in Amazon QuickSight
|
6293
6564
|
#
|
6294
6565
|
# @option params [required, String] :aws_account_id
|
6295
|
-
# The ID of the
|
6296
|
-
# updating.
|
6566
|
+
# The ID of the Amazon Web Services account; that contains the analysis
|
6567
|
+
# that you're updating.
|
6297
6568
|
#
|
6298
6569
|
# @option params [required, String] :analysis_id
|
6299
6570
|
# The ID for the analysis that you're updating. This ID displays in the
|
@@ -6392,9 +6663,9 @@ module Aws::QuickSight
|
|
6392
6663
|
# Updates the read and write permissions for an analysis.
|
6393
6664
|
#
|
6394
6665
|
# @option params [required, String] :aws_account_id
|
6395
|
-
# The ID of the
|
6396
|
-
# you're updating. You must be using the
|
6397
|
-
# is in.
|
6666
|
+
# The ID of the Amazon Web Services account; that contains the analysis
|
6667
|
+
# whose permissions you're updating. You must be using the Amazon Web
|
6668
|
+
# Services account; that the analysis is in.
|
6398
6669
|
#
|
6399
6670
|
# @option params [required, String] :analysis_id
|
6400
6671
|
# The ID of the analysis whose permissions you're updating. The ID is
|
@@ -6455,11 +6726,18 @@ module Aws::QuickSight
|
|
6455
6726
|
req.send_request(options)
|
6456
6727
|
end
|
6457
6728
|
|
6458
|
-
# Updates a dashboard in an
|
6729
|
+
# Updates a dashboard in an Amazon Web Services account;.
|
6730
|
+
#
|
6731
|
+
# <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
|
6732
|
+
# immediately publish the new version. You can update the published
|
6733
|
+
# version of a dashboard by using the UpdateDashboardPublishedVersion
|
6734
|
+
# API operation.
|
6735
|
+
#
|
6736
|
+
# </note>
|
6459
6737
|
#
|
6460
6738
|
# @option params [required, String] :aws_account_id
|
6461
|
-
# The ID of the
|
6462
|
-
# updating.
|
6739
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
6740
|
+
# that you're updating.
|
6463
6741
|
#
|
6464
6742
|
# @option params [required, String] :dashboard_id
|
6465
6743
|
# The ID for the dashboard.
|
@@ -6475,8 +6753,8 @@ module Aws::QuickSight
|
|
6475
6753
|
# from an analysis, first convert the analysis to a template by using
|
6476
6754
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
6477
6755
|
# Amazon Resource Name (ARN) of the source template. The
|
6478
|
-
# `SourceTemplate` ARN can contain any
|
6479
|
-
# QuickSight-supported
|
6756
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account; and
|
6757
|
+
# any QuickSight-supported Amazon Web Services Region;.
|
6480
6758
|
#
|
6481
6759
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
6482
6760
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -6512,7 +6790,8 @@ module Aws::QuickSight
|
|
6512
6790
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
6513
6791
|
# this dashboard. If you add a value for this field, it overrides the
|
6514
6792
|
# value that was originally associated with the entity. The theme ARN
|
6515
|
-
# must exist in the same
|
6793
|
+
# must exist in the same Amazon Web Services account; where you create
|
6794
|
+
# the dashboard.
|
6516
6795
|
#
|
6517
6796
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6518
6797
|
#
|
@@ -6602,8 +6881,8 @@ module Aws::QuickSight
|
|
6602
6881
|
# Updates read and write permissions on a dashboard.
|
6603
6882
|
#
|
6604
6883
|
# @option params [required, String] :aws_account_id
|
6605
|
-
# The ID of the
|
6606
|
-
# permissions you're updating.
|
6884
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
6885
|
+
# whose permissions you're updating.
|
6607
6886
|
#
|
6608
6887
|
# @option params [required, String] :dashboard_id
|
6609
6888
|
# The ID for the dashboard.
|
@@ -6664,8 +6943,8 @@ module Aws::QuickSight
|
|
6664
6943
|
# Updates the published version of a dashboard.
|
6665
6944
|
#
|
6666
6945
|
# @option params [required, String] :aws_account_id
|
6667
|
-
# The ID of the
|
6668
|
-
# updating.
|
6946
|
+
# The ID of the Amazon Web Services account; that contains the dashboard
|
6947
|
+
# that you're updating.
|
6669
6948
|
#
|
6670
6949
|
# @option params [required, String] :dashboard_id
|
6671
6950
|
# The ID for the dashboard.
|
@@ -6707,11 +6986,11 @@ module Aws::QuickSight
|
|
6707
6986
|
# Updates a dataset.
|
6708
6987
|
#
|
6709
6988
|
# @option params [required, String] :aws_account_id
|
6710
|
-
# The
|
6989
|
+
# The Amazon Web Services account; ID.
|
6711
6990
|
#
|
6712
6991
|
# @option params [required, String] :data_set_id
|
6713
6992
|
# The ID for the dataset that you want to update. This ID is unique per
|
6714
|
-
#
|
6993
|
+
# Amazon Web Services Region; for each Amazon Web Services account;.
|
6715
6994
|
#
|
6716
6995
|
# @option params [required, String] :name
|
6717
6996
|
# The display name for the dataset.
|
@@ -6738,6 +7017,11 @@ module Aws::QuickSight
|
|
6738
7017
|
# @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
|
6739
7018
|
# The row-level security configuration for the data you want to create.
|
6740
7019
|
#
|
7020
|
+
# @option params [Types::RowLevelPermissionTagConfiguration] :row_level_permission_tag_configuration
|
7021
|
+
# The configuration of tags on a dataset to set row-level security.
|
7022
|
+
# Row-level security tags are currently supported for anonymous
|
7023
|
+
# embedding only.
|
7024
|
+
#
|
6741
7025
|
# @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
|
6742
7026
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
6743
7027
|
#
|
@@ -6879,6 +7163,18 @@ module Aws::QuickSight
|
|
6879
7163
|
# arn: "Arn", # required
|
6880
7164
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
6881
7165
|
# format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
|
7166
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
7167
|
+
# },
|
7168
|
+
# row_level_permission_tag_configuration: {
|
7169
|
+
# status: "ENABLED", # accepts ENABLED, DISABLED
|
7170
|
+
# tag_rules: [ # required
|
7171
|
+
# {
|
7172
|
+
# tag_key: "SessionTagKey", # required
|
7173
|
+
# column_name: "String", # required
|
7174
|
+
# tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
|
7175
|
+
# match_all_value: "SessionTagValue",
|
7176
|
+
# },
|
7177
|
+
# ],
|
6882
7178
|
# },
|
6883
7179
|
# column_level_permission_rules: [
|
6884
7180
|
# {
|
@@ -6912,11 +7208,12 @@ module Aws::QuickSight
|
|
6912
7208
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
6913
7209
|
#
|
6914
7210
|
# @option params [required, String] :aws_account_id
|
6915
|
-
# The
|
7211
|
+
# The Amazon Web Services account; ID.
|
6916
7212
|
#
|
6917
7213
|
# @option params [required, String] :data_set_id
|
6918
7214
|
# The ID for the dataset whose permissions you want to update. This ID
|
6919
|
-
# is unique per
|
7215
|
+
# is unique per Amazon Web Services Region; for each Amazon Web Services
|
7216
|
+
# account;.
|
6920
7217
|
#
|
6921
7218
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
6922
7219
|
# The resource permissions that you want to grant to the dataset.
|
@@ -6969,11 +7266,11 @@ module Aws::QuickSight
|
|
6969
7266
|
# Updates a data source.
|
6970
7267
|
#
|
6971
7268
|
# @option params [required, String] :aws_account_id
|
6972
|
-
# The
|
7269
|
+
# The Amazon Web Services account; ID.
|
6973
7270
|
#
|
6974
7271
|
# @option params [required, String] :data_source_id
|
6975
|
-
# The ID of the data source. This ID is unique per
|
6976
|
-
#
|
7272
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
7273
|
+
# Region; for each Amazon Web Services account;.
|
6977
7274
|
#
|
6978
7275
|
# @option params [required, String] :name
|
6979
7276
|
# A display name for the data source.
|
@@ -7228,11 +7525,11 @@ module Aws::QuickSight
|
|
7228
7525
|
# Updates the permissions to a data source.
|
7229
7526
|
#
|
7230
7527
|
# @option params [required, String] :aws_account_id
|
7231
|
-
# The
|
7528
|
+
# The Amazon Web Services account; ID.
|
7232
7529
|
#
|
7233
7530
|
# @option params [required, String] :data_source_id
|
7234
|
-
# The ID of the data source. This ID is unique per
|
7235
|
-
#
|
7531
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
7532
|
+
# Region; for each Amazon Web Services account;.
|
7236
7533
|
#
|
7237
7534
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7238
7535
|
# A list of resource permissions that you want to grant on the data
|
@@ -7396,9 +7693,9 @@ module Aws::QuickSight
|
|
7396
7693
|
# The description for the group that you want to update.
|
7397
7694
|
#
|
7398
7695
|
# @option params [required, String] :aws_account_id
|
7399
|
-
# The ID for the
|
7400
|
-
# the ID for the
|
7401
|
-
# account.
|
7696
|
+
# The ID for the Amazon Web Services account; that the group is in.
|
7697
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
7698
|
+
# contains your Amazon QuickSight account.
|
7402
7699
|
#
|
7403
7700
|
# @option params [required, String] :namespace
|
7404
7701
|
# The namespace. Currently, you should set this to `default`.
|
@@ -7441,11 +7738,12 @@ module Aws::QuickSight
|
|
7441
7738
|
# request. This overwrites all of the users included in `Identities`.
|
7442
7739
|
#
|
7443
7740
|
# @option params [required, String] :aws_account_id
|
7444
|
-
# The ID of the
|
7741
|
+
# The ID of the Amazon Web Services account; that contains the IAM
|
7742
|
+
# policy assignment.
|
7445
7743
|
#
|
7446
7744
|
# @option params [required, String] :assignment_name
|
7447
7745
|
# The name of the assignment, also called a rule. This name must be
|
7448
|
-
# unique within an
|
7746
|
+
# unique within an Amazon Web Services account;.
|
7449
7747
|
#
|
7450
7748
|
# @option params [required, String] :namespace
|
7451
7749
|
# The namespace of the assignment.
|
@@ -7518,8 +7816,8 @@ module Aws::QuickSight
|
|
7518
7816
|
# another template.
|
7519
7817
|
#
|
7520
7818
|
# @option params [required, String] :aws_account_id
|
7521
|
-
# The ID of the
|
7522
|
-
# updating.
|
7819
|
+
# The ID of the Amazon Web Services account; that contains the template
|
7820
|
+
# that you're updating.
|
7523
7821
|
#
|
7524
7822
|
# @option params [required, String] :template_id
|
7525
7823
|
# The ID for the template.
|
@@ -7531,8 +7829,8 @@ module Aws::QuickSight
|
|
7531
7829
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
7532
7830
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
7533
7831
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
7534
|
-
# `SourceTemplate` ARN can contain any
|
7535
|
-
# QuickSight-supported
|
7832
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account; and
|
7833
|
+
# any QuickSight-supported Amazon Web Services Region;.
|
7536
7834
|
#
|
7537
7835
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
7538
7836
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -7601,8 +7899,8 @@ module Aws::QuickSight
|
|
7601
7899
|
# Updates the template alias of a template.
|
7602
7900
|
#
|
7603
7901
|
# @option params [required, String] :aws_account_id
|
7604
|
-
# The ID of the
|
7605
|
-
# you're updating.
|
7902
|
+
# The ID of the Amazon Web Services account; that contains the template
|
7903
|
+
# alias that you're updating.
|
7606
7904
|
#
|
7607
7905
|
# @option params [required, String] :template_id
|
7608
7906
|
# The ID for the template.
|
@@ -7652,7 +7950,7 @@ module Aws::QuickSight
|
|
7652
7950
|
# Updates the resource permissions for a template.
|
7653
7951
|
#
|
7654
7952
|
# @option params [required, String] :aws_account_id
|
7655
|
-
# The ID of the
|
7953
|
+
# The ID of the Amazon Web Services account; that contains the template.
|
7656
7954
|
#
|
7657
7955
|
# @option params [required, String] :template_id
|
7658
7956
|
# The ID for the template.
|
@@ -7713,8 +8011,8 @@ module Aws::QuickSight
|
|
7713
8011
|
# Updates a theme.
|
7714
8012
|
#
|
7715
8013
|
# @option params [required, String] :aws_account_id
|
7716
|
-
# The ID of the
|
7717
|
-
# updating.
|
8014
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
8015
|
+
# that you're updating.
|
7718
8016
|
#
|
7719
8017
|
# @option params [required, String] :theme_id
|
7720
8018
|
# The ID for the theme.
|
@@ -7724,8 +8022,8 @@ module Aws::QuickSight
|
|
7724
8022
|
#
|
7725
8023
|
# @option params [required, String] :base_theme_id
|
7726
8024
|
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
7727
|
-
# inherits from. All themes initially inherit from a default
|
7728
|
-
# theme.
|
8025
|
+
# inherits from. All themes initially inherit from a default Amazon
|
8026
|
+
# QuickSight theme.
|
7729
8027
|
#
|
7730
8028
|
# @option params [String] :version_description
|
7731
8029
|
# A description of the theme version that you're updating Every time
|
@@ -7816,8 +8114,8 @@ module Aws::QuickSight
|
|
7816
8114
|
# Updates an alias of a theme.
|
7817
8115
|
#
|
7818
8116
|
# @option params [required, String] :aws_account_id
|
7819
|
-
# The ID of the
|
7820
|
-
# updating.
|
8117
|
+
# The ID of the Amazon Web Services account; that contains the theme
|
8118
|
+
# alias that you're updating.
|
7821
8119
|
#
|
7822
8120
|
# @option params [required, String] :theme_id
|
7823
8121
|
# The ID for the theme.
|
@@ -7905,7 +8203,7 @@ module Aws::QuickSight
|
|
7905
8203
|
# * To specify no permissions, omit the permissions list.
|
7906
8204
|
#
|
7907
8205
|
# @option params [required, String] :aws_account_id
|
7908
|
-
# The ID of the
|
8206
|
+
# The ID of the Amazon Web Services account; that contains the theme.
|
7909
8207
|
#
|
7910
8208
|
# @option params [required, String] :theme_id
|
7911
8209
|
# The ID for the theme.
|
@@ -7969,8 +8267,9 @@ module Aws::QuickSight
|
|
7969
8267
|
# The Amazon QuickSight user name that you want to update.
|
7970
8268
|
#
|
7971
8269
|
# @option params [required, String] :aws_account_id
|
7972
|
-
# The ID for the
|
7973
|
-
#
|
8270
|
+
# The ID for the Amazon Web Services account; that the user is in.
|
8271
|
+
# Currently, you use the ID for the Amazon Web Services account; that
|
8272
|
+
# contains your Amazon QuickSight account.
|
7974
8273
|
#
|
7975
8274
|
# @option params [required, String] :namespace
|
7976
8275
|
# The namespace. Currently, you should set this to `default`.
|
@@ -8019,8 +8318,7 @@ module Aws::QuickSight
|
|
8019
8318
|
# QuickSight (admin, author, reader).
|
8020
8319
|
#
|
8021
8320
|
# This feature is available only to QuickSight Enterprise edition
|
8022
|
-
# subscriptions
|
8023
|
-
# (SSO).
|
8321
|
+
# subscriptions.
|
8024
8322
|
#
|
8025
8323
|
# @option params [Boolean] :unapply_custom_permissions
|
8026
8324
|
# A flag that you use to indicate that you want to remove all custom
|
@@ -8117,7 +8415,7 @@ module Aws::QuickSight
|
|
8117
8415
|
params: params,
|
8118
8416
|
config: config)
|
8119
8417
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8120
|
-
context[:gem_version] = '1.
|
8418
|
+
context[:gem_version] = '1.51.0'
|
8121
8419
|
Seahorse::Client::Request.new(handlers, context)
|
8122
8420
|
end
|
8123
8421
|
|