aws-sdk-quicksight 1.157.0 → 1.158.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +601 -460
- data/lib/aws-sdk-quicksight/client_api.rb +100 -0
- data/lib/aws-sdk-quicksight/types.rb +778 -561
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +88 -5
- data/sig/types.rbs +74 -4
- metadata +1 -1
@@ -1385,10 +1385,9 @@ module Aws::QuickSight
|
|
1385
1385
|
# Creates Amazon QuickSight customizations for the current Amazon Web
|
1386
1386
|
# Services Region. Currently, you can add a custom default theme by
|
1387
1387
|
# using the `CreateAccountCustomization` or `UpdateAccountCustomization`
|
1388
|
-
# API operation. To further customize
|
1389
|
-
#
|
1390
|
-
#
|
1391
|
-
# Guide.*
|
1388
|
+
# API operation. To further customize QuickSight by removing QuickSight
|
1389
|
+
# sample assets and videos for all new users, see [Customizing
|
1390
|
+
# QuickSight][1] in the *Amazon QuickSight User Guide.*
|
1392
1391
|
#
|
1393
1392
|
# You can create customizations for your Amazon Web Services account or,
|
1394
1393
|
# if you specify a namespace, for a QuickSight namespace instead.
|
@@ -1412,16 +1411,15 @@ module Aws::QuickSight
|
|
1412
1411
|
#
|
1413
1412
|
# @option params [required, String] :aws_account_id
|
1414
1413
|
# The ID for the Amazon Web Services account that you want to customize
|
1415
|
-
#
|
1414
|
+
# QuickSight for.
|
1416
1415
|
#
|
1417
1416
|
# @option params [String] :namespace
|
1418
|
-
# The
|
1419
|
-
# to.
|
1417
|
+
# The QuickSight namespace that you want to add customizations to.
|
1420
1418
|
#
|
1421
1419
|
# @option params [required, Types::AccountCustomization] :account_customization
|
1422
|
-
# The
|
1423
|
-
#
|
1424
|
-
#
|
1420
|
+
# The QuickSight customizations you're adding in the current Amazon Web
|
1421
|
+
# Services Region. You can add these to an Amazon Web Services account
|
1422
|
+
# and a QuickSight namespace.
|
1425
1423
|
#
|
1426
1424
|
# For example, you can add a default theme by setting
|
1427
1425
|
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
@@ -1479,8 +1477,7 @@ module Aws::QuickSight
|
|
1479
1477
|
req.send_request(options)
|
1480
1478
|
end
|
1481
1479
|
|
1482
|
-
# Creates an
|
1483
|
-
# QuickSight Q.
|
1480
|
+
# Creates an QuickSight account, or subscribes to QuickSight Q.
|
1484
1481
|
#
|
1485
1482
|
# The Amazon Web Services Region for the account is derived from what is
|
1486
1483
|
# configured in the CLI or SDK.
|
@@ -1488,10 +1485,10 @@ module Aws::QuickSight
|
|
1488
1485
|
# Before you use this operation, make sure that you can connect to an
|
1489
1486
|
# existing Amazon Web Services account. If you don't have an Amazon Web
|
1490
1487
|
# Services account, see [Sign up for Amazon Web Services][1] in the
|
1491
|
-
# *Amazon QuickSight User Guide*. The person who signs up for
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1488
|
+
# *Amazon QuickSight User Guide*. The person who signs up for QuickSight
|
1489
|
+
# needs to have the correct Identity and Access Management (IAM)
|
1490
|
+
# permissions. For more information, see [IAM Policy Examples for
|
1491
|
+
# QuickSight][2] in the *QuickSight User Guide*.
|
1495
1492
|
#
|
1496
1493
|
# If your IAM policy includes both the `Subscribe` and
|
1497
1494
|
# `CreateAccountSubscription` actions, make sure that both actions are
|
@@ -1500,15 +1497,15 @@ module Aws::QuickSight
|
|
1500
1497
|
#
|
1501
1498
|
# You can't pass an existing IAM role to access other Amazon Web
|
1502
1499
|
# Services services using this API operation. To pass your existing IAM
|
1503
|
-
# role to
|
1504
|
-
#
|
1500
|
+
# role to QuickSight, see [Passing IAM roles to QuickSight][3] in the
|
1501
|
+
# *QuickSight User Guide*.
|
1505
1502
|
#
|
1506
1503
|
# You can't set default resource access on the new account from the
|
1507
|
-
#
|
1508
|
-
#
|
1504
|
+
# QuickSight API. Instead, add default resource access from the
|
1505
|
+
# QuickSight console. For more information about setting default
|
1509
1506
|
# resource access to Amazon Web Services services, see [Setting default
|
1510
|
-
# resource access to Amazon Web Services services][4] in the *
|
1511
|
-
#
|
1507
|
+
# resource access to Amazon Web Services services][4] in the *QuickSight
|
1508
|
+
# User Guide*.
|
1512
1509
|
#
|
1513
1510
|
#
|
1514
1511
|
#
|
@@ -1518,7 +1515,7 @@ module Aws::QuickSight
|
|
1518
1515
|
# [4]: https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html
|
1519
1516
|
#
|
1520
1517
|
# @option params [String] :edition
|
1521
|
-
# The edition of
|
1518
|
+
# The edition of QuickSight that you want your account to have.
|
1522
1519
|
# Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
|
1523
1520
|
#
|
1524
1521
|
# If you choose `ENTERPRISE_AND_Q`, the following parameters are
|
@@ -1533,7 +1530,7 @@ module Aws::QuickSight
|
|
1533
1530
|
# * `ContactNumber`
|
1534
1531
|
#
|
1535
1532
|
# @option params [required, String] :authentication_method
|
1536
|
-
# The method that you want to use to authenticate your
|
1533
|
+
# The method that you want to use to authenticate your QuickSight
|
1537
1534
|
# account.
|
1538
1535
|
#
|
1539
1536
|
# If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName` and
|
@@ -1544,46 +1541,43 @@ module Aws::QuickSight
|
|
1544
1541
|
#
|
1545
1542
|
# @option params [required, String] :aws_account_id
|
1546
1543
|
# The Amazon Web Services account ID of the account that you're using
|
1547
|
-
# to create your
|
1544
|
+
# to create your QuickSight account.
|
1548
1545
|
#
|
1549
1546
|
# @option params [required, String] :account_name
|
1550
|
-
# The name of your
|
1551
|
-
#
|
1552
|
-
#
|
1553
|
-
#
|
1547
|
+
# The name of your QuickSight account. This name is unique over all of
|
1548
|
+
# Amazon Web Services, and it appears only when users sign in. You
|
1549
|
+
# can't change `AccountName` value after the QuickSight account is
|
1550
|
+
# created.
|
1554
1551
|
#
|
1555
1552
|
# @option params [required, String] :notification_email
|
1556
|
-
# The email address that you want
|
1557
|
-
#
|
1558
|
-
# QuickSight subscription.
|
1553
|
+
# The email address that you want QuickSight to send notifications to
|
1554
|
+
# regarding your QuickSight account or QuickSight subscription.
|
1559
1555
|
#
|
1560
1556
|
# @option params [String] :active_directory_name
|
1561
1557
|
# The name of your Active Directory. This field is required if
|
1562
1558
|
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
1563
|
-
#
|
1559
|
+
# QuickSight account.
|
1564
1560
|
#
|
1565
1561
|
# @option params [String] :realm
|
1566
|
-
# The realm of the Active Directory that is associated with your
|
1562
|
+
# The realm of the Active Directory that is associated with your
|
1567
1563
|
# QuickSight account. This field is required if `ACTIVE_DIRECTORY` is
|
1568
|
-
# the selected authentication method of the new
|
1569
|
-
# account.
|
1564
|
+
# the selected authentication method of the new QuickSight account.
|
1570
1565
|
#
|
1571
1566
|
# @option params [String] :directory_id
|
1572
|
-
# The ID of the Active Directory that is associated with your
|
1573
|
-
#
|
1567
|
+
# The ID of the Active Directory that is associated with your QuickSight
|
1568
|
+
# account.
|
1574
1569
|
#
|
1575
1570
|
# @option params [Array<String>] :admin_group
|
1576
1571
|
# The admin group associated with your Active Directory or IAM Identity
|
1577
1572
|
# Center account. Either this field or the `AdminProGroup` field is
|
1578
1573
|
# required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
1579
|
-
# selected authentication method of the new
|
1574
|
+
# selected authentication method of the new QuickSight account.
|
1580
1575
|
#
|
1581
|
-
# For more information about using IAM Identity Center in
|
1582
|
-
#
|
1583
|
-
#
|
1584
|
-
#
|
1585
|
-
# [
|
1586
|
-
# in the Amazon QuickSight User Guide.
|
1576
|
+
# For more information about using IAM Identity Center in QuickSight,
|
1577
|
+
# see [Using IAM Identity Center with QuickSight Enterprise Edition][1]
|
1578
|
+
# in the QuickSight User Guide. For more information about using Active
|
1579
|
+
# Directory in QuickSight, see [Using Active Directory with QuickSight
|
1580
|
+
# Enterprise Edition][2] in the QuickSight User Guide.
|
1587
1581
|
#
|
1588
1582
|
#
|
1589
1583
|
#
|
@@ -1594,12 +1588,11 @@ module Aws::QuickSight
|
|
1594
1588
|
# The author group associated with your Active Directory or IAM Identity
|
1595
1589
|
# Center account.
|
1596
1590
|
#
|
1597
|
-
# For more information about using IAM Identity Center in
|
1598
|
-
#
|
1599
|
-
#
|
1600
|
-
#
|
1601
|
-
# [
|
1602
|
-
# in the Amazon QuickSight User Guide.
|
1591
|
+
# For more information about using IAM Identity Center in QuickSight,
|
1592
|
+
# see [Using IAM Identity Center with QuickSight Enterprise Edition][1]
|
1593
|
+
# in the QuickSight User Guide. For more information about using Active
|
1594
|
+
# Directory in QuickSight, see [Using Active Directory with QuickSight
|
1595
|
+
# Enterprise Edition][2] in the QuickSight User Guide.
|
1603
1596
|
#
|
1604
1597
|
#
|
1605
1598
|
#
|
@@ -1610,12 +1603,11 @@ module Aws::QuickSight
|
|
1610
1603
|
# The reader group associated with your Active Directory or IAM Identity
|
1611
1604
|
# Center account.
|
1612
1605
|
#
|
1613
|
-
# For more information about using IAM Identity Center in
|
1614
|
-
#
|
1615
|
-
#
|
1616
|
-
#
|
1617
|
-
# [
|
1618
|
-
# in the Amazon QuickSight User Guide.
|
1606
|
+
# For more information about using IAM Identity Center in QuickSight,
|
1607
|
+
# see [Using IAM Identity Center with QuickSight Enterprise Edition][1]
|
1608
|
+
# in the QuickSight User Guide. For more information about using Active
|
1609
|
+
# Directory in QuickSight, see [Using Active Directory with QuickSight
|
1610
|
+
# Enterprise Edition][2] in the QuickSight User Guide.
|
1619
1611
|
#
|
1620
1612
|
#
|
1621
1613
|
#
|
@@ -1626,14 +1618,13 @@ module Aws::QuickSight
|
|
1626
1618
|
# The admin pro group associated with your Active Directory or IAM
|
1627
1619
|
# Identity Center account. Either this field or the `AdminGroup` field
|
1628
1620
|
# is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
1629
|
-
# selected authentication method of the new
|
1621
|
+
# selected authentication method of the new QuickSight account.
|
1630
1622
|
#
|
1631
|
-
# For more information about using IAM Identity Center in
|
1632
|
-
#
|
1633
|
-
#
|
1634
|
-
#
|
1635
|
-
# [
|
1636
|
-
# in the Amazon QuickSight User Guide.
|
1623
|
+
# For more information about using IAM Identity Center in QuickSight,
|
1624
|
+
# see [Using IAM Identity Center with QuickSight Enterprise Edition][1]
|
1625
|
+
# in the QuickSight User Guide. For more information about using Active
|
1626
|
+
# Directory in QuickSight, see [Using Active Directory with QuickSight
|
1627
|
+
# Enterprise Edition][2] in the QuickSight User Guide.
|
1637
1628
|
#
|
1638
1629
|
#
|
1639
1630
|
#
|
@@ -1644,12 +1635,11 @@ module Aws::QuickSight
|
|
1644
1635
|
# The author pro group associated with your Active Directory or IAM
|
1645
1636
|
# Identity Center account.
|
1646
1637
|
#
|
1647
|
-
# For more information about using IAM Identity Center in
|
1648
|
-
#
|
1649
|
-
#
|
1650
|
-
#
|
1651
|
-
# [
|
1652
|
-
# in the Amazon QuickSight User Guide.
|
1638
|
+
# For more information about using IAM Identity Center in QuickSight,
|
1639
|
+
# see [Using IAM Identity Center with QuickSight Enterprise Edition][1]
|
1640
|
+
# in the QuickSight User Guide. For more information about using Active
|
1641
|
+
# Directory in QuickSight, see [Using Active Directory with QuickSight
|
1642
|
+
# Enterprise Edition][2] in the QuickSight User Guide.
|
1653
1643
|
#
|
1654
1644
|
#
|
1655
1645
|
#
|
@@ -1660,12 +1650,11 @@ module Aws::QuickSight
|
|
1660
1650
|
# The reader pro group associated with your Active Directory or IAM
|
1661
1651
|
# Identity Center account.
|
1662
1652
|
#
|
1663
|
-
# For more information about using IAM Identity Center in
|
1664
|
-
#
|
1665
|
-
#
|
1666
|
-
#
|
1667
|
-
# [
|
1668
|
-
# in the Amazon QuickSight User Guide.
|
1653
|
+
# For more information about using IAM Identity Center in QuickSight,
|
1654
|
+
# see [Using IAM Identity Center with QuickSight Enterprise Edition][1]
|
1655
|
+
# in the QuickSight User Guide. For more information about using Active
|
1656
|
+
# Directory in QuickSight, see [Using Active Directory with QuickSight
|
1657
|
+
# Enterprise Edition][2] in the QuickSight User Guide.
|
1669
1658
|
#
|
1670
1659
|
#
|
1671
1660
|
#
|
@@ -1673,28 +1662,25 @@ module Aws::QuickSight
|
|
1673
1662
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
1674
1663
|
#
|
1675
1664
|
# @option params [String] :first_name
|
1676
|
-
# The first name of the author of the
|
1677
|
-
#
|
1678
|
-
#
|
1679
|
-
# QuickSight account.
|
1665
|
+
# The first name of the author of the QuickSight account to use for
|
1666
|
+
# future communications. This field is required if `ENTERPPRISE_AND_Q`
|
1667
|
+
# is the selected edition of the new QuickSight account.
|
1680
1668
|
#
|
1681
1669
|
# @option params [String] :last_name
|
1682
|
-
# The last name of the author of the
|
1683
|
-
#
|
1684
|
-
#
|
1685
|
-
# QuickSight account.
|
1670
|
+
# The last name of the author of the QuickSight account to use for
|
1671
|
+
# future communications. This field is required if `ENTERPPRISE_AND_Q`
|
1672
|
+
# is the selected edition of the new QuickSight account.
|
1686
1673
|
#
|
1687
1674
|
# @option params [String] :email_address
|
1688
|
-
# The email address of the author of the
|
1689
|
-
#
|
1690
|
-
#
|
1691
|
-
# QuickSight account.
|
1675
|
+
# The email address of the author of the QuickSight account to use for
|
1676
|
+
# future communications. This field is required if `ENTERPPRISE_AND_Q`
|
1677
|
+
# is the selected edition of the new QuickSight account.
|
1692
1678
|
#
|
1693
1679
|
# @option params [String] :contact_number
|
1694
|
-
# A 10-digit phone number for the author of the
|
1695
|
-
#
|
1696
|
-
# `ENTERPPRISE_AND_Q` is the selected edition of the new
|
1697
|
-
#
|
1680
|
+
# A 10-digit phone number for the author of the QuickSight account to
|
1681
|
+
# use for future communications. This field is required if
|
1682
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new QuickSight
|
1683
|
+
# account.
|
1698
1684
|
#
|
1699
1685
|
# @option params [String] :iam_identity_center_instance_arn
|
1700
1686
|
# The Amazon Resource Name (ARN) for the IAM Identity Center instance.
|
@@ -1760,7 +1746,7 @@ module Aws::QuickSight
|
|
1760
1746
|
#
|
1761
1747
|
# @option params [required, String] :name
|
1762
1748
|
# A descriptive name for the analysis that you're creating. This name
|
1763
|
-
# displays for the analysis in the
|
1749
|
+
# displays for the analysis in the QuickSight console.
|
1764
1750
|
#
|
1765
1751
|
# @option params [Types::Parameters] :parameters
|
1766
1752
|
# The parameter names and override values that you want to use. An
|
@@ -1786,8 +1772,8 @@ module Aws::QuickSight
|
|
1786
1772
|
#
|
1787
1773
|
# @option params [String] :theme_arn
|
1788
1774
|
# The ARN for the theme to apply to the analysis that you're creating.
|
1789
|
-
# To see the theme in the
|
1790
|
-
#
|
1775
|
+
# To see the theme in the QuickSight console, make sure that you have
|
1776
|
+
# access to it.
|
1791
1777
|
#
|
1792
1778
|
# @option params [Array<Types::Tag>] :tags
|
1793
1779
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -1808,8 +1794,8 @@ module Aws::QuickSight
|
|
1808
1794
|
# errors.
|
1809
1795
|
#
|
1810
1796
|
# @option params [Array<String>] :folder_arns
|
1811
|
-
# When you create the analysis,
|
1812
|
-
#
|
1797
|
+
# When you create the analysis, QuickSight adds the analysis to these
|
1798
|
+
# folders.
|
1813
1799
|
#
|
1814
1800
|
# @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1815
1801
|
#
|
@@ -1836,13 +1822,13 @@ module Aws::QuickSight
|
|
1836
1822
|
req.send_request(options)
|
1837
1823
|
end
|
1838
1824
|
|
1839
|
-
# Creates an
|
1825
|
+
# Creates an QuickSight brand.
|
1840
1826
|
#
|
1841
1827
|
# @option params [required, String] :aws_account_id
|
1842
1828
|
# The ID of the Amazon Web Services account that owns the brand.
|
1843
1829
|
#
|
1844
1830
|
# @option params [required, String] :brand_id
|
1845
|
-
# The ID of the
|
1831
|
+
# The ID of the QuickSight brand.
|
1846
1832
|
#
|
1847
1833
|
# @option params [Types::BrandDefinition] :brand_definition
|
1848
1834
|
# The definition of the brand.
|
@@ -2066,6 +2052,8 @@ module Aws::QuickSight
|
|
2066
2052
|
# export_to_csv_in_scheduled_reports: "DENY", # accepts DENY
|
2067
2053
|
# export_to_excel_in_scheduled_reports: "DENY", # accepts DENY
|
2068
2054
|
# include_content_in_scheduled_reports_email: "DENY", # accepts DENY
|
2055
|
+
# dashboard: "DENY", # accepts DENY
|
2056
|
+
# analysis: "DENY", # accepts DENY
|
2069
2057
|
# },
|
2070
2058
|
# tags: [
|
2071
2059
|
# {
|
@@ -2094,12 +2082,12 @@ module Aws::QuickSight
|
|
2094
2082
|
# `DashboardDefinition`. To first create a template, see the `
|
2095
2083
|
# CreateTemplate ` API operation.
|
2096
2084
|
#
|
2097
|
-
# A dashboard is an entity in
|
2098
|
-
#
|
2099
|
-
#
|
2100
|
-
#
|
2101
|
-
#
|
2102
|
-
#
|
2085
|
+
# A dashboard is an entity in QuickSight that identifies QuickSight
|
2086
|
+
# reports, created from analyses. You can share QuickSight dashboards.
|
2087
|
+
# With the right permissions, you can create scheduled email reports
|
2088
|
+
# from them. If you have the correct permissions, you can create a
|
2089
|
+
# dashboard from a template that exists in a different Amazon Web
|
2090
|
+
# Services account.
|
2103
2091
|
#
|
2104
2092
|
# @option params [required, String] :aws_account_id
|
2105
2093
|
# The ID of the Amazon Web Services account where you want to create the
|
@@ -2132,7 +2120,7 @@ module Aws::QuickSight
|
|
2132
2120
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
2133
2121
|
# the Amazon Resource Name (ARN) of the source template. The
|
2134
2122
|
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
2135
|
-
# any
|
2123
|
+
# any QuickSight-supported Amazon Web Services Region.
|
2136
2124
|
#
|
2137
2125
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
2138
2126
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -2153,9 +2141,9 @@ module Aws::QuickSight
|
|
2153
2141
|
#
|
2154
2142
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
2155
2143
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
2156
|
-
#
|
2157
|
-
#
|
2158
|
-
#
|
2144
|
+
# QuickSight disables the left filter pane on the published dashboard,
|
2145
|
+
# which can be used for ad hoc (one-time) filtering. This option is
|
2146
|
+
# `ENABLED` by default.
|
2159
2147
|
#
|
2160
2148
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
2161
2149
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -2166,6 +2154,16 @@ module Aws::QuickSight
|
|
2166
2154
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
2167
2155
|
# by default.
|
2168
2156
|
#
|
2157
|
+
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
|
2158
|
+
# be either `ENABLED` or `DISABLED`. The option to build an executive
|
2159
|
+
# summary is disabled when this is set to `DISABLED`. This option is
|
2160
|
+
# `ENABLED` by default.
|
2161
|
+
#
|
2162
|
+
# * `AvailabilityStatus` for `DataStoriesSharingOption` - This status
|
2163
|
+
# can be either `ENABLED` or `DISABLED`. The option to share a data
|
2164
|
+
# story is disabled when this is set to `DISABLED`. This option is
|
2165
|
+
# `ENABLED` by default.
|
2166
|
+
#
|
2169
2167
|
# @option params [String] :theme_arn
|
2170
2168
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
2171
2169
|
# this dashboard. If you add a value for this field, it overrides the
|
@@ -2187,8 +2185,8 @@ module Aws::QuickSight
|
|
2187
2185
|
# errors.
|
2188
2186
|
#
|
2189
2187
|
# @option params [Array<String>] :folder_arns
|
2190
|
-
# When you create the dashboard,
|
2191
|
-
#
|
2188
|
+
# When you create the dashboard, QuickSight adds the dashboard to these
|
2189
|
+
# folders.
|
2192
2190
|
#
|
2193
2191
|
# @option params [Types::LinkSharingConfiguration] :link_sharing_configuration
|
2194
2192
|
# A structure that contains the permissions of a shareable link to the
|
@@ -2250,7 +2248,7 @@ module Aws::QuickSight
|
|
2250
2248
|
# Indicates whether you want to import the data into SPICE.
|
2251
2249
|
#
|
2252
2250
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
2253
|
-
# Groupings of columns that work together in certain
|
2251
|
+
# Groupings of columns that work together in certain QuickSight
|
2254
2252
|
# features. Currently, only geospatial hierarchy is supported.
|
2255
2253
|
#
|
2256
2254
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -2284,8 +2282,8 @@ module Aws::QuickSight
|
|
2284
2282
|
# The parameter declarations of the dataset.
|
2285
2283
|
#
|
2286
2284
|
# @option params [Array<String>] :folder_arns
|
2287
|
-
# When you create the dataset,
|
2288
|
-
#
|
2285
|
+
# When you create the dataset, QuickSight adds the dataset to these
|
2286
|
+
# folders.
|
2289
2287
|
#
|
2290
2288
|
# @option params [Types::PerformanceConfiguration] :performance_configuration
|
2291
2289
|
# The configuration for the performance optimization of the dataset that
|
@@ -2575,23 +2573,23 @@ module Aws::QuickSight
|
|
2575
2573
|
# Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.
|
2576
2574
|
#
|
2577
2575
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
2578
|
-
# The parameters that
|
2579
|
-
#
|
2576
|
+
# The parameters that QuickSight uses to connect to your underlying
|
2577
|
+
# source.
|
2580
2578
|
#
|
2581
2579
|
# @option params [Types::DataSourceCredentials] :credentials
|
2582
|
-
# The credentials
|
2583
|
-
#
|
2584
|
-
#
|
2580
|
+
# The credentials QuickSight that uses to connect to your underlying
|
2581
|
+
# source. Currently, only credentials based on user name and password
|
2582
|
+
# are supported.
|
2585
2583
|
#
|
2586
2584
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
2587
2585
|
# A list of resource permissions on the data source.
|
2588
2586
|
#
|
2589
2587
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
2590
|
-
# Use this parameter only when you want
|
2588
|
+
# Use this parameter only when you want QuickSight to use a VPC
|
2591
2589
|
# connection when connecting to your underlying source.
|
2592
2590
|
#
|
2593
2591
|
# @option params [Types::SslProperties] :ssl_properties
|
2594
|
-
# Secure Socket Layer (SSL) properties that apply when
|
2592
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
2595
2593
|
# connects to your underlying source.
|
2596
2594
|
#
|
2597
2595
|
# @option params [Array<Types::Tag>] :tags
|
@@ -2599,8 +2597,8 @@ module Aws::QuickSight
|
|
2599
2597
|
# assigned to the data source.
|
2600
2598
|
#
|
2601
2599
|
# @option params [Array<String>] :folder_arns
|
2602
|
-
# When you create the data source,
|
2603
|
-
#
|
2600
|
+
# When you create the data source, QuickSight adds the data source to
|
2601
|
+
# these folders.
|
2604
2602
|
#
|
2605
2603
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2606
2604
|
#
|
@@ -2616,7 +2614,7 @@ module Aws::QuickSight
|
|
2616
2614
|
# aws_account_id: "AwsAccountId", # required
|
2617
2615
|
# data_source_id: "ResourceId", # required
|
2618
2616
|
# name: "ResourceName", # required
|
2619
|
-
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS, STARBURST, TRINO, BIGQUERY
|
2617
|
+
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS, STARBURST, TRINO, BIGQUERY, GOOGLESHEETS
|
2620
2618
|
# data_source_parameters: {
|
2621
2619
|
# amazon_elasticsearch_parameters: {
|
2622
2620
|
# domain: "Domain", # required
|
@@ -2775,6 +2773,9 @@ module Aws::QuickSight
|
|
2775
2773
|
# database: "Database",
|
2776
2774
|
# sql_endpoint_path: "SqlEndpointPath", # required
|
2777
2775
|
# },
|
2776
|
+
# custom_connection_parameters: {
|
2777
|
+
# connection_type: "String",
|
2778
|
+
# },
|
2778
2779
|
# },
|
2779
2780
|
# credentials: {
|
2780
2781
|
# credential_pair: {
|
@@ -2939,6 +2940,9 @@ module Aws::QuickSight
|
|
2939
2940
|
# database: "Database",
|
2940
2941
|
# sql_endpoint_path: "SqlEndpointPath", # required
|
2941
2942
|
# },
|
2943
|
+
# custom_connection_parameters: {
|
2944
|
+
# connection_type: "String",
|
2945
|
+
# },
|
2942
2946
|
# },
|
2943
2947
|
# ],
|
2944
2948
|
# },
|
@@ -3109,10 +3113,10 @@ module Aws::QuickSight
|
|
3109
3113
|
req.send_request(options)
|
3110
3114
|
end
|
3111
3115
|
|
3112
|
-
# Use the `CreateGroup` operation to create a group in
|
3113
|
-
#
|
3114
|
-
#
|
3115
|
-
#
|
3116
|
+
# Use the `CreateGroup` operation to create a group in QuickSight. You
|
3117
|
+
# can create up to 10,000 groups in a namespace. If you want to create
|
3118
|
+
# more than 10,000 groups in a namespace, contact Amazon Web Services
|
3119
|
+
# Support.
|
3116
3120
|
#
|
3117
3121
|
# The permissions resource is
|
3118
3122
|
# `arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
|
@@ -3222,7 +3226,7 @@ module Aws::QuickSight
|
|
3222
3226
|
#
|
3223
3227
|
# @option params [required, String] :aws_account_id
|
3224
3228
|
# The ID of the Amazon Web Services account where you want to assign an
|
3225
|
-
# IAM policy to
|
3229
|
+
# IAM policy to QuickSight users or groups.
|
3226
3230
|
#
|
3227
3231
|
# @option params [required, String] :assignment_name
|
3228
3232
|
# The name of the assignment, also called a rule. The name must be
|
@@ -3241,12 +3245,12 @@ module Aws::QuickSight
|
|
3241
3245
|
# when creating the data source.
|
3242
3246
|
#
|
3243
3247
|
# @option params [String] :policy_arn
|
3244
|
-
# The ARN for the IAM policy to apply to the
|
3245
|
-
#
|
3248
|
+
# The ARN for the IAM policy to apply to the QuickSight users and groups
|
3249
|
+
# specified in this assignment.
|
3246
3250
|
#
|
3247
3251
|
# @option params [Hash<String,Array>] :identities
|
3248
|
-
# The
|
3249
|
-
#
|
3252
|
+
# The QuickSight users, groups, or both that you want to assign the
|
3253
|
+
# policy to.
|
3250
3254
|
#
|
3251
3255
|
# @option params [required, String] :namespace
|
3252
3256
|
# The namespace that contains the assignment.
|
@@ -3360,19 +3364,19 @@ module Aws::QuickSight
|
|
3360
3364
|
# (Enterprise edition only) Creates a new namespace for you to use with
|
3361
3365
|
# Amazon QuickSight.
|
3362
3366
|
#
|
3363
|
-
# A namespace allows you to isolate the
|
3364
|
-
#
|
3365
|
-
#
|
3366
|
-
#
|
3367
|
-
#
|
3368
|
-
#
|
3369
|
-
#
|
3370
|
-
#
|
3371
|
-
#
|
3367
|
+
# A namespace allows you to isolate the QuickSight users and groups that
|
3368
|
+
# are registered for that namespace. Users that access the namespace can
|
3369
|
+
# share assets only with other users or groups in the same namespace.
|
3370
|
+
# They can't see users and groups in other namespaces. You can create a
|
3371
|
+
# namespace after your Amazon Web Services account is subscribed to
|
3372
|
+
# QuickSight. The namespace must be unique within the Amazon Web
|
3373
|
+
# Services account. By default, there is a limit of 100 namespaces per
|
3374
|
+
# Amazon Web Services account. To increase your limit, create a ticket
|
3375
|
+
# with Amazon Web Services Support.
|
3372
3376
|
#
|
3373
3377
|
# @option params [required, String] :aws_account_id
|
3374
3378
|
# The ID for the Amazon Web Services account that you want to create the
|
3375
|
-
#
|
3379
|
+
# QuickSight namespace in.
|
3376
3380
|
#
|
3377
3381
|
# @option params [required, String] :namespace
|
3378
3382
|
# The name that you want to use to describe the new namespace.
|
@@ -3485,8 +3489,8 @@ module Aws::QuickSight
|
|
3485
3489
|
req.send_request(options)
|
3486
3490
|
end
|
3487
3491
|
|
3488
|
-
# Use `CreateRoleMembership` to add an existing
|
3489
|
-
#
|
3492
|
+
# Use `CreateRoleMembership` to add an existing QuickSight group to an
|
3493
|
+
# existing role.
|
3490
3494
|
#
|
3491
3495
|
# @option params [required, String] :member_name
|
3492
3496
|
# The name of the group that you want to add to the role.
|
@@ -3532,13 +3536,12 @@ module Aws::QuickSight
|
|
3532
3536
|
end
|
3533
3537
|
|
3534
3538
|
# Creates a template either from a `TemplateDefinition` or from an
|
3535
|
-
# existing
|
3536
|
-
#
|
3537
|
-
# analyses.
|
3539
|
+
# existing QuickSight analysis or template. You can use the resulting
|
3540
|
+
# template to create additional dashboards, templates, or analyses.
|
3538
3541
|
#
|
3539
|
-
# A *template* is an entity in
|
3540
|
-
#
|
3541
|
-
#
|
3542
|
+
# A *template* is an entity in QuickSight that encapsulates the metadata
|
3543
|
+
# required to create an analysis and that you can use to create s
|
3544
|
+
# dashboard. A template adds a layer of abstraction by using
|
3542
3545
|
# placeholders to replace the dataset associated with the analysis. You
|
3543
3546
|
# can use templates to create dashboards by replacing dataset
|
3544
3547
|
# placeholders with datasets that follow the same schema that was used
|
@@ -3568,7 +3571,7 @@ module Aws::QuickSight
|
|
3568
3571
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
3569
3572
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
3570
3573
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
3571
|
-
# any
|
3574
|
+
# any QuickSight-supported Amazon Web Services Region.
|
3572
3575
|
#
|
3573
3576
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
3574
3577
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -3642,7 +3645,7 @@ module Aws::QuickSight
|
|
3642
3645
|
# @option params [required, String] :alias_name
|
3643
3646
|
# The name that you want to give to the template alias that you're
|
3644
3647
|
# creating. Don't start the alias name with the `$` character. Alias
|
3645
|
-
# names that start with `$` are reserved by
|
3648
|
+
# names that start with `$` are reserved by QuickSight.
|
3646
3649
|
#
|
3647
3650
|
# @option params [required, Integer] :template_version_number
|
3648
3651
|
# The version number of the template.
|
@@ -3923,7 +3926,7 @@ module Aws::QuickSight
|
|
3923
3926
|
# filter_name: "LimitedString", # required
|
3924
3927
|
# filter_synonyms: ["LimitedString"],
|
3925
3928
|
# operand_field_name: "LimitedString", # required
|
3926
|
-
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
|
3929
|
+
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, NULL_FILTER
|
3927
3930
|
# category_filter: {
|
3928
3931
|
# category_filter_function: "EXACT", # accepts EXACT, CONTAINS
|
3929
3932
|
# category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
|
@@ -3972,6 +3975,14 @@ module Aws::QuickSight
|
|
3972
3975
|
# singular_constant: "LimitedString",
|
3973
3976
|
# },
|
3974
3977
|
# },
|
3978
|
+
# null_filter: {
|
3979
|
+
# null_filter_type: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
|
3980
|
+
# constant: {
|
3981
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
3982
|
+
# singular_constant: "LimitedString",
|
3983
|
+
# },
|
3984
|
+
# inverse: false,
|
3985
|
+
# },
|
3975
3986
|
# },
|
3976
3987
|
# ],
|
3977
3988
|
# columns: [
|
@@ -4292,18 +4303,48 @@ module Aws::QuickSight
|
|
4292
4303
|
req.send_request(options)
|
4293
4304
|
end
|
4294
4305
|
|
4306
|
+
# Unapplies a custom permissions profile from an account.
|
4307
|
+
#
|
4308
|
+
# @option params [required, String] :aws_account_id
|
4309
|
+
# The ID of the Amazon Web Services account from which you want to
|
4310
|
+
# unapply the custom permissions profile.
|
4311
|
+
#
|
4312
|
+
# @return [Types::DeleteAccountCustomPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4313
|
+
#
|
4314
|
+
# * {Types::DeleteAccountCustomPermissionResponse#request_id #request_id} => String
|
4315
|
+
# * {Types::DeleteAccountCustomPermissionResponse#status #status} => Integer
|
4316
|
+
#
|
4317
|
+
# @example Request syntax with placeholder values
|
4318
|
+
#
|
4319
|
+
# resp = client.delete_account_custom_permission({
|
4320
|
+
# aws_account_id: "AwsAccountId", # required
|
4321
|
+
# })
|
4322
|
+
#
|
4323
|
+
# @example Response structure
|
4324
|
+
#
|
4325
|
+
# resp.request_id #=> String
|
4326
|
+
# resp.status #=> Integer
|
4327
|
+
#
|
4328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomPermission AWS API Documentation
|
4329
|
+
#
|
4330
|
+
# @overload delete_account_custom_permission(params = {})
|
4331
|
+
# @param [Hash] params ({})
|
4332
|
+
def delete_account_custom_permission(params = {}, options = {})
|
4333
|
+
req = build_request(:delete_account_custom_permission, params)
|
4334
|
+
req.send_request(options)
|
4335
|
+
end
|
4336
|
+
|
4295
4337
|
# Deletes all Amazon QuickSight customizations in this Amazon Web
|
4296
4338
|
# Services Region for the specified Amazon Web Services account and
|
4297
|
-
#
|
4339
|
+
# QuickSight namespace.
|
4298
4340
|
#
|
4299
4341
|
# @option params [required, String] :aws_account_id
|
4300
4342
|
# The ID for the Amazon Web Services account that you want to delete
|
4301
|
-
#
|
4302
|
-
# Region.
|
4343
|
+
# QuickSight customizations from in this Amazon Web Services Region.
|
4303
4344
|
#
|
4304
4345
|
# @option params [String] :namespace
|
4305
|
-
# The
|
4306
|
-
#
|
4346
|
+
# The QuickSight namespace that you're deleting the customizations
|
4347
|
+
# from.
|
4307
4348
|
#
|
4308
4349
|
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4309
4350
|
#
|
@@ -4331,10 +4372,10 @@ module Aws::QuickSight
|
|
4331
4372
|
req.send_request(options)
|
4332
4373
|
end
|
4333
4374
|
|
4334
|
-
# Use the `DeleteAccountSubscription` operation to delete an
|
4335
|
-
#
|
4336
|
-
#
|
4337
|
-
#
|
4375
|
+
# Use the `DeleteAccountSubscription` operation to delete an QuickSight
|
4376
|
+
# account. This operation will result in an error message if you have
|
4377
|
+
# configured your account termination protection settings to `True`. To
|
4378
|
+
# change this setting and delete your account, call the
|
4338
4379
|
# `UpdateAccountSettings` API and set the value of the
|
4339
4380
|
# `TerminationProtectionEnabled` parameter to `False`, then make another
|
4340
4381
|
# call to the `DeleteAccountSubscription` API.
|
@@ -4371,10 +4412,9 @@ module Aws::QuickSight
|
|
4371
4412
|
# Deletes an analysis from Amazon QuickSight. You can optionally include
|
4372
4413
|
# a recovery window during which you can restore the analysis. If you
|
4373
4414
|
# don't specify a recovery window value, the operation defaults to 30
|
4374
|
-
# days.
|
4375
|
-
#
|
4376
|
-
#
|
4377
|
-
# permanently.
|
4415
|
+
# days. QuickSight attaches a `DeletionTime` stamp to the response that
|
4416
|
+
# specifies the end of the recovery window. At the end of the recovery
|
4417
|
+
# window, QuickSight deletes the analysis permanently.
|
4378
4418
|
#
|
4379
4419
|
# At any time before recovery window ends, you can use the
|
4380
4420
|
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
@@ -4383,9 +4423,8 @@ module Aws::QuickSight
|
|
4383
4423
|
# make a template from it.
|
4384
4424
|
#
|
4385
4425
|
# An analysis that's scheduled for deletion isn't accessible in the
|
4386
|
-
#
|
4387
|
-
#
|
4388
|
-
# from it.
|
4426
|
+
# QuickSight console. To access it in the console, restore it. Deleting
|
4427
|
+
# an analysis doesn't delete the dashboards that you publish from it.
|
4389
4428
|
#
|
4390
4429
|
# @option params [required, String] :aws_account_id
|
4391
4430
|
# The ID of the Amazon Web Services account where you want to delete an
|
@@ -4395,8 +4434,8 @@ module Aws::QuickSight
|
|
4395
4434
|
# The ID of the analysis that you're deleting.
|
4396
4435
|
#
|
4397
4436
|
# @option params [Integer] :recovery_window_in_days
|
4398
|
-
# A value that specifies the number of days that
|
4399
|
-
#
|
4437
|
+
# A value that specifies the number of days that QuickSight waits before
|
4438
|
+
# it deletes the analysis. You can't use this parameter with the
|
4400
4439
|
# `ForceDeleteWithoutRecovery` option in the same API call. The default
|
4401
4440
|
# value is 30.
|
4402
4441
|
#
|
@@ -4439,13 +4478,13 @@ module Aws::QuickSight
|
|
4439
4478
|
req.send_request(options)
|
4440
4479
|
end
|
4441
4480
|
|
4442
|
-
# Deletes an
|
4481
|
+
# Deletes an QuickSight brand.
|
4443
4482
|
#
|
4444
4483
|
# @option params [required, String] :aws_account_id
|
4445
4484
|
# The ID of the Amazon Web Services account that owns the brand.
|
4446
4485
|
#
|
4447
4486
|
# @option params [required, String] :brand_id
|
4448
|
-
# The ID of the
|
4487
|
+
# The ID of the QuickSight brand.
|
4449
4488
|
#
|
4450
4489
|
# @return [Types::DeleteBrandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4451
4490
|
#
|
@@ -4694,19 +4733,18 @@ module Aws::QuickSight
|
|
4694
4733
|
req.send_request(options)
|
4695
4734
|
end
|
4696
4735
|
|
4697
|
-
# Deletes a linked Amazon Q Business application from an
|
4698
|
-
#
|
4736
|
+
# Deletes a linked Amazon Q Business application from an QuickSight
|
4737
|
+
# account
|
4699
4738
|
#
|
4700
4739
|
# @option params [required, String] :aws_account_id
|
4701
|
-
# The ID of the
|
4702
|
-
#
|
4740
|
+
# The ID of the QuickSight account that you want to disconnect from a
|
4741
|
+
# Amazon Q Business application.
|
4703
4742
|
#
|
4704
4743
|
# @option params [String] :namespace
|
4705
|
-
# The
|
4706
|
-
#
|
4707
|
-
#
|
4708
|
-
#
|
4709
|
-
# parameter.
|
4744
|
+
# The QuickSight namespace that you want to delete a linked Amazon Q
|
4745
|
+
# Business application from. If this field is left blank, the Amazon Q
|
4746
|
+
# Business application is deleted from the default namespace. Currently,
|
4747
|
+
# the default namespace is the only valid value for this parameter.
|
4710
4748
|
#
|
4711
4749
|
# @return [Types::DeleteDefaultQBusinessApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4712
4750
|
#
|
@@ -4943,11 +4981,10 @@ module Aws::QuickSight
|
|
4943
4981
|
end
|
4944
4982
|
|
4945
4983
|
# Deletes all access scopes and authorized targets that are associated
|
4946
|
-
# with a service from the
|
4947
|
-
# application.
|
4984
|
+
# with a service from the QuickSight IAM Identity Center application.
|
4948
4985
|
#
|
4949
|
-
# This operation is only supported for
|
4950
|
-
#
|
4986
|
+
# This operation is only supported for QuickSight accounts that use IAM
|
4987
|
+
# Identity Center.
|
4951
4988
|
#
|
4952
4989
|
# @option params [required, String] :aws_account_id
|
4953
4990
|
# The ID of the Amazon Web Services account that you want to delete an
|
@@ -4991,7 +5028,7 @@ module Aws::QuickSight
|
|
4991
5028
|
#
|
4992
5029
|
# @option params [required, String] :aws_account_id
|
4993
5030
|
# The ID for the Amazon Web Services account that you want to delete the
|
4994
|
-
#
|
5031
|
+
# QuickSight namespace from.
|
4995
5032
|
#
|
4996
5033
|
# @option params [required, String] :namespace
|
4997
5034
|
# The namespace that you want to delete.
|
@@ -5589,11 +5626,45 @@ module Aws::QuickSight
|
|
5589
5626
|
req.send_request(options)
|
5590
5627
|
end
|
5591
5628
|
|
5629
|
+
# Describes the custom permissions profile that is applied to an
|
5630
|
+
# account.
|
5631
|
+
#
|
5632
|
+
# @option params [required, String] :aws_account_id
|
5633
|
+
# The ID of the Amazon Web Services account for which you want to
|
5634
|
+
# describe the applied custom permissions profile.
|
5635
|
+
#
|
5636
|
+
# @return [Types::DescribeAccountCustomPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5637
|
+
#
|
5638
|
+
# * {Types::DescribeAccountCustomPermissionResponse#custom_permissions_name #custom_permissions_name} => String
|
5639
|
+
# * {Types::DescribeAccountCustomPermissionResponse#request_id #request_id} => String
|
5640
|
+
# * {Types::DescribeAccountCustomPermissionResponse#status #status} => Integer
|
5641
|
+
#
|
5642
|
+
# @example Request syntax with placeholder values
|
5643
|
+
#
|
5644
|
+
# resp = client.describe_account_custom_permission({
|
5645
|
+
# aws_account_id: "AwsAccountId", # required
|
5646
|
+
# })
|
5647
|
+
#
|
5648
|
+
# @example Response structure
|
5649
|
+
#
|
5650
|
+
# resp.custom_permissions_name #=> String
|
5651
|
+
# resp.request_id #=> String
|
5652
|
+
# resp.status #=> Integer
|
5653
|
+
#
|
5654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomPermission AWS API Documentation
|
5655
|
+
#
|
5656
|
+
# @overload describe_account_custom_permission(params = {})
|
5657
|
+
# @param [Hash] params ({})
|
5658
|
+
def describe_account_custom_permission(params = {}, options = {})
|
5659
|
+
req = build_request(:describe_account_custom_permission, params)
|
5660
|
+
req.send_request(options)
|
5661
|
+
end
|
5662
|
+
|
5592
5663
|
# Describes the customizations associated with the provided Amazon Web
|
5593
|
-
# Services account and Amazon
|
5594
|
-
#
|
5595
|
-
#
|
5596
|
-
#
|
5664
|
+
# Services account and Amazon QuickSight namespace in an Amazon Web
|
5665
|
+
# Services Region. The QuickSight console evaluates which customizations
|
5666
|
+
# to apply by running this API operation with the `Resolved` flag
|
5667
|
+
# included.
|
5597
5668
|
#
|
5598
5669
|
# To determine what customizations display when you run this command, it
|
5599
5670
|
# can help to visualize the relationship of the entities involved.
|
@@ -5601,18 +5672,18 @@ module Aws::QuickSight
|
|
5601
5672
|
# * `Amazon Web Services account` - The Amazon Web Services account
|
5602
5673
|
# exists at the top of the hierarchy. It has the potential to use all
|
5603
5674
|
# of the Amazon Web Services Regions and Amazon Web Services Services.
|
5604
|
-
# When you subscribe to
|
5605
|
-
#
|
5606
|
-
#
|
5607
|
-
#
|
5675
|
+
# When you subscribe to QuickSight, you choose one Amazon Web Services
|
5676
|
+
# Region to use as your home Region. That's where your free SPICE
|
5677
|
+
# capacity is located. You can use QuickSight in any supported Amazon
|
5678
|
+
# Web Services Region.
|
5608
5679
|
#
|
5609
5680
|
# * `Amazon Web Services Region` - In each Amazon Web Services Region
|
5610
|
-
# where you sign in to
|
5611
|
-
#
|
5612
|
-
#
|
5613
|
-
#
|
5614
|
-
#
|
5615
|
-
#
|
5681
|
+
# where you sign in to QuickSight at least once, QuickSight acts as a
|
5682
|
+
# separate instance of the same service. If you have a user directory,
|
5683
|
+
# it resides in us-east-1, which is the US East (N. Virginia).
|
5684
|
+
# Generally speaking, these users have access to QuickSight in any
|
5685
|
+
# Amazon Web Services Region, unless they are constrained to a
|
5686
|
+
# namespace.
|
5616
5687
|
#
|
5617
5688
|
# To run the command in a different Amazon Web Services Region, you
|
5618
5689
|
# change your Region settings. If you're using the CLI, you can use
|
@@ -5634,11 +5705,11 @@ module Aws::QuickSight
|
|
5634
5705
|
# and Amazon Web Services Region.
|
5635
5706
|
#
|
5636
5707
|
# * `Applied customizations` - Within an Amazon Web Services Region, a
|
5637
|
-
# set of
|
5638
|
-
#
|
5639
|
-
#
|
5640
|
-
#
|
5641
|
-
#
|
5708
|
+
# set of QuickSight customizations can apply to an Amazon Web Services
|
5709
|
+
# account or to a namespace. Settings that you apply to a namespace
|
5710
|
+
# override settings that you apply to an Amazon Web Services account.
|
5711
|
+
# All settings are isolated to a single Amazon Web Services Region. To
|
5712
|
+
# apply them in other Amazon Web Services Regions, run the
|
5642
5713
|
# `CreateAccountCustomization` command in each Amazon Web Services
|
5643
5714
|
# Region where you want to apply the same customizations.
|
5644
5715
|
#
|
@@ -5650,19 +5721,19 @@ module Aws::QuickSight
|
|
5650
5721
|
#
|
5651
5722
|
# @option params [required, String] :aws_account_id
|
5652
5723
|
# The ID for the Amazon Web Services account that you want to describe
|
5653
|
-
#
|
5724
|
+
# QuickSight customizations for.
|
5654
5725
|
#
|
5655
5726
|
# @option params [String] :namespace
|
5656
|
-
# The
|
5657
|
-
#
|
5727
|
+
# The QuickSight namespace that you want to describe QuickSight
|
5728
|
+
# customizations for.
|
5658
5729
|
#
|
5659
5730
|
# @option params [Boolean] :resolved
|
5660
5731
|
# The `Resolved` flag works with the other parameters to determine which
|
5661
|
-
# view of
|
5662
|
-
#
|
5663
|
-
#
|
5664
|
-
#
|
5665
|
-
#
|
5732
|
+
# view of QuickSight customizations is returned. You can add this flag
|
5733
|
+
# to your command to use the same view that QuickSight uses to identify
|
5734
|
+
# which customizations to apply to the console. Omit this flag, or set
|
5735
|
+
# it to `no-resolved`, to reveal customizations that are configured at
|
5736
|
+
# different levels.
|
5666
5737
|
#
|
5667
5738
|
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5668
5739
|
#
|
@@ -5700,7 +5771,7 @@ module Aws::QuickSight
|
|
5700
5771
|
req.send_request(options)
|
5701
5772
|
end
|
5702
5773
|
|
5703
|
-
# Describes the settings that were used when your
|
5774
|
+
# Describes the settings that were used when your QuickSight
|
5704
5775
|
# subscription was first created in this Amazon Web Services account.
|
5705
5776
|
#
|
5706
5777
|
# @option params [required, String] :aws_account_id
|
@@ -5740,14 +5811,14 @@ module Aws::QuickSight
|
|
5740
5811
|
end
|
5741
5812
|
|
5742
5813
|
# Use the DescribeAccountSubscription operation to receive a description
|
5743
|
-
# of an
|
5814
|
+
# of an QuickSight account's subscription. A successful API call
|
5744
5815
|
# returns an `AccountInfo` object that includes an account's name,
|
5745
5816
|
# subscription status, authentication type, edition, and notification
|
5746
5817
|
# email address.
|
5747
5818
|
#
|
5748
5819
|
# @option params [required, String] :aws_account_id
|
5749
|
-
# The Amazon Web Services account ID associated with your
|
5750
|
-
#
|
5820
|
+
# The Amazon Web Services account ID associated with your QuickSight
|
5821
|
+
# account.
|
5751
5822
|
#
|
5752
5823
|
# @return [Types::DescribeAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5753
5824
|
#
|
@@ -6243,6 +6314,7 @@ module Aws::QuickSight
|
|
6243
6314
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.port #=> Integer
|
6244
6315
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.database #=> String
|
6245
6316
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
6317
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
|
6246
6318
|
# resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
6247
6319
|
# resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
6248
6320
|
# resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
|
@@ -6379,7 +6451,7 @@ module Aws::QuickSight
|
|
6379
6451
|
# The ID of the Amazon Web Services account that owns the brand.
|
6380
6452
|
#
|
6381
6453
|
# @option params [required, String] :brand_id
|
6382
|
-
# The ID of the
|
6454
|
+
# The ID of the QuickSight brand.
|
6383
6455
|
#
|
6384
6456
|
# @option params [String] :version_id
|
6385
6457
|
# The ID of the specific version. The default value is the latest
|
@@ -6506,7 +6578,7 @@ module Aws::QuickSight
|
|
6506
6578
|
# The ID of the Amazon Web Services account that owns the brand.
|
6507
6579
|
#
|
6508
6580
|
# @option params [required, String] :brand_id
|
6509
|
-
# The ID of the
|
6581
|
+
# The ID of the QuickSight brand.
|
6510
6582
|
#
|
6511
6583
|
# @return [Types::DescribeBrandPublishedVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6512
6584
|
#
|
@@ -6641,6 +6713,8 @@ module Aws::QuickSight
|
|
6641
6713
|
# resp.custom_permissions.capabilities.export_to_csv_in_scheduled_reports #=> String, one of "DENY"
|
6642
6714
|
# resp.custom_permissions.capabilities.export_to_excel_in_scheduled_reports #=> String, one of "DENY"
|
6643
6715
|
# resp.custom_permissions.capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
|
6716
|
+
# resp.custom_permissions.capabilities.dashboard #=> String, one of "DENY"
|
6717
|
+
# resp.custom_permissions.capabilities.analysis #=> String, one of "DENY"
|
6644
6718
|
# resp.request_id #=> String
|
6645
6719
|
#
|
6646
6720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeCustomPermissions AWS API Documentation
|
@@ -7346,7 +7420,7 @@ module Aws::QuickSight
|
|
7346
7420
|
# resp.data_source.arn #=> String
|
7347
7421
|
# resp.data_source.data_source_id #=> String
|
7348
7422
|
# resp.data_source.name #=> String
|
7349
|
-
# resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY"
|
7423
|
+
# resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS"
|
7350
7424
|
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
7351
7425
|
# resp.data_source.created_time #=> Time
|
7352
7426
|
# resp.data_source.last_updated_time #=> Time
|
@@ -7438,6 +7512,7 @@ module Aws::QuickSight
|
|
7438
7512
|
# resp.data_source.data_source_parameters.impala_parameters.port #=> Integer
|
7439
7513
|
# resp.data_source.data_source_parameters.impala_parameters.database #=> String
|
7440
7514
|
# resp.data_source.data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
7515
|
+
# resp.data_source.data_source_parameters.custom_connection_parameters.connection_type #=> String
|
7441
7516
|
# resp.data_source.alternate_data_source_parameters #=> Array
|
7442
7517
|
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
7443
7518
|
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -7527,6 +7602,7 @@ module Aws::QuickSight
|
|
7527
7602
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.port #=> Integer
|
7528
7603
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.database #=> String
|
7529
7604
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
|
7605
|
+
# resp.data_source.alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
|
7530
7606
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
7531
7607
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
7532
7608
|
# resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
@@ -7588,18 +7664,18 @@ module Aws::QuickSight
|
|
7588
7664
|
req.send_request(options)
|
7589
7665
|
end
|
7590
7666
|
|
7591
|
-
# Describes a Amazon Q Business application that is linked to an
|
7667
|
+
# Describes a Amazon Q Business application that is linked to an
|
7592
7668
|
# QuickSight account.
|
7593
7669
|
#
|
7594
7670
|
# @option params [required, String] :aws_account_id
|
7595
|
-
# The ID of the
|
7671
|
+
# The ID of the QuickSight account that is linked to the Amazon Q
|
7596
7672
|
# Business application that you want described.
|
7597
7673
|
#
|
7598
7674
|
# @option params [String] :namespace
|
7599
|
-
# The
|
7600
|
-
#
|
7601
|
-
#
|
7602
|
-
#
|
7675
|
+
# The QuickSight namespace that contains the linked Amazon Q Business
|
7676
|
+
# application. If this field is left blank, the default namespace is
|
7677
|
+
# used. Currently, the default namespace is the only valid value for
|
7678
|
+
# this parameter.
|
7603
7679
|
#
|
7604
7680
|
# @return [Types::DescribeDefaultQBusinessApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7605
7681
|
#
|
@@ -8034,8 +8110,8 @@ module Aws::QuickSight
|
|
8034
8110
|
req.send_request(options)
|
8035
8111
|
end
|
8036
8112
|
|
8037
|
-
# Describes all customer managed key registrations in a
|
8038
|
-
#
|
8113
|
+
# Describes all customer managed key registrations in a QuickSight
|
8114
|
+
# account.
|
8039
8115
|
#
|
8040
8116
|
# @option params [required, String] :aws_account_id
|
8041
8117
|
# The ID of the Amazon Web Services account that contains the customer
|
@@ -8048,6 +8124,7 @@ module Aws::QuickSight
|
|
8048
8124
|
#
|
8049
8125
|
# * {Types::DescribeKeyRegistrationResponse#aws_account_id #aws_account_id} => String
|
8050
8126
|
# * {Types::DescribeKeyRegistrationResponse#key_registration #key_registration} => Array<Types::RegisteredCustomerManagedKey>
|
8127
|
+
# * {Types::DescribeKeyRegistrationResponse#q_data_key #q_data_key} => Types::QDataKey
|
8051
8128
|
# * {Types::DescribeKeyRegistrationResponse#request_id #request_id} => String
|
8052
8129
|
# * {Types::DescribeKeyRegistrationResponse#status #status} => Integer
|
8053
8130
|
#
|
@@ -8064,6 +8141,8 @@ module Aws::QuickSight
|
|
8064
8141
|
# resp.key_registration #=> Array
|
8065
8142
|
# resp.key_registration[0].key_arn #=> String
|
8066
8143
|
# resp.key_registration[0].default_key #=> Boolean
|
8144
|
+
# resp.q_data_key.q_data_key_arn #=> String
|
8145
|
+
# resp.q_data_key.q_data_key_type #=> String, one of "AWS_OWNED", "CMK"
|
8067
8146
|
# resp.request_id #=> String
|
8068
8147
|
# resp.status #=> Integer
|
8069
8148
|
#
|
@@ -8079,7 +8158,7 @@ module Aws::QuickSight
|
|
8079
8158
|
# Describes the current namespace.
|
8080
8159
|
#
|
8081
8160
|
# @option params [required, String] :aws_account_id
|
8082
|
-
# The ID for the Amazon Web Services account that contains the
|
8161
|
+
# The ID for the Amazon Web Services account that contains the
|
8083
8162
|
# QuickSight namespace that you want to describe.
|
8084
8163
|
#
|
8085
8164
|
# @option params [required, String] :namespace
|
@@ -8154,11 +8233,11 @@ module Aws::QuickSight
|
|
8154
8233
|
req.send_request(options)
|
8155
8234
|
end
|
8156
8235
|
|
8157
|
-
# Describes the state of a
|
8236
|
+
# Describes the state of a QuickSight Q Search configuration.
|
8158
8237
|
#
|
8159
8238
|
# @option params [required, String] :aws_account_id
|
8160
|
-
# The ID of the Amazon Web Services account that contains the
|
8161
|
-
#
|
8239
|
+
# The ID of the Amazon Web Services account that contains the QuickSight
|
8240
|
+
# Q Search configuration that the user wants described.
|
8162
8241
|
#
|
8163
8242
|
# @return [Types::DescribeQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8164
8243
|
#
|
@@ -8766,7 +8845,7 @@ module Aws::QuickSight
|
|
8766
8845
|
# resp.topic.data_sets[0].filters[0].filter_synonyms #=> Array
|
8767
8846
|
# resp.topic.data_sets[0].filters[0].filter_synonyms[0] #=> String
|
8768
8847
|
# resp.topic.data_sets[0].filters[0].operand_field_name #=> String
|
8769
|
-
# resp.topic.data_sets[0].filters[0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER"
|
8848
|
+
# resp.topic.data_sets[0].filters[0].filter_type #=> String, one of "CATEGORY_FILTER", "NUMERIC_EQUALITY_FILTER", "NUMERIC_RANGE_FILTER", "DATE_RANGE_FILTER", "RELATIVE_DATE_FILTER", "NULL_FILTER"
|
8770
8849
|
# resp.topic.data_sets[0].filters[0].category_filter.category_filter_function #=> String, one of "EXACT", "CONTAINS"
|
8771
8850
|
# resp.topic.data_sets[0].filters[0].category_filter.category_filter_type #=> String, one of "CUSTOM_FILTER", "CUSTOM_FILTER_LIST", "FILTER_LIST"
|
8772
8851
|
# resp.topic.data_sets[0].filters[0].category_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
@@ -8790,6 +8869,10 @@ module Aws::QuickSight
|
|
8790
8869
|
# resp.topic.data_sets[0].filters[0].relative_date_filter.relative_date_filter_function #=> String, one of "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
|
8791
8870
|
# resp.topic.data_sets[0].filters[0].relative_date_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
8792
8871
|
# resp.topic.data_sets[0].filters[0].relative_date_filter.constant.singular_constant #=> String
|
8872
|
+
# resp.topic.data_sets[0].filters[0].null_filter.null_filter_type #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
|
8873
|
+
# resp.topic.data_sets[0].filters[0].null_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
|
8874
|
+
# resp.topic.data_sets[0].filters[0].null_filter.constant.singular_constant #=> String
|
8875
|
+
# resp.topic.data_sets[0].filters[0].null_filter.inverse #=> Boolean
|
8793
8876
|
# resp.topic.data_sets[0].columns #=> Array
|
8794
8877
|
# resp.topic.data_sets[0].columns[0].column_name #=> String
|
8795
8878
|
# resp.topic.data_sets[0].columns[0].column_friendly_name #=> String
|
@@ -9212,9 +9295,9 @@ module Aws::QuickSight
|
|
9212
9295
|
# \[15-600\] minutes range.
|
9213
9296
|
#
|
9214
9297
|
# @option params [required, String] :namespace
|
9215
|
-
# The
|
9216
|
-
#
|
9217
|
-
#
|
9298
|
+
# The QuickSight namespace that the anonymous user virtually belongs to.
|
9299
|
+
# If you are not using an Amazon QuickSight custom namespace, set this
|
9300
|
+
# to `default`.
|
9218
9301
|
#
|
9219
9302
|
# @option params [Array<Types::SessionTag>] :session_tags
|
9220
9303
|
# The session tags used for row-level security. Before you use this
|
@@ -9231,9 +9314,8 @@ module Aws::QuickSight
|
|
9231
9314
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
9232
9315
|
#
|
9233
9316
|
# @option params [required, Array<String>] :authorized_resource_arns
|
9234
|
-
# The Amazon Resource Names (ARNs) for the
|
9235
|
-
#
|
9236
|
-
# session.
|
9317
|
+
# The Amazon Resource Names (ARNs) for the QuickSight resources that the
|
9318
|
+
# user is authorized to access during the lifetime of the session.
|
9237
9319
|
#
|
9238
9320
|
# If you choose `Dashboard` embedding experience, pass the list of
|
9239
9321
|
# dashboard ARNs in the account that you want the user to be able to
|
@@ -9251,9 +9333,9 @@ module Aws::QuickSight
|
|
9251
9333
|
# The domains that you want to add to the allow list for access to the
|
9252
9334
|
# generated URL that is then embedded. This optional parameter overrides
|
9253
9335
|
# the static domains that are configured in the Manage QuickSight menu
|
9254
|
-
# in the
|
9255
|
-
#
|
9256
|
-
#
|
9336
|
+
# in the QuickSight console. Instead, it allows only the domains that
|
9337
|
+
# you include in this parameter. You can list up to three domains or
|
9338
|
+
# subdomains in each API call.
|
9257
9339
|
#
|
9258
9340
|
# To include all subdomains under a specific domain to the allow list,
|
9259
9341
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
@@ -9370,17 +9452,17 @@ module Aws::QuickSight
|
|
9370
9452
|
#
|
9371
9453
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
9372
9454
|
# The experience that you want to embed. For registered users, you can
|
9373
|
-
# embed
|
9374
|
-
#
|
9375
|
-
#
|
9455
|
+
# embed QuickSight dashboards, QuickSight visuals, the QuickSight Q
|
9456
|
+
# search bar, the QuickSight Generative Q&A experience, or the
|
9457
|
+
# entire QuickSight console.
|
9376
9458
|
#
|
9377
9459
|
# @option params [Array<String>] :allowed_domains
|
9378
9460
|
# The domains that you want to add to the allow list for access to the
|
9379
9461
|
# generated URL that is then embedded. This optional parameter overrides
|
9380
9462
|
# the static domains that are configured in the Manage QuickSight menu
|
9381
|
-
# in the
|
9382
|
-
#
|
9383
|
-
#
|
9463
|
+
# in the QuickSight console. Instead, it allows only the domains that
|
9464
|
+
# you include in this parameter. You can list up to three domains or
|
9465
|
+
# subdomains in each API call.
|
9384
9466
|
#
|
9385
9467
|
# To include all subdomains under a specific domain to the allow list,
|
9386
9468
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
@@ -9493,9 +9575,9 @@ module Aws::QuickSight
|
|
9493
9575
|
req.send_request(options)
|
9494
9576
|
end
|
9495
9577
|
|
9496
|
-
# Generates an embed URL that you can use to embed an
|
9578
|
+
# Generates an embed URL that you can use to embed an QuickSight
|
9497
9579
|
# experience in your website. This action can be used for any type of
|
9498
|
-
# user that is registered in an
|
9580
|
+
# user that is registered in an QuickSight account that uses IAM
|
9499
9581
|
# Identity Center for authentication. This API requires
|
9500
9582
|
# [identity-enhanced IAM Role sessions][1] for the authenticated user
|
9501
9583
|
# that the API call is being made for.
|
@@ -9504,9 +9586,9 @@ module Aws::QuickSight
|
|
9504
9586
|
# user is authenticated and receives the embed URL that is specific to
|
9505
9587
|
# that user. The IAM Identity Center application that the user has
|
9506
9588
|
# logged into needs to have [trusted Identity Propagation enabled for
|
9507
|
-
#
|
9508
|
-
#
|
9509
|
-
#
|
9589
|
+
# QuickSight][3] with the scope value set to `quicksight:read`. Before
|
9590
|
+
# you use this action, make sure that you have configured the relevant
|
9591
|
+
# QuickSight resource and permissions.
|
9510
9592
|
#
|
9511
9593
|
#
|
9512
9594
|
#
|
@@ -9522,8 +9604,7 @@ module Aws::QuickSight
|
|
9522
9604
|
#
|
9523
9605
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
9524
9606
|
# The type of experience you want to embed. For registered users, you
|
9525
|
-
# can embed
|
9526
|
-
# console.
|
9607
|
+
# can embed QuickSight dashboards or the QuickSight console.
|
9527
9608
|
#
|
9528
9609
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
9529
9610
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
@@ -9641,9 +9722,9 @@ module Aws::QuickSight
|
|
9641
9722
|
end
|
9642
9723
|
|
9643
9724
|
# Generates a temporary session URL and authorization code(bearer token)
|
9644
|
-
# that you can use to embed an
|
9645
|
-
#
|
9646
|
-
#
|
9725
|
+
# that you can use to embed an QuickSight read-only dashboard in your
|
9726
|
+
# website or application. Before you use this command, make sure that
|
9727
|
+
# you have configured the dashboards and permissions.
|
9647
9728
|
#
|
9648
9729
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
9649
9730
|
# not from the user's browser. The following rules apply to the
|
@@ -9656,7 +9737,7 @@ module Aws::QuickSight
|
|
9656
9737
|
# * They are valid for 5 minutes after you run this command.
|
9657
9738
|
#
|
9658
9739
|
# * You are charged only when the URL is used or there is interaction
|
9659
|
-
# with
|
9740
|
+
# with QuickSight.
|
9660
9741
|
#
|
9661
9742
|
# * The resulting user session is valid for 15 minutes (default) up to
|
9662
9743
|
# 10 hours (maximum). You can use the optional
|
@@ -9701,11 +9782,11 @@ module Aws::QuickSight
|
|
9701
9782
|
# Adds persistence of state for the user session in an embedded
|
9702
9783
|
# dashboard. Persistence applies to the sheet and the parameter
|
9703
9784
|
# settings. These are control settings that the dashboard subscriber
|
9704
|
-
# (
|
9705
|
-
#
|
9706
|
-
#
|
9707
|
-
#
|
9708
|
-
#
|
9785
|
+
# (QuickSight reader) chooses while viewing the dashboard. If this is
|
9786
|
+
# set to `TRUE`, the settings are the same when the subscriber reopens
|
9787
|
+
# the same dashboard URL. The state is stored in QuickSight, not in a
|
9788
|
+
# browser cookie. If this is set to FALSE, the state of the user session
|
9789
|
+
# is not persisted. The default is `FALSE`.
|
9709
9790
|
#
|
9710
9791
|
# @option params [String] :user_arn
|
9711
9792
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -9725,18 +9806,17 @@ module Aws::QuickSight
|
|
9725
9806
|
# role-based sessions.
|
9726
9807
|
#
|
9727
9808
|
# @option params [String] :namespace
|
9728
|
-
# The
|
9729
|
-
#
|
9730
|
-
#
|
9809
|
+
# The QuickSight namespace that contains the dashboard IDs in this
|
9810
|
+
# request. If you're not using a custom namespace, set `Namespace =
|
9811
|
+
# default`.
|
9731
9812
|
#
|
9732
9813
|
# @option params [Array<String>] :additional_dashboard_ids
|
9733
9814
|
# A list of one or more dashboard IDs that you want anonymous users to
|
9734
9815
|
# have tempporary access to. Currently, the `IdentityType` parameter
|
9735
9816
|
# must be set to `ANONYMOUS` because other identity types authenticate
|
9736
|
-
# as
|
9737
|
-
#
|
9738
|
-
#
|
9739
|
-
# dashboards.
|
9817
|
+
# as QuickSight or IAM users. For example, if you set "`--dashboard-id
|
9818
|
+
# dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS`",
|
9819
|
+
# the session can access all three dashboards.
|
9740
9820
|
#
|
9741
9821
|
# @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9742
9822
|
#
|
@@ -9775,14 +9855,14 @@ module Aws::QuickSight
|
|
9775
9855
|
end
|
9776
9856
|
|
9777
9857
|
# Generates a session URL and authorization code that you can use to
|
9778
|
-
# embed the Amazon
|
9779
|
-
#
|
9858
|
+
# embed the Amazon QuickSight console in your web server code. Use
|
9859
|
+
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
9780
9860
|
# that allows users to create data sources, datasets, analyses, and
|
9781
|
-
# dashboards. The users who access an embedded
|
9782
|
-
#
|
9783
|
-
#
|
9784
|
-
#
|
9785
|
-
#
|
9861
|
+
# dashboards. The users who access an embedded QuickSight console need
|
9862
|
+
# belong to the author or admin security cohort. If you want to restrict
|
9863
|
+
# permissions to some of these features, add a custom permissions
|
9864
|
+
# profile to the user with the ` UpdateUser ` API operation. Use `
|
9865
|
+
# RegisterUser ` API operation to add a new user with a custom
|
9786
9866
|
# permission profile attached. For more information, see the following
|
9787
9867
|
# sections in the *Amazon QuickSight User Guide*:
|
9788
9868
|
#
|
@@ -9796,7 +9876,7 @@ module Aws::QuickSight
|
|
9796
9876
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
9797
9877
|
#
|
9798
9878
|
# @option params [required, String] :aws_account_id
|
9799
|
-
# The ID for the Amazon Web Services account associated with your
|
9879
|
+
# The ID for the Amazon Web Services account associated with your
|
9800
9880
|
# QuickSight subscription.
|
9801
9881
|
#
|
9802
9882
|
# @option params [String] :entry_point
|
@@ -9812,10 +9892,10 @@ module Aws::QuickSight
|
|
9812
9892
|
# * `/start/favorites`
|
9813
9893
|
#
|
9814
9894
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
9815
|
-
# key from the
|
9895
|
+
# key from the QuickSight console URL of the dashboard
|
9816
9896
|
#
|
9817
9897
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
9818
|
-
# from the
|
9898
|
+
# from the QuickSight console URL of the analysis
|
9819
9899
|
#
|
9820
9900
|
# @option params [Integer] :session_lifetime_in_minutes
|
9821
9901
|
# How many minutes the session is valid. The session lifetime must be
|
@@ -10032,7 +10112,7 @@ module Aws::QuickSight
|
|
10032
10112
|
req.send_request(options)
|
10033
10113
|
end
|
10034
10114
|
|
10035
|
-
# Lists all brands in an
|
10115
|
+
# Lists all brands in an QuickSight account.
|
10036
10116
|
#
|
10037
10117
|
# @option params [required, String] :aws_account_id
|
10038
10118
|
# The ID of the Amazon Web Services account that owns the brands that
|
@@ -10140,6 +10220,8 @@ module Aws::QuickSight
|
|
10140
10220
|
# resp.custom_permissions_list[0].capabilities.export_to_csv_in_scheduled_reports #=> String, one of "DENY"
|
10141
10221
|
# resp.custom_permissions_list[0].capabilities.export_to_excel_in_scheduled_reports #=> String, one of "DENY"
|
10142
10222
|
# resp.custom_permissions_list[0].capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
|
10223
|
+
# resp.custom_permissions_list[0].capabilities.dashboard #=> String, one of "DENY"
|
10224
|
+
# resp.custom_permissions_list[0].capabilities.analysis #=> String, one of "DENY"
|
10143
10225
|
# resp.next_token #=> String
|
10144
10226
|
# resp.request_id #=> String
|
10145
10227
|
#
|
@@ -10152,7 +10234,7 @@ module Aws::QuickSight
|
|
10152
10234
|
req.send_request(options)
|
10153
10235
|
end
|
10154
10236
|
|
10155
|
-
# Lists all the versions of the dashboards in the
|
10237
|
+
# Lists all the versions of the dashboards in the QuickSight
|
10156
10238
|
# subscription.
|
10157
10239
|
#
|
10158
10240
|
# @option params [required, String] :aws_account_id
|
@@ -10361,7 +10443,7 @@ module Aws::QuickSight
|
|
10361
10443
|
# resp.data_sources[0].arn #=> String
|
10362
10444
|
# resp.data_sources[0].data_source_id #=> String
|
10363
10445
|
# resp.data_sources[0].name #=> String
|
10364
|
-
# resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY"
|
10446
|
+
# resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS"
|
10365
10447
|
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
10366
10448
|
# resp.data_sources[0].created_time #=> Time
|
10367
10449
|
# resp.data_sources[0].last_updated_time #=> Time
|
@@ -10453,6 +10535,7 @@ module Aws::QuickSight
|
|
10453
10535
|
# resp.data_sources[0].data_source_parameters.impala_parameters.port #=> Integer
|
10454
10536
|
# resp.data_sources[0].data_source_parameters.impala_parameters.database #=> String
|
10455
10537
|
# resp.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
10538
|
+
# resp.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
|
10456
10539
|
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
10457
10540
|
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
10458
10541
|
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -10542,6 +10625,7 @@ module Aws::QuickSight
|
|
10542
10625
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.port #=> Integer
|
10543
10626
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.database #=> String
|
10544
10627
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
|
10628
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
|
10545
10629
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
10546
10630
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
10547
10631
|
# resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
@@ -10939,11 +11023,11 @@ module Aws::QuickSight
|
|
10939
11023
|
req.send_request(options)
|
10940
11024
|
end
|
10941
11025
|
|
10942
|
-
# Lists all services and authorized targets that the
|
10943
|
-
#
|
11026
|
+
# Lists all services and authorized targets that the QuickSight IAM
|
11027
|
+
# Identity Center application can access.
|
10944
11028
|
#
|
10945
|
-
# This operation is only supported for
|
10946
|
-
#
|
11029
|
+
# This operation is only supported for QuickSight accounts that use IAM
|
11030
|
+
# Identity Center.
|
10947
11031
|
#
|
10948
11032
|
# @option params [required, String] :aws_account_id
|
10949
11033
|
# The ID of the Amazon Web Services account that contain the identity
|
@@ -11059,7 +11143,7 @@ module Aws::QuickSight
|
|
11059
11143
|
# This operation doesn't list deleted namespaces.
|
11060
11144
|
#
|
11061
11145
|
# @option params [required, String] :aws_account_id
|
11062
|
-
# The ID for the Amazon Web Services account that contains the
|
11146
|
+
# The ID for the Amazon Web Services account that contains the
|
11063
11147
|
# QuickSight namespaces that you want to list.
|
11064
11148
|
#
|
11065
11149
|
# @option params [String] :next_token
|
@@ -11544,7 +11628,7 @@ module Aws::QuickSight
|
|
11544
11628
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
11545
11629
|
# QuickSight.
|
11546
11630
|
#
|
11547
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
11631
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
11548
11632
|
# QuickSight.
|
11549
11633
|
#
|
11550
11634
|
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -12356,9 +12440,9 @@ module Aws::QuickSight
|
|
12356
12440
|
# user is authenticated and receives the embed URL that is specific to
|
12357
12441
|
# that user. The IAM Identity Center application that the user has
|
12358
12442
|
# logged into needs to have [trusted Identity Propagation enabled for
|
12359
|
-
#
|
12360
|
-
#
|
12361
|
-
#
|
12443
|
+
# QuickSight][2] with the scope value set to `quicksight:read`. Before
|
12444
|
+
# you use this action, make sure that you have configured the relevant
|
12445
|
+
# QuickSight resource and permissions.
|
12362
12446
|
#
|
12363
12447
|
# We recommend enabling the `QSearchStatus` API to unlock the full
|
12364
12448
|
# potential of `PredictQnA`. When `QSearchStatus` is enabled, it first
|
@@ -12510,23 +12594,22 @@ module Aws::QuickSight
|
|
12510
12594
|
|
12511
12595
|
# Creates an Amazon QuickSight user whose identity is associated with
|
12512
12596
|
# the Identity and Access Management (IAM) identity or role specified in
|
12513
|
-
# the request. When you register a new user from the
|
12514
|
-
#
|
12515
|
-
#
|
12516
|
-
#
|
12517
|
-
#
|
12518
|
-
#
|
12519
|
-
#
|
12520
|
-
#
|
12521
|
-
# QuickSight][1].
|
12597
|
+
# the request. When you register a new user from the QuickSight API,
|
12598
|
+
# QuickSight generates a registration URL. The user accesses this
|
12599
|
+
# registration URL to create their account. QuickSight doesn't send a
|
12600
|
+
# registration email to users who are registered from the QuickSight
|
12601
|
+
# API. If you want new users to receive a registration email, then add
|
12602
|
+
# those users in the QuickSight console. For more information on
|
12603
|
+
# registering a new user in the QuickSight console, see [ Inviting users
|
12604
|
+
# to access QuickSight][1].
|
12522
12605
|
#
|
12523
12606
|
#
|
12524
12607
|
#
|
12525
12608
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users
|
12526
12609
|
#
|
12527
12610
|
# @option params [required, String] :identity_type
|
12528
|
-
# The identity type that your
|
12529
|
-
#
|
12611
|
+
# The identity type that your QuickSight account uses to manage the
|
12612
|
+
# identity of users.
|
12530
12613
|
#
|
12531
12614
|
# @option params [required, String] :email
|
12532
12615
|
# The email address of the user that you want to register.
|
@@ -12544,9 +12627,9 @@ module Aws::QuickSight
|
|
12544
12627
|
# QuickSight settings.
|
12545
12628
|
#
|
12546
12629
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
12547
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
12548
|
-
#
|
12549
|
-
#
|
12630
|
+
# Reader role. Reader Pros have access to Amazon Q in QuickSight, can
|
12631
|
+
# build stories with Amazon Q, and can generate executive summaries
|
12632
|
+
# from dashboards.
|
12550
12633
|
#
|
12551
12634
|
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
12552
12635
|
# Author role. Author Pros can author dashboards with natural language
|
@@ -12609,17 +12692,16 @@ module Aws::QuickSight
|
|
12609
12692
|
#
|
12610
12693
|
# A set of custom permissions includes any combination of these
|
12611
12694
|
# restrictions. Currently, you need to create the profile names for
|
12612
|
-
# custom permission sets by using the
|
12613
|
-
#
|
12614
|
-
# permissions to a
|
12695
|
+
# custom permission sets by using the QuickSight console. Then, you use
|
12696
|
+
# the `RegisterUser` API operation to assign the named set of
|
12697
|
+
# permissions to a QuickSight user.
|
12615
12698
|
#
|
12616
|
-
#
|
12699
|
+
# QuickSight custom permissions are applied through IAM policies.
|
12617
12700
|
# Therefore, they override the permissions typically granted by
|
12618
|
-
# assigning
|
12619
|
-
#
|
12620
|
-
# pro, reader pro).
|
12701
|
+
# assigning QuickSight users to one of the default security cohorts in
|
12702
|
+
# QuickSight (admin, author, reader, admin pro, author pro, reader pro).
|
12621
12703
|
#
|
12622
|
-
# This feature is available only to
|
12704
|
+
# This feature is available only to QuickSight Enterprise edition
|
12623
12705
|
# subscriptions.
|
12624
12706
|
#
|
12625
12707
|
# @option params [String] :external_login_federation_provider_type
|
@@ -12639,10 +12721,10 @@ module Aws::QuickSight
|
|
12639
12721
|
#
|
12640
12722
|
# @option params [String] :custom_federation_provider_url
|
12641
12723
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
12642
|
-
# identity to let a user federate into
|
12643
|
-
#
|
12644
|
-
#
|
12645
|
-
#
|
12724
|
+
# identity to let a user federate into QuickSight with an associated
|
12725
|
+
# Identity and Access Management(IAM) role. This parameter should only
|
12726
|
+
# be used when `ExternalLoginFederationProviderType` parameter is set to
|
12727
|
+
# `CUSTOM_OIDC`.
|
12646
12728
|
#
|
12647
12729
|
# @option params [String] :external_login_id
|
12648
12730
|
# The identity ID for a user in the external login provider.
|
@@ -13008,7 +13090,7 @@ module Aws::QuickSight
|
|
13008
13090
|
# resp.data_source_summaries[0].arn #=> String
|
13009
13091
|
# resp.data_source_summaries[0].data_source_id #=> String
|
13010
13092
|
# resp.data_source_summaries[0].name #=> String
|
13011
|
-
# resp.data_source_summaries[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY"
|
13093
|
+
# resp.data_source_summaries[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL", "DATABRICKS", "STARBURST", "TRINO", "BIGQUERY", "GOOGLESHEETS"
|
13012
13094
|
# resp.data_source_summaries[0].created_time #=> Time
|
13013
13095
|
# resp.data_source_summaries[0].last_updated_time #=> Time
|
13014
13096
|
# resp.next_token #=> String
|
@@ -13090,7 +13172,7 @@ module Aws::QuickSight
|
|
13090
13172
|
end
|
13091
13173
|
|
13092
13174
|
# Use the `SearchGroups` operation to search groups in a specified
|
13093
|
-
#
|
13175
|
+
# QuickSight namespace using the supplied filters.
|
13094
13176
|
#
|
13095
13177
|
# @option params [required, String] :aws_account_id
|
13096
13178
|
# The ID for the Amazon Web Services account that the group is in.
|
@@ -13155,7 +13237,7 @@ module Aws::QuickSight
|
|
13155
13237
|
req.send_request(options)
|
13156
13238
|
end
|
13157
13239
|
|
13158
|
-
# Searches for any Q topic that exists in an
|
13240
|
+
# Searches for any Q topic that exists in an QuickSight account.
|
13159
13241
|
#
|
13160
13242
|
# @option params [required, String] :aws_account_id
|
13161
13243
|
# The ID of the Amazon Web Services account that contains the topic that
|
@@ -13217,14 +13299,14 @@ module Aws::QuickSight
|
|
13217
13299
|
|
13218
13300
|
# Starts an Asset Bundle export job.
|
13219
13301
|
#
|
13220
|
-
# An Asset Bundle export job exports specified
|
13221
|
-
#
|
13302
|
+
# An Asset Bundle export job exports specified QuickSight assets. You
|
13303
|
+
# can also choose to export any asset dependencies in the same job.
|
13222
13304
|
# Export jobs run asynchronously and can be polled with a
|
13223
13305
|
# `DescribeAssetBundleExportJob` API call. When a job is successfully
|
13224
13306
|
# completed, a download URL that contains the exported assets is
|
13225
13307
|
# returned. The URL is valid for 5 minutes and can be refreshed with a
|
13226
|
-
# `DescribeAssetBundleExportJob` API call. Each
|
13227
|
-
#
|
13308
|
+
# `DescribeAssetBundleExportJob` API call. Each QuickSight account can
|
13309
|
+
# run up to 5 export jobs concurrently.
|
13228
13310
|
#
|
13229
13311
|
# The API caller must have the necessary permissions in their IAM role
|
13230
13312
|
# to access each resource before the resources can be exported.
|
@@ -13399,13 +13481,12 @@ module Aws::QuickSight
|
|
13399
13481
|
|
13400
13482
|
# Starts an Asset Bundle import job.
|
13401
13483
|
#
|
13402
|
-
# An Asset Bundle import job imports specified
|
13403
|
-
#
|
13404
|
-
#
|
13405
|
-
#
|
13406
|
-
#
|
13407
|
-
#
|
13408
|
-
# concurrently.
|
13484
|
+
# An Asset Bundle import job imports specified QuickSight assets into an
|
13485
|
+
# QuickSight account. You can also choose to import a naming prefix and
|
13486
|
+
# specified configuration overrides. The assets that are contained in
|
13487
|
+
# the bundle file that you provide are used to create or update a new or
|
13488
|
+
# existing asset in your QuickSight account. Each QuickSight account can
|
13489
|
+
# run up to 5 import jobs concurrently.
|
13409
13490
|
#
|
13410
13491
|
# The API caller must have the necessary `"create"`, `"describe"`, and
|
13411
13492
|
# `"update"` permissions in their IAM role to access each resource type
|
@@ -13435,7 +13516,7 @@ module Aws::QuickSight
|
|
13435
13516
|
#
|
13436
13517
|
# If you choose `DO_NOTHING`, failed import jobs will not attempt to
|
13437
13518
|
# roll back any asset changes caused by the failed job, possibly keeping
|
13438
|
-
# the
|
13519
|
+
# the QuickSight account in an inconsistent state.
|
13439
13520
|
#
|
13440
13521
|
# @option params [Types::AssetBundleImportJobOverridePermissions] :override_permissions
|
13441
13522
|
# Optional permission overrides that are applied to the resource
|
@@ -13649,6 +13730,9 @@ module Aws::QuickSight
|
|
13649
13730
|
# database: "Database",
|
13650
13731
|
# sql_endpoint_path: "SqlEndpointPath", # required
|
13651
13732
|
# },
|
13733
|
+
# custom_connection_parameters: {
|
13734
|
+
# connection_type: "String",
|
13735
|
+
# },
|
13652
13736
|
# },
|
13653
13737
|
# vpc_connection_properties: {
|
13654
13738
|
# vpc_connection_arn: "Arn", # required
|
@@ -13897,15 +13981,14 @@ module Aws::QuickSight
|
|
13897
13981
|
#
|
13898
13982
|
# **StartDashboardSnapshotJob API throttling**
|
13899
13983
|
#
|
13900
|
-
#
|
13901
|
-
#
|
13984
|
+
# QuickSight utilizes API throttling to create a more consistent user
|
13985
|
+
# experience within a time span for customers when they call the
|
13902
13986
|
# `StartDashboardSnapshotJob`. By default, 12 jobs can run
|
13903
13987
|
# simlutaneously in one Amazon Web Services account and users can submit
|
13904
13988
|
# up 10 API requests per second before an account is throttled. If an
|
13905
13989
|
# overwhelming number of API requests are made by the same user in a
|
13906
|
-
# short period of time,
|
13907
|
-
#
|
13908
|
-
# QuickSight users.
|
13990
|
+
# short period of time, QuickSight throttles the API calls to maintin an
|
13991
|
+
# optimal experience and reliability for all QuickSight users.
|
13909
13992
|
#
|
13910
13993
|
# **Common throttling scenarios**
|
13911
13994
|
#
|
@@ -13921,8 +14004,7 @@ module Aws::QuickSight
|
|
13921
14004
|
#
|
13922
14005
|
# * **A large number of API requests are submitted on an Amazon Web
|
13923
14006
|
# Services account.** When a user makes more than 10 API calls to the
|
13924
|
-
#
|
13925
|
-
# returned.
|
14007
|
+
# QuickSight API in one second, a `ThrottlingException` is returned.
|
13926
14008
|
#
|
13927
14009
|
# If your use case requires a higher throttling limit, contact your
|
13928
14010
|
# account admin or [Amazon Web ServicesSupport][1] to explore options to
|
@@ -13934,11 +14016,11 @@ module Aws::QuickSight
|
|
13934
14016
|
# the degree of frequency and parallelism of API calls as much as you
|
13935
14017
|
# can to avoid throttling. You can also perform a timing test to
|
13936
14018
|
# calculate an estimate for the total processing time of your projected
|
13937
|
-
# load that stays within the throttling limits of the
|
13938
|
-
#
|
13939
|
-
#
|
13940
|
-
#
|
13941
|
-
#
|
14019
|
+
# load that stays within the throttling limits of the QuickSight APIs.
|
14020
|
+
# For example, if your projected traffic is 100 snapshot jobs before
|
14021
|
+
# 12:00 PM per day, start 12 jobs in parallel and measure the amount of
|
14022
|
+
# time it takes to proccess all 12 jobs. Once you obtain the result,
|
14023
|
+
# multiply the duration by 9, for example `(12 minutes * 9 = 108
|
13942
14024
|
# minutes)`. Use the new result to determine the latest time at which
|
13943
14025
|
# the jobs need to be started to meet your target deadline.
|
13944
14026
|
#
|
@@ -13982,7 +14064,7 @@ module Aws::QuickSight
|
|
13982
14064
|
# @option params [required, Types::SnapshotUserConfiguration] :user_configuration
|
13983
14065
|
# A structure that contains information about the anonymous users that
|
13984
14066
|
# the generated snapshot is for. This API will not return information
|
13985
|
-
# about registered
|
14067
|
+
# about registered QuickSight.
|
13986
14068
|
#
|
13987
14069
|
# @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
|
13988
14070
|
# A structure that describes the configuration of the dashboard
|
@@ -14092,9 +14174,9 @@ module Aws::QuickSight
|
|
14092
14174
|
# Only one job can run simultaneously in a given schedule. Repeated
|
14093
14175
|
# requests are skipped with a `202` HTTP status code.
|
14094
14176
|
#
|
14095
|
-
# For more information, see [Scheduling and sending
|
14096
|
-
#
|
14097
|
-
#
|
14177
|
+
# For more information, see [Scheduling and sending QuickSight reports
|
14178
|
+
# by email][1] and [Configuring email report settings for a QuickSight
|
14179
|
+
# dashboard][2] in the *Amazon QuickSight User Guide*.
|
14098
14180
|
#
|
14099
14181
|
#
|
14100
14182
|
#
|
@@ -14111,9 +14193,9 @@ module Aws::QuickSight
|
|
14111
14193
|
#
|
14112
14194
|
# @option params [required, String] :schedule_id
|
14113
14195
|
# The ID of the schedule that you want to start a snapshot job schedule
|
14114
|
-
# for. The schedule ID can be found in the
|
14115
|
-
#
|
14116
|
-
#
|
14196
|
+
# for. The schedule ID can be found in the QuickSight console in the
|
14197
|
+
# **Schedules** pane of the dashboard that the schedule is configured
|
14198
|
+
# for.
|
14117
14199
|
#
|
14118
14200
|
# @return [Types::StartDashboardSnapshotJobScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14119
14201
|
#
|
@@ -14142,8 +14224,8 @@ module Aws::QuickSight
|
|
14142
14224
|
req.send_request(options)
|
14143
14225
|
end
|
14144
14226
|
|
14145
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
14146
|
-
#
|
14227
|
+
# Assigns one or more tags (key-value pairs) to the specified QuickSight
|
14228
|
+
# resource.
|
14147
14229
|
#
|
14148
14230
|
# Tags can help you organize and categorize your resources. You can also
|
14149
14231
|
# use them to scope user permissions, by granting a user permission to
|
@@ -14154,20 +14236,20 @@ module Aws::QuickSight
|
|
14154
14236
|
# key that is already associated with the resource, the new tag value
|
14155
14237
|
# that you specify replaces the previous value for that tag.
|
14156
14238
|
#
|
14157
|
-
# You can associate as many as 50 tags with a resource.
|
14158
|
-
#
|
14159
|
-
#
|
14239
|
+
# You can associate as many as 50 tags with a resource. QuickSight
|
14240
|
+
# supports tagging on data set, data source, dashboard, template, topic,
|
14241
|
+
# and user.
|
14160
14242
|
#
|
14161
|
-
# Tagging for
|
14162
|
-
#
|
14243
|
+
# Tagging for QuickSight works in a similar way to tagging for other
|
14244
|
+
# Amazon Web Services services, except for the following:
|
14163
14245
|
#
|
14164
|
-
# * Tags are used to track costs for users in
|
14165
|
-
#
|
14166
|
-
#
|
14167
|
-
#
|
14246
|
+
# * Tags are used to track costs for users in QuickSight. You can't tag
|
14247
|
+
# other resources that QuickSight costs are based on, such as storage
|
14248
|
+
# capacoty (SPICE), session usage, alert consumption, or reporting
|
14249
|
+
# units.
|
14168
14250
|
#
|
14169
|
-
# *
|
14170
|
-
#
|
14251
|
+
# * QuickSight doesn't currently support the tag editor for Resource
|
14252
|
+
# Groups.
|
14171
14253
|
#
|
14172
14254
|
# @option params [required, String] :resource_arn
|
14173
14255
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
@@ -14242,12 +14324,48 @@ module Aws::QuickSight
|
|
14242
14324
|
req.send_request(options)
|
14243
14325
|
end
|
14244
14326
|
|
14327
|
+
# Applies a custom permissions profile to an account.
|
14328
|
+
#
|
14329
|
+
# @option params [required, String] :custom_permissions_name
|
14330
|
+
# The name of the custom permissions profile that you want to apply to
|
14331
|
+
# an account.
|
14332
|
+
#
|
14333
|
+
# @option params [required, String] :aws_account_id
|
14334
|
+
# The ID of the Amazon Web Services account for which you want to apply
|
14335
|
+
# a custom permissions profile.
|
14336
|
+
#
|
14337
|
+
# @return [Types::UpdateAccountCustomPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14338
|
+
#
|
14339
|
+
# * {Types::UpdateAccountCustomPermissionResponse#request_id #request_id} => String
|
14340
|
+
# * {Types::UpdateAccountCustomPermissionResponse#status #status} => Integer
|
14341
|
+
#
|
14342
|
+
# @example Request syntax with placeholder values
|
14343
|
+
#
|
14344
|
+
# resp = client.update_account_custom_permission({
|
14345
|
+
# custom_permissions_name: "CustomPermissionsName", # required
|
14346
|
+
# aws_account_id: "AwsAccountId", # required
|
14347
|
+
# })
|
14348
|
+
#
|
14349
|
+
# @example Response structure
|
14350
|
+
#
|
14351
|
+
# resp.request_id #=> String
|
14352
|
+
# resp.status #=> Integer
|
14353
|
+
#
|
14354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomPermission AWS API Documentation
|
14355
|
+
#
|
14356
|
+
# @overload update_account_custom_permission(params = {})
|
14357
|
+
# @param [Hash] params ({})
|
14358
|
+
def update_account_custom_permission(params = {}, options = {})
|
14359
|
+
req = build_request(:update_account_custom_permission, params)
|
14360
|
+
req.send_request(options)
|
14361
|
+
end
|
14362
|
+
|
14245
14363
|
# Updates Amazon QuickSight customizations for the current Amazon Web
|
14246
14364
|
# Services Region. Currently, the only customization that you can use is
|
14247
14365
|
# a theme.
|
14248
14366
|
#
|
14249
14367
|
# You can use customizations for your Amazon Web Services account or, if
|
14250
|
-
# you specify a namespace, for a
|
14368
|
+
# you specify a namespace, for a QuickSight namespace instead.
|
14251
14369
|
# Customizations that apply to a namespace override customizations that
|
14252
14370
|
# apply to an Amazon Web Services account. To find out which
|
14253
14371
|
# customizations apply, use the `DescribeAccountCustomization` API
|
@@ -14255,15 +14373,14 @@ module Aws::QuickSight
|
|
14255
14373
|
#
|
14256
14374
|
# @option params [required, String] :aws_account_id
|
14257
14375
|
# The ID for the Amazon Web Services account that you want to update
|
14258
|
-
#
|
14376
|
+
# QuickSight customizations for.
|
14259
14377
|
#
|
14260
14378
|
# @option params [String] :namespace
|
14261
|
-
# The namespace that you want to update
|
14262
|
-
# for.
|
14379
|
+
# The namespace that you want to update QuickSight customizations for.
|
14263
14380
|
#
|
14264
14381
|
# @option params [required, Types::AccountCustomization] :account_customization
|
14265
|
-
# The
|
14266
|
-
#
|
14382
|
+
# The QuickSight customizations you're updating in the current Amazon
|
14383
|
+
# Web Services Region.
|
14267
14384
|
#
|
14268
14385
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14269
14386
|
#
|
@@ -14308,24 +14425,23 @@ module Aws::QuickSight
|
|
14308
14425
|
# account.
|
14309
14426
|
#
|
14310
14427
|
# @option params [required, String] :aws_account_id
|
14311
|
-
# The ID for the Amazon Web Services account that contains the
|
14428
|
+
# The ID for the Amazon Web Services account that contains the
|
14312
14429
|
# QuickSight settings that you want to list.
|
14313
14430
|
#
|
14314
14431
|
# @option params [required, String] :default_namespace
|
14315
14432
|
# The default namespace for this Amazon Web Services account. Currently,
|
14316
14433
|
# the default is `default`. IAM users that register for the first time
|
14317
|
-
# with
|
14318
|
-
#
|
14434
|
+
# with QuickSight provide an email address that becomes associated with
|
14435
|
+
# the default namespace.
|
14319
14436
|
#
|
14320
14437
|
# @option params [String] :notification_email
|
14321
|
-
# The email address that you want
|
14322
|
-
#
|
14323
|
-
# QuickSight subscription.
|
14438
|
+
# The email address that you want QuickSight to send notifications to
|
14439
|
+
# regarding your Amazon Web Services account or QuickSight subscription.
|
14324
14440
|
#
|
14325
14441
|
# @option params [Boolean] :termination_protection_enabled
|
14326
|
-
# A boolean value that determines whether or not an
|
14327
|
-
#
|
14328
|
-
#
|
14442
|
+
# A boolean value that determines whether or not an QuickSight account
|
14443
|
+
# can be deleted. A `True` value doesn't allow the account to be
|
14444
|
+
# deleted and results in an error message if a user tries to make a
|
14329
14445
|
# `DeleteAccountSubscription` request. A `False` value will allow the
|
14330
14446
|
# account to be deleted.
|
14331
14447
|
#
|
@@ -14369,7 +14485,7 @@ module Aws::QuickSight
|
|
14369
14485
|
#
|
14370
14486
|
# @option params [required, String] :name
|
14371
14487
|
# A descriptive name for the analysis that you're updating. This name
|
14372
|
-
# displays for the analysis in the
|
14488
|
+
# displays for the analysis in the QuickSight console.
|
14373
14489
|
#
|
14374
14490
|
# @option params [Types::Parameters] :parameters
|
14375
14491
|
# The parameter names and override values that you want to use. An
|
@@ -14383,8 +14499,8 @@ module Aws::QuickSight
|
|
14383
14499
|
#
|
14384
14500
|
# @option params [String] :theme_arn
|
14385
14501
|
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
14386
|
-
# that you're creating. To see the theme in the
|
14387
|
-
#
|
14502
|
+
# that you're creating. To see the theme in the QuickSight console,
|
14503
|
+
# make sure that you have access to it.
|
14388
14504
|
#
|
14389
14505
|
# @option params [Types::AnalysisDefinition] :definition
|
14390
14506
|
# The definition of an analysis.
|
@@ -14488,16 +14604,16 @@ module Aws::QuickSight
|
|
14488
14604
|
req.send_request(options)
|
14489
14605
|
end
|
14490
14606
|
|
14491
|
-
# Updates an
|
14492
|
-
#
|
14493
|
-
#
|
14607
|
+
# Updates an QuickSight application with a token exchange grant. This
|
14608
|
+
# operation only supports QuickSight applications that are registered
|
14609
|
+
# with IAM Identity Center.
|
14494
14610
|
#
|
14495
14611
|
# @option params [required, String] :aws_account_id
|
14496
14612
|
# The ID of the Amazon Web Services account to be updated with a token
|
14497
14613
|
# exchange grant.
|
14498
14614
|
#
|
14499
14615
|
# @option params [required, String] :namespace
|
14500
|
-
# The namespace of the
|
14616
|
+
# The namespace of the QuickSight application.
|
14501
14617
|
#
|
14502
14618
|
# @return [Types::UpdateApplicationWithTokenExchangeGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14503
14619
|
#
|
@@ -14531,7 +14647,7 @@ module Aws::QuickSight
|
|
14531
14647
|
# The ID of the Amazon Web Services account that owns the brand.
|
14532
14648
|
#
|
14533
14649
|
# @option params [required, String] :brand_id
|
14534
|
-
# The ID of the
|
14650
|
+
# The ID of the QuickSight brand.
|
14535
14651
|
#
|
14536
14652
|
# @option params [Types::BrandDefinition] :brand_definition
|
14537
14653
|
# The definition of the brand.
|
@@ -14737,7 +14853,7 @@ module Aws::QuickSight
|
|
14737
14853
|
# The ID of the Amazon Web Services account that owns the brand.
|
14738
14854
|
#
|
14739
14855
|
# @option params [required, String] :brand_id
|
14740
|
-
# The ID of the
|
14856
|
+
# The ID of the QuickSight brand.
|
14741
14857
|
#
|
14742
14858
|
# @option params [required, String] :version_id
|
14743
14859
|
# The ID of the published version.
|
@@ -14816,6 +14932,8 @@ module Aws::QuickSight
|
|
14816
14932
|
# export_to_csv_in_scheduled_reports: "DENY", # accepts DENY
|
14817
14933
|
# export_to_excel_in_scheduled_reports: "DENY", # accepts DENY
|
14818
14934
|
# include_content_in_scheduled_reports_email: "DENY", # accepts DENY
|
14935
|
+
# dashboard: "DENY", # accepts DENY
|
14936
|
+
# analysis: "DENY", # accepts DENY
|
14819
14937
|
# },
|
14820
14938
|
# })
|
14821
14939
|
#
|
@@ -14862,7 +14980,7 @@ module Aws::QuickSight
|
|
14862
14980
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
14863
14981
|
# the Amazon Resource Name (ARN) of the source template. The
|
14864
14982
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
14865
|
-
# any
|
14983
|
+
# any QuickSight-supported Amazon Web Services Region.
|
14866
14984
|
#
|
14867
14985
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
14868
14986
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -14881,9 +14999,9 @@ module Aws::QuickSight
|
|
14881
14999
|
#
|
14882
15000
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
14883
15001
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
14884
|
-
#
|
14885
|
-
#
|
14886
|
-
#
|
15002
|
+
# QuickSight disables the left filter pane on the published dashboard,
|
15003
|
+
# which can be used for ad hoc (one-time) filtering. This option is
|
15004
|
+
# `ENABLED` by default.
|
14887
15005
|
#
|
14888
15006
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
14889
15007
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -14894,6 +15012,16 @@ module Aws::QuickSight
|
|
14894
15012
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
14895
15013
|
# by default.
|
14896
15014
|
#
|
15015
|
+
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
|
15016
|
+
# be either `ENABLED` or `DISABLED`. The option to build an executive
|
15017
|
+
# summary is disabled when this is set to `DISABLED`. This option is
|
15018
|
+
# `ENABLED` by default.
|
15019
|
+
#
|
15020
|
+
# * `AvailabilityStatus` for `DataStoriesSharingOption` - This status
|
15021
|
+
# can be either `ENABLED` or `DISABLED`. The option to share a data
|
15022
|
+
# story is disabled when this is set to `DISABLED`. This option is
|
15023
|
+
# `ENABLED` by default.
|
15024
|
+
#
|
14897
15025
|
# @option params [String] :theme_arn
|
14898
15026
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
14899
15027
|
# this dashboard. If you add a value for this field, it overrides the
|
@@ -15175,7 +15303,7 @@ module Aws::QuickSight
|
|
15175
15303
|
# Indicates whether you want to import the data into SPICE.
|
15176
15304
|
#
|
15177
15305
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
15178
|
-
# Groupings of columns that work together in certain
|
15306
|
+
# Groupings of columns that work together in certain QuickSight
|
15179
15307
|
# features. Currently, only geospatial hierarchy is supported.
|
15180
15308
|
#
|
15181
15309
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -15525,20 +15653,20 @@ module Aws::QuickSight
|
|
15525
15653
|
# A display name for the data source.
|
15526
15654
|
#
|
15527
15655
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
15528
|
-
# The parameters that
|
15529
|
-
#
|
15656
|
+
# The parameters that QuickSight uses to connect to your underlying
|
15657
|
+
# source.
|
15530
15658
|
#
|
15531
15659
|
# @option params [Types::DataSourceCredentials] :credentials
|
15532
|
-
# The credentials that
|
15660
|
+
# The credentials that QuickSight that uses to connect to your
|
15533
15661
|
# underlying source. Currently, only credentials based on user name and
|
15534
15662
|
# password are supported.
|
15535
15663
|
#
|
15536
15664
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
15537
|
-
# Use this parameter only when you want
|
15665
|
+
# Use this parameter only when you want QuickSight to use a VPC
|
15538
15666
|
# connection when connecting to your underlying source.
|
15539
15667
|
#
|
15540
15668
|
# @option params [Types::SslProperties] :ssl_properties
|
15541
|
-
# Secure Socket Layer (SSL) properties that apply when
|
15669
|
+
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
15542
15670
|
# connects to your underlying source.
|
15543
15671
|
#
|
15544
15672
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -15713,6 +15841,9 @@ module Aws::QuickSight
|
|
15713
15841
|
# database: "Database",
|
15714
15842
|
# sql_endpoint_path: "SqlEndpointPath", # required
|
15715
15843
|
# },
|
15844
|
+
# custom_connection_parameters: {
|
15845
|
+
# connection_type: "String",
|
15846
|
+
# },
|
15716
15847
|
# },
|
15717
15848
|
# credentials: {
|
15718
15849
|
# credential_pair: {
|
@@ -15877,6 +16008,9 @@ module Aws::QuickSight
|
|
15877
16008
|
# database: "Database",
|
15878
16009
|
# sql_endpoint_path: "SqlEndpointPath", # required
|
15879
16010
|
# },
|
16011
|
+
# custom_connection_parameters: {
|
16012
|
+
# connection_type: "String",
|
16013
|
+
# },
|
15880
16014
|
# },
|
15881
16015
|
# ],
|
15882
16016
|
# },
|
@@ -15967,18 +16101,18 @@ module Aws::QuickSight
|
|
15967
16101
|
req.send_request(options)
|
15968
16102
|
end
|
15969
16103
|
|
15970
|
-
# Updates a Amazon Q Business application that is linked to a
|
15971
|
-
#
|
16104
|
+
# Updates a Amazon Q Business application that is linked to a QuickSight
|
16105
|
+
# account.
|
15972
16106
|
#
|
15973
16107
|
# @option params [required, String] :aws_account_id
|
15974
|
-
# The ID of the
|
15975
|
-
#
|
16108
|
+
# The ID of the QuickSight account that is connected to the Amazon Q
|
16109
|
+
# Business application that you want to update.
|
15976
16110
|
#
|
15977
16111
|
# @option params [String] :namespace
|
15978
|
-
# The
|
15979
|
-
#
|
15980
|
-
#
|
15981
|
-
#
|
16112
|
+
# The QuickSight namespace that contains the linked Amazon Q Business
|
16113
|
+
# application. If this field is left blank, the default namespace is
|
16114
|
+
# used. Currently, the default namespace is the only valid value for
|
16115
|
+
# this parameter.
|
15982
16116
|
#
|
15983
16117
|
# @option params [required, String] :application_id
|
15984
16118
|
# The ID of the Amazon Q Business application that you want to update.
|
@@ -16194,12 +16328,12 @@ module Aws::QuickSight
|
|
16194
16328
|
# when creating the data source.
|
16195
16329
|
#
|
16196
16330
|
# @option params [String] :policy_arn
|
16197
|
-
# The ARN for the IAM policy to apply to the
|
16198
|
-
#
|
16331
|
+
# The ARN for the IAM policy to apply to the QuickSight users and groups
|
16332
|
+
# specified in this assignment.
|
16199
16333
|
#
|
16200
16334
|
# @option params [Hash<String,Array>] :identities
|
16201
|
-
# The
|
16202
|
-
#
|
16335
|
+
# The QuickSight users, groups, or both that you want to assign the
|
16336
|
+
# policy to.
|
16203
16337
|
#
|
16204
16338
|
# @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16205
16339
|
#
|
@@ -16246,10 +16380,10 @@ module Aws::QuickSight
|
|
16246
16380
|
end
|
16247
16381
|
|
16248
16382
|
# Adds or updates services and authorized targets to configure what the
|
16249
|
-
#
|
16383
|
+
# QuickSight IAM Identity Center application can access.
|
16250
16384
|
#
|
16251
|
-
# This operation is only supported for
|
16252
|
-
#
|
16385
|
+
# This operation is only supported for QuickSight accounts using IAM
|
16386
|
+
# Identity Center
|
16253
16387
|
#
|
16254
16388
|
# @option params [required, String] :aws_account_id
|
16255
16389
|
# The ID of the Amazon Web Services account that contains the identity
|
@@ -16352,7 +16486,7 @@ module Aws::QuickSight
|
|
16352
16486
|
req.send_request(options)
|
16353
16487
|
end
|
16354
16488
|
|
16355
|
-
# Updates a customer managed key in a
|
16489
|
+
# Updates a customer managed key in a QuickSight account.
|
16356
16490
|
#
|
16357
16491
|
# @option params [required, String] :aws_account_id
|
16358
16492
|
# The ID of the Amazon Web Services account that contains the customer
|
@@ -16360,7 +16494,7 @@ module Aws::QuickSight
|
|
16360
16494
|
#
|
16361
16495
|
# @option params [required, Array<Types::RegisteredCustomerManagedKey>] :key_registration
|
16362
16496
|
# A list of `RegisteredCustomerManagedKey` objects to be updated to the
|
16363
|
-
#
|
16497
|
+
# QuickSight account.
|
16364
16498
|
#
|
16365
16499
|
# @return [Types::UpdateKeyRegistrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16366
16500
|
#
|
@@ -16402,28 +16536,28 @@ module Aws::QuickSight
|
|
16402
16536
|
end
|
16403
16537
|
|
16404
16538
|
# Use the `UpdatePublicSharingSettings` operation to turn on or turn off
|
16405
|
-
# the public sharing settings of an
|
16539
|
+
# the public sharing settings of an QuickSight dashboard.
|
16406
16540
|
#
|
16407
16541
|
# To use this operation, turn on session capacity pricing for your
|
16408
|
-
#
|
16542
|
+
# QuickSight account.
|
16409
16543
|
#
|
16410
16544
|
# Before you can turn on public sharing on your account, make sure to
|
16411
16545
|
# give public sharing permissions to an administrative user in the
|
16412
16546
|
# Identity and Access Management (IAM) console. For more information on
|
16413
|
-
# using IAM with
|
16414
|
-
#
|
16547
|
+
# using IAM with QuickSight, see [Using QuickSight with IAM][1] in the
|
16548
|
+
# *QuickSight User Guide*.
|
16415
16549
|
#
|
16416
16550
|
#
|
16417
16551
|
#
|
16418
16552
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html
|
16419
16553
|
#
|
16420
16554
|
# @option params [required, String] :aws_account_id
|
16421
|
-
# The Amazon Web Services account ID associated with your
|
16422
|
-
#
|
16555
|
+
# The Amazon Web Services account ID associated with your QuickSight
|
16556
|
+
# subscription.
|
16423
16557
|
#
|
16424
16558
|
# @option params [Boolean] :public_sharing_enabled
|
16425
16559
|
# A Boolean value that indicates whether public sharing is turned on for
|
16426
|
-
# an
|
16560
|
+
# an QuickSight account.
|
16427
16561
|
#
|
16428
16562
|
# @return [Types::UpdatePublicSharingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16429
16563
|
#
|
@@ -16458,9 +16592,9 @@ module Aws::QuickSight
|
|
16458
16592
|
# personalization configuration that the user wants to update.
|
16459
16593
|
#
|
16460
16594
|
# @option params [required, String] :personalization_mode
|
16461
|
-
# An option to allow
|
16462
|
-
#
|
16463
|
-
#
|
16595
|
+
# An option to allow QuickSight to customize data stories with user
|
16596
|
+
# specific metadata, specifically location and job information, in your
|
16597
|
+
# IAM Identity Center instance.
|
16464
16598
|
#
|
16465
16599
|
# @return [Types::UpdateQPersonalizationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16466
16600
|
#
|
@@ -16490,15 +16624,15 @@ module Aws::QuickSight
|
|
16490
16624
|
req.send_request(options)
|
16491
16625
|
end
|
16492
16626
|
|
16493
|
-
# Updates the state of a
|
16627
|
+
# Updates the state of a QuickSight Q Search configuration.
|
16494
16628
|
#
|
16495
16629
|
# @option params [required, String] :aws_account_id
|
16496
|
-
# The ID of the Amazon Web Services account that contains the
|
16497
|
-
#
|
16630
|
+
# The ID of the Amazon Web Services account that contains the QuickSight
|
16631
|
+
# Q Search configuration that you want to update.
|
16498
16632
|
#
|
16499
16633
|
# @option params [required, String] :q_search_status
|
16500
|
-
# The status of the
|
16501
|
-
#
|
16634
|
+
# The status of the QuickSight Q Search configuration that the user
|
16635
|
+
# wants to update.
|
16502
16636
|
#
|
16503
16637
|
# @return [Types::UpdateQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16504
16638
|
#
|
@@ -16630,8 +16764,7 @@ module Aws::QuickSight
|
|
16630
16764
|
req.send_request(options)
|
16631
16765
|
end
|
16632
16766
|
|
16633
|
-
# Updates the SPICE capacity configuration for a
|
16634
|
-
# account.
|
16767
|
+
# Updates the SPICE capacity configuration for a QuickSight account.
|
16635
16768
|
#
|
16636
16769
|
# @option params [required, String] :aws_account_id
|
16637
16770
|
# The ID of the Amazon Web Services account that contains the SPICE
|
@@ -16691,7 +16824,7 @@ module Aws::QuickSight
|
|
16691
16824
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
16692
16825
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
16693
16826
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
16694
|
-
# any
|
16827
|
+
# any QuickSight-supported Amazon Web Services Region;.
|
16695
16828
|
#
|
16696
16829
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
16697
16830
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -16871,8 +17004,8 @@ module Aws::QuickSight
|
|
16871
17004
|
#
|
16872
17005
|
# @option params [required, String] :base_theme_id
|
16873
17006
|
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
16874
|
-
# inherits from. All themes initially inherit from a default
|
16875
|
-
#
|
17007
|
+
# inherits from. All themes initially inherit from a default QuickSight
|
17008
|
+
# theme.
|
16876
17009
|
#
|
16877
17010
|
# @option params [String] :version_description
|
16878
17011
|
# A description of the theme version that you're updating Every time
|
@@ -17164,7 +17297,7 @@ module Aws::QuickSight
|
|
17164
17297
|
# filter_name: "LimitedString", # required
|
17165
17298
|
# filter_synonyms: ["LimitedString"],
|
17166
17299
|
# operand_field_name: "LimitedString", # required
|
17167
|
-
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER
|
17300
|
+
# filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, NULL_FILTER
|
17168
17301
|
# category_filter: {
|
17169
17302
|
# category_filter_function: "EXACT", # accepts EXACT, CONTAINS
|
17170
17303
|
# category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
|
@@ -17213,6 +17346,14 @@ module Aws::QuickSight
|
|
17213
17346
|
# singular_constant: "LimitedString",
|
17214
17347
|
# },
|
17215
17348
|
# },
|
17349
|
+
# null_filter: {
|
17350
|
+
# null_filter_type: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
|
17351
|
+
# constant: {
|
17352
|
+
# constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
|
17353
|
+
# singular_constant: "LimitedString",
|
17354
|
+
# },
|
17355
|
+
# inverse: false,
|
17356
|
+
# },
|
17216
17357
|
# },
|
17217
17358
|
# ],
|
17218
17359
|
# columns: [
|
@@ -17538,9 +17679,9 @@ module Aws::QuickSight
|
|
17538
17679
|
# QuickSight settings.
|
17539
17680
|
#
|
17540
17681
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
17541
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
17542
|
-
#
|
17543
|
-
#
|
17682
|
+
# Reader role. Reader Pros have access to Amazon Q in QuickSight, can
|
17683
|
+
# build stories with Amazon Q, and can generate executive summaries
|
17684
|
+
# from dashboards.
|
17544
17685
|
#
|
17545
17686
|
# * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
|
17546
17687
|
# Author role. Author Pros can author dashboards with natural language
|
@@ -17551,8 +17692,8 @@ module Aws::QuickSight
|
|
17551
17692
|
# QuickSight administrative settings. Admin Pro users are billed at
|
17552
17693
|
# Author Pro pricing.
|
17553
17694
|
#
|
17554
|
-
# The name of the
|
17555
|
-
#
|
17695
|
+
# The name of the QuickSight role is invisible to the user except for
|
17696
|
+
# the console screens dealing with permissions.
|
17556
17697
|
#
|
17557
17698
|
# @option params [String] :custom_permissions_name
|
17558
17699
|
# (Enterprise edition only) The name of the custom permissions profile
|
@@ -17570,16 +17711,16 @@ module Aws::QuickSight
|
|
17570
17711
|
#
|
17571
17712
|
# A set of custom permissions includes any combination of these
|
17572
17713
|
# restrictions. Currently, you need to create the profile names for
|
17573
|
-
# custom permission sets by using the
|
17574
|
-
#
|
17575
|
-
# permissions to a
|
17714
|
+
# custom permission sets by using the QuickSight console. Then, you use
|
17715
|
+
# the `RegisterUser` API operation to assign the named set of
|
17716
|
+
# permissions to a QuickSight user.
|
17576
17717
|
#
|
17577
|
-
#
|
17718
|
+
# QuickSight custom permissions are applied through IAM policies.
|
17578
17719
|
# Therefore, they override the permissions typically granted by
|
17579
|
-
# assigning
|
17580
|
-
#
|
17720
|
+
# assigning QuickSight users to one of the default security cohorts in
|
17721
|
+
# QuickSight (admin, author, reader).
|
17581
17722
|
#
|
17582
|
-
# This feature is available only to
|
17723
|
+
# This feature is available only to QuickSight Enterprise edition
|
17583
17724
|
# subscriptions.
|
17584
17725
|
#
|
17585
17726
|
# @option params [Boolean] :unapply_custom_permissions
|
@@ -17591,9 +17732,9 @@ module Aws::QuickSight
|
|
17591
17732
|
#
|
17592
17733
|
# @option params [String] :external_login_federation_provider_type
|
17593
17734
|
# The type of supported external login provider that provides identity
|
17594
|
-
# to let a user federate into
|
17595
|
-
#
|
17596
|
-
#
|
17735
|
+
# to let a user federate into QuickSight with an associated Identity and
|
17736
|
+
# Access Management(IAM) role. The type of supported external login
|
17737
|
+
# provider can be one of the following.
|
17597
17738
|
#
|
17598
17739
|
# * `COGNITO`: Amazon Cognito. The provider URL is
|
17599
17740
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
|
@@ -17610,10 +17751,10 @@ module Aws::QuickSight
|
|
17610
17751
|
#
|
17611
17752
|
# @option params [String] :custom_federation_provider_url
|
17612
17753
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
17613
|
-
# identity to let a user federate into
|
17614
|
-
#
|
17615
|
-
#
|
17616
|
-
#
|
17754
|
+
# identity to let a user federate into QuickSight with an associated
|
17755
|
+
# Identity and Access Management(IAM) role. This parameter should only
|
17756
|
+
# be used when `ExternalLoginFederationProviderType` parameter is set to
|
17757
|
+
# `CUSTOM_OIDC`.
|
17617
17758
|
#
|
17618
17759
|
# @option params [String] :external_login_id
|
17619
17760
|
# The identity ID for a user in the external login provider.
|
@@ -17792,7 +17933,7 @@ module Aws::QuickSight
|
|
17792
17933
|
tracer: tracer
|
17793
17934
|
)
|
17794
17935
|
context[:gem_name] = 'aws-sdk-quicksight'
|
17795
|
-
context[:gem_version] = '1.
|
17936
|
+
context[:gem_version] = '1.158.0'
|
17796
17937
|
Seahorse::Client::Request.new(handlers, context)
|
17797
17938
|
end
|
17798
17939
|
|