aws-sdk-quicksight 1.157.0 → 1.159.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.
@@ -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 Amazon QuickSight by removing
1389
- # Amazon QuickSight sample assets and videos for all new users, see
1390
- # [Customizing Amazon QuickSight][1] in the *Amazon QuickSight User
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
- # Amazon QuickSight for.
1414
+ # QuickSight for.
1416
1415
  #
1417
1416
  # @option params [String] :namespace
1418
- # The Amazon QuickSight namespace that you want to add customizations
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 Amazon QuickSight customizations you're adding in the current
1423
- # Amazon Web Services Region. You can add these to an Amazon Web
1424
- # Services account and a QuickSight namespace.
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 Amazon QuickSight account, or subscribes to Amazon
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 Amazon
1492
- # QuickSight needs to have the correct Identity and Access Management
1493
- # (IAM) permissions. For more information, see [IAM Policy Examples for
1494
- # Amazon QuickSight][2] in the *Amazon QuickSight User Guide*.
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 Amazon QuickSight, see [Passing IAM roles to Amazon
1504
- # QuickSight][3] in the *Amazon QuickSight User Guide*.
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
- # Amazon QuickSight API. Instead, add default resource access from the
1508
- # Amazon QuickSight console. For more information about setting default
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 *Amazon
1511
- # QuickSight User Guide*.
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 Amazon QuickSight that you want your account to have.
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 Amazon QuickSight
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 Amazon QuickSight account.
1544
+ # to create your QuickSight account.
1548
1545
  #
1549
1546
  # @option params [required, String] :account_name
1550
- # The name of your Amazon QuickSight account. This name is unique over
1551
- # all of Amazon Web Services, and it appears only when users sign in.
1552
- # You can't change `AccountName` value after the Amazon QuickSight
1553
- # account is created.
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 Amazon QuickSight to send
1557
- # notifications to regarding your Amazon QuickSight account or Amazon
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
- # Amazon QuickSight account.
1559
+ # QuickSight account.
1564
1560
  #
1565
1561
  # @option params [String] :realm
1566
- # The realm of the Active Directory that is associated with your Amazon
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 Amazon QuickSight
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 Amazon
1573
- # QuickSight account.
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 Amazon QuickSight account.
1574
+ # selected authentication method of the new QuickSight account.
1580
1575
  #
1581
- # For more information about using IAM Identity Center in Amazon
1582
- # QuickSight, see [Using IAM Identity Center with Amazon QuickSight
1583
- # Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
1584
- # information about using Active Directory in Amazon QuickSight, see
1585
- # [Using Active Directory with Amazon QuickSight Enterprise Edition][2]
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 Amazon
1598
- # QuickSight, see [Using IAM Identity Center with Amazon QuickSight
1599
- # Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
1600
- # information about using Active Directory in Amazon QuickSight, see
1601
- # [Using Active Directory with Amazon QuickSight Enterprise Edition][2]
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 Amazon
1614
- # QuickSight, see [Using IAM Identity Center with Amazon QuickSight
1615
- # Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
1616
- # information about using Active Directory in Amazon QuickSight, see
1617
- # [Using Active Directory with Amazon QuickSight Enterprise Edition][2]
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 Amazon QuickSight account.
1621
+ # selected authentication method of the new QuickSight account.
1630
1622
  #
1631
- # For more information about using IAM Identity Center in Amazon
1632
- # QuickSight, see [Using IAM Identity Center with Amazon QuickSight
1633
- # Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
1634
- # information about using Active Directory in Amazon QuickSight, see
1635
- # [Using Active Directory with Amazon QuickSight Enterprise Edition][2]
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 Amazon
1648
- # QuickSight, see [Using IAM Identity Center with Amazon QuickSight
1649
- # Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
1650
- # information about using Active Directory in Amazon QuickSight, see
1651
- # [Using Active Directory with Amazon QuickSight Enterprise Edition][2]
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 Amazon
1664
- # QuickSight, see [Using IAM Identity Center with Amazon QuickSight
1665
- # Enterprise Edition][1] in the Amazon QuickSight User Guide. For more
1666
- # information about using Active Directory in Amazon QuickSight, see
1667
- # [Using Active Directory with Amazon QuickSight Enterprise Edition][2]
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 Amazon QuickSight account to use
1677
- # for future communications. This field is required if
1678
- # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
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 Amazon QuickSight account to use
1683
- # for future communications. This field is required if
1684
- # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
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 Amazon QuickSight account to
1689
- # use for future communications. This field is required if
1690
- # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
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 Amazon QuickSight
1695
- # account to use for future communications. This field is required if
1696
- # `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon
1697
- # QuickSight account.
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 Amazon QuickSight console.
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 Amazon QuickSight console, make sure that you
1790
- # have access to it.
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, Amazon QuickSight adds the analysis to
1812
- # these folders.
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 Amazon QuickSight brand.
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 Amazon QuickSight brand.
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 Amazon QuickSight that identifies Amazon
2098
- # QuickSight reports, created from analyses. You can share Amazon
2099
- # QuickSight dashboards. With the right permissions, you can create
2100
- # scheduled email reports from them. If you have the correct
2101
- # permissions, you can create a dashboard from a template that exists in
2102
- # a different Amazon Web Services account.
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 Amazon QuickSight-supported Amazon Web Services Region.
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
- # Amazon QuickSight disables the left filter pane on the published
2157
- # dashboard, which can be used for ad hoc (one-time) filtering. This
2158
- # option is `ENABLED` by default.
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, Amazon QuickSight adds the dashboard to
2191
- # these folders.
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 Amazon QuickSight
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, Amazon QuickSight adds the dataset to
2288
- # these folders.
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 Amazon QuickSight uses to connect to your
2579
- # underlying source.
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 Amazon QuickSight that uses to connect to your
2583
- # underlying source. Currently, only credentials based on user name and
2584
- # password are supported.
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 Amazon QuickSight to use a VPC
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 Amazon QuickSight
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, Amazon QuickSight adds the data
2603
- # source to these folders.
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 Amazon
3113
- # QuickSight. You can create up to 10,000 groups in a namespace. If you
3114
- # want to create more than 10,000 groups in a namespace, contact Amazon
3115
- # Web Services Support.
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 Amazon QuickSight users or groups.
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 Amazon QuickSight users and
3245
- # groups specified in this assignment.
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 Amazon QuickSight users, groups, or both that you want to assign
3249
- # the policy to.
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 Amazon QuickSight users and
3364
- # groups that are registered for that namespace. Users that access the
3365
- # namespace can share assets only with other users or groups in the same
3366
- # namespace. They can't see users and groups in other namespaces. You
3367
- # can create a namespace after your Amazon Web Services account is
3368
- # subscribed to Amazon QuickSight. The namespace must be unique within
3369
- # the Amazon Web Services account. By default, there is a limit of 100
3370
- # namespaces per Amazon Web Services account. To increase your limit,
3371
- # create a ticket with Amazon Web ServicesSupport.
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
- # Amazon QuickSight namespace in.
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 Amazon QuickSight group
3489
- # to an existing role.
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 Amazon QuickSight analysis or template. You can use the
3536
- # resulting template to create additional dashboards, templates, or
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 Amazon QuickSight that encapsulates the
3540
- # metadata required to create an analysis and that you can use to create
3541
- # s dashboard. A template adds a layer of abstraction by using
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 Amazon QuickSight-supported Amazon Web Services Region.
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 Amazon QuickSight.
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,67 @@ 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
+
4337
+ # This API permanently deletes all QuickSight customizations for the
4338
+ # specified Amazon Web Services account and namespace in this Amazon Web
4339
+ # Services Region. When you delete account customizations:
4340
+ #
4341
+ # * All customizations are removed including themes, branding, and
4342
+ # visual settings
4343
+ #
4344
+ # * The deletion affects only the specified Amazon Web Services Region -
4345
+ # customizations in other regions remain unchanged
4346
+ #
4347
+ # * This action cannot be undone through the API
4348
+ #
4349
+ # * Users will see default QuickSight styling after customizations are
4350
+ # deleted
4351
+ #
4352
+ # **Before proceeding:** Ensure you have backups of any custom themes
4353
+ # or
4354
+ # branding elements you may want to recreate.
4355
+ #
4295
4356
  # Deletes all Amazon QuickSight customizations in this Amazon Web
4296
4357
  # Services Region for the specified Amazon Web Services account and
4297
- # Amazon QuickSight namespace.
4358
+ # QuickSight namespace.
4298
4359
  #
4299
4360
  # @option params [required, String] :aws_account_id
4300
4361
  # The ID for the Amazon Web Services account that you want to delete
4301
- # Amazon QuickSight customizations from in this Amazon Web Services
4302
- # Region.
4362
+ # QuickSight customizations from in this Amazon Web Services Region.
4303
4363
  #
4304
4364
  # @option params [String] :namespace
4305
- # The Amazon QuickSight namespace that you're deleting the
4306
- # customizations from.
4365
+ # The QuickSight namespace that you're deleting the customizations
4366
+ # from.
4307
4367
  #
4308
4368
  # @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4309
4369
  #
@@ -4331,10 +4391,41 @@ module Aws::QuickSight
4331
4391
  req.send_request(options)
4332
4392
  end
4333
4393
 
4334
- # Use the `DeleteAccountSubscription` operation to delete an Amazon
4335
- # QuickSight account. This operation will result in an error message if
4336
- # you have configured your account termination protection settings to
4337
- # `True`. To change this setting and delete your account, call the
4394
+ # Deleting your QuickSight account subscription has permanent,
4395
+ # irreversible consequences across all Amazon Web Services regions:
4396
+ #
4397
+ # * Global deletion Running this operation from any single region
4398
+ # will
4399
+ # delete your QuickSight account and all data in every Amazon Web
4400
+ # Services region where you have QuickSight resources.
4401
+ #
4402
+ # * Complete data loss – All dashboards, analyses, datasets, data
4403
+ # sources, and custom visuals will be permanently deleted across all
4404
+ # regions.
4405
+ #
4406
+ # * Embedded content failure – All embedded dashboards and visuals in
4407
+ # your applications will immediately stop working and display errors
4408
+ # to end users.
4409
+ #
4410
+ # * Shared resources removed – All shared dashboards, folders, and
4411
+ # resources will become inaccessible to other users and external
4412
+ # recipients.
4413
+ #
4414
+ # * User access terminated – All QuickSight users in your account will
4415
+ # lose access immediately, including authors, readers, and
4416
+ # administrators.
4417
+ #
4418
+ # * **No recovery possible** – Once deleted, your QuickSight account and
4419
+ # all associated data cannot be restored.
4420
+ #
4421
+ # Consider exporting critical dashboards and data before proceeding
4422
+ # with
4423
+ # account deletion.
4424
+ #
4425
+ # Use the `DeleteAccountSubscription` operation to delete an QuickSight
4426
+ # account. This operation will result in an error message if you have
4427
+ # configured your account termination protection settings to `True`. To
4428
+ # change this setting and delete your account, call the
4338
4429
  # `UpdateAccountSettings` API and set the value of the
4339
4430
  # `TerminationProtectionEnabled` parameter to `False`, then make another
4340
4431
  # call to the `DeleteAccountSubscription` API.
@@ -4371,10 +4462,9 @@ module Aws::QuickSight
4371
4462
  # Deletes an analysis from Amazon QuickSight. You can optionally include
4372
4463
  # a recovery window during which you can restore the analysis. If you
4373
4464
  # don't specify a recovery window value, the operation defaults to 30
4374
- # days. Amazon QuickSight attaches a `DeletionTime` stamp to the
4375
- # response that specifies the end of the recovery window. At the end of
4376
- # the recovery window, Amazon QuickSight deletes the analysis
4377
- # permanently.
4465
+ # days. QuickSight attaches a `DeletionTime` stamp to the response that
4466
+ # specifies the end of the recovery window. At the end of the recovery
4467
+ # window, QuickSight deletes the analysis permanently.
4378
4468
  #
4379
4469
  # At any time before recovery window ends, you can use the
4380
4470
  # `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
@@ -4383,9 +4473,8 @@ module Aws::QuickSight
4383
4473
  # make a template from it.
4384
4474
  #
4385
4475
  # An analysis that's scheduled for deletion isn't accessible in the
4386
- # Amazon QuickSight console. To access it in the console, restore it.
4387
- # Deleting an analysis doesn't delete the dashboards that you publish
4388
- # from it.
4476
+ # QuickSight console. To access it in the console, restore it. Deleting
4477
+ # an analysis doesn't delete the dashboards that you publish from it.
4389
4478
  #
4390
4479
  # @option params [required, String] :aws_account_id
4391
4480
  # The ID of the Amazon Web Services account where you want to delete an
@@ -4395,8 +4484,8 @@ module Aws::QuickSight
4395
4484
  # The ID of the analysis that you're deleting.
4396
4485
  #
4397
4486
  # @option params [Integer] :recovery_window_in_days
4398
- # A value that specifies the number of days that Amazon QuickSight waits
4399
- # before it deletes the analysis. You can't use this parameter with the
4487
+ # A value that specifies the number of days that QuickSight waits before
4488
+ # it deletes the analysis. You can't use this parameter with the
4400
4489
  # `ForceDeleteWithoutRecovery` option in the same API call. The default
4401
4490
  # value is 30.
4402
4491
  #
@@ -4439,13 +4528,27 @@ module Aws::QuickSight
4439
4528
  req.send_request(options)
4440
4529
  end
4441
4530
 
4442
- # Deletes an Amazon QuickSight brand.
4531
+ # This API permanently deletes the specified QuickSight brand. When you
4532
+ # delete a brand:
4533
+ #
4534
+ # * The brand and all its associated branding elements are permanently
4535
+ # removed
4536
+ #
4537
+ # * Any applications or dashboards using this brand will revert to
4538
+ # default styling
4539
+ #
4540
+ # * This action cannot be undone through the API
4541
+ #
4542
+ # **Before proceeding:** Verify that the brand is no longer needed and
4543
+ # consider the impact on any applications currently using this brand.
4544
+ #
4545
+ # Deletes an QuickSight brand.
4443
4546
  #
4444
4547
  # @option params [required, String] :aws_account_id
4445
4548
  # The ID of the Amazon Web Services account that owns the brand.
4446
4549
  #
4447
4550
  # @option params [required, String] :brand_id
4448
- # The ID of the Amazon QuickSight brand.
4551
+ # The ID of the QuickSight brand.
4449
4552
  #
4450
4553
  # @return [Types::DeleteBrandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4451
4554
  #
@@ -4694,19 +4797,18 @@ module Aws::QuickSight
4694
4797
  req.send_request(options)
4695
4798
  end
4696
4799
 
4697
- # Deletes a linked Amazon Q Business application from an Amazon
4698
- # QuickSight account
4800
+ # Deletes a linked Amazon Q Business application from an QuickSight
4801
+ # account
4699
4802
  #
4700
4803
  # @option params [required, String] :aws_account_id
4701
- # The ID of the Amazon QuickSight account that you want to disconnect
4702
- # from a Amazon Q Business application.
4804
+ # The ID of the QuickSight account that you want to disconnect from a
4805
+ # Amazon Q Business application.
4703
4806
  #
4704
4807
  # @option params [String] :namespace
4705
- # The Amazon QuickSight namespace that you want to delete a linked
4706
- # Amazon Q Business application from. If this field is left blank, the
4707
- # Amazon Q Business application is deleted from the default namespace.
4708
- # Currently, the default namespace is the only valid value for this
4709
- # parameter.
4808
+ # The QuickSight namespace that you want to delete a linked Amazon Q
4809
+ # Business application from. If this field is left blank, the Amazon Q
4810
+ # Business application is deleted from the default namespace. Currently,
4811
+ # the default namespace is the only valid value for this parameter.
4710
4812
  #
4711
4813
  # @return [Types::DeleteDefaultQBusinessApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4712
4814
  #
@@ -4943,11 +5045,10 @@ module Aws::QuickSight
4943
5045
  end
4944
5046
 
4945
5047
  # Deletes all access scopes and authorized targets that are associated
4946
- # with a service from the Amazon QuickSight IAM Identity Center
4947
- # application.
5048
+ # with a service from the QuickSight IAM Identity Center application.
4948
5049
  #
4949
- # This operation is only supported for Amazon QuickSight accounts that
4950
- # use IAM Identity Center.
5050
+ # This operation is only supported for QuickSight accounts that use IAM
5051
+ # Identity Center.
4951
5052
  #
4952
5053
  # @option params [required, String] :aws_account_id
4953
5054
  # The ID of the Amazon Web Services account that you want to delete an
@@ -4991,7 +5092,7 @@ module Aws::QuickSight
4991
5092
  #
4992
5093
  # @option params [required, String] :aws_account_id
4993
5094
  # The ID for the Amazon Web Services account that you want to delete the
4994
- # Amazon QuickSight namespace from.
5095
+ # QuickSight namespace from.
4995
5096
  #
4996
5097
  # @option params [required, String] :namespace
4997
5098
  # The namespace that you want to delete.
@@ -5589,11 +5690,45 @@ module Aws::QuickSight
5589
5690
  req.send_request(options)
5590
5691
  end
5591
5692
 
5693
+ # Describes the custom permissions profile that is applied to an
5694
+ # account.
5695
+ #
5696
+ # @option params [required, String] :aws_account_id
5697
+ # The ID of the Amazon Web Services account for which you want to
5698
+ # describe the applied custom permissions profile.
5699
+ #
5700
+ # @return [Types::DescribeAccountCustomPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5701
+ #
5702
+ # * {Types::DescribeAccountCustomPermissionResponse#custom_permissions_name #custom_permissions_name} => String
5703
+ # * {Types::DescribeAccountCustomPermissionResponse#request_id #request_id} => String
5704
+ # * {Types::DescribeAccountCustomPermissionResponse#status #status} => Integer
5705
+ #
5706
+ # @example Request syntax with placeholder values
5707
+ #
5708
+ # resp = client.describe_account_custom_permission({
5709
+ # aws_account_id: "AwsAccountId", # required
5710
+ # })
5711
+ #
5712
+ # @example Response structure
5713
+ #
5714
+ # resp.custom_permissions_name #=> String
5715
+ # resp.request_id #=> String
5716
+ # resp.status #=> Integer
5717
+ #
5718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomPermission AWS API Documentation
5719
+ #
5720
+ # @overload describe_account_custom_permission(params = {})
5721
+ # @param [Hash] params ({})
5722
+ def describe_account_custom_permission(params = {}, options = {})
5723
+ req = build_request(:describe_account_custom_permission, params)
5724
+ req.send_request(options)
5725
+ end
5726
+
5592
5727
  # Describes the customizations associated with the provided Amazon Web
5593
- # Services account and Amazon Amazon QuickSight namespace in an Amazon
5594
- # Web Services Region. The Amazon QuickSight console evaluates which
5595
- # customizations to apply by running this API operation with the
5596
- # `Resolved` flag included.
5728
+ # Services account and Amazon QuickSight namespace in an Amazon Web
5729
+ # Services Region. The QuickSight console evaluates which customizations
5730
+ # to apply by running this API operation with the `Resolved` flag
5731
+ # included.
5597
5732
  #
5598
5733
  # To determine what customizations display when you run this command, it
5599
5734
  # can help to visualize the relationship of the entities involved.
@@ -5601,18 +5736,18 @@ module Aws::QuickSight
5601
5736
  # * `Amazon Web Services account` - The Amazon Web Services account
5602
5737
  # exists at the top of the hierarchy. It has the potential to use all
5603
5738
  # of the Amazon Web Services Regions and Amazon Web Services Services.
5604
- # When you subscribe to Amazon QuickSight, you choose one Amazon Web
5605
- # Services Region to use as your home Region. That's where your free
5606
- # SPICE capacity is located. You can use Amazon QuickSight in any
5607
- # supported Amazon Web Services Region.
5739
+ # When you subscribe to QuickSight, you choose one Amazon Web Services
5740
+ # Region to use as your home Region. That's where your free SPICE
5741
+ # capacity is located. You can use QuickSight in any supported Amazon
5742
+ # Web Services Region.
5608
5743
  #
5609
5744
  # * `Amazon Web Services Region` - In each Amazon Web Services Region
5610
- # where you sign in to Amazon QuickSight at least once, Amazon
5611
- # QuickSight acts as a separate instance of the same service. If you
5612
- # have a user directory, it resides in us-east-1, which is the US East
5613
- # (N. Virginia). Generally speaking, these users have access to Amazon
5614
- # QuickSight in any Amazon Web Services Region, unless they are
5615
- # constrained to a namespace.
5745
+ # where you sign in to QuickSight at least once, QuickSight acts as a
5746
+ # separate instance of the same service. If you have a user directory,
5747
+ # it resides in us-east-1, which is the US East (N. Virginia).
5748
+ # Generally speaking, these users have access to QuickSight in any
5749
+ # Amazon Web Services Region, unless they are constrained to a
5750
+ # namespace.
5616
5751
  #
5617
5752
  # To run the command in a different Amazon Web Services Region, you
5618
5753
  # change your Region settings. If you're using the CLI, you can use
@@ -5634,11 +5769,11 @@ module Aws::QuickSight
5634
5769
  # and Amazon Web Services Region.
5635
5770
  #
5636
5771
  # * `Applied customizations` - Within an Amazon Web Services Region, a
5637
- # set of Amazon QuickSight customizations can apply to an Amazon Web
5638
- # Services account or to a namespace. Settings that you apply to a
5639
- # namespace override settings that you apply to an Amazon Web Services
5640
- # account. All settings are isolated to a single Amazon Web Services
5641
- # Region. To apply them in other Amazon Web Services Regions, run the
5772
+ # set of QuickSight customizations can apply to an Amazon Web Services
5773
+ # account or to a namespace. Settings that you apply to a namespace
5774
+ # override settings that you apply to an Amazon Web Services account.
5775
+ # All settings are isolated to a single Amazon Web Services Region. To
5776
+ # apply them in other Amazon Web Services Regions, run the
5642
5777
  # `CreateAccountCustomization` command in each Amazon Web Services
5643
5778
  # Region where you want to apply the same customizations.
5644
5779
  #
@@ -5650,19 +5785,19 @@ module Aws::QuickSight
5650
5785
  #
5651
5786
  # @option params [required, String] :aws_account_id
5652
5787
  # The ID for the Amazon Web Services account that you want to describe
5653
- # Amazon QuickSight customizations for.
5788
+ # QuickSight customizations for.
5654
5789
  #
5655
5790
  # @option params [String] :namespace
5656
- # The Amazon QuickSight namespace that you want to describe Amazon
5657
- # QuickSight customizations for.
5791
+ # The QuickSight namespace that you want to describe QuickSight
5792
+ # customizations for.
5658
5793
  #
5659
5794
  # @option params [Boolean] :resolved
5660
5795
  # The `Resolved` flag works with the other parameters to determine which
5661
- # view of Amazon QuickSight customizations is returned. You can add this
5662
- # flag to your command to use the same view that Amazon QuickSight uses
5663
- # to identify which customizations to apply to the console. Omit this
5664
- # flag, or set it to `no-resolved`, to reveal customizations that are
5665
- # configured at different levels.
5796
+ # view of QuickSight customizations is returned. You can add this flag
5797
+ # to your command to use the same view that QuickSight uses to identify
5798
+ # which customizations to apply to the console. Omit this flag, or set
5799
+ # it to `no-resolved`, to reveal customizations that are configured at
5800
+ # different levels.
5666
5801
  #
5667
5802
  # @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5668
5803
  #
@@ -5700,7 +5835,7 @@ module Aws::QuickSight
5700
5835
  req.send_request(options)
5701
5836
  end
5702
5837
 
5703
- # Describes the settings that were used when your Amazon QuickSight
5838
+ # Describes the settings that were used when your QuickSight
5704
5839
  # subscription was first created in this Amazon Web Services account.
5705
5840
  #
5706
5841
  # @option params [required, String] :aws_account_id
@@ -5740,14 +5875,14 @@ module Aws::QuickSight
5740
5875
  end
5741
5876
 
5742
5877
  # Use the DescribeAccountSubscription operation to receive a description
5743
- # of an Amazon QuickSight account's subscription. A successful API call
5878
+ # of an QuickSight account's subscription. A successful API call
5744
5879
  # returns an `AccountInfo` object that includes an account's name,
5745
5880
  # subscription status, authentication type, edition, and notification
5746
5881
  # email address.
5747
5882
  #
5748
5883
  # @option params [required, String] :aws_account_id
5749
- # The Amazon Web Services account ID associated with your Amazon
5750
- # QuickSight account.
5884
+ # The Amazon Web Services account ID associated with your QuickSight
5885
+ # account.
5751
5886
  #
5752
5887
  # @return [Types::DescribeAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5753
5888
  #
@@ -6243,6 +6378,7 @@ module Aws::QuickSight
6243
6378
  # resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.port #=> Integer
6244
6379
  # resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.database #=> String
6245
6380
  # resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
6381
+ # resp.override_parameters.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
6246
6382
  # resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
6247
6383
  # resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
6248
6384
  # resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
@@ -6379,7 +6515,7 @@ module Aws::QuickSight
6379
6515
  # The ID of the Amazon Web Services account that owns the brand.
6380
6516
  #
6381
6517
  # @option params [required, String] :brand_id
6382
- # The ID of the Amazon QuickSight brand.
6518
+ # The ID of the QuickSight brand.
6383
6519
  #
6384
6520
  # @option params [String] :version_id
6385
6521
  # The ID of the specific version. The default value is the latest
@@ -6506,7 +6642,7 @@ module Aws::QuickSight
6506
6642
  # The ID of the Amazon Web Services account that owns the brand.
6507
6643
  #
6508
6644
  # @option params [required, String] :brand_id
6509
- # The ID of the Amazon QuickSight brand.
6645
+ # The ID of the QuickSight brand.
6510
6646
  #
6511
6647
  # @return [Types::DescribeBrandPublishedVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6512
6648
  #
@@ -6641,6 +6777,8 @@ module Aws::QuickSight
6641
6777
  # resp.custom_permissions.capabilities.export_to_csv_in_scheduled_reports #=> String, one of "DENY"
6642
6778
  # resp.custom_permissions.capabilities.export_to_excel_in_scheduled_reports #=> String, one of "DENY"
6643
6779
  # resp.custom_permissions.capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
6780
+ # resp.custom_permissions.capabilities.dashboard #=> String, one of "DENY"
6781
+ # resp.custom_permissions.capabilities.analysis #=> String, one of "DENY"
6644
6782
  # resp.request_id #=> String
6645
6783
  #
6646
6784
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeCustomPermissions AWS API Documentation
@@ -7346,7 +7484,7 @@ module Aws::QuickSight
7346
7484
  # resp.data_source.arn #=> String
7347
7485
  # resp.data_source.data_source_id #=> String
7348
7486
  # 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"
7487
+ # 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
7488
  # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
7351
7489
  # resp.data_source.created_time #=> Time
7352
7490
  # resp.data_source.last_updated_time #=> Time
@@ -7438,6 +7576,7 @@ module Aws::QuickSight
7438
7576
  # resp.data_source.data_source_parameters.impala_parameters.port #=> Integer
7439
7577
  # resp.data_source.data_source_parameters.impala_parameters.database #=> String
7440
7578
  # resp.data_source.data_source_parameters.impala_parameters.sql_endpoint_path #=> String
7579
+ # resp.data_source.data_source_parameters.custom_connection_parameters.connection_type #=> String
7441
7580
  # resp.data_source.alternate_data_source_parameters #=> Array
7442
7581
  # resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
7443
7582
  # resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
@@ -7527,6 +7666,7 @@ module Aws::QuickSight
7527
7666
  # resp.data_source.alternate_data_source_parameters[0].impala_parameters.port #=> Integer
7528
7667
  # resp.data_source.alternate_data_source_parameters[0].impala_parameters.database #=> String
7529
7668
  # resp.data_source.alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
7669
+ # resp.data_source.alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
7530
7670
  # resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
7531
7671
  # resp.data_source.ssl_properties.disable_ssl #=> Boolean
7532
7672
  # 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 +7728,18 @@ module Aws::QuickSight
7588
7728
  req.send_request(options)
7589
7729
  end
7590
7730
 
7591
- # Describes a Amazon Q Business application that is linked to an Amazon
7731
+ # Describes a Amazon Q Business application that is linked to an
7592
7732
  # QuickSight account.
7593
7733
  #
7594
7734
  # @option params [required, String] :aws_account_id
7595
- # The ID of the Amazon QuickSight account that is linked to the Amazon Q
7735
+ # The ID of the QuickSight account that is linked to the Amazon Q
7596
7736
  # Business application that you want described.
7597
7737
  #
7598
7738
  # @option params [String] :namespace
7599
- # The Amazon QuickSight namespace that contains the linked Amazon Q
7600
- # Business application. If this field is left blank, the default
7601
- # namespace is used. Currently, the default namespace is the only valid
7602
- # value for this parameter.
7739
+ # The QuickSight namespace that contains the linked Amazon Q Business
7740
+ # application. If this field is left blank, the default namespace is
7741
+ # used. Currently, the default namespace is the only valid value for
7742
+ # this parameter.
7603
7743
  #
7604
7744
  # @return [Types::DescribeDefaultQBusinessApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7605
7745
  #
@@ -8034,8 +8174,8 @@ module Aws::QuickSight
8034
8174
  req.send_request(options)
8035
8175
  end
8036
8176
 
8037
- # Describes all customer managed key registrations in a Amazon
8038
- # QuickSight account.
8177
+ # Describes all customer managed key registrations in a QuickSight
8178
+ # account.
8039
8179
  #
8040
8180
  # @option params [required, String] :aws_account_id
8041
8181
  # The ID of the Amazon Web Services account that contains the customer
@@ -8048,6 +8188,7 @@ module Aws::QuickSight
8048
8188
  #
8049
8189
  # * {Types::DescribeKeyRegistrationResponse#aws_account_id #aws_account_id} => String
8050
8190
  # * {Types::DescribeKeyRegistrationResponse#key_registration #key_registration} => Array&lt;Types::RegisteredCustomerManagedKey&gt;
8191
+ # * {Types::DescribeKeyRegistrationResponse#q_data_key #q_data_key} => Types::QDataKey
8051
8192
  # * {Types::DescribeKeyRegistrationResponse#request_id #request_id} => String
8052
8193
  # * {Types::DescribeKeyRegistrationResponse#status #status} => Integer
8053
8194
  #
@@ -8064,6 +8205,8 @@ module Aws::QuickSight
8064
8205
  # resp.key_registration #=> Array
8065
8206
  # resp.key_registration[0].key_arn #=> String
8066
8207
  # resp.key_registration[0].default_key #=> Boolean
8208
+ # resp.q_data_key.q_data_key_arn #=> String
8209
+ # resp.q_data_key.q_data_key_type #=> String, one of "AWS_OWNED", "CMK"
8067
8210
  # resp.request_id #=> String
8068
8211
  # resp.status #=> Integer
8069
8212
  #
@@ -8079,7 +8222,7 @@ module Aws::QuickSight
8079
8222
  # Describes the current namespace.
8080
8223
  #
8081
8224
  # @option params [required, String] :aws_account_id
8082
- # The ID for the Amazon Web Services account that contains the Amazon
8225
+ # The ID for the Amazon Web Services account that contains the
8083
8226
  # QuickSight namespace that you want to describe.
8084
8227
  #
8085
8228
  # @option params [required, String] :namespace
@@ -8154,11 +8297,11 @@ module Aws::QuickSight
8154
8297
  req.send_request(options)
8155
8298
  end
8156
8299
 
8157
- # Describes the state of a Amazon QuickSight Q Search configuration.
8300
+ # Describes the state of a QuickSight Q Search configuration.
8158
8301
  #
8159
8302
  # @option params [required, String] :aws_account_id
8160
- # The ID of the Amazon Web Services account that contains the Amazon
8161
- # QuickSight Q Search configuration that the user wants described.
8303
+ # The ID of the Amazon Web Services account that contains the QuickSight
8304
+ # Q Search configuration that the user wants described.
8162
8305
  #
8163
8306
  # @return [Types::DescribeQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8164
8307
  #
@@ -8766,7 +8909,7 @@ module Aws::QuickSight
8766
8909
  # resp.topic.data_sets[0].filters[0].filter_synonyms #=> Array
8767
8910
  # resp.topic.data_sets[0].filters[0].filter_synonyms[0] #=> String
8768
8911
  # 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"
8912
+ # 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
8913
  # resp.topic.data_sets[0].filters[0].category_filter.category_filter_function #=> String, one of "EXACT", "CONTAINS"
8771
8914
  # resp.topic.data_sets[0].filters[0].category_filter.category_filter_type #=> String, one of "CUSTOM_FILTER", "CUSTOM_FILTER_LIST", "FILTER_LIST"
8772
8915
  # resp.topic.data_sets[0].filters[0].category_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
@@ -8790,6 +8933,10 @@ module Aws::QuickSight
8790
8933
  # resp.topic.data_sets[0].filters[0].relative_date_filter.relative_date_filter_function #=> String, one of "PREVIOUS", "THIS", "LAST", "NEXT", "NOW"
8791
8934
  # resp.topic.data_sets[0].filters[0].relative_date_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
8792
8935
  # resp.topic.data_sets[0].filters[0].relative_date_filter.constant.singular_constant #=> String
8936
+ # resp.topic.data_sets[0].filters[0].null_filter.null_filter_type #=> String, one of "ALL_VALUES", "NON_NULLS_ONLY", "NULLS_ONLY"
8937
+ # resp.topic.data_sets[0].filters[0].null_filter.constant.constant_type #=> String, one of "SINGULAR", "RANGE", "COLLECTIVE"
8938
+ # resp.topic.data_sets[0].filters[0].null_filter.constant.singular_constant #=> String
8939
+ # resp.topic.data_sets[0].filters[0].null_filter.inverse #=> Boolean
8793
8940
  # resp.topic.data_sets[0].columns #=> Array
8794
8941
  # resp.topic.data_sets[0].columns[0].column_name #=> String
8795
8942
  # resp.topic.data_sets[0].columns[0].column_friendly_name #=> String
@@ -9212,9 +9359,9 @@ module Aws::QuickSight
9212
9359
  # \[15-600\] minutes range.
9213
9360
  #
9214
9361
  # @option params [required, String] :namespace
9215
- # The Amazon QuickSight namespace that the anonymous user virtually
9216
- # belongs to. If you are not using an Amazon QuickSight custom
9217
- # namespace, set this to `default`.
9362
+ # The QuickSight namespace that the anonymous user virtually belongs to.
9363
+ # If you are not using an Amazon QuickSight custom namespace, set this
9364
+ # to `default`.
9218
9365
  #
9219
9366
  # @option params [Array<Types::SessionTag>] :session_tags
9220
9367
  # The session tags used for row-level security. Before you use this
@@ -9231,9 +9378,8 @@ module Aws::QuickSight
9231
9378
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
9232
9379
  #
9233
9380
  # @option params [required, Array<String>] :authorized_resource_arns
9234
- # The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
9235
- # that the user is authorized to access during the lifetime of the
9236
- # session.
9381
+ # The Amazon Resource Names (ARNs) for the QuickSight resources that the
9382
+ # user is authorized to access during the lifetime of the session.
9237
9383
  #
9238
9384
  # If you choose `Dashboard` embedding experience, pass the list of
9239
9385
  # dashboard ARNs in the account that you want the user to be able to
@@ -9251,9 +9397,9 @@ module Aws::QuickSight
9251
9397
  # The domains that you want to add to the allow list for access to the
9252
9398
  # generated URL that is then embedded. This optional parameter overrides
9253
9399
  # the static domains that are configured in the Manage QuickSight menu
9254
- # in the Amazon QuickSight console. Instead, it allows only the domains
9255
- # that you include in this parameter. You can list up to three domains
9256
- # or subdomains in each API call.
9400
+ # in the QuickSight console. Instead, it allows only the domains that
9401
+ # you include in this parameter. You can list up to three domains or
9402
+ # subdomains in each API call.
9257
9403
  #
9258
9404
  # To include all subdomains under a specific domain to the allow list,
9259
9405
  # use `*`. For example, `https://*.sapp.amazon.com` includes all
@@ -9370,17 +9516,17 @@ module Aws::QuickSight
9370
9516
  #
9371
9517
  # @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
9372
9518
  # The experience that you want to embed. For registered users, you can
9373
- # embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the
9374
- # Amazon QuickSight Q search bar, the Amazon QuickSight Generative
9375
- # Q&amp;A experience, or the entire Amazon QuickSight console.
9519
+ # embed QuickSight dashboards, QuickSight visuals, the QuickSight Q
9520
+ # search bar, the QuickSight Generative Q&amp;A experience, or the
9521
+ # entire QuickSight console.
9376
9522
  #
9377
9523
  # @option params [Array<String>] :allowed_domains
9378
9524
  # The domains that you want to add to the allow list for access to the
9379
9525
  # generated URL that is then embedded. This optional parameter overrides
9380
9526
  # the static domains that are configured in the Manage QuickSight menu
9381
- # in the Amazon QuickSight console. Instead, it allows only the domains
9382
- # that you include in this parameter. You can list up to three domains
9383
- # or subdomains in each API call.
9527
+ # in the QuickSight console. Instead, it allows only the domains that
9528
+ # you include in this parameter. You can list up to three domains or
9529
+ # subdomains in each API call.
9384
9530
  #
9385
9531
  # To include all subdomains under a specific domain to the allow list,
9386
9532
  # use `*`. For example, `https://*.sapp.amazon.com` includes all
@@ -9493,9 +9639,9 @@ module Aws::QuickSight
9493
9639
  req.send_request(options)
9494
9640
  end
9495
9641
 
9496
- # Generates an embed URL that you can use to embed an Amazon QuickSight
9642
+ # Generates an embed URL that you can use to embed an QuickSight
9497
9643
  # experience in your website. This action can be used for any type of
9498
- # user that is registered in an Amazon QuickSight account that uses IAM
9644
+ # user that is registered in an QuickSight account that uses IAM
9499
9645
  # Identity Center for authentication. This API requires
9500
9646
  # [identity-enhanced IAM Role sessions][1] for the authenticated user
9501
9647
  # that the API call is being made for.
@@ -9504,9 +9650,9 @@ module Aws::QuickSight
9504
9650
  # user is authenticated and receives the embed URL that is specific to
9505
9651
  # that user. The IAM Identity Center application that the user has
9506
9652
  # logged into needs to have [trusted Identity Propagation enabled for
9507
- # Amazon QuickSight][3] with the scope value set to `quicksight:read`.
9508
- # Before you use this action, make sure that you have configured the
9509
- # relevant Amazon QuickSight resource and permissions.
9653
+ # QuickSight][3] with the scope value set to `quicksight:read`. Before
9654
+ # you use this action, make sure that you have configured the relevant
9655
+ # QuickSight resource and permissions.
9510
9656
  #
9511
9657
  #
9512
9658
  #
@@ -9522,8 +9668,7 @@ module Aws::QuickSight
9522
9668
  #
9523
9669
  # @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
9524
9670
  # The type of experience you want to embed. For registered users, you
9525
- # can embed Amazon QuickSight dashboards or the Amazon QuickSight
9526
- # console.
9671
+ # can embed QuickSight dashboards or the QuickSight console.
9527
9672
  #
9528
9673
  # <note markdown="1"> Exactly one of the experience configurations is required. You can
9529
9674
  # choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
@@ -9641,9 +9786,9 @@ module Aws::QuickSight
9641
9786
  end
9642
9787
 
9643
9788
  # Generates a temporary session URL and authorization code(bearer token)
9644
- # that you can use to embed an Amazon QuickSight read-only dashboard in
9645
- # your website or application. Before you use this command, make sure
9646
- # that you have configured the dashboards and permissions.
9789
+ # that you can use to embed an QuickSight read-only dashboard in your
9790
+ # website or application. Before you use this command, make sure that
9791
+ # you have configured the dashboards and permissions.
9647
9792
  #
9648
9793
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
9649
9794
  # not from the user's browser. The following rules apply to the
@@ -9656,7 +9801,7 @@ module Aws::QuickSight
9656
9801
  # * They are valid for 5 minutes after you run this command.
9657
9802
  #
9658
9803
  # * You are charged only when the URL is used or there is interaction
9659
- # with Amazon QuickSight.
9804
+ # with QuickSight.
9660
9805
  #
9661
9806
  # * The resulting user session is valid for 15 minutes (default) up to
9662
9807
  # 10 hours (maximum). You can use the optional
@@ -9701,11 +9846,11 @@ module Aws::QuickSight
9701
9846
  # Adds persistence of state for the user session in an embedded
9702
9847
  # dashboard. Persistence applies to the sheet and the parameter
9703
9848
  # settings. These are control settings that the dashboard subscriber
9704
- # (Amazon QuickSight reader) chooses while viewing the dashboard. If
9705
- # this is set to `TRUE`, the settings are the same when the subscriber
9706
- # reopens the same dashboard URL. The state is stored in Amazon
9707
- # QuickSight, not in a browser cookie. If this is set to FALSE, the
9708
- # state of the user session is not persisted. The default is `FALSE`.
9849
+ # (QuickSight reader) chooses while viewing the dashboard. If this is
9850
+ # set to `TRUE`, the settings are the same when the subscriber reopens
9851
+ # the same dashboard URL. The state is stored in QuickSight, not in a
9852
+ # browser cookie. If this is set to FALSE, the state of the user session
9853
+ # is not persisted. The default is `FALSE`.
9709
9854
  #
9710
9855
  # @option params [String] :user_arn
9711
9856
  # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
@@ -9725,18 +9870,17 @@ module Aws::QuickSight
9725
9870
  # role-based sessions.
9726
9871
  #
9727
9872
  # @option params [String] :namespace
9728
- # The Amazon QuickSight namespace that contains the dashboard IDs in
9729
- # this request. If you're not using a custom namespace, set `Namespace
9730
- # = default`.
9873
+ # The QuickSight namespace that contains the dashboard IDs in this
9874
+ # request. If you're not using a custom namespace, set `Namespace =
9875
+ # default`.
9731
9876
  #
9732
9877
  # @option params [Array<String>] :additional_dashboard_ids
9733
9878
  # A list of one or more dashboard IDs that you want anonymous users to
9734
9879
  # have tempporary access to. Currently, the `IdentityType` parameter
9735
9880
  # must be set to `ANONYMOUS` because other identity types authenticate
9736
- # as Amazon QuickSight or IAM users. For example, if you set
9737
- # "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
9738
- # identity-type ANONYMOUS`", the session can access all three
9739
- # dashboards.
9881
+ # as QuickSight or IAM users. For example, if you set "`--dashboard-id
9882
+ # dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS`",
9883
+ # the session can access all three dashboards.
9740
9884
  #
9741
9885
  # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9742
9886
  #
@@ -9775,14 +9919,14 @@ module Aws::QuickSight
9775
9919
  end
9776
9920
 
9777
9921
  # Generates a session URL and authorization code that you can use to
9778
- # embed the Amazon Amazon QuickSight console in your web server code.
9779
- # Use `GetSessionEmbedUrl` where you want to provide an authoring portal
9922
+ # embed the Amazon QuickSight console in your web server code. Use
9923
+ # `GetSessionEmbedUrl` where you want to provide an authoring portal
9780
9924
  # that allows users to create data sources, datasets, analyses, and
9781
- # dashboards. The users who access an embedded Amazon QuickSight console
9782
- # need belong to the author or admin security cohort. If you want to
9783
- # restrict permissions to some of these features, add a custom
9784
- # permissions profile to the user with the ` UpdateUser ` API operation.
9785
- # Use ` RegisterUser ` API operation to add a new user with a custom
9925
+ # dashboards. The users who access an embedded QuickSight console need
9926
+ # belong to the author or admin security cohort. If you want to restrict
9927
+ # permissions to some of these features, add a custom permissions
9928
+ # profile to the user with the ` UpdateUser ` API operation. Use `
9929
+ # RegisterUser ` API operation to add a new user with a custom
9786
9930
  # permission profile attached. For more information, see the following
9787
9931
  # sections in the *Amazon QuickSight User Guide*:
9788
9932
  #
@@ -9796,7 +9940,7 @@ module Aws::QuickSight
9796
9940
  # [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
9797
9941
  #
9798
9942
  # @option params [required, String] :aws_account_id
9799
- # The ID for the Amazon Web Services account associated with your Amazon
9943
+ # The ID for the Amazon Web Services account associated with your
9800
9944
  # QuickSight subscription.
9801
9945
  #
9802
9946
  # @option params [String] :entry_point
@@ -9812,10 +9956,10 @@ module Aws::QuickSight
9812
9956
  # * `/start/favorites`
9813
9957
  #
9814
9958
  # * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
9815
- # key from the Amazon QuickSight console URL of the dashboard
9959
+ # key from the QuickSight console URL of the dashboard
9816
9960
  #
9817
9961
  # * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
9818
- # from the Amazon QuickSight console URL of the analysis
9962
+ # from the QuickSight console URL of the analysis
9819
9963
  #
9820
9964
  # @option params [Integer] :session_lifetime_in_minutes
9821
9965
  # How many minutes the session is valid. The session lifetime must be
@@ -10032,7 +10176,7 @@ module Aws::QuickSight
10032
10176
  req.send_request(options)
10033
10177
  end
10034
10178
 
10035
- # Lists all brands in an Amazon QuickSight account.
10179
+ # Lists all brands in an QuickSight account.
10036
10180
  #
10037
10181
  # @option params [required, String] :aws_account_id
10038
10182
  # The ID of the Amazon Web Services account that owns the brands that
@@ -10140,6 +10284,8 @@ module Aws::QuickSight
10140
10284
  # resp.custom_permissions_list[0].capabilities.export_to_csv_in_scheduled_reports #=> String, one of "DENY"
10141
10285
  # resp.custom_permissions_list[0].capabilities.export_to_excel_in_scheduled_reports #=> String, one of "DENY"
10142
10286
  # resp.custom_permissions_list[0].capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
10287
+ # resp.custom_permissions_list[0].capabilities.dashboard #=> String, one of "DENY"
10288
+ # resp.custom_permissions_list[0].capabilities.analysis #=> String, one of "DENY"
10143
10289
  # resp.next_token #=> String
10144
10290
  # resp.request_id #=> String
10145
10291
  #
@@ -10152,7 +10298,7 @@ module Aws::QuickSight
10152
10298
  req.send_request(options)
10153
10299
  end
10154
10300
 
10155
- # Lists all the versions of the dashboards in the Amazon QuickSight
10301
+ # Lists all the versions of the dashboards in the QuickSight
10156
10302
  # subscription.
10157
10303
  #
10158
10304
  # @option params [required, String] :aws_account_id
@@ -10361,7 +10507,7 @@ module Aws::QuickSight
10361
10507
  # resp.data_sources[0].arn #=> String
10362
10508
  # resp.data_sources[0].data_source_id #=> String
10363
10509
  # 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"
10510
+ # 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
10511
  # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
10366
10512
  # resp.data_sources[0].created_time #=> Time
10367
10513
  # resp.data_sources[0].last_updated_time #=> Time
@@ -10453,6 +10599,7 @@ module Aws::QuickSight
10453
10599
  # resp.data_sources[0].data_source_parameters.impala_parameters.port #=> Integer
10454
10600
  # resp.data_sources[0].data_source_parameters.impala_parameters.database #=> String
10455
10601
  # resp.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
10602
+ # resp.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
10456
10603
  # resp.data_sources[0].alternate_data_source_parameters #=> Array
10457
10604
  # resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
10458
10605
  # resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
@@ -10542,6 +10689,7 @@ module Aws::QuickSight
10542
10689
  # resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.port #=> Integer
10543
10690
  # resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.database #=> String
10544
10691
  # resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
10692
+ # resp.data_sources[0].alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
10545
10693
  # resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
10546
10694
  # resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
10547
10695
  # 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 +11087,11 @@ module Aws::QuickSight
10939
11087
  req.send_request(options)
10940
11088
  end
10941
11089
 
10942
- # Lists all services and authorized targets that the Amazon QuickSight
10943
- # IAM Identity Center application can access.
11090
+ # Lists all services and authorized targets that the QuickSight IAM
11091
+ # Identity Center application can access.
10944
11092
  #
10945
- # This operation is only supported for Amazon QuickSight accounts that
10946
- # use IAM Identity Center.
11093
+ # This operation is only supported for QuickSight accounts that use IAM
11094
+ # Identity Center.
10947
11095
  #
10948
11096
  # @option params [required, String] :aws_account_id
10949
11097
  # The ID of the Amazon Web Services account that contain the identity
@@ -11059,7 +11207,7 @@ module Aws::QuickSight
11059
11207
  # This operation doesn't list deleted namespaces.
11060
11208
  #
11061
11209
  # @option params [required, String] :aws_account_id
11062
- # The ID for the Amazon Web Services account that contains the Amazon
11210
+ # The ID for the Amazon Web Services account that contains the
11063
11211
  # QuickSight namespaces that you want to list.
11064
11212
  #
11065
11213
  # @option params [String] :next_token
@@ -11544,7 +11692,7 @@ module Aws::QuickSight
11544
11692
  # * `CUSTOM` - Display only the themes created by people using Amazon
11545
11693
  # QuickSight.
11546
11694
  #
11547
- # * `QUICKSIGHT` - Display only the starting themes defined by Amazon
11695
+ # * `QUICKSIGHT` - Display only the starting themes defined by
11548
11696
  # QuickSight.
11549
11697
  #
11550
11698
  # @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -12356,9 +12504,9 @@ module Aws::QuickSight
12356
12504
  # user is authenticated and receives the embed URL that is specific to
12357
12505
  # that user. The IAM Identity Center application that the user has
12358
12506
  # logged into needs to have [trusted Identity Propagation enabled for
12359
- # Amazon QuickSight][2] with the scope value set to `quicksight:read`.
12360
- # Before you use this action, make sure that you have configured the
12361
- # relevant Amazon QuickSight resource and permissions.
12507
+ # QuickSight][2] with the scope value set to `quicksight:read`. Before
12508
+ # you use this action, make sure that you have configured the relevant
12509
+ # QuickSight resource and permissions.
12362
12510
  #
12363
12511
  # We recommend enabling the `QSearchStatus` API to unlock the full
12364
12512
  # potential of `PredictQnA`. When `QSearchStatus` is enabled, it first
@@ -12510,23 +12658,22 @@ module Aws::QuickSight
12510
12658
 
12511
12659
  # Creates an Amazon QuickSight user whose identity is associated with
12512
12660
  # the Identity and Access Management (IAM) identity or role specified in
12513
- # the request. When you register a new user from the Amazon QuickSight
12514
- # API, Amazon QuickSight generates a registration URL. The user accesses
12515
- # this registration URL to create their account. Amazon QuickSight
12516
- # doesn't send a registration email to users who are registered from
12517
- # the Amazon QuickSight API. If you want new users to receive a
12518
- # registration email, then add those users in the Amazon QuickSight
12519
- # console. For more information on registering a new user in the Amazon
12520
- # QuickSight console, see [ Inviting users to access Amazon
12521
- # QuickSight][1].
12661
+ # the request. When you register a new user from the QuickSight API,
12662
+ # QuickSight generates a registration URL. The user accesses this
12663
+ # registration URL to create their account. QuickSight doesn't send a
12664
+ # registration email to users who are registered from the QuickSight
12665
+ # API. If you want new users to receive a registration email, then add
12666
+ # those users in the QuickSight console. For more information on
12667
+ # registering a new user in the QuickSight console, see [ Inviting users
12668
+ # to access QuickSight][1].
12522
12669
  #
12523
12670
  #
12524
12671
  #
12525
12672
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users
12526
12673
  #
12527
12674
  # @option params [required, String] :identity_type
12528
- # The identity type that your Amazon QuickSight account uses to manage
12529
- # the identity of users.
12675
+ # The identity type that your QuickSight account uses to manage the
12676
+ # identity of users.
12530
12677
  #
12531
12678
  # @option params [required, String] :email
12532
12679
  # The email address of the user that you want to register.
@@ -12544,9 +12691,9 @@ module Aws::QuickSight
12544
12691
  # QuickSight settings.
12545
12692
  #
12546
12693
  # * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
12547
- # Reader role. Reader Pros have access to Amazon Q in Amazon
12548
- # QuickSight, can build stories with Amazon Q, and can generate
12549
- # executive summaries from dashboards.
12694
+ # Reader role. Reader Pros have access to Amazon Q in QuickSight, can
12695
+ # build stories with Amazon Q, and can generate executive summaries
12696
+ # from dashboards.
12550
12697
  #
12551
12698
  # * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
12552
12699
  # Author role. Author Pros can author dashboards with natural language
@@ -12609,17 +12756,16 @@ module Aws::QuickSight
12609
12756
  #
12610
12757
  # A set of custom permissions includes any combination of these
12611
12758
  # restrictions. Currently, you need to create the profile names for
12612
- # custom permission sets by using the Amazon QuickSight console. Then,
12613
- # you use the `RegisterUser` API operation to assign the named set of
12614
- # permissions to a Amazon QuickSight user.
12759
+ # custom permission sets by using the QuickSight console. Then, you use
12760
+ # the `RegisterUser` API operation to assign the named set of
12761
+ # permissions to a QuickSight user.
12615
12762
  #
12616
- # Amazon QuickSight custom permissions are applied through IAM policies.
12763
+ # QuickSight custom permissions are applied through IAM policies.
12617
12764
  # Therefore, they override the permissions typically granted by
12618
- # assigning Amazon QuickSight users to one of the default security
12619
- # cohorts in Amazon QuickSight (admin, author, reader, admin pro, author
12620
- # pro, reader pro).
12765
+ # assigning QuickSight users to one of the default security cohorts in
12766
+ # QuickSight (admin, author, reader, admin pro, author pro, reader pro).
12621
12767
  #
12622
- # This feature is available only to Amazon QuickSight Enterprise edition
12768
+ # This feature is available only to QuickSight Enterprise edition
12623
12769
  # subscriptions.
12624
12770
  #
12625
12771
  # @option params [String] :external_login_federation_provider_type
@@ -12639,10 +12785,10 @@ module Aws::QuickSight
12639
12785
  #
12640
12786
  # @option params [String] :custom_federation_provider_url
12641
12787
  # The URL of the custom OpenID Connect (OIDC) provider that provides
12642
- # identity to let a user federate into Amazon QuickSight with an
12643
- # associated Identity and Access Management(IAM) role. This parameter
12644
- # should only be used when `ExternalLoginFederationProviderType`
12645
- # parameter is set to `CUSTOM_OIDC`.
12788
+ # identity to let a user federate into QuickSight with an associated
12789
+ # Identity and Access Management(IAM) role. This parameter should only
12790
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
12791
+ # `CUSTOM_OIDC`.
12646
12792
  #
12647
12793
  # @option params [String] :external_login_id
12648
12794
  # The identity ID for a user in the external login provider.
@@ -13008,7 +13154,7 @@ module Aws::QuickSight
13008
13154
  # resp.data_source_summaries[0].arn #=> String
13009
13155
  # resp.data_source_summaries[0].data_source_id #=> String
13010
13156
  # 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"
13157
+ # 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
13158
  # resp.data_source_summaries[0].created_time #=> Time
13013
13159
  # resp.data_source_summaries[0].last_updated_time #=> Time
13014
13160
  # resp.next_token #=> String
@@ -13090,7 +13236,7 @@ module Aws::QuickSight
13090
13236
  end
13091
13237
 
13092
13238
  # Use the `SearchGroups` operation to search groups in a specified
13093
- # Amazon QuickSight namespace using the supplied filters.
13239
+ # QuickSight namespace using the supplied filters.
13094
13240
  #
13095
13241
  # @option params [required, String] :aws_account_id
13096
13242
  # The ID for the Amazon Web Services account that the group is in.
@@ -13155,7 +13301,7 @@ module Aws::QuickSight
13155
13301
  req.send_request(options)
13156
13302
  end
13157
13303
 
13158
- # Searches for any Q topic that exists in an Amazon QuickSight account.
13304
+ # Searches for any Q topic that exists in an QuickSight account.
13159
13305
  #
13160
13306
  # @option params [required, String] :aws_account_id
13161
13307
  # The ID of the Amazon Web Services account that contains the topic that
@@ -13217,14 +13363,14 @@ module Aws::QuickSight
13217
13363
 
13218
13364
  # Starts an Asset Bundle export job.
13219
13365
  #
13220
- # An Asset Bundle export job exports specified Amazon QuickSight assets.
13221
- # You can also choose to export any asset dependencies in the same job.
13366
+ # An Asset Bundle export job exports specified QuickSight assets. You
13367
+ # can also choose to export any asset dependencies in the same job.
13222
13368
  # Export jobs run asynchronously and can be polled with a
13223
13369
  # `DescribeAssetBundleExportJob` API call. When a job is successfully
13224
13370
  # completed, a download URL that contains the exported assets is
13225
13371
  # returned. The URL is valid for 5 minutes and can be refreshed with a
13226
- # `DescribeAssetBundleExportJob` API call. Each Amazon QuickSight
13227
- # account can run up to 5 export jobs concurrently.
13372
+ # `DescribeAssetBundleExportJob` API call. Each QuickSight account can
13373
+ # run up to 5 export jobs concurrently.
13228
13374
  #
13229
13375
  # The API caller must have the necessary permissions in their IAM role
13230
13376
  # to access each resource before the resources can be exported.
@@ -13399,13 +13545,12 @@ module Aws::QuickSight
13399
13545
 
13400
13546
  # Starts an Asset Bundle import job.
13401
13547
  #
13402
- # An Asset Bundle import job imports specified Amazon QuickSight assets
13403
- # into an Amazon QuickSight account. You can also choose to import a
13404
- # naming prefix and specified configuration overrides. The assets that
13405
- # are contained in the bundle file that you provide are used to create
13406
- # or update a new or existing asset in your Amazon QuickSight account.
13407
- # Each Amazon QuickSight account can run up to 5 import jobs
13408
- # concurrently.
13548
+ # An Asset Bundle import job imports specified QuickSight assets into an
13549
+ # QuickSight account. You can also choose to import a naming prefix and
13550
+ # specified configuration overrides. The assets that are contained in
13551
+ # the bundle file that you provide are used to create or update a new or
13552
+ # existing asset in your QuickSight account. Each QuickSight account can
13553
+ # run up to 5 import jobs concurrently.
13409
13554
  #
13410
13555
  # The API caller must have the necessary `"create"`, `"describe"`, and
13411
13556
  # `"update"` permissions in their IAM role to access each resource type
@@ -13435,7 +13580,7 @@ module Aws::QuickSight
13435
13580
  #
13436
13581
  # If you choose `DO_NOTHING`, failed import jobs will not attempt to
13437
13582
  # roll back any asset changes caused by the failed job, possibly keeping
13438
- # the Amazon QuickSight account in an inconsistent state.
13583
+ # the QuickSight account in an inconsistent state.
13439
13584
  #
13440
13585
  # @option params [Types::AssetBundleImportJobOverridePermissions] :override_permissions
13441
13586
  # Optional permission overrides that are applied to the resource
@@ -13649,6 +13794,9 @@ module Aws::QuickSight
13649
13794
  # database: "Database",
13650
13795
  # sql_endpoint_path: "SqlEndpointPath", # required
13651
13796
  # },
13797
+ # custom_connection_parameters: {
13798
+ # connection_type: "String",
13799
+ # },
13652
13800
  # },
13653
13801
  # vpc_connection_properties: {
13654
13802
  # vpc_connection_arn: "Arn", # required
@@ -13897,15 +14045,14 @@ module Aws::QuickSight
13897
14045
  #
13898
14046
  # **StartDashboardSnapshotJob API throttling**
13899
14047
  #
13900
- # Amazon QuickSight utilizes API throttling to create a more consistent
13901
- # user experience within a time span for customers when they call the
14048
+ # QuickSight utilizes API throttling to create a more consistent user
14049
+ # experience within a time span for customers when they call the
13902
14050
  # `StartDashboardSnapshotJob`. By default, 12 jobs can run
13903
14051
  # simlutaneously in one Amazon Web Services account and users can submit
13904
14052
  # up 10 API requests per second before an account is throttled. If an
13905
14053
  # overwhelming number of API requests are made by the same user in a
13906
- # short period of time, Amazon QuickSight throttles the API calls to
13907
- # maintin an optimal experience and reliability for all Amazon
13908
- # QuickSight users.
14054
+ # short period of time, QuickSight throttles the API calls to maintin an
14055
+ # optimal experience and reliability for all QuickSight users.
13909
14056
  #
13910
14057
  # **Common throttling scenarios**
13911
14058
  #
@@ -13921,8 +14068,7 @@ module Aws::QuickSight
13921
14068
  #
13922
14069
  # * **A large number of API requests are submitted on an Amazon Web
13923
14070
  # Services account.** When a user makes more than 10 API calls to the
13924
- # Amazon QuickSight API in one second, a `ThrottlingException` is
13925
- # returned.
14071
+ # QuickSight API in one second, a `ThrottlingException` is returned.
13926
14072
  #
13927
14073
  # If your use case requires a higher throttling limit, contact your
13928
14074
  # account admin or [Amazon Web ServicesSupport][1] to explore options to
@@ -13934,11 +14080,11 @@ module Aws::QuickSight
13934
14080
  # the degree of frequency and parallelism of API calls as much as you
13935
14081
  # can to avoid throttling. You can also perform a timing test to
13936
14082
  # calculate an estimate for the total processing time of your projected
13937
- # load that stays within the throttling limits of the Amazon QuickSight
13938
- # APIs. For example, if your projected traffic is 100 snapshot jobs
13939
- # before 12:00 PM per day, start 12 jobs in parallel and measure the
13940
- # amount of time it takes to proccess all 12 jobs. Once you obtain the
13941
- # result, multiply the duration by 9, for example `(12 minutes * 9 = 108
14083
+ # load that stays within the throttling limits of the QuickSight APIs.
14084
+ # For example, if your projected traffic is 100 snapshot jobs before
14085
+ # 12:00 PM per day, start 12 jobs in parallel and measure the amount of
14086
+ # time it takes to proccess all 12 jobs. Once you obtain the result,
14087
+ # multiply the duration by 9, for example `(12 minutes * 9 = 108
13942
14088
  # minutes)`. Use the new result to determine the latest time at which
13943
14089
  # the jobs need to be started to meet your target deadline.
13944
14090
  #
@@ -13982,7 +14128,7 @@ module Aws::QuickSight
13982
14128
  # @option params [required, Types::SnapshotUserConfiguration] :user_configuration
13983
14129
  # A structure that contains information about the anonymous users that
13984
14130
  # the generated snapshot is for. This API will not return information
13985
- # about registered Amazon QuickSight.
14131
+ # about registered QuickSight.
13986
14132
  #
13987
14133
  # @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
13988
14134
  # A structure that describes the configuration of the dashboard
@@ -14092,9 +14238,9 @@ module Aws::QuickSight
14092
14238
  # Only one job can run simultaneously in a given schedule. Repeated
14093
14239
  # requests are skipped with a `202` HTTP status code.
14094
14240
  #
14095
- # For more information, see [Scheduling and sending Amazon QuickSight
14096
- # reports by email][1] and [Configuring email report settings for a
14097
- # Amazon QuickSight dashboard][2] in the *Amazon QuickSight User Guide*.
14241
+ # For more information, see [Scheduling and sending QuickSight reports
14242
+ # by email][1] and [Configuring email report settings for a QuickSight
14243
+ # dashboard][2] in the *Amazon QuickSight User Guide*.
14098
14244
  #
14099
14245
  #
14100
14246
  #
@@ -14111,9 +14257,9 @@ module Aws::QuickSight
14111
14257
  #
14112
14258
  # @option params [required, String] :schedule_id
14113
14259
  # The ID of the schedule that you want to start a snapshot job schedule
14114
- # for. The schedule ID can be found in the Amazon QuickSight console in
14115
- # the **Schedules** pane of the dashboard that the schedule is
14116
- # configured for.
14260
+ # for. The schedule ID can be found in the QuickSight console in the
14261
+ # **Schedules** pane of the dashboard that the schedule is configured
14262
+ # for.
14117
14263
  #
14118
14264
  # @return [Types::StartDashboardSnapshotJobScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
14119
14265
  #
@@ -14142,8 +14288,8 @@ module Aws::QuickSight
14142
14288
  req.send_request(options)
14143
14289
  end
14144
14290
 
14145
- # Assigns one or more tags (key-value pairs) to the specified Amazon
14146
- # QuickSight resource.
14291
+ # Assigns one or more tags (key-value pairs) to the specified QuickSight
14292
+ # resource.
14147
14293
  #
14148
14294
  # Tags can help you organize and categorize your resources. You can also
14149
14295
  # use them to scope user permissions, by granting a user permission to
@@ -14154,20 +14300,20 @@ module Aws::QuickSight
14154
14300
  # key that is already associated with the resource, the new tag value
14155
14301
  # that you specify replaces the previous value for that tag.
14156
14302
  #
14157
- # You can associate as many as 50 tags with a resource. Amazon
14158
- # QuickSight supports tagging on data set, data source, dashboard,
14159
- # template, topic, and user.
14303
+ # You can associate as many as 50 tags with a resource. QuickSight
14304
+ # supports tagging on data set, data source, dashboard, template, topic,
14305
+ # and user.
14160
14306
  #
14161
- # Tagging for Amazon QuickSight works in a similar way to tagging for
14162
- # other Amazon Web Services services, except for the following:
14307
+ # Tagging for QuickSight works in a similar way to tagging for other
14308
+ # Amazon Web Services services, except for the following:
14163
14309
  #
14164
- # * Tags are used to track costs for users in Amazon QuickSight. You
14165
- # can't tag other resources that Amazon QuickSight costs are based
14166
- # on, such as storage capacoty (SPICE), session usage, alert
14167
- # consumption, or reporting units.
14310
+ # * Tags are used to track costs for users in QuickSight. You can't tag
14311
+ # other resources that QuickSight costs are based on, such as storage
14312
+ # capacoty (SPICE), session usage, alert consumption, or reporting
14313
+ # units.
14168
14314
  #
14169
- # * Amazon QuickSight doesn't currently support the tag editor for
14170
- # Resource Groups.
14315
+ # * QuickSight doesn't currently support the tag editor for Resource
14316
+ # Groups.
14171
14317
  #
14172
14318
  # @option params [required, String] :resource_arn
14173
14319
  # The Amazon Resource Name (ARN) of the resource that you want to tag.
@@ -14242,12 +14388,48 @@ module Aws::QuickSight
14242
14388
  req.send_request(options)
14243
14389
  end
14244
14390
 
14391
+ # Applies a custom permissions profile to an account.
14392
+ #
14393
+ # @option params [required, String] :custom_permissions_name
14394
+ # The name of the custom permissions profile that you want to apply to
14395
+ # an account.
14396
+ #
14397
+ # @option params [required, String] :aws_account_id
14398
+ # The ID of the Amazon Web Services account for which you want to apply
14399
+ # a custom permissions profile.
14400
+ #
14401
+ # @return [Types::UpdateAccountCustomPermissionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
14402
+ #
14403
+ # * {Types::UpdateAccountCustomPermissionResponse#request_id #request_id} => String
14404
+ # * {Types::UpdateAccountCustomPermissionResponse#status #status} => Integer
14405
+ #
14406
+ # @example Request syntax with placeholder values
14407
+ #
14408
+ # resp = client.update_account_custom_permission({
14409
+ # custom_permissions_name: "CustomPermissionsName", # required
14410
+ # aws_account_id: "AwsAccountId", # required
14411
+ # })
14412
+ #
14413
+ # @example Response structure
14414
+ #
14415
+ # resp.request_id #=> String
14416
+ # resp.status #=> Integer
14417
+ #
14418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomPermission AWS API Documentation
14419
+ #
14420
+ # @overload update_account_custom_permission(params = {})
14421
+ # @param [Hash] params ({})
14422
+ def update_account_custom_permission(params = {}, options = {})
14423
+ req = build_request(:update_account_custom_permission, params)
14424
+ req.send_request(options)
14425
+ end
14426
+
14245
14427
  # Updates Amazon QuickSight customizations for the current Amazon Web
14246
14428
  # Services Region. Currently, the only customization that you can use is
14247
14429
  # a theme.
14248
14430
  #
14249
14431
  # You can use customizations for your Amazon Web Services account or, if
14250
- # you specify a namespace, for a Amazon QuickSight namespace instead.
14432
+ # you specify a namespace, for a QuickSight namespace instead.
14251
14433
  # Customizations that apply to a namespace override customizations that
14252
14434
  # apply to an Amazon Web Services account. To find out which
14253
14435
  # customizations apply, use the `DescribeAccountCustomization` API
@@ -14255,15 +14437,14 @@ module Aws::QuickSight
14255
14437
  #
14256
14438
  # @option params [required, String] :aws_account_id
14257
14439
  # The ID for the Amazon Web Services account that you want to update
14258
- # Amazon QuickSight customizations for.
14440
+ # QuickSight customizations for.
14259
14441
  #
14260
14442
  # @option params [String] :namespace
14261
- # The namespace that you want to update Amazon QuickSight customizations
14262
- # for.
14443
+ # The namespace that you want to update QuickSight customizations for.
14263
14444
  #
14264
14445
  # @option params [required, Types::AccountCustomization] :account_customization
14265
- # The Amazon QuickSight customizations you're updating in the current
14266
- # Amazon Web Services Region.
14446
+ # The QuickSight customizations you're updating in the current Amazon
14447
+ # Web Services Region.
14267
14448
  #
14268
14449
  # @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
14269
14450
  #
@@ -14308,24 +14489,23 @@ module Aws::QuickSight
14308
14489
  # account.
14309
14490
  #
14310
14491
  # @option params [required, String] :aws_account_id
14311
- # The ID for the Amazon Web Services account that contains the Amazon
14492
+ # The ID for the Amazon Web Services account that contains the
14312
14493
  # QuickSight settings that you want to list.
14313
14494
  #
14314
14495
  # @option params [required, String] :default_namespace
14315
14496
  # The default namespace for this Amazon Web Services account. Currently,
14316
14497
  # the default is `default`. IAM users that register for the first time
14317
- # with Amazon QuickSight provide an email address that becomes
14318
- # associated with the default namespace.
14498
+ # with QuickSight provide an email address that becomes associated with
14499
+ # the default namespace.
14319
14500
  #
14320
14501
  # @option params [String] :notification_email
14321
- # The email address that you want Amazon QuickSight to send
14322
- # notifications to regarding your Amazon Web Services account or Amazon
14323
- # QuickSight subscription.
14502
+ # The email address that you want QuickSight to send notifications to
14503
+ # regarding your Amazon Web Services account or QuickSight subscription.
14324
14504
  #
14325
14505
  # @option params [Boolean] :termination_protection_enabled
14326
- # A boolean value that determines whether or not an Amazon QuickSight
14327
- # account can be deleted. A `True` value doesn't allow the account to
14328
- # be deleted and results in an error message if a user tries to make a
14506
+ # A boolean value that determines whether or not an QuickSight account
14507
+ # can be deleted. A `True` value doesn't allow the account to be
14508
+ # deleted and results in an error message if a user tries to make a
14329
14509
  # `DeleteAccountSubscription` request. A `False` value will allow the
14330
14510
  # account to be deleted.
14331
14511
  #
@@ -14369,7 +14549,7 @@ module Aws::QuickSight
14369
14549
  #
14370
14550
  # @option params [required, String] :name
14371
14551
  # A descriptive name for the analysis that you're updating. This name
14372
- # displays for the analysis in the Amazon QuickSight console.
14552
+ # displays for the analysis in the QuickSight console.
14373
14553
  #
14374
14554
  # @option params [Types::Parameters] :parameters
14375
14555
  # The parameter names and override values that you want to use. An
@@ -14383,8 +14563,8 @@ module Aws::QuickSight
14383
14563
  #
14384
14564
  # @option params [String] :theme_arn
14385
14565
  # The Amazon Resource Name (ARN) for the theme to apply to the analysis
14386
- # that you're creating. To see the theme in the Amazon QuickSight
14387
- # console, make sure that you have access to it.
14566
+ # that you're creating. To see the theme in the QuickSight console,
14567
+ # make sure that you have access to it.
14388
14568
  #
14389
14569
  # @option params [Types::AnalysisDefinition] :definition
14390
14570
  # The definition of an analysis.
@@ -14488,16 +14668,16 @@ module Aws::QuickSight
14488
14668
  req.send_request(options)
14489
14669
  end
14490
14670
 
14491
- # Updates an Amazon QuickSight application with a token exchange grant.
14492
- # This operation only supports Amazon QuickSight applications that are
14493
- # registered with IAM Identity Center.
14671
+ # Updates an QuickSight application with a token exchange grant. This
14672
+ # operation only supports QuickSight applications that are registered
14673
+ # with IAM Identity Center.
14494
14674
  #
14495
14675
  # @option params [required, String] :aws_account_id
14496
14676
  # The ID of the Amazon Web Services account to be updated with a token
14497
14677
  # exchange grant.
14498
14678
  #
14499
14679
  # @option params [required, String] :namespace
14500
- # The namespace of the Amazon QuickSight application.
14680
+ # The namespace of the QuickSight application.
14501
14681
  #
14502
14682
  # @return [Types::UpdateApplicationWithTokenExchangeGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
14503
14683
  #
@@ -14531,7 +14711,7 @@ module Aws::QuickSight
14531
14711
  # The ID of the Amazon Web Services account that owns the brand.
14532
14712
  #
14533
14713
  # @option params [required, String] :brand_id
14534
- # The ID of the Amazon QuickSight brand.
14714
+ # The ID of the QuickSight brand.
14535
14715
  #
14536
14716
  # @option params [Types::BrandDefinition] :brand_definition
14537
14717
  # The definition of the brand.
@@ -14737,7 +14917,7 @@ module Aws::QuickSight
14737
14917
  # The ID of the Amazon Web Services account that owns the brand.
14738
14918
  #
14739
14919
  # @option params [required, String] :brand_id
14740
- # The ID of the Amazon QuickSight brand.
14920
+ # The ID of the QuickSight brand.
14741
14921
  #
14742
14922
  # @option params [required, String] :version_id
14743
14923
  # The ID of the published version.
@@ -14816,6 +14996,8 @@ module Aws::QuickSight
14816
14996
  # export_to_csv_in_scheduled_reports: "DENY", # accepts DENY
14817
14997
  # export_to_excel_in_scheduled_reports: "DENY", # accepts DENY
14818
14998
  # include_content_in_scheduled_reports_email: "DENY", # accepts DENY
14999
+ # dashboard: "DENY", # accepts DENY
15000
+ # analysis: "DENY", # accepts DENY
14819
15001
  # },
14820
15002
  # })
14821
15003
  #
@@ -14862,7 +15044,7 @@ module Aws::QuickSight
14862
15044
  # the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
14863
15045
  # the Amazon Resource Name (ARN) of the source template. The
14864
15046
  # `SourceTemplate` ARN can contain any Amazon Web Services account and
14865
- # any Amazon QuickSight-supported Amazon Web Services Region.
15047
+ # any QuickSight-supported Amazon Web Services Region.
14866
15048
  #
14867
15049
  # Use the `DataSetReferences` entity within `SourceTemplate` to list the
14868
15050
  # replacement datasets for the placeholders listed in the original. The
@@ -14881,9 +15063,9 @@ module Aws::QuickSight
14881
15063
  #
14882
15064
  # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
14883
15065
  # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
14884
- # Amazon QuickSight disables the left filter pane on the published
14885
- # dashboard, which can be used for ad hoc (one-time) filtering. This
14886
- # option is `ENABLED` by default.
15066
+ # QuickSight disables the left filter pane on the published dashboard,
15067
+ # which can be used for ad hoc (one-time) filtering. This option is
15068
+ # `ENABLED` by default.
14887
15069
  #
14888
15070
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
14889
15071
  # either `ENABLED` or `DISABLED`. The visual option to export data to
@@ -14894,6 +15076,16 @@ module Aws::QuickSight
14894
15076
  # can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
14895
15077
  # by default.
14896
15078
  #
15079
+ # * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
15080
+ # be either `ENABLED` or `DISABLED`. The option to build an executive
15081
+ # summary is disabled when this is set to `DISABLED`. This option is
15082
+ # `ENABLED` by default.
15083
+ #
15084
+ # * `AvailabilityStatus` for `DataStoriesSharingOption` - This status
15085
+ # can be either `ENABLED` or `DISABLED`. The option to share a data
15086
+ # story is disabled when this is set to `DISABLED`. This option is
15087
+ # `ENABLED` by default.
15088
+ #
14897
15089
  # @option params [String] :theme_arn
14898
15090
  # The Amazon Resource Name (ARN) of the theme that is being used for
14899
15091
  # this dashboard. If you add a value for this field, it overrides the
@@ -15175,7 +15367,7 @@ module Aws::QuickSight
15175
15367
  # Indicates whether you want to import the data into SPICE.
15176
15368
  #
15177
15369
  # @option params [Array<Types::ColumnGroup>] :column_groups
15178
- # Groupings of columns that work together in certain Amazon QuickSight
15370
+ # Groupings of columns that work together in certain QuickSight
15179
15371
  # features. Currently, only geospatial hierarchy is supported.
15180
15372
  #
15181
15373
  # @option params [Hash<String,Types::FieldFolder>] :field_folders
@@ -15525,20 +15717,20 @@ module Aws::QuickSight
15525
15717
  # A display name for the data source.
15526
15718
  #
15527
15719
  # @option params [Types::DataSourceParameters] :data_source_parameters
15528
- # The parameters that Amazon QuickSight uses to connect to your
15529
- # underlying source.
15720
+ # The parameters that QuickSight uses to connect to your underlying
15721
+ # source.
15530
15722
  #
15531
15723
  # @option params [Types::DataSourceCredentials] :credentials
15532
- # The credentials that Amazon QuickSight that uses to connect to your
15724
+ # The credentials that QuickSight that uses to connect to your
15533
15725
  # underlying source. Currently, only credentials based on user name and
15534
15726
  # password are supported.
15535
15727
  #
15536
15728
  # @option params [Types::VpcConnectionProperties] :vpc_connection_properties
15537
- # Use this parameter only when you want Amazon QuickSight to use a VPC
15729
+ # Use this parameter only when you want QuickSight to use a VPC
15538
15730
  # connection when connecting to your underlying source.
15539
15731
  #
15540
15732
  # @option params [Types::SslProperties] :ssl_properties
15541
- # Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
15733
+ # Secure Socket Layer (SSL) properties that apply when QuickSight
15542
15734
  # connects to your underlying source.
15543
15735
  #
15544
15736
  # @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -15713,6 +15905,9 @@ module Aws::QuickSight
15713
15905
  # database: "Database",
15714
15906
  # sql_endpoint_path: "SqlEndpointPath", # required
15715
15907
  # },
15908
+ # custom_connection_parameters: {
15909
+ # connection_type: "String",
15910
+ # },
15716
15911
  # },
15717
15912
  # credentials: {
15718
15913
  # credential_pair: {
@@ -15877,6 +16072,9 @@ module Aws::QuickSight
15877
16072
  # database: "Database",
15878
16073
  # sql_endpoint_path: "SqlEndpointPath", # required
15879
16074
  # },
16075
+ # custom_connection_parameters: {
16076
+ # connection_type: "String",
16077
+ # },
15880
16078
  # },
15881
16079
  # ],
15882
16080
  # },
@@ -15967,18 +16165,18 @@ module Aws::QuickSight
15967
16165
  req.send_request(options)
15968
16166
  end
15969
16167
 
15970
- # Updates a Amazon Q Business application that is linked to a Amazon
15971
- # QuickSight account.
16168
+ # Updates a Amazon Q Business application that is linked to a QuickSight
16169
+ # account.
15972
16170
  #
15973
16171
  # @option params [required, String] :aws_account_id
15974
- # The ID of the Amazon QuickSight account that is connected to the
15975
- # Amazon Q Business application that you want to update.
16172
+ # The ID of the QuickSight account that is connected to the Amazon Q
16173
+ # Business application that you want to update.
15976
16174
  #
15977
16175
  # @option params [String] :namespace
15978
- # The Amazon QuickSight namespace that contains the linked Amazon Q
15979
- # Business application. If this field is left blank, the default
15980
- # namespace is used. Currently, the default namespace is the only valid
15981
- # value for this parameter.
16176
+ # The QuickSight namespace that contains the linked Amazon Q Business
16177
+ # application. If this field is left blank, the default namespace is
16178
+ # used. Currently, the default namespace is the only valid value for
16179
+ # this parameter.
15982
16180
  #
15983
16181
  # @option params [required, String] :application_id
15984
16182
  # The ID of the Amazon Q Business application that you want to update.
@@ -16194,12 +16392,12 @@ module Aws::QuickSight
16194
16392
  # when creating the data source.
16195
16393
  #
16196
16394
  # @option params [String] :policy_arn
16197
- # The ARN for the IAM policy to apply to the Amazon QuickSight users and
16198
- # groups specified in this assignment.
16395
+ # The ARN for the IAM policy to apply to the QuickSight users and groups
16396
+ # specified in this assignment.
16199
16397
  #
16200
16398
  # @option params [Hash<String,Array>] :identities
16201
- # The Amazon QuickSight users, groups, or both that you want to assign
16202
- # the policy to.
16399
+ # The QuickSight users, groups, or both that you want to assign the
16400
+ # policy to.
16203
16401
  #
16204
16402
  # @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
16205
16403
  #
@@ -16246,10 +16444,10 @@ module Aws::QuickSight
16246
16444
  end
16247
16445
 
16248
16446
  # Adds or updates services and authorized targets to configure what the
16249
- # Amazon QuickSight IAM Identity Center application can access.
16447
+ # QuickSight IAM Identity Center application can access.
16250
16448
  #
16251
- # This operation is only supported for Amazon QuickSight accounts using
16252
- # IAM Identity Center
16449
+ # This operation is only supported for QuickSight accounts using IAM
16450
+ # Identity Center
16253
16451
  #
16254
16452
  # @option params [required, String] :aws_account_id
16255
16453
  # The ID of the Amazon Web Services account that contains the identity
@@ -16352,7 +16550,7 @@ module Aws::QuickSight
16352
16550
  req.send_request(options)
16353
16551
  end
16354
16552
 
16355
- # Updates a customer managed key in a Amazon QuickSight account.
16553
+ # Updates a customer managed key in a QuickSight account.
16356
16554
  #
16357
16555
  # @option params [required, String] :aws_account_id
16358
16556
  # The ID of the Amazon Web Services account that contains the customer
@@ -16360,7 +16558,7 @@ module Aws::QuickSight
16360
16558
  #
16361
16559
  # @option params [required, Array<Types::RegisteredCustomerManagedKey>] :key_registration
16362
16560
  # A list of `RegisteredCustomerManagedKey` objects to be updated to the
16363
- # Amazon QuickSight account.
16561
+ # QuickSight account.
16364
16562
  #
16365
16563
  # @return [Types::UpdateKeyRegistrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
16366
16564
  #
@@ -16401,29 +16599,42 @@ module Aws::QuickSight
16401
16599
  req.send_request(options)
16402
16600
  end
16403
16601
 
16602
+ # This API controls public sharing settings for your entire QuickSight
16603
+ # account, affecting data security and access. When you enable public
16604
+ # sharing:
16605
+ #
16606
+ # * Dashboards can be shared publicly
16607
+ #
16608
+ # * This setting affects your entire Amazon Web Services account and all
16609
+ # QuickSight users
16610
+ #
16611
+ # **Before proceeding:** Ensure you understand the security
16612
+ # implications
16613
+ # and have proper IAM permissions configured.
16614
+ #
16404
16615
  # Use the `UpdatePublicSharingSettings` operation to turn on or turn off
16405
- # the public sharing settings of an Amazon QuickSight dashboard.
16616
+ # the public sharing settings of an QuickSight dashboard.
16406
16617
  #
16407
16618
  # To use this operation, turn on session capacity pricing for your
16408
- # Amazon QuickSight account.
16619
+ # QuickSight account.
16409
16620
  #
16410
16621
  # Before you can turn on public sharing on your account, make sure to
16411
16622
  # give public sharing permissions to an administrative user in the
16412
16623
  # Identity and Access Management (IAM) console. For more information on
16413
- # using IAM with Amazon QuickSight, see [Using Amazon QuickSight with
16414
- # IAM][1] in the *Amazon QuickSight User Guide*.
16624
+ # using IAM with QuickSight, see [Using QuickSight with IAM][1] in the
16625
+ # *QuickSight User Guide*.
16415
16626
  #
16416
16627
  #
16417
16628
  #
16418
16629
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html
16419
16630
  #
16420
16631
  # @option params [required, String] :aws_account_id
16421
- # The Amazon Web Services account ID associated with your Amazon
16422
- # QuickSight subscription.
16632
+ # The Amazon Web Services account ID associated with your QuickSight
16633
+ # subscription.
16423
16634
  #
16424
16635
  # @option params [Boolean] :public_sharing_enabled
16425
16636
  # A Boolean value that indicates whether public sharing is turned on for
16426
- # an Amazon QuickSight account.
16637
+ # an QuickSight account.
16427
16638
  #
16428
16639
  # @return [Types::UpdatePublicSharingSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
16429
16640
  #
@@ -16458,9 +16669,9 @@ module Aws::QuickSight
16458
16669
  # personalization configuration that the user wants to update.
16459
16670
  #
16460
16671
  # @option params [required, String] :personalization_mode
16461
- # An option to allow Amazon QuickSight to customize data stories with
16462
- # user specific metadata, specifically location and job information, in
16463
- # your IAM Identity Center instance.
16672
+ # An option to allow QuickSight to customize data stories with user
16673
+ # specific metadata, specifically location and job information, in your
16674
+ # IAM Identity Center instance.
16464
16675
  #
16465
16676
  # @return [Types::UpdateQPersonalizationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
16466
16677
  #
@@ -16490,15 +16701,15 @@ module Aws::QuickSight
16490
16701
  req.send_request(options)
16491
16702
  end
16492
16703
 
16493
- # Updates the state of a Amazon QuickSight Q Search configuration.
16704
+ # Updates the state of a QuickSight Q Search configuration.
16494
16705
  #
16495
16706
  # @option params [required, String] :aws_account_id
16496
- # The ID of the Amazon Web Services account that contains the Amazon
16497
- # QuickSight Q Search configuration that you want to update.
16707
+ # The ID of the Amazon Web Services account that contains the QuickSight
16708
+ # Q Search configuration that you want to update.
16498
16709
  #
16499
16710
  # @option params [required, String] :q_search_status
16500
- # The status of the Amazon QuickSight Q Search configuration that the
16501
- # user wants to update.
16711
+ # The status of the QuickSight Q Search configuration that the user
16712
+ # wants to update.
16502
16713
  #
16503
16714
  # @return [Types::UpdateQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
16504
16715
  #
@@ -16630,8 +16841,7 @@ module Aws::QuickSight
16630
16841
  req.send_request(options)
16631
16842
  end
16632
16843
 
16633
- # Updates the SPICE capacity configuration for a Amazon QuickSight
16634
- # account.
16844
+ # Updates the SPICE capacity configuration for a QuickSight account.
16635
16845
  #
16636
16846
  # @option params [required, String] :aws_account_id
16637
16847
  # The ID of the Amazon Web Services account that contains the SPICE
@@ -16691,7 +16901,7 @@ module Aws::QuickSight
16691
16901
  # For `SourceTemplate`, specify the ARN of the source template. For
16692
16902
  # `SourceAnalysis`, specify the ARN of the source analysis. The
16693
16903
  # `SourceTemplate` ARN can contain any Amazon Web Services account and
16694
- # any Amazon QuickSight-supported Amazon Web Services Region;.
16904
+ # any QuickSight-supported Amazon Web Services Region;.
16695
16905
  #
16696
16906
  # Use the `DataSetReferences` entity within `SourceTemplate` or
16697
16907
  # `SourceAnalysis` to list the replacement datasets for the placeholders
@@ -16871,8 +17081,8 @@ module Aws::QuickSight
16871
17081
  #
16872
17082
  # @option params [required, String] :base_theme_id
16873
17083
  # The theme ID, defined by Amazon QuickSight, that a custom theme
16874
- # inherits from. All themes initially inherit from a default Amazon
16875
- # QuickSight theme.
17084
+ # inherits from. All themes initially inherit from a default QuickSight
17085
+ # theme.
16876
17086
  #
16877
17087
  # @option params [String] :version_description
16878
17088
  # A description of the theme version that you're updating Every time
@@ -17164,7 +17374,7 @@ module Aws::QuickSight
17164
17374
  # filter_name: "LimitedString", # required
17165
17375
  # filter_synonyms: ["LimitedString"],
17166
17376
  # 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
17377
+ # filter_type: "CATEGORY_FILTER", # accepts CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, RELATIVE_DATE_FILTER, NULL_FILTER
17168
17378
  # category_filter: {
17169
17379
  # category_filter_function: "EXACT", # accepts EXACT, CONTAINS
17170
17380
  # category_filter_type: "CUSTOM_FILTER", # accepts CUSTOM_FILTER, CUSTOM_FILTER_LIST, FILTER_LIST
@@ -17213,6 +17423,14 @@ module Aws::QuickSight
17213
17423
  # singular_constant: "LimitedString",
17214
17424
  # },
17215
17425
  # },
17426
+ # null_filter: {
17427
+ # null_filter_type: "ALL_VALUES", # accepts ALL_VALUES, NON_NULLS_ONLY, NULLS_ONLY
17428
+ # constant: {
17429
+ # constant_type: "SINGULAR", # accepts SINGULAR, RANGE, COLLECTIVE
17430
+ # singular_constant: "LimitedString",
17431
+ # },
17432
+ # inverse: false,
17433
+ # },
17216
17434
  # },
17217
17435
  # ],
17218
17436
  # columns: [
@@ -17538,9 +17756,9 @@ module Aws::QuickSight
17538
17756
  # QuickSight settings.
17539
17757
  #
17540
17758
  # * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
17541
- # Reader role. Reader Pros have access to Amazon Q in Amazon
17542
- # QuickSight, can build stories with Amazon Q, and can generate
17543
- # executive summaries from dashboards.
17759
+ # Reader role. Reader Pros have access to Amazon Q in QuickSight, can
17760
+ # build stories with Amazon Q, and can generate executive summaries
17761
+ # from dashboards.
17544
17762
  #
17545
17763
  # * `AUTHOR_PRO`: Author Pro adds Generative BI capabilities to the
17546
17764
  # Author role. Author Pros can author dashboards with natural language
@@ -17551,8 +17769,8 @@ module Aws::QuickSight
17551
17769
  # QuickSight administrative settings. Admin Pro users are billed at
17552
17770
  # Author Pro pricing.
17553
17771
  #
17554
- # The name of the Amazon QuickSight role is invisible to the user except
17555
- # for the console screens dealing with permissions.
17772
+ # The name of the QuickSight role is invisible to the user except for
17773
+ # the console screens dealing with permissions.
17556
17774
  #
17557
17775
  # @option params [String] :custom_permissions_name
17558
17776
  # (Enterprise edition only) The name of the custom permissions profile
@@ -17570,16 +17788,16 @@ module Aws::QuickSight
17570
17788
  #
17571
17789
  # A set of custom permissions includes any combination of these
17572
17790
  # restrictions. Currently, you need to create the profile names for
17573
- # custom permission sets by using the Amazon QuickSight console. Then,
17574
- # you use the `RegisterUser` API operation to assign the named set of
17575
- # permissions to a Amazon QuickSight user.
17791
+ # custom permission sets by using the QuickSight console. Then, you use
17792
+ # the `RegisterUser` API operation to assign the named set of
17793
+ # permissions to a QuickSight user.
17576
17794
  #
17577
- # Amazon QuickSight custom permissions are applied through IAM policies.
17795
+ # QuickSight custom permissions are applied through IAM policies.
17578
17796
  # Therefore, they override the permissions typically granted by
17579
- # assigning Amazon QuickSight users to one of the default security
17580
- # cohorts in Amazon QuickSight (admin, author, reader).
17797
+ # assigning QuickSight users to one of the default security cohorts in
17798
+ # QuickSight (admin, author, reader).
17581
17799
  #
17582
- # This feature is available only to Amazon QuickSight Enterprise edition
17800
+ # This feature is available only to QuickSight Enterprise edition
17583
17801
  # subscriptions.
17584
17802
  #
17585
17803
  # @option params [Boolean] :unapply_custom_permissions
@@ -17591,9 +17809,9 @@ module Aws::QuickSight
17591
17809
  #
17592
17810
  # @option params [String] :external_login_federation_provider_type
17593
17811
  # The type of supported external login provider that provides identity
17594
- # to let a user federate into Amazon QuickSight with an associated
17595
- # Identity and Access Management(IAM) role. The type of supported
17596
- # external login provider can be one of the following.
17812
+ # to let a user federate into QuickSight with an associated Identity and
17813
+ # Access Management(IAM) role. The type of supported external login
17814
+ # provider can be one of the following.
17597
17815
  #
17598
17816
  # * `COGNITO`: Amazon Cognito. The provider URL is
17599
17817
  # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
@@ -17610,10 +17828,10 @@ module Aws::QuickSight
17610
17828
  #
17611
17829
  # @option params [String] :custom_federation_provider_url
17612
17830
  # The URL of the custom OpenID Connect (OIDC) provider that provides
17613
- # identity to let a user federate into Amazon QuickSight with an
17614
- # associated Identity and Access Management(IAM) role. This parameter
17615
- # should only be used when `ExternalLoginFederationProviderType`
17616
- # parameter is set to `CUSTOM_OIDC`.
17831
+ # identity to let a user federate into QuickSight with an associated
17832
+ # Identity and Access Management(IAM) role. This parameter should only
17833
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
17834
+ # `CUSTOM_OIDC`.
17617
17835
  #
17618
17836
  # @option params [String] :external_login_id
17619
17837
  # The identity ID for a user in the external login provider.
@@ -17792,7 +18010,7 @@ module Aws::QuickSight
17792
18010
  tracer: tracer
17793
18011
  )
17794
18012
  context[:gem_name] = 'aws-sdk-quicksight'
17795
- context[:gem_version] = '1.157.0'
18013
+ context[:gem_version] = '1.159.0'
17796
18014
  Seahorse::Client::Request.new(handlers, context)
17797
18015
  end
17798
18016