aws-sdk-quicksight 1.159.0 → 1.161.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1662 -472
- data/lib/aws-sdk-quicksight/client_api.rb +725 -0
- data/lib/aws-sdk-quicksight/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-quicksight/types.rb +2716 -626
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/sig/client.rbs +529 -5
- data/sig/types.rbs +569 -3
- metadata +1 -1
|
@@ -1382,15 +1382,15 @@ module Aws::QuickSight
|
|
|
1382
1382
|
req.send_request(options)
|
|
1383
1383
|
end
|
|
1384
1384
|
|
|
1385
|
-
# Creates Amazon
|
|
1386
|
-
#
|
|
1387
|
-
#
|
|
1388
|
-
#
|
|
1389
|
-
#
|
|
1390
|
-
#
|
|
1385
|
+
# Creates Amazon Quick Sight customizations. Currently, you can add a
|
|
1386
|
+
# custom default theme by using the `CreateAccountCustomization` or
|
|
1387
|
+
# `UpdateAccountCustomization` API operation. To further customize
|
|
1388
|
+
# Amazon Quick Sight by removing Amazon Quick Sight sample assets and
|
|
1389
|
+
# videos for all new users, see [Customizing Quick Sight][1] in the
|
|
1390
|
+
# *Amazon Quick Sight User Guide.*
|
|
1391
1391
|
#
|
|
1392
1392
|
# You can create customizations for your Amazon Web Services account or,
|
|
1393
|
-
# if you specify a namespace, for a
|
|
1393
|
+
# if you specify a namespace, for a Quick Sight namespace instead.
|
|
1394
1394
|
# Customizations that apply to a namespace always override
|
|
1395
1395
|
# customizations that apply to an Amazon Web Services account. To find
|
|
1396
1396
|
# out which customizations apply, use the `DescribeAccountCustomization`
|
|
@@ -1411,15 +1411,14 @@ module Aws::QuickSight
|
|
|
1411
1411
|
#
|
|
1412
1412
|
# @option params [required, String] :aws_account_id
|
|
1413
1413
|
# The ID for the Amazon Web Services account that you want to customize
|
|
1414
|
-
#
|
|
1414
|
+
# Quick Sight for.
|
|
1415
1415
|
#
|
|
1416
1416
|
# @option params [String] :namespace
|
|
1417
|
-
# The
|
|
1417
|
+
# The Quick Sight namespace that you want to add customizations to.
|
|
1418
1418
|
#
|
|
1419
1419
|
# @option params [required, Types::AccountCustomization] :account_customization
|
|
1420
|
-
# The
|
|
1421
|
-
#
|
|
1422
|
-
# and a QuickSight namespace.
|
|
1420
|
+
# The Quick Sight customizations you're adding. You can add these to an
|
|
1421
|
+
# Amazon Web Services account and a QuickSight namespace.
|
|
1423
1422
|
#
|
|
1424
1423
|
# For example, you can add a default theme by setting
|
|
1425
1424
|
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
|
@@ -1477,7 +1476,8 @@ module Aws::QuickSight
|
|
|
1477
1476
|
req.send_request(options)
|
|
1478
1477
|
end
|
|
1479
1478
|
|
|
1480
|
-
# Creates an
|
|
1479
|
+
# Creates an Amazon Quick Sight account, or subscribes to Amazon Quick
|
|
1480
|
+
# Sight Q.
|
|
1481
1481
|
#
|
|
1482
1482
|
# The Amazon Web Services Region for the account is derived from what is
|
|
1483
1483
|
# configured in the CLI or SDK.
|
|
@@ -1485,10 +1485,10 @@ module Aws::QuickSight
|
|
|
1485
1485
|
# Before you use this operation, make sure that you can connect to an
|
|
1486
1486
|
# existing Amazon Web Services account. If you don't have an Amazon Web
|
|
1487
1487
|
# Services account, see [Sign up for Amazon Web Services][1] in the
|
|
1488
|
-
# *Amazon
|
|
1489
|
-
# needs to have the correct Identity and Access Management
|
|
1490
|
-
# permissions. For more information, see [IAM Policy Examples for
|
|
1491
|
-
#
|
|
1488
|
+
# *Amazon Quick Sight User Guide*. The person who signs up for Amazon
|
|
1489
|
+
# Quick Sight needs to have the correct Identity and Access Management
|
|
1490
|
+
# (IAM) permissions. For more information, see [IAM Policy Examples for
|
|
1491
|
+
# Amazon Quick Sight][2] in the *Amazon Quick Sight User Guide*.
|
|
1492
1492
|
#
|
|
1493
1493
|
# If your IAM policy includes both the `Subscribe` and
|
|
1494
1494
|
# `CreateAccountSubscription` actions, make sure that both actions are
|
|
@@ -1497,15 +1497,15 @@ module Aws::QuickSight
|
|
|
1497
1497
|
#
|
|
1498
1498
|
# You can't pass an existing IAM role to access other Amazon Web
|
|
1499
1499
|
# Services services using this API operation. To pass your existing IAM
|
|
1500
|
-
# role to
|
|
1501
|
-
# *
|
|
1500
|
+
# role to Amazon Quick Sight, see [Passing IAM roles to Amazon Quick
|
|
1501
|
+
# Sight][3] in the *Amazon Quick Sight User Guide*.
|
|
1502
1502
|
#
|
|
1503
1503
|
# You can't set default resource access on the new account from the
|
|
1504
|
-
#
|
|
1505
|
-
#
|
|
1504
|
+
# Amazon Quick Sight API. Instead, add default resource access from the
|
|
1505
|
+
# Amazon Quick Sight console. For more information about setting default
|
|
1506
1506
|
# resource access to Amazon Web Services services, see [Setting default
|
|
1507
|
-
# resource access to Amazon Web Services services][4] in the *
|
|
1508
|
-
# User Guide*.
|
|
1507
|
+
# resource access to Amazon Web Services services][4] in the *Amazon
|
|
1508
|
+
# Quick Sight User Guide*.
|
|
1509
1509
|
#
|
|
1510
1510
|
#
|
|
1511
1511
|
#
|
|
@@ -1515,7 +1515,7 @@ module Aws::QuickSight
|
|
|
1515
1515
|
# [4]: https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html
|
|
1516
1516
|
#
|
|
1517
1517
|
# @option params [String] :edition
|
|
1518
|
-
# The edition of
|
|
1518
|
+
# The edition of Amazon Quick Sight that you want your account to have.
|
|
1519
1519
|
# Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
|
|
1520
1520
|
#
|
|
1521
1521
|
# If you choose `ENTERPRISE_AND_Q`, the following parameters are
|
|
@@ -1530,7 +1530,7 @@ module Aws::QuickSight
|
|
|
1530
1530
|
# * `ContactNumber`
|
|
1531
1531
|
#
|
|
1532
1532
|
# @option params [required, String] :authentication_method
|
|
1533
|
-
# The method that you want to use to authenticate your
|
|
1533
|
+
# The method that you want to use to authenticate your Quick Sight
|
|
1534
1534
|
# account.
|
|
1535
1535
|
#
|
|
1536
1536
|
# If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName` and
|
|
@@ -1541,43 +1541,44 @@ module Aws::QuickSight
|
|
|
1541
1541
|
#
|
|
1542
1542
|
# @option params [required, String] :aws_account_id
|
|
1543
1543
|
# The Amazon Web Services account ID of the account that you're using
|
|
1544
|
-
# to create your
|
|
1544
|
+
# to create your Quick Sight account.
|
|
1545
1545
|
#
|
|
1546
1546
|
# @option params [required, String] :account_name
|
|
1547
|
-
# The name of your
|
|
1548
|
-
# Amazon Web Services, and it appears only when users sign in.
|
|
1549
|
-
# can't change `AccountName` value after the
|
|
1550
|
-
# created.
|
|
1547
|
+
# The name of your Amazon Quick Sight account. This name is unique over
|
|
1548
|
+
# all of Amazon Web Services, and it appears only when users sign in.
|
|
1549
|
+
# You can't change `AccountName` value after the Amazon Quick Sight
|
|
1550
|
+
# account is created.
|
|
1551
1551
|
#
|
|
1552
1552
|
# @option params [required, String] :notification_email
|
|
1553
|
-
# The email address that you want
|
|
1554
|
-
# regarding your
|
|
1553
|
+
# The email address that you want Quick Sight to send notifications to
|
|
1554
|
+
# regarding your Quick Sight account or Quick Sight subscription.
|
|
1555
1555
|
#
|
|
1556
1556
|
# @option params [String] :active_directory_name
|
|
1557
1557
|
# The name of your Active Directory. This field is required if
|
|
1558
1558
|
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
|
1559
|
-
#
|
|
1559
|
+
# Quick Sight account.
|
|
1560
1560
|
#
|
|
1561
1561
|
# @option params [String] :realm
|
|
1562
|
-
# The realm of the Active Directory that is associated with your
|
|
1563
|
-
#
|
|
1564
|
-
#
|
|
1562
|
+
# The realm of the Active Directory that is associated with your Quick
|
|
1563
|
+
# Sight account. This field is required if `ACTIVE_DIRECTORY` is the
|
|
1564
|
+
# selected authentication method of the new Quick Sight account.
|
|
1565
1565
|
#
|
|
1566
1566
|
# @option params [String] :directory_id
|
|
1567
|
-
# The ID of the Active Directory that is associated with your
|
|
1568
|
-
# account.
|
|
1567
|
+
# The ID of the Active Directory that is associated with your Quick
|
|
1568
|
+
# Sight account.
|
|
1569
1569
|
#
|
|
1570
1570
|
# @option params [Array<String>] :admin_group
|
|
1571
1571
|
# The admin group associated with your Active Directory or IAM Identity
|
|
1572
1572
|
# Center account. Either this field or the `AdminProGroup` field is
|
|
1573
1573
|
# required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
|
1574
|
-
# selected authentication method of the new
|
|
1574
|
+
# selected authentication method of the new Quick Sight account.
|
|
1575
1575
|
#
|
|
1576
|
-
# For more information about using IAM Identity Center in
|
|
1577
|
-
# see [Using IAM Identity Center with
|
|
1578
|
-
# in the
|
|
1579
|
-
#
|
|
1580
|
-
# Enterprise Edition][2]
|
|
1576
|
+
# For more information about using IAM Identity Center in Amazon Quick
|
|
1577
|
+
# Sight, see [Using IAM Identity Center with Amazon Quick Sight
|
|
1578
|
+
# Enterprise Edition][1] in the Amazon Quick Sight User Guide. For more
|
|
1579
|
+
# information about using Active Directory in Amazon Quick Sight, see
|
|
1580
|
+
# [Using Active Directory with Amazon Quick Sight Enterprise Edition][2]
|
|
1581
|
+
# in the Amazon Quick Sight User Guide.
|
|
1581
1582
|
#
|
|
1582
1583
|
#
|
|
1583
1584
|
#
|
|
@@ -1588,11 +1589,12 @@ module Aws::QuickSight
|
|
|
1588
1589
|
# The author group associated with your Active Directory or IAM Identity
|
|
1589
1590
|
# Center account.
|
|
1590
1591
|
#
|
|
1591
|
-
# For more information about using IAM Identity Center in
|
|
1592
|
-
# see [Using IAM Identity Center with
|
|
1593
|
-
# in the
|
|
1594
|
-
#
|
|
1595
|
-
# Enterprise Edition][2]
|
|
1592
|
+
# For more information about using IAM Identity Center in Amazon Quick
|
|
1593
|
+
# Sight, see [Using IAM Identity Center with Amazon Quick Sight
|
|
1594
|
+
# Enterprise Edition][1] in the Amazon Quick Sight User Guide. For more
|
|
1595
|
+
# information about using Active Directory in Amazon Quick Sight, see
|
|
1596
|
+
# [Using Active Directory with Amazon Quick Sight Enterprise Edition][2]
|
|
1597
|
+
# in the Amazon Quick Sight User Guide.
|
|
1596
1598
|
#
|
|
1597
1599
|
#
|
|
1598
1600
|
#
|
|
@@ -1603,11 +1605,12 @@ module Aws::QuickSight
|
|
|
1603
1605
|
# The reader group associated with your Active Directory or IAM Identity
|
|
1604
1606
|
# Center account.
|
|
1605
1607
|
#
|
|
1606
|
-
# For more information about using IAM Identity Center in
|
|
1607
|
-
# see [Using IAM Identity Center with
|
|
1608
|
-
# in the
|
|
1609
|
-
#
|
|
1610
|
-
# Enterprise Edition][2]
|
|
1608
|
+
# For more information about using IAM Identity Center in Amazon Quick
|
|
1609
|
+
# Sight, see [Using IAM Identity Center with Amazon Quick Sight
|
|
1610
|
+
# Enterprise Edition][1] in the Amazon Quick Sight User Guide. For more
|
|
1611
|
+
# information about using Active Directory in Amazon Quick Sight, see
|
|
1612
|
+
# [Using Active Directory with Amazon Quick Sight Enterprise Edition][2]
|
|
1613
|
+
# in the Amazon Quick Sight User Guide.
|
|
1611
1614
|
#
|
|
1612
1615
|
#
|
|
1613
1616
|
#
|
|
@@ -1618,13 +1621,14 @@ module Aws::QuickSight
|
|
|
1618
1621
|
# The admin pro group associated with your Active Directory or IAM
|
|
1619
1622
|
# Identity Center account. Either this field or the `AdminGroup` field
|
|
1620
1623
|
# is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
|
1621
|
-
# selected authentication method of the new
|
|
1624
|
+
# selected authentication method of the new Quick Sight account.
|
|
1622
1625
|
#
|
|
1623
|
-
# For more information about using IAM Identity Center in
|
|
1624
|
-
# see [Using IAM Identity Center with
|
|
1625
|
-
# in the
|
|
1626
|
-
#
|
|
1627
|
-
# Enterprise Edition][2]
|
|
1626
|
+
# For more information about using IAM Identity Center in Amazon Quick
|
|
1627
|
+
# Sight, see [Using IAM Identity Center with Amazon Quick Sight
|
|
1628
|
+
# Enterprise Edition][1] in the Amazon Quick Sight User Guide. For more
|
|
1629
|
+
# information about using Active Directory in Amazon Quick Sight, see
|
|
1630
|
+
# [Using Active Directory with Amazon Quick Sight Enterprise Edition][2]
|
|
1631
|
+
# in the Amazon Quick Sight User Guide.
|
|
1628
1632
|
#
|
|
1629
1633
|
#
|
|
1630
1634
|
#
|
|
@@ -1635,11 +1639,12 @@ module Aws::QuickSight
|
|
|
1635
1639
|
# The author pro group associated with your Active Directory or IAM
|
|
1636
1640
|
# Identity Center account.
|
|
1637
1641
|
#
|
|
1638
|
-
# For more information about using IAM Identity Center in
|
|
1639
|
-
# see [Using IAM Identity Center with
|
|
1640
|
-
# in the
|
|
1641
|
-
#
|
|
1642
|
-
# Enterprise Edition][2]
|
|
1642
|
+
# For more information about using IAM Identity Center in Amazon Quick
|
|
1643
|
+
# Sight, see [Using IAM Identity Center with Amazon Quick Sight
|
|
1644
|
+
# Enterprise Edition][1] in the Amazon Quick Sight User Guide. For more
|
|
1645
|
+
# information about using Active Directory in Amazon Quick Sight, see
|
|
1646
|
+
# [Using Active Directory with Amazon Quick Sight Enterprise Edition][2]
|
|
1647
|
+
# in the Amazon Quick Sight User Guide.
|
|
1643
1648
|
#
|
|
1644
1649
|
#
|
|
1645
1650
|
#
|
|
@@ -1650,11 +1655,12 @@ module Aws::QuickSight
|
|
|
1650
1655
|
# The reader pro group associated with your Active Directory or IAM
|
|
1651
1656
|
# Identity Center account.
|
|
1652
1657
|
#
|
|
1653
|
-
# For more information about using IAM Identity Center in
|
|
1654
|
-
# see [Using IAM Identity Center with
|
|
1655
|
-
# in the
|
|
1656
|
-
#
|
|
1657
|
-
# Enterprise Edition][2]
|
|
1658
|
+
# For more information about using IAM Identity Center in Amazon Quick
|
|
1659
|
+
# Sight, see [Using IAM Identity Center with Amazon Quick Sight
|
|
1660
|
+
# Enterprise Edition][1] in the Amazon Quick Sight User Guide. For more
|
|
1661
|
+
# information about using Active Directory in Amazon Quick Sight, see
|
|
1662
|
+
# [Using Active Directory with Amazon Quick Sight Enterprise Edition][2]
|
|
1663
|
+
# in the Amazon Quick Sight User Guide.
|
|
1658
1664
|
#
|
|
1659
1665
|
#
|
|
1660
1666
|
#
|
|
@@ -1662,25 +1668,28 @@ module Aws::QuickSight
|
|
|
1662
1668
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
|
1663
1669
|
#
|
|
1664
1670
|
# @option params [String] :first_name
|
|
1665
|
-
# The first name of the author of the
|
|
1666
|
-
# future communications. This field is required if
|
|
1667
|
-
# is the selected edition of the new
|
|
1671
|
+
# The first name of the author of the Amazon Quick Sight account to use
|
|
1672
|
+
# for future communications. This field is required if
|
|
1673
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon Quick
|
|
1674
|
+
# Sight account.
|
|
1668
1675
|
#
|
|
1669
1676
|
# @option params [String] :last_name
|
|
1670
|
-
# The last name of the author of the
|
|
1671
|
-
# future communications. This field is required if
|
|
1672
|
-
# is the selected edition of the new
|
|
1677
|
+
# The last name of the author of the Amazon Quick Sight account to use
|
|
1678
|
+
# for future communications. This field is required if
|
|
1679
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon Quick
|
|
1680
|
+
# Sight account.
|
|
1673
1681
|
#
|
|
1674
1682
|
# @option params [String] :email_address
|
|
1675
|
-
# The email address of the author of the
|
|
1676
|
-
# future communications. This field is required if
|
|
1677
|
-
# is the selected edition of the new
|
|
1683
|
+
# The email address of the author of the Amazon Quick Sight account to
|
|
1684
|
+
# use for future communications. This field is required if
|
|
1685
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon Quick
|
|
1686
|
+
# Sight account.
|
|
1678
1687
|
#
|
|
1679
1688
|
# @option params [String] :contact_number
|
|
1680
|
-
# A 10-digit phone number for the author of the
|
|
1681
|
-
# use for future communications. This field is required if
|
|
1682
|
-
# `ENTERPPRISE_AND_Q` is the selected edition of the new
|
|
1683
|
-
# account.
|
|
1689
|
+
# A 10-digit phone number for the author of the Amazon Quick Sight
|
|
1690
|
+
# account to use for future communications. This field is required if
|
|
1691
|
+
# `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon Quick
|
|
1692
|
+
# Sight account.
|
|
1684
1693
|
#
|
|
1685
1694
|
# @option params [String] :iam_identity_center_instance_arn
|
|
1686
1695
|
# The Amazon Resource Name (ARN) for the IAM Identity Center instance.
|
|
@@ -1733,7 +1742,142 @@ module Aws::QuickSight
|
|
|
1733
1742
|
req.send_request(options)
|
|
1734
1743
|
end
|
|
1735
1744
|
|
|
1736
|
-
# Creates an
|
|
1745
|
+
# Creates an action connector that enables Amazon Quick Sight to connect
|
|
1746
|
+
# to external services and perform actions. Action connectors support
|
|
1747
|
+
# various authentication methods and can be configured with specific
|
|
1748
|
+
# actions from supported connector types like Amazon S3, Salesforce,
|
|
1749
|
+
# JIRA.
|
|
1750
|
+
#
|
|
1751
|
+
# @option params [required, String] :aws_account_id
|
|
1752
|
+
# The Amazon Web Services account ID associated with the action
|
|
1753
|
+
# connector.
|
|
1754
|
+
#
|
|
1755
|
+
# @option params [required, String] :action_connector_id
|
|
1756
|
+
# A unique identifier for the action connector. This ID must be unique
|
|
1757
|
+
# within the Amazon Web Services account. The `ActionConnectorId` must
|
|
1758
|
+
# not start with the prefix `quicksuite-`
|
|
1759
|
+
#
|
|
1760
|
+
# @option params [required, String] :name
|
|
1761
|
+
# A descriptive name for the action connector.
|
|
1762
|
+
#
|
|
1763
|
+
# @option params [required, String] :type
|
|
1764
|
+
# The type of action connector.
|
|
1765
|
+
#
|
|
1766
|
+
# @option params [required, Types::AuthConfig] :authentication_config
|
|
1767
|
+
# The authentication configuration for connecting to the external
|
|
1768
|
+
# service. This includes the authentication type, base URL, and
|
|
1769
|
+
# authentication metadata such as client credentials or API keys.
|
|
1770
|
+
#
|
|
1771
|
+
# @option params [String] :description
|
|
1772
|
+
# An optional description of the action connector.
|
|
1773
|
+
#
|
|
1774
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
|
1775
|
+
# The permissions configuration that defines which users, groups, or
|
|
1776
|
+
# namespaces can access this action connector and what operations they
|
|
1777
|
+
# can perform.
|
|
1778
|
+
#
|
|
1779
|
+
# @option params [String] :vpc_connection_arn
|
|
1780
|
+
# The ARN of the VPC connection to use for secure connectivity to the
|
|
1781
|
+
# external service.
|
|
1782
|
+
#
|
|
1783
|
+
# @option params [Array<Types::Tag>] :tags
|
|
1784
|
+
# A list of tags to apply to the action connector for resource
|
|
1785
|
+
# management and organization.
|
|
1786
|
+
#
|
|
1787
|
+
# @return [Types::CreateActionConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1788
|
+
#
|
|
1789
|
+
# * {Types::CreateActionConnectorResponse#arn #arn} => String
|
|
1790
|
+
# * {Types::CreateActionConnectorResponse#creation_status #creation_status} => String
|
|
1791
|
+
# * {Types::CreateActionConnectorResponse#action_connector_id #action_connector_id} => String
|
|
1792
|
+
# * {Types::CreateActionConnectorResponse#request_id #request_id} => String
|
|
1793
|
+
# * {Types::CreateActionConnectorResponse#status #status} => Integer
|
|
1794
|
+
#
|
|
1795
|
+
# @example Request syntax with placeholder values
|
|
1796
|
+
#
|
|
1797
|
+
# resp = client.create_action_connector({
|
|
1798
|
+
# aws_account_id: "AwsAccountId", # required
|
|
1799
|
+
# action_connector_id: "ShortRestrictiveResourceId", # required
|
|
1800
|
+
# name: "ActionConnectorName", # required
|
|
1801
|
+
# type: "GENERIC_HTTP", # required, accepts GENERIC_HTTP, SERVICENOW_NOW_PLATFORM, SALESFORCE_CRM, MICROSOFT_OUTLOOK, PAGERDUTY_ADVANCE, JIRA_CLOUD, ATLASSIAN_CONFLUENCE, AMAZON_S3, AMAZON_BEDROCK_AGENT_RUNTIME, AMAZON_BEDROCK_RUNTIME, AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME, AMAZON_TEXTRACT, AMAZON_COMPREHEND, AMAZON_COMPREHEND_MEDICAL, MICROSOFT_ONEDRIVE, MICROSOFT_SHAREPOINT, MICROSOFT_TEAMS, SAP_BUSINESSPARTNER, SAP_PRODUCTMASTERDATA, SAP_PHYSICALINVENTORY, SAP_BILLOFMATERIALS, SAP_MATERIALSTOCK, ZENDESK_SUITE, SMARTSHEET, SLACK, ASANA, BAMBOO_HR
|
|
1802
|
+
# authentication_config: { # required
|
|
1803
|
+
# authentication_type: "BASIC", # required, accepts BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, NONE, IAM, OAUTH2_AUTHORIZATION_CODE
|
|
1804
|
+
# authentication_metadata: { # required
|
|
1805
|
+
# authorization_code_grant_metadata: {
|
|
1806
|
+
# base_endpoint: "Endpoint", # required
|
|
1807
|
+
# redirect_url: "Endpoint", # required
|
|
1808
|
+
# authorization_code_grant_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
|
|
1809
|
+
# authorization_code_grant_credentials_details: {
|
|
1810
|
+
# authorization_code_grant_details: {
|
|
1811
|
+
# client_id: "ClientId", # required
|
|
1812
|
+
# client_secret: "ClientSecret", # required
|
|
1813
|
+
# token_endpoint: "Endpoint", # required
|
|
1814
|
+
# authorization_endpoint: "Endpoint", # required
|
|
1815
|
+
# },
|
|
1816
|
+
# },
|
|
1817
|
+
# },
|
|
1818
|
+
# client_credentials_grant_metadata: {
|
|
1819
|
+
# base_endpoint: "Endpoint", # required
|
|
1820
|
+
# client_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
|
|
1821
|
+
# client_credentials_details: {
|
|
1822
|
+
# client_credentials_grant_details: {
|
|
1823
|
+
# client_id: "ClientId", # required
|
|
1824
|
+
# client_secret: "ClientSecret", # required
|
|
1825
|
+
# token_endpoint: "Endpoint", # required
|
|
1826
|
+
# },
|
|
1827
|
+
# },
|
|
1828
|
+
# },
|
|
1829
|
+
# basic_auth_connection_metadata: {
|
|
1830
|
+
# base_endpoint: "Endpoint", # required
|
|
1831
|
+
# username: "ActionUserName", # required
|
|
1832
|
+
# password: "ActionPassword", # required
|
|
1833
|
+
# },
|
|
1834
|
+
# api_key_connection_metadata: {
|
|
1835
|
+
# base_endpoint: "Endpoint", # required
|
|
1836
|
+
# api_key: "APIKey", # required
|
|
1837
|
+
# email: "Email",
|
|
1838
|
+
# },
|
|
1839
|
+
# none_connection_metadata: {
|
|
1840
|
+
# base_endpoint: "Endpoint", # required
|
|
1841
|
+
# },
|
|
1842
|
+
# iam_connection_metadata: {
|
|
1843
|
+
# role_arn: "RoleArn", # required
|
|
1844
|
+
# },
|
|
1845
|
+
# },
|
|
1846
|
+
# },
|
|
1847
|
+
# description: "ActionConnectorDescription",
|
|
1848
|
+
# permissions: [
|
|
1849
|
+
# {
|
|
1850
|
+
# principal: "Principal", # required
|
|
1851
|
+
# actions: ["String"], # required
|
|
1852
|
+
# },
|
|
1853
|
+
# ],
|
|
1854
|
+
# vpc_connection_arn: "Arn",
|
|
1855
|
+
# tags: [
|
|
1856
|
+
# {
|
|
1857
|
+
# key: "TagKey", # required
|
|
1858
|
+
# value: "TagValue", # required
|
|
1859
|
+
# },
|
|
1860
|
+
# ],
|
|
1861
|
+
# })
|
|
1862
|
+
#
|
|
1863
|
+
# @example Response structure
|
|
1864
|
+
#
|
|
1865
|
+
# resp.arn #=> String
|
|
1866
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
1867
|
+
# resp.action_connector_id #=> String
|
|
1868
|
+
# resp.request_id #=> String
|
|
1869
|
+
# resp.status #=> Integer
|
|
1870
|
+
#
|
|
1871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateActionConnector AWS API Documentation
|
|
1872
|
+
#
|
|
1873
|
+
# @overload create_action_connector(params = {})
|
|
1874
|
+
# @param [Hash] params ({})
|
|
1875
|
+
def create_action_connector(params = {}, options = {})
|
|
1876
|
+
req = build_request(:create_action_connector, params)
|
|
1877
|
+
req.send_request(options)
|
|
1878
|
+
end
|
|
1879
|
+
|
|
1880
|
+
# Creates an analysis in Amazon Quick Sight. Analyses can be created
|
|
1737
1881
|
# either from a template or from an `AnalysisDefinition`.
|
|
1738
1882
|
#
|
|
1739
1883
|
# @option params [required, String] :aws_account_id
|
|
@@ -1746,7 +1890,7 @@ module Aws::QuickSight
|
|
|
1746
1890
|
#
|
|
1747
1891
|
# @option params [required, String] :name
|
|
1748
1892
|
# A descriptive name for the analysis that you're creating. This name
|
|
1749
|
-
# displays for the analysis in the
|
|
1893
|
+
# displays for the analysis in the Amazon Quick Sight console.
|
|
1750
1894
|
#
|
|
1751
1895
|
# @option params [Types::Parameters] :parameters
|
|
1752
1896
|
# The parameter names and override values that you want to use. An
|
|
@@ -1772,8 +1916,8 @@ module Aws::QuickSight
|
|
|
1772
1916
|
#
|
|
1773
1917
|
# @option params [String] :theme_arn
|
|
1774
1918
|
# The ARN for the theme to apply to the analysis that you're creating.
|
|
1775
|
-
# To see the theme in the
|
|
1776
|
-
# access to it.
|
|
1919
|
+
# To see the theme in the Amazon Quick Sight console, make sure that you
|
|
1920
|
+
# have access to it.
|
|
1777
1921
|
#
|
|
1778
1922
|
# @option params [Array<Types::Tag>] :tags
|
|
1779
1923
|
# Contains a map of the key-value pairs for the resource tag or tags
|
|
@@ -1794,8 +1938,8 @@ module Aws::QuickSight
|
|
|
1794
1938
|
# errors.
|
|
1795
1939
|
#
|
|
1796
1940
|
# @option params [Array<String>] :folder_arns
|
|
1797
|
-
# When you create the analysis,
|
|
1798
|
-
# folders.
|
|
1941
|
+
# When you create the analysis, Amazon Quick Sight adds the analysis to
|
|
1942
|
+
# these folders.
|
|
1799
1943
|
#
|
|
1800
1944
|
# @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1801
1945
|
#
|
|
@@ -1822,7 +1966,7 @@ module Aws::QuickSight
|
|
|
1822
1966
|
req.send_request(options)
|
|
1823
1967
|
end
|
|
1824
1968
|
|
|
1825
|
-
# Creates an
|
|
1969
|
+
# Creates an Quick Sight brand.
|
|
1826
1970
|
#
|
|
1827
1971
|
# @option params [required, String] :aws_account_id
|
|
1828
1972
|
# The ID of the Amazon Web Services account that owns the brand.
|
|
@@ -1889,6 +2033,24 @@ module Aws::QuickSight
|
|
|
1889
2033
|
# background: "HexColor",
|
|
1890
2034
|
# },
|
|
1891
2035
|
# },
|
|
2036
|
+
# contextual_accent_palette: {
|
|
2037
|
+
# connection: {
|
|
2038
|
+
# foreground: "HexColor",
|
|
2039
|
+
# background: "HexColor",
|
|
2040
|
+
# },
|
|
2041
|
+
# visualization: {
|
|
2042
|
+
# foreground: "HexColor",
|
|
2043
|
+
# background: "HexColor",
|
|
2044
|
+
# },
|
|
2045
|
+
# insight: {
|
|
2046
|
+
# foreground: "HexColor",
|
|
2047
|
+
# background: "HexColor",
|
|
2048
|
+
# },
|
|
2049
|
+
# automation: {
|
|
2050
|
+
# foreground: "HexColor",
|
|
2051
|
+
# background: "HexColor",
|
|
2052
|
+
# },
|
|
2053
|
+
# },
|
|
1892
2054
|
# brand_element_style: {
|
|
1893
2055
|
# navbar_style: {
|
|
1894
2056
|
# global_navbar: {
|
|
@@ -1983,6 +2145,14 @@ module Aws::QuickSight
|
|
|
1983
2145
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
|
1984
2146
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
|
1985
2147
|
# resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
|
|
2148
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
|
|
2149
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
|
|
2150
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
|
|
2151
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
|
|
2152
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
|
|
2153
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
|
|
2154
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
|
|
2155
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
|
|
1986
2156
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
|
1987
2157
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
|
1988
2158
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
|
@@ -2054,6 +2224,18 @@ module Aws::QuickSight
|
|
|
2054
2224
|
# include_content_in_scheduled_reports_email: "DENY", # accepts DENY
|
|
2055
2225
|
# dashboard: "DENY", # accepts DENY
|
|
2056
2226
|
# analysis: "DENY", # accepts DENY
|
|
2227
|
+
# automate: "DENY", # accepts DENY
|
|
2228
|
+
# flow: "DENY", # accepts DENY
|
|
2229
|
+
# publish_without_approval: "DENY", # accepts DENY
|
|
2230
|
+
# use_bedrock_models: "DENY", # accepts DENY
|
|
2231
|
+
# perform_flow_ui_task: "DENY", # accepts DENY
|
|
2232
|
+
# use_agent_web_search: "DENY", # accepts DENY
|
|
2233
|
+
# knowledge_base: "DENY", # accepts DENY
|
|
2234
|
+
# action: "DENY", # accepts DENY
|
|
2235
|
+
# space: "DENY", # accepts DENY
|
|
2236
|
+
# chat_agent: "DENY", # accepts DENY
|
|
2237
|
+
# create_chat_agents: "DENY", # accepts DENY
|
|
2238
|
+
# research: "DENY", # accepts DENY
|
|
2057
2239
|
# },
|
|
2058
2240
|
# tags: [
|
|
2059
2241
|
# {
|
|
@@ -2082,12 +2264,12 @@ module Aws::QuickSight
|
|
|
2082
2264
|
# `DashboardDefinition`. To first create a template, see the `
|
|
2083
2265
|
# CreateTemplate ` API operation.
|
|
2084
2266
|
#
|
|
2085
|
-
# A dashboard is an entity in
|
|
2086
|
-
# reports, created from analyses. You can share
|
|
2087
|
-
# With the right permissions, you can create scheduled
|
|
2088
|
-
# from them. If you have the correct permissions, you can
|
|
2089
|
-
# dashboard from a template that exists in a different Amazon
|
|
2090
|
-
# Services account.
|
|
2267
|
+
# A dashboard is an entity in Amazon Quick Sight that identifies Amazon
|
|
2268
|
+
# Quick Sight reports, created from analyses. You can share Amazon Quick
|
|
2269
|
+
# Sight dashboards. With the right permissions, you can create scheduled
|
|
2270
|
+
# email reports from them. If you have the correct permissions, you can
|
|
2271
|
+
# create a dashboard from a template that exists in a different Amazon
|
|
2272
|
+
# Web Services account.
|
|
2091
2273
|
#
|
|
2092
2274
|
# @option params [required, String] :aws_account_id
|
|
2093
2275
|
# The ID of the Amazon Web Services account where you want to create the
|
|
@@ -2120,7 +2302,7 @@ module Aws::QuickSight
|
|
|
2120
2302
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
|
2121
2303
|
# the Amazon Resource Name (ARN) of the source template. The
|
|
2122
2304
|
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
|
2123
|
-
# any
|
|
2305
|
+
# any Amazon Quick Sight-supported Amazon Web Services Region.
|
|
2124
2306
|
#
|
|
2125
2307
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
|
2126
2308
|
# replacement datasets for the placeholders listed in the original. The
|
|
@@ -2141,9 +2323,9 @@ module Aws::QuickSight
|
|
|
2141
2323
|
#
|
|
2142
2324
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
|
2143
2325
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
|
2144
|
-
#
|
|
2145
|
-
# which can be used for ad hoc (one-time) filtering. This
|
|
2146
|
-
# `ENABLED` by default.
|
|
2326
|
+
# Amazon Quick Sight disables the left filter pane on the published
|
|
2327
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
2328
|
+
# option is `ENABLED` by default.
|
|
2147
2329
|
#
|
|
2148
2330
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
|
2149
2331
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
|
@@ -2154,6 +2336,11 @@ module Aws::QuickSight
|
|
|
2154
2336
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
|
2155
2337
|
# by default.
|
|
2156
2338
|
#
|
|
2339
|
+
# * `AvailabilityStatus` for `QuickSuiteActionsOption` - This status can
|
|
2340
|
+
# be either `ENABLED` or `DISABLED`. Features related to Actions in
|
|
2341
|
+
# Amazon Quick Suite on dashboards are disabled when this is set to
|
|
2342
|
+
# `DISABLED`. This option is `DISABLED` by default.
|
|
2343
|
+
#
|
|
2157
2344
|
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
|
|
2158
2345
|
# be either `ENABLED` or `DISABLED`. The option to build an executive
|
|
2159
2346
|
# summary is disabled when this is set to `DISABLED`. This option is
|
|
@@ -2185,8 +2372,8 @@ module Aws::QuickSight
|
|
|
2185
2372
|
# errors.
|
|
2186
2373
|
#
|
|
2187
2374
|
# @option params [Array<String>] :folder_arns
|
|
2188
|
-
# When you create the dashboard,
|
|
2189
|
-
# folders.
|
|
2375
|
+
# When you create the dashboard, Amazon Quick Sight adds the dashboard
|
|
2376
|
+
# to these folders.
|
|
2190
2377
|
#
|
|
2191
2378
|
# @option params [Types::LinkSharingConfiguration] :link_sharing_configuration
|
|
2192
2379
|
# A structure that contains the permissions of a shareable link to the
|
|
@@ -2248,7 +2435,7 @@ module Aws::QuickSight
|
|
|
2248
2435
|
# Indicates whether you want to import the data into SPICE.
|
|
2249
2436
|
#
|
|
2250
2437
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
|
2251
|
-
# Groupings of columns that work together in certain
|
|
2438
|
+
# Groupings of columns that work together in certain Amazon Quick Sight
|
|
2252
2439
|
# features. Currently, only geospatial hierarchy is supported.
|
|
2253
2440
|
#
|
|
2254
2441
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
|
@@ -2282,8 +2469,8 @@ module Aws::QuickSight
|
|
|
2282
2469
|
# The parameter declarations of the dataset.
|
|
2283
2470
|
#
|
|
2284
2471
|
# @option params [Array<String>] :folder_arns
|
|
2285
|
-
# When you create the dataset,
|
|
2286
|
-
# folders.
|
|
2472
|
+
# When you create the dataset, Amazon Quick Sight adds the dataset to
|
|
2473
|
+
# these folders.
|
|
2287
2474
|
#
|
|
2288
2475
|
# @option params [Types::PerformanceConfiguration] :performance_configuration
|
|
2289
2476
|
# The configuration for the performance optimization of the dataset that
|
|
@@ -2573,32 +2760,32 @@ module Aws::QuickSight
|
|
|
2573
2760
|
# Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.
|
|
2574
2761
|
#
|
|
2575
2762
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
|
2576
|
-
# The parameters that
|
|
2577
|
-
# source.
|
|
2763
|
+
# The parameters that Amazon Quick Sight uses to connect to your
|
|
2764
|
+
# underlying source.
|
|
2578
2765
|
#
|
|
2579
2766
|
# @option params [Types::DataSourceCredentials] :credentials
|
|
2580
|
-
# The credentials
|
|
2581
|
-
# source. Currently, only credentials based on user name and
|
|
2582
|
-
# are supported.
|
|
2767
|
+
# The credentials Amazon Quick Sight that uses to connect to your
|
|
2768
|
+
# underlying source. Currently, only credentials based on user name and
|
|
2769
|
+
# password are supported.
|
|
2583
2770
|
#
|
|
2584
2771
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
|
2585
2772
|
# A list of resource permissions on the data source.
|
|
2586
2773
|
#
|
|
2587
2774
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
|
2588
|
-
# Use this parameter only when you want
|
|
2775
|
+
# Use this parameter only when you want Amazon Quick Sight to use a VPC
|
|
2589
2776
|
# connection when connecting to your underlying source.
|
|
2590
2777
|
#
|
|
2591
2778
|
# @option params [Types::SslProperties] :ssl_properties
|
|
2592
|
-
# Secure Socket Layer (SSL) properties that apply when
|
|
2593
|
-
# connects to your underlying source.
|
|
2779
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon Quick
|
|
2780
|
+
# Sight connects to your underlying source.
|
|
2594
2781
|
#
|
|
2595
2782
|
# @option params [Array<Types::Tag>] :tags
|
|
2596
2783
|
# Contains a map of the key-value pairs for the resource tag or tags
|
|
2597
2784
|
# assigned to the data source.
|
|
2598
2785
|
#
|
|
2599
2786
|
# @option params [Array<String>] :folder_arns
|
|
2600
|
-
# When you create the data source,
|
|
2601
|
-
# these folders.
|
|
2787
|
+
# When you create the data source, Amazon Quick Sight adds the data
|
|
2788
|
+
# source to these folders.
|
|
2602
2789
|
#
|
|
2603
2790
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2604
2791
|
#
|
|
@@ -2614,7 +2801,7 @@ module Aws::QuickSight
|
|
|
2614
2801
|
# aws_account_id: "AwsAccountId", # required
|
|
2615
2802
|
# data_source_id: "ResourceId", # required
|
|
2616
2803
|
# name: "ResourceName", # required
|
|
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
|
|
2804
|
+
# 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, GOOGLE_DRIVE, CONFLUENCE, SHAREPOINT, ONE_DRIVE, WEB_CRAWLER, S3_KNOWLEDGE_BASE, QBUSINESS
|
|
2618
2805
|
# data_source_parameters: {
|
|
2619
2806
|
# amazon_elasticsearch_parameters: {
|
|
2620
2807
|
# domain: "Domain", # required
|
|
@@ -2694,6 +2881,11 @@ module Aws::QuickSight
|
|
|
2694
2881
|
# },
|
|
2695
2882
|
# role_arn: "RoleArn",
|
|
2696
2883
|
# },
|
|
2884
|
+
# s3_knowledge_base_parameters: {
|
|
2885
|
+
# role_arn: "RoleArn",
|
|
2886
|
+
# bucket_url: "S3Bucket", # required
|
|
2887
|
+
# metadata_files_location: "MetadataFilesLocation",
|
|
2888
|
+
# },
|
|
2697
2889
|
# service_now_parameters: {
|
|
2698
2890
|
# site_base_url: "SiteBaseUrl", # required
|
|
2699
2891
|
# },
|
|
@@ -2776,6 +2968,22 @@ module Aws::QuickSight
|
|
|
2776
2968
|
# custom_connection_parameters: {
|
|
2777
2969
|
# connection_type: "String",
|
|
2778
2970
|
# },
|
|
2971
|
+
# web_crawler_parameters: {
|
|
2972
|
+
# web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
|
|
2973
|
+
# username_field_xpath: "XpathFields",
|
|
2974
|
+
# password_field_xpath: "XpathFields",
|
|
2975
|
+
# username_button_xpath: "XpathFields",
|
|
2976
|
+
# password_button_xpath: "XpathFields",
|
|
2977
|
+
# login_page_url: "SiteBaseUrl",
|
|
2978
|
+
# web_proxy_host_name: "Host",
|
|
2979
|
+
# web_proxy_port_number: 1,
|
|
2980
|
+
# },
|
|
2981
|
+
# confluence_parameters: {
|
|
2982
|
+
# confluence_url: "SiteBaseUrl", # required
|
|
2983
|
+
# },
|
|
2984
|
+
# q_business_parameters: {
|
|
2985
|
+
# application_arn: "ApplicationArn", # required
|
|
2986
|
+
# },
|
|
2779
2987
|
# },
|
|
2780
2988
|
# credentials: {
|
|
2781
2989
|
# credential_pair: {
|
|
@@ -2861,6 +3069,11 @@ module Aws::QuickSight
|
|
|
2861
3069
|
# },
|
|
2862
3070
|
# role_arn: "RoleArn",
|
|
2863
3071
|
# },
|
|
3072
|
+
# s3_knowledge_base_parameters: {
|
|
3073
|
+
# role_arn: "RoleArn",
|
|
3074
|
+
# bucket_url: "S3Bucket", # required
|
|
3075
|
+
# metadata_files_location: "MetadataFilesLocation",
|
|
3076
|
+
# },
|
|
2864
3077
|
# service_now_parameters: {
|
|
2865
3078
|
# site_base_url: "SiteBaseUrl", # required
|
|
2866
3079
|
# },
|
|
@@ -2943,11 +3156,31 @@ module Aws::QuickSight
|
|
|
2943
3156
|
# custom_connection_parameters: {
|
|
2944
3157
|
# connection_type: "String",
|
|
2945
3158
|
# },
|
|
3159
|
+
# web_crawler_parameters: {
|
|
3160
|
+
# web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
|
|
3161
|
+
# username_field_xpath: "XpathFields",
|
|
3162
|
+
# password_field_xpath: "XpathFields",
|
|
3163
|
+
# username_button_xpath: "XpathFields",
|
|
3164
|
+
# password_button_xpath: "XpathFields",
|
|
3165
|
+
# login_page_url: "SiteBaseUrl",
|
|
3166
|
+
# web_proxy_host_name: "Host",
|
|
3167
|
+
# web_proxy_port_number: 1,
|
|
3168
|
+
# },
|
|
3169
|
+
# confluence_parameters: {
|
|
3170
|
+
# confluence_url: "SiteBaseUrl", # required
|
|
3171
|
+
# },
|
|
3172
|
+
# q_business_parameters: {
|
|
3173
|
+
# application_arn: "ApplicationArn", # required
|
|
3174
|
+
# },
|
|
2946
3175
|
# },
|
|
2947
3176
|
# ],
|
|
2948
3177
|
# },
|
|
2949
3178
|
# copy_source_arn: "CopySourceArn",
|
|
2950
3179
|
# secret_arn: "SecretArn",
|
|
3180
|
+
# web_proxy_credentials: {
|
|
3181
|
+
# web_proxy_username: "DbUsername", # required
|
|
3182
|
+
# web_proxy_password: "Password", # required
|
|
3183
|
+
# },
|
|
2951
3184
|
# },
|
|
2952
3185
|
# permissions: [
|
|
2953
3186
|
# {
|
|
@@ -3113,7 +3346,7 @@ module Aws::QuickSight
|
|
|
3113
3346
|
req.send_request(options)
|
|
3114
3347
|
end
|
|
3115
3348
|
|
|
3116
|
-
# Use the `CreateGroup` operation to create a group in
|
|
3349
|
+
# Use the `CreateGroup` operation to create a group in Quick Sight. You
|
|
3117
3350
|
# can create up to 10,000 groups in a namespace. If you want to create
|
|
3118
3351
|
# more than 10,000 groups in a namespace, contact Amazon Web Services
|
|
3119
3352
|
# Support.
|
|
@@ -3133,7 +3366,7 @@ module Aws::QuickSight
|
|
|
3133
3366
|
# @option params [required, String] :aws_account_id
|
|
3134
3367
|
# The ID for the Amazon Web Services account that the group is in.
|
|
3135
3368
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
3136
|
-
# contains your Amazon
|
|
3369
|
+
# contains your Amazon Quick Sight account.
|
|
3137
3370
|
#
|
|
3138
3371
|
# @option params [required, String] :namespace
|
|
3139
3372
|
# The namespace that you want the group to be a part of.
|
|
@@ -3171,7 +3404,7 @@ module Aws::QuickSight
|
|
|
3171
3404
|
req.send_request(options)
|
|
3172
3405
|
end
|
|
3173
3406
|
|
|
3174
|
-
# Adds an Amazon
|
|
3407
|
+
# Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
|
|
3175
3408
|
#
|
|
3176
3409
|
# @option params [required, String] :member_name
|
|
3177
3410
|
# The name of the user that you want to add to the group membership.
|
|
@@ -3182,7 +3415,7 @@ module Aws::QuickSight
|
|
|
3182
3415
|
# @option params [required, String] :aws_account_id
|
|
3183
3416
|
# The ID for the Amazon Web Services account that the group is in.
|
|
3184
3417
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
3185
|
-
# contains your Amazon
|
|
3418
|
+
# contains your Amazon Quick Sight account.
|
|
3186
3419
|
#
|
|
3187
3420
|
# @option params [required, String] :namespace
|
|
3188
3421
|
# The namespace that you want the user to be a part of.
|
|
@@ -3220,13 +3453,13 @@ module Aws::QuickSight
|
|
|
3220
3453
|
|
|
3221
3454
|
# Creates an assignment with one specified IAM policy, identified by its
|
|
3222
3455
|
# Amazon Resource Name (ARN). This policy assignment is attached to the
|
|
3223
|
-
# specified groups or users of Amazon
|
|
3456
|
+
# specified groups or users of Amazon Quick Sight. Assignment names are
|
|
3224
3457
|
# unique per Amazon Web Services account. To avoid overwriting rules in
|
|
3225
3458
|
# other namespaces, use assignment names that are unique.
|
|
3226
3459
|
#
|
|
3227
3460
|
# @option params [required, String] :aws_account_id
|
|
3228
3461
|
# The ID of the Amazon Web Services account where you want to assign an
|
|
3229
|
-
# IAM policy to
|
|
3462
|
+
# IAM policy to Amazon Quick Sight users or groups.
|
|
3230
3463
|
#
|
|
3231
3464
|
# @option params [required, String] :assignment_name
|
|
3232
3465
|
# The name of the assignment, also called a rule. The name must be
|
|
@@ -3245,12 +3478,12 @@ module Aws::QuickSight
|
|
|
3245
3478
|
# when creating the data source.
|
|
3246
3479
|
#
|
|
3247
3480
|
# @option params [String] :policy_arn
|
|
3248
|
-
# The ARN for the IAM policy to apply to the
|
|
3249
|
-
# specified in this assignment.
|
|
3481
|
+
# The ARN for the IAM policy to apply to the Amazon Quick Sight users
|
|
3482
|
+
# and groups specified in this assignment.
|
|
3250
3483
|
#
|
|
3251
3484
|
# @option params [Hash<String,Array>] :identities
|
|
3252
|
-
# The
|
|
3253
|
-
# policy to.
|
|
3485
|
+
# The Amazon Quick Sight users, groups, or both that you want to assign
|
|
3486
|
+
# the policy to.
|
|
3254
3487
|
#
|
|
3255
3488
|
# @option params [required, String] :namespace
|
|
3256
3489
|
# The namespace that contains the assignment.
|
|
@@ -3362,21 +3595,21 @@ module Aws::QuickSight
|
|
|
3362
3595
|
end
|
|
3363
3596
|
|
|
3364
3597
|
# (Enterprise edition only) Creates a new namespace for you to use with
|
|
3365
|
-
# Amazon
|
|
3366
|
-
#
|
|
3367
|
-
# A namespace allows you to isolate the
|
|
3368
|
-
# are registered for that namespace. Users that access the
|
|
3369
|
-
# share assets only with other users or groups in the same
|
|
3370
|
-
# They can't see users and groups in other namespaces. You
|
|
3371
|
-
# namespace after your Amazon Web Services account is
|
|
3372
|
-
#
|
|
3373
|
-
# Services account. By default, there is a limit of 100
|
|
3374
|
-
# Amazon Web Services account. To increase your limit,
|
|
3375
|
-
# with Amazon Web Services Support.
|
|
3598
|
+
# Amazon Quick Sight.
|
|
3599
|
+
#
|
|
3600
|
+
# A namespace allows you to isolate the Quick Sight users and groups
|
|
3601
|
+
# that are registered for that namespace. Users that access the
|
|
3602
|
+
# namespace can share assets only with other users or groups in the same
|
|
3603
|
+
# namespace. They can't see users and groups in other namespaces. You
|
|
3604
|
+
# can create a namespace after your Amazon Web Services account is
|
|
3605
|
+
# subscribed to Quick Sight. The namespace must be unique within the
|
|
3606
|
+
# Amazon Web Services account. By default, there is a limit of 100
|
|
3607
|
+
# namespaces per Amazon Web Services account. To increase your limit,
|
|
3608
|
+
# create a ticket with Amazon Web Services Support.
|
|
3376
3609
|
#
|
|
3377
3610
|
# @option params [required, String] :aws_account_id
|
|
3378
3611
|
# The ID for the Amazon Web Services account that you want to create the
|
|
3379
|
-
#
|
|
3612
|
+
# Quick Sight namespace in.
|
|
3380
3613
|
#
|
|
3381
3614
|
# @option params [required, String] :namespace
|
|
3382
3615
|
# The name that you want to use to describe the new namespace.
|
|
@@ -3489,7 +3722,7 @@ module Aws::QuickSight
|
|
|
3489
3722
|
req.send_request(options)
|
|
3490
3723
|
end
|
|
3491
3724
|
|
|
3492
|
-
# Use `CreateRoleMembership` to add an existing
|
|
3725
|
+
# Use `CreateRoleMembership` to add an existing Quick Sight group to an
|
|
3493
3726
|
# existing role.
|
|
3494
3727
|
#
|
|
3495
3728
|
# @option params [required, String] :member_name
|
|
@@ -3498,8 +3731,8 @@ module Aws::QuickSight
|
|
|
3498
3731
|
# @option params [required, String] :aws_account_id
|
|
3499
3732
|
# The ID for the Amazon Web Services account that you want to create a
|
|
3500
3733
|
# group in. The Amazon Web Services account ID that you provide must be
|
|
3501
|
-
# the same Amazon Web Services account that contains your Amazon
|
|
3502
|
-
#
|
|
3734
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
|
3735
|
+
# Sight account.
|
|
3503
3736
|
#
|
|
3504
3737
|
# @option params [required, String] :namespace
|
|
3505
3738
|
# The namespace that the role belongs to.
|
|
@@ -3536,12 +3769,12 @@ module Aws::QuickSight
|
|
|
3536
3769
|
end
|
|
3537
3770
|
|
|
3538
3771
|
# Creates a template either from a `TemplateDefinition` or from an
|
|
3539
|
-
# existing
|
|
3772
|
+
# existing Quick Sight analysis or template. You can use the resulting
|
|
3540
3773
|
# template to create additional dashboards, templates, or analyses.
|
|
3541
3774
|
#
|
|
3542
|
-
# A *template* is an entity in
|
|
3543
|
-
# required to create an analysis and that you can use to create
|
|
3544
|
-
# dashboard. A template adds a layer of abstraction by using
|
|
3775
|
+
# A *template* is an entity in Quick Sight that encapsulates the
|
|
3776
|
+
# metadata required to create an analysis and that you can use to create
|
|
3777
|
+
# s dashboard. A template adds a layer of abstraction by using
|
|
3545
3778
|
# placeholders to replace the dataset associated with the analysis. You
|
|
3546
3779
|
# can use templates to create dashboards by replacing dataset
|
|
3547
3780
|
# placeholders with datasets that follow the same schema that was used
|
|
@@ -3550,7 +3783,7 @@ module Aws::QuickSight
|
|
|
3550
3783
|
# @option params [required, String] :aws_account_id
|
|
3551
3784
|
# The ID for the Amazon Web Services account that the group is in. You
|
|
3552
3785
|
# use the ID for the Amazon Web Services account that contains your
|
|
3553
|
-
# Amazon
|
|
3786
|
+
# Amazon Quick Sight account.
|
|
3554
3787
|
#
|
|
3555
3788
|
# @option params [required, String] :template_id
|
|
3556
3789
|
# An ID for the template that you want to create. This template is
|
|
@@ -3571,7 +3804,7 @@ module Aws::QuickSight
|
|
|
3571
3804
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
|
3572
3805
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
|
3573
3806
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
|
3574
|
-
# any
|
|
3807
|
+
# any Quick Sight-supported Amazon Web Services Region.
|
|
3575
3808
|
#
|
|
3576
3809
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
|
3577
3810
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
|
@@ -3645,7 +3878,7 @@ module Aws::QuickSight
|
|
|
3645
3878
|
# @option params [required, String] :alias_name
|
|
3646
3879
|
# The name that you want to give to the template alias that you're
|
|
3647
3880
|
# creating. Don't start the alias name with the `$` character. Alias
|
|
3648
|
-
# names that start with `$` are reserved by
|
|
3881
|
+
# names that start with `$` are reserved by Quick Sight.
|
|
3649
3882
|
#
|
|
3650
3883
|
# @option params [required, Integer] :template_version_number
|
|
3651
3884
|
# The version number of the template.
|
|
@@ -3686,7 +3919,8 @@ module Aws::QuickSight
|
|
|
3686
3919
|
#
|
|
3687
3920
|
# A *theme* is set of configuration options for color and layout. Themes
|
|
3688
3921
|
# apply to analyses and dashboards. For more information, see [Using
|
|
3689
|
-
# Themes in Amazon
|
|
3922
|
+
# Themes in Amazon Quick Sight][1] in the *Amazon Quick Sight User
|
|
3923
|
+
# Guide*.
|
|
3690
3924
|
#
|
|
3691
3925
|
#
|
|
3692
3926
|
#
|
|
@@ -3705,7 +3939,7 @@ module Aws::QuickSight
|
|
|
3705
3939
|
#
|
|
3706
3940
|
# @option params [required, String] :base_theme_id
|
|
3707
3941
|
# The ID of the theme that a custom theme will inherit from. All themes
|
|
3708
|
-
# inherit from one of the starting themes defined by Amazon
|
|
3942
|
+
# inherit from one of the starting themes defined by Amazon Quick Sight.
|
|
3709
3943
|
# For a list of the starting themes, use `ListThemes` or choose
|
|
3710
3944
|
# **Themes** from within an analysis.
|
|
3711
3945
|
#
|
|
@@ -3833,7 +4067,7 @@ module Aws::QuickSight
|
|
|
3833
4067
|
# @option params [required, String] :alias_name
|
|
3834
4068
|
# The name that you want to give to the theme alias that you are
|
|
3835
4069
|
# creating. The alias name can't begin with a `$`. Alias names that
|
|
3836
|
-
# start with `$` are reserved by Amazon
|
|
4070
|
+
# start with `$` are reserved by Amazon Quick Sight.
|
|
3837
4071
|
#
|
|
3838
4072
|
# @option params [required, Integer] :theme_version_number
|
|
3839
4073
|
# The version number of the theme.
|
|
@@ -4334,35 +4568,31 @@ module Aws::QuickSight
|
|
|
4334
4568
|
req.send_request(options)
|
|
4335
4569
|
end
|
|
4336
4570
|
|
|
4337
|
-
# This API permanently deletes all
|
|
4338
|
-
# specified Amazon Web Services account and namespace
|
|
4339
|
-
#
|
|
4571
|
+
# This API permanently deletes all Quick Sight customizations for the
|
|
4572
|
+
# specified Amazon Web Services account and namespace. When you delete
|
|
4573
|
+
# account customizations:
|
|
4340
4574
|
#
|
|
4341
4575
|
# * All customizations are removed including themes, branding, and
|
|
4342
4576
|
# visual settings
|
|
4343
4577
|
#
|
|
4344
|
-
# * The deletion affects only the specified Amazon Web Services Region -
|
|
4345
|
-
# customizations in other regions remain unchanged
|
|
4346
|
-
#
|
|
4347
4578
|
# * This action cannot be undone through the API
|
|
4348
4579
|
#
|
|
4349
|
-
# * Users will see default
|
|
4580
|
+
# * Users will see default Quick Sight styling after customizations are
|
|
4350
4581
|
# deleted
|
|
4351
4582
|
#
|
|
4352
4583
|
# **Before proceeding:** Ensure you have backups of any custom themes
|
|
4353
4584
|
# or
|
|
4354
4585
|
# branding elements you may want to recreate.
|
|
4355
4586
|
#
|
|
4356
|
-
# Deletes all Amazon
|
|
4357
|
-
#
|
|
4358
|
-
# QuickSight namespace.
|
|
4587
|
+
# Deletes all Amazon Quick Sight customizations for the specified Amazon
|
|
4588
|
+
# Web Services account and Quick Sight namespace.
|
|
4359
4589
|
#
|
|
4360
4590
|
# @option params [required, String] :aws_account_id
|
|
4361
4591
|
# The ID for the Amazon Web Services account that you want to delete
|
|
4362
|
-
#
|
|
4592
|
+
# Quick Sight customizations from.
|
|
4363
4593
|
#
|
|
4364
4594
|
# @option params [String] :namespace
|
|
4365
|
-
# The
|
|
4595
|
+
# The Quick Sight namespace that you're deleting the customizations
|
|
4366
4596
|
# from.
|
|
4367
4597
|
#
|
|
4368
4598
|
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -4391,13 +4621,13 @@ module Aws::QuickSight
|
|
|
4391
4621
|
req.send_request(options)
|
|
4392
4622
|
end
|
|
4393
4623
|
|
|
4394
|
-
# Deleting your
|
|
4624
|
+
# Deleting your Quick Sight account subscription has permanent,
|
|
4395
4625
|
# irreversible consequences across all Amazon Web Services regions:
|
|
4396
4626
|
#
|
|
4397
4627
|
# * Global deletion – Running this operation from any single region
|
|
4398
4628
|
# will
|
|
4399
|
-
# delete your
|
|
4400
|
-
# Services region where you have
|
|
4629
|
+
# delete your Quick Sight account and all data in every Amazon Web
|
|
4630
|
+
# Services region where you have Quick Sight resources.
|
|
4401
4631
|
#
|
|
4402
4632
|
# * Complete data loss – All dashboards, analyses, datasets, data
|
|
4403
4633
|
# sources, and custom visuals will be permanently deleted across all
|
|
@@ -4411,18 +4641,18 @@ module Aws::QuickSight
|
|
|
4411
4641
|
# resources will become inaccessible to other users and external
|
|
4412
4642
|
# recipients.
|
|
4413
4643
|
#
|
|
4414
|
-
# * User access terminated – All
|
|
4644
|
+
# * User access terminated – All Quick Sight users in your account will
|
|
4415
4645
|
# lose access immediately, including authors, readers, and
|
|
4416
4646
|
# administrators.
|
|
4417
4647
|
#
|
|
4418
|
-
# * **No recovery possible** – Once deleted, your
|
|
4419
|
-
# all associated data cannot be restored.
|
|
4648
|
+
# * **No recovery possible** – Once deleted, your Quick Sight account
|
|
4649
|
+
# and all associated data cannot be restored.
|
|
4420
4650
|
#
|
|
4421
4651
|
# Consider exporting critical dashboards and data before proceeding
|
|
4422
4652
|
# with
|
|
4423
4653
|
# account deletion.
|
|
4424
4654
|
#
|
|
4425
|
-
# Use the `DeleteAccountSubscription` operation to delete an
|
|
4655
|
+
# Use the `DeleteAccountSubscription` operation to delete an Quick Sight
|
|
4426
4656
|
# account. This operation will result in an error message if you have
|
|
4427
4657
|
# configured your account termination protection settings to `True`. To
|
|
4428
4658
|
# change this setting and delete your account, call the
|
|
@@ -4459,12 +4689,55 @@ module Aws::QuickSight
|
|
|
4459
4689
|
req.send_request(options)
|
|
4460
4690
|
end
|
|
4461
4691
|
|
|
4462
|
-
#
|
|
4463
|
-
#
|
|
4464
|
-
#
|
|
4465
|
-
#
|
|
4466
|
-
#
|
|
4467
|
-
#
|
|
4692
|
+
# Hard deletes an action connector, making it unrecoverable. This
|
|
4693
|
+
# operation removes the connector and all its associated configurations.
|
|
4694
|
+
# Any resources currently using this action connector will no longer be
|
|
4695
|
+
# able to perform actions through it.
|
|
4696
|
+
#
|
|
4697
|
+
# @option params [required, String] :aws_account_id
|
|
4698
|
+
# The Amazon Web Services account ID that contains the action connector
|
|
4699
|
+
# to delete.
|
|
4700
|
+
#
|
|
4701
|
+
# @option params [required, String] :action_connector_id
|
|
4702
|
+
# The unique identifier of the action connector to delete.
|
|
4703
|
+
#
|
|
4704
|
+
# @return [Types::DeleteActionConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4705
|
+
#
|
|
4706
|
+
# * {Types::DeleteActionConnectorResponse#arn #arn} => String
|
|
4707
|
+
# * {Types::DeleteActionConnectorResponse#action_connector_id #action_connector_id} => String
|
|
4708
|
+
# * {Types::DeleteActionConnectorResponse#request_id #request_id} => String
|
|
4709
|
+
# * {Types::DeleteActionConnectorResponse#status #status} => Integer
|
|
4710
|
+
#
|
|
4711
|
+
# @example Request syntax with placeholder values
|
|
4712
|
+
#
|
|
4713
|
+
# resp = client.delete_action_connector({
|
|
4714
|
+
# aws_account_id: "AwsAccountId", # required
|
|
4715
|
+
# action_connector_id: "ShortRestrictiveResourceId", # required
|
|
4716
|
+
# })
|
|
4717
|
+
#
|
|
4718
|
+
# @example Response structure
|
|
4719
|
+
#
|
|
4720
|
+
# resp.arn #=> String
|
|
4721
|
+
# resp.action_connector_id #=> String
|
|
4722
|
+
# resp.request_id #=> String
|
|
4723
|
+
# resp.status #=> Integer
|
|
4724
|
+
#
|
|
4725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteActionConnector AWS API Documentation
|
|
4726
|
+
#
|
|
4727
|
+
# @overload delete_action_connector(params = {})
|
|
4728
|
+
# @param [Hash] params ({})
|
|
4729
|
+
def delete_action_connector(params = {}, options = {})
|
|
4730
|
+
req = build_request(:delete_action_connector, params)
|
|
4731
|
+
req.send_request(options)
|
|
4732
|
+
end
|
|
4733
|
+
|
|
4734
|
+
# Deletes an analysis from Amazon Quick Sight. You can optionally
|
|
4735
|
+
# include a recovery window during which you can restore the analysis.
|
|
4736
|
+
# If you don't specify a recovery window value, the operation defaults
|
|
4737
|
+
# to 30 days. Amazon Quick Sight attaches a `DeletionTime` stamp to the
|
|
4738
|
+
# response that specifies the end of the recovery window. At the end of
|
|
4739
|
+
# the recovery window, Amazon Quick Sight deletes the analysis
|
|
4740
|
+
# permanently.
|
|
4468
4741
|
#
|
|
4469
4742
|
# At any time before recovery window ends, you can use the
|
|
4470
4743
|
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
|
@@ -4473,8 +4746,9 @@ module Aws::QuickSight
|
|
|
4473
4746
|
# make a template from it.
|
|
4474
4747
|
#
|
|
4475
4748
|
# An analysis that's scheduled for deletion isn't accessible in the
|
|
4476
|
-
#
|
|
4477
|
-
# an analysis doesn't delete the dashboards that you publish
|
|
4749
|
+
# Amazon Quick Sight console. To access it in the console, restore it.
|
|
4750
|
+
# Deleting an analysis doesn't delete the dashboards that you publish
|
|
4751
|
+
# from it.
|
|
4478
4752
|
#
|
|
4479
4753
|
# @option params [required, String] :aws_account_id
|
|
4480
4754
|
# The ID of the Amazon Web Services account where you want to delete an
|
|
@@ -4484,10 +4758,10 @@ module Aws::QuickSight
|
|
|
4484
4758
|
# The ID of the analysis that you're deleting.
|
|
4485
4759
|
#
|
|
4486
4760
|
# @option params [Integer] :recovery_window_in_days
|
|
4487
|
-
# A value that specifies the number of days that
|
|
4488
|
-
# it deletes the analysis. You can't use this parameter
|
|
4489
|
-
# `ForceDeleteWithoutRecovery` option in the same API call. The
|
|
4490
|
-
# value is 30.
|
|
4761
|
+
# A value that specifies the number of days that Amazon Quick Sight
|
|
4762
|
+
# waits before it deletes the analysis. You can't use this parameter
|
|
4763
|
+
# with the `ForceDeleteWithoutRecovery` option in the same API call. The
|
|
4764
|
+
# default value is 30.
|
|
4491
4765
|
#
|
|
4492
4766
|
# @option params [Boolean] :force_delete_without_recovery
|
|
4493
4767
|
# This option defaults to the value `NoForceDeleteWithoutRecovery`. To
|
|
@@ -4528,7 +4802,7 @@ module Aws::QuickSight
|
|
|
4528
4802
|
req.send_request(options)
|
|
4529
4803
|
end
|
|
4530
4804
|
|
|
4531
|
-
# This API permanently deletes the specified
|
|
4805
|
+
# This API permanently deletes the specified Quick Sight brand. When you
|
|
4532
4806
|
# delete a brand:
|
|
4533
4807
|
#
|
|
4534
4808
|
# * The brand and all its associated branding elements are permanently
|
|
@@ -4542,7 +4816,7 @@ module Aws::QuickSight
|
|
|
4542
4816
|
# **Before proceeding:** Verify that the brand is no longer needed and
|
|
4543
4817
|
# consider the impact on any applications currently using this brand.
|
|
4544
4818
|
#
|
|
4545
|
-
# Deletes an
|
|
4819
|
+
# Deletes an Quick Sight brand.
|
|
4546
4820
|
#
|
|
4547
4821
|
# @option params [required, String] :aws_account_id
|
|
4548
4822
|
# The ID of the Amazon Web Services account that owns the brand.
|
|
@@ -4797,15 +5071,15 @@ module Aws::QuickSight
|
|
|
4797
5071
|
req.send_request(options)
|
|
4798
5072
|
end
|
|
4799
5073
|
|
|
4800
|
-
# Deletes a linked Amazon Q Business application from an
|
|
5074
|
+
# Deletes a linked Amazon Q Business application from an Quick Sight
|
|
4801
5075
|
# account
|
|
4802
5076
|
#
|
|
4803
5077
|
# @option params [required, String] :aws_account_id
|
|
4804
|
-
# The ID of the
|
|
5078
|
+
# The ID of the Quick Sight account that you want to disconnect from a
|
|
4805
5079
|
# Amazon Q Business application.
|
|
4806
5080
|
#
|
|
4807
5081
|
# @option params [String] :namespace
|
|
4808
|
-
# The
|
|
5082
|
+
# The Quick Sight namespace that you want to delete a linked Amazon Q
|
|
4809
5083
|
# Business application from. If this field is left blank, the Amazon Q
|
|
4810
5084
|
# Business application is deleted from the default namespace. Currently,
|
|
4811
5085
|
# the default namespace is the only valid value for this parameter.
|
|
@@ -4917,7 +5191,7 @@ module Aws::QuickSight
|
|
|
4917
5191
|
req.send_request(options)
|
|
4918
5192
|
end
|
|
4919
5193
|
|
|
4920
|
-
# Removes a user group from Amazon
|
|
5194
|
+
# Removes a user group from Amazon Quick Sight.
|
|
4921
5195
|
#
|
|
4922
5196
|
# @option params [required, String] :group_name
|
|
4923
5197
|
# The name of the group that you want to delete.
|
|
@@ -4925,7 +5199,7 @@ module Aws::QuickSight
|
|
|
4925
5199
|
# @option params [required, String] :aws_account_id
|
|
4926
5200
|
# The ID for the Amazon Web Services account that the group is in.
|
|
4927
5201
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
4928
|
-
# contains your Amazon
|
|
5202
|
+
# contains your Amazon Quick Sight account.
|
|
4929
5203
|
#
|
|
4930
5204
|
# @option params [required, String] :namespace
|
|
4931
5205
|
# The namespace of the group that you want to delete.
|
|
@@ -4970,7 +5244,7 @@ module Aws::QuickSight
|
|
|
4970
5244
|
# @option params [required, String] :aws_account_id
|
|
4971
5245
|
# The ID for the Amazon Web Services account that the group is in.
|
|
4972
5246
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
4973
|
-
# contains your Amazon
|
|
5247
|
+
# contains your Amazon Quick Sight account.
|
|
4974
5248
|
#
|
|
4975
5249
|
# @option params [required, String] :namespace
|
|
4976
5250
|
# The namespace of the group that you want to remove a user from.
|
|
@@ -5045,9 +5319,9 @@ module Aws::QuickSight
|
|
|
5045
5319
|
end
|
|
5046
5320
|
|
|
5047
5321
|
# Deletes all access scopes and authorized targets that are associated
|
|
5048
|
-
# with a service from the
|
|
5322
|
+
# with a service from the Quick Sight IAM Identity Center application.
|
|
5049
5323
|
#
|
|
5050
|
-
# This operation is only supported for
|
|
5324
|
+
# This operation is only supported for Quick Sight accounts that use IAM
|
|
5051
5325
|
# Identity Center.
|
|
5052
5326
|
#
|
|
5053
5327
|
# @option params [required, String] :aws_account_id
|
|
@@ -5092,7 +5366,7 @@ module Aws::QuickSight
|
|
|
5092
5366
|
#
|
|
5093
5367
|
# @option params [required, String] :aws_account_id
|
|
5094
5368
|
# The ID for the Amazon Web Services account that you want to delete the
|
|
5095
|
-
#
|
|
5369
|
+
# Quick Sight namespace from.
|
|
5096
5370
|
#
|
|
5097
5371
|
# @option params [required, String] :namespace
|
|
5098
5372
|
# The namespace that you want to delete.
|
|
@@ -5173,7 +5447,7 @@ module Aws::QuickSight
|
|
|
5173
5447
|
# @option params [required, String] :aws_account_id
|
|
5174
5448
|
# The ID for the Amazon Web Services account that the group is in.
|
|
5175
5449
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
5176
|
-
# contains your Amazon
|
|
5450
|
+
# contains your Amazon Quick Sight account.
|
|
5177
5451
|
#
|
|
5178
5452
|
# @option params [required, String] :namespace
|
|
5179
5453
|
# The namespace that includes the role.
|
|
@@ -5216,8 +5490,8 @@ module Aws::QuickSight
|
|
|
5216
5490
|
# @option params [required, String] :aws_account_id
|
|
5217
5491
|
# The ID for the Amazon Web Services account that you want to create a
|
|
5218
5492
|
# group in. The Amazon Web Services account ID that you provide must be
|
|
5219
|
-
# the same Amazon Web Services account that contains your Amazon
|
|
5220
|
-
#
|
|
5493
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
|
5494
|
+
# Sight account.
|
|
5221
5495
|
#
|
|
5222
5496
|
# @option params [required, String] :namespace
|
|
5223
5497
|
# The namespace that contains the role.
|
|
@@ -5523,7 +5797,7 @@ module Aws::QuickSight
|
|
|
5523
5797
|
req.send_request(options)
|
|
5524
5798
|
end
|
|
5525
5799
|
|
|
5526
|
-
# Deletes the Amazon
|
|
5800
|
+
# Deletes the Amazon Quick Sight user that is associated with the
|
|
5527
5801
|
# identity of the IAM user or role that's making the call. The IAM user
|
|
5528
5802
|
# isn't deleted as a result of this call.
|
|
5529
5803
|
#
|
|
@@ -5533,7 +5807,7 @@ module Aws::QuickSight
|
|
|
5533
5807
|
# @option params [required, String] :aws_account_id
|
|
5534
5808
|
# The ID for the Amazon Web Services account that the user is in.
|
|
5535
5809
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
5536
|
-
# contains your Amazon
|
|
5810
|
+
# contains your Amazon Quick Sight account.
|
|
5537
5811
|
#
|
|
5538
5812
|
# @option params [required, String] :namespace
|
|
5539
5813
|
# The namespace. Currently, you should set this to `default`.
|
|
@@ -5573,7 +5847,7 @@ module Aws::QuickSight
|
|
|
5573
5847
|
# @option params [required, String] :aws_account_id
|
|
5574
5848
|
# The ID for the Amazon Web Services account that the user is in.
|
|
5575
5849
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
5576
|
-
# contains your Amazon
|
|
5850
|
+
# contains your Amazon Quick Sight account.
|
|
5577
5851
|
#
|
|
5578
5852
|
# @option params [required, String] :namespace
|
|
5579
5853
|
# The namespace. Currently, you should set this to `default`.
|
|
@@ -5725,10 +5999,9 @@ module Aws::QuickSight
|
|
|
5725
5999
|
end
|
|
5726
6000
|
|
|
5727
6001
|
# Describes the customizations associated with the provided Amazon Web
|
|
5728
|
-
# Services account and Amazon
|
|
5729
|
-
#
|
|
5730
|
-
#
|
|
5731
|
-
# included.
|
|
6002
|
+
# Services account and Amazon Quick Sight namespace. The Quick Sight
|
|
6003
|
+
# console evaluates which customizations to apply by running this API
|
|
6004
|
+
# operation with the `Resolved` flag included.
|
|
5732
6005
|
#
|
|
5733
6006
|
# To determine what customizations display when you run this command, it
|
|
5734
6007
|
# can help to visualize the relationship of the entities involved.
|
|
@@ -5736,18 +6009,16 @@ module Aws::QuickSight
|
|
|
5736
6009
|
# * `Amazon Web Services account` - The Amazon Web Services account
|
|
5737
6010
|
# exists at the top of the hierarchy. It has the potential to use all
|
|
5738
6011
|
# of the Amazon Web Services Regions and Amazon Web Services Services.
|
|
5739
|
-
# When you subscribe to
|
|
5740
|
-
# Region to use as your home Region. That's where your free
|
|
5741
|
-
# capacity is located. You can use
|
|
5742
|
-
# Web Services Region.
|
|
5743
|
-
#
|
|
5744
|
-
# * `Amazon Web Services Region` -
|
|
5745
|
-
#
|
|
5746
|
-
#
|
|
5747
|
-
#
|
|
5748
|
-
#
|
|
5749
|
-
# Amazon Web Services Region, unless they are constrained to a
|
|
5750
|
-
# namespace.
|
|
6012
|
+
# When you subscribe to Quick Sight, you choose one Amazon Web
|
|
6013
|
+
# Services Region to use as your home Region. That's where your free
|
|
6014
|
+
# SPICE capacity is located. You can use Quick Sight in any supported
|
|
6015
|
+
# Amazon Web Services Region.
|
|
6016
|
+
#
|
|
6017
|
+
# * `Amazon Web Services Region` - You can sign in to Quick Sight in any
|
|
6018
|
+
# Amazon Web Services Region. If you have a user directory, it resides
|
|
6019
|
+
# in us-east-1, which is US East (N. Virginia). Generally speaking,
|
|
6020
|
+
# these users have access to Quick Sight in any Amazon Web Services
|
|
6021
|
+
# Region, unless they are constrained to a namespace.
|
|
5751
6022
|
#
|
|
5752
6023
|
# To run the command in a different Amazon Web Services Region, you
|
|
5753
6024
|
# change your Region settings. If you're using the CLI, you can use
|
|
@@ -5760,7 +6031,7 @@ module Aws::QuickSight
|
|
|
5760
6031
|
# * Run `aws configure` to change your default Amazon Web Services
|
|
5761
6032
|
# Region. Use Enter to key the same settings for your keys. For more
|
|
5762
6033
|
# information, see [Configuring the CLI][3].
|
|
5763
|
-
# * `Namespace` - A
|
|
6034
|
+
# * `Namespace` - A Quick Sight namespace is a partition that contains
|
|
5764
6035
|
# users and assets (data sources, datasets, dashboards, and so on). To
|
|
5765
6036
|
# access assets that are in a specific namespace, users and groups
|
|
5766
6037
|
# must also be part of the same namespace. People who share a
|
|
@@ -5768,14 +6039,10 @@ module Aws::QuickSight
|
|
|
5768
6039
|
# namespaces, even if they are in the same Amazon Web Services account
|
|
5769
6040
|
# and Amazon Web Services Region.
|
|
5770
6041
|
#
|
|
5771
|
-
# * `Applied customizations` -
|
|
5772
|
-
#
|
|
5773
|
-
#
|
|
5774
|
-
#
|
|
5775
|
-
# All settings are isolated to a single Amazon Web Services Region. To
|
|
5776
|
-
# apply them in other Amazon Web Services Regions, run the
|
|
5777
|
-
# `CreateAccountCustomization` command in each Amazon Web Services
|
|
5778
|
-
# Region where you want to apply the same customizations.
|
|
6042
|
+
# * `Applied customizations` - Quick Sight customizations can apply to
|
|
6043
|
+
# an Amazon Web Services account or to a namespace. Settings that you
|
|
6044
|
+
# apply to a namespace override settings that you apply to an Amazon
|
|
6045
|
+
# Web Services account.
|
|
5779
6046
|
#
|
|
5780
6047
|
#
|
|
5781
6048
|
#
|
|
@@ -5785,16 +6052,16 @@ module Aws::QuickSight
|
|
|
5785
6052
|
#
|
|
5786
6053
|
# @option params [required, String] :aws_account_id
|
|
5787
6054
|
# The ID for the Amazon Web Services account that you want to describe
|
|
5788
|
-
#
|
|
6055
|
+
# Quick Sight customizations for.
|
|
5789
6056
|
#
|
|
5790
6057
|
# @option params [String] :namespace
|
|
5791
|
-
# The
|
|
6058
|
+
# The Quick Sight namespace that you want to describe Quick Sight
|
|
5792
6059
|
# customizations for.
|
|
5793
6060
|
#
|
|
5794
6061
|
# @option params [Boolean] :resolved
|
|
5795
6062
|
# The `Resolved` flag works with the other parameters to determine which
|
|
5796
|
-
# view of
|
|
5797
|
-
# to your command to use the same view that
|
|
6063
|
+
# view of Quick Sight customizations is returned. You can add this flag
|
|
6064
|
+
# to your command to use the same view that Quick Sight uses to identify
|
|
5798
6065
|
# which customizations to apply to the console. Omit this flag, or set
|
|
5799
6066
|
# it to `no-resolved`, to reveal customizations that are configured at
|
|
5800
6067
|
# different levels.
|
|
@@ -5835,7 +6102,7 @@ module Aws::QuickSight
|
|
|
5835
6102
|
req.send_request(options)
|
|
5836
6103
|
end
|
|
5837
6104
|
|
|
5838
|
-
# Describes the settings that were used when your
|
|
6105
|
+
# Describes the settings that were used when your Quick Sight
|
|
5839
6106
|
# subscription was first created in this Amazon Web Services account.
|
|
5840
6107
|
#
|
|
5841
6108
|
# @option params [required, String] :aws_account_id
|
|
@@ -5875,13 +6142,13 @@ module Aws::QuickSight
|
|
|
5875
6142
|
end
|
|
5876
6143
|
|
|
5877
6144
|
# Use the DescribeAccountSubscription operation to receive a description
|
|
5878
|
-
# of an
|
|
6145
|
+
# of an Quick Sight account's subscription. A successful API call
|
|
5879
6146
|
# returns an `AccountInfo` object that includes an account's name,
|
|
5880
6147
|
# subscription status, authentication type, edition, and notification
|
|
5881
6148
|
# email address.
|
|
5882
6149
|
#
|
|
5883
6150
|
# @option params [required, String] :aws_account_id
|
|
5884
|
-
# The Amazon Web Services account ID associated with your
|
|
6151
|
+
# The Amazon Web Services account ID associated with your Quick Sight
|
|
5885
6152
|
# account.
|
|
5886
6153
|
#
|
|
5887
6154
|
# @return [Types::DescribeAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -5916,6 +6183,120 @@ module Aws::QuickSight
|
|
|
5916
6183
|
req.send_request(options)
|
|
5917
6184
|
end
|
|
5918
6185
|
|
|
6186
|
+
# Retrieves detailed information about an action connector, including
|
|
6187
|
+
# its configuration, authentication settings, enabled actions, and
|
|
6188
|
+
# current status.
|
|
6189
|
+
#
|
|
6190
|
+
# @option params [required, String] :aws_account_id
|
|
6191
|
+
# The Amazon Web Services account ID that contains the action connector.
|
|
6192
|
+
#
|
|
6193
|
+
# @option params [required, String] :action_connector_id
|
|
6194
|
+
# The unique identifier of the action connector to describe.
|
|
6195
|
+
#
|
|
6196
|
+
# @return [Types::DescribeActionConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6197
|
+
#
|
|
6198
|
+
# * {Types::DescribeActionConnectorResponse#action_connector #action_connector} => Types::ActionConnector
|
|
6199
|
+
# * {Types::DescribeActionConnectorResponse#request_id #request_id} => String
|
|
6200
|
+
# * {Types::DescribeActionConnectorResponse#status #status} => Integer
|
|
6201
|
+
#
|
|
6202
|
+
# @example Request syntax with placeholder values
|
|
6203
|
+
#
|
|
6204
|
+
# resp = client.describe_action_connector({
|
|
6205
|
+
# aws_account_id: "AwsAccountId", # required
|
|
6206
|
+
# action_connector_id: "ShortRestrictiveResourceId", # required
|
|
6207
|
+
# })
|
|
6208
|
+
#
|
|
6209
|
+
# @example Response structure
|
|
6210
|
+
#
|
|
6211
|
+
# resp.action_connector.arn #=> String
|
|
6212
|
+
# resp.action_connector.action_connector_id #=> String
|
|
6213
|
+
# resp.action_connector.type #=> String, one of "GENERIC_HTTP", "SERVICENOW_NOW_PLATFORM", "SALESFORCE_CRM", "MICROSOFT_OUTLOOK", "PAGERDUTY_ADVANCE", "JIRA_CLOUD", "ATLASSIAN_CONFLUENCE", "AMAZON_S3", "AMAZON_BEDROCK_AGENT_RUNTIME", "AMAZON_BEDROCK_RUNTIME", "AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME", "AMAZON_TEXTRACT", "AMAZON_COMPREHEND", "AMAZON_COMPREHEND_MEDICAL", "MICROSOFT_ONEDRIVE", "MICROSOFT_SHAREPOINT", "MICROSOFT_TEAMS", "SAP_BUSINESSPARTNER", "SAP_PRODUCTMASTERDATA", "SAP_PHYSICALINVENTORY", "SAP_BILLOFMATERIALS", "SAP_MATERIALSTOCK", "ZENDESK_SUITE", "SMARTSHEET", "SLACK", "ASANA", "BAMBOO_HR"
|
|
6214
|
+
# resp.action_connector.name #=> String
|
|
6215
|
+
# resp.action_connector.created_time #=> Time
|
|
6216
|
+
# resp.action_connector.last_updated_time #=> Time
|
|
6217
|
+
# resp.action_connector.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
6218
|
+
# resp.action_connector.error.message #=> String
|
|
6219
|
+
# resp.action_connector.error.type #=> String, one of "INTERNAL_FAILURE"
|
|
6220
|
+
# resp.action_connector.description #=> String
|
|
6221
|
+
# resp.action_connector.authentication_config.authentication_type #=> String, one of "BASIC", "API_KEY", "OAUTH2_CLIENT_CREDENTIALS", "NONE", "IAM", "OAUTH2_AUTHORIZATION_CODE"
|
|
6222
|
+
# resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.base_endpoint #=> String
|
|
6223
|
+
# resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.redirect_url #=> String
|
|
6224
|
+
# resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.read_authorization_code_grant_credentials_details.read_authorization_code_grant_details.client_id #=> String
|
|
6225
|
+
# resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.read_authorization_code_grant_credentials_details.read_authorization_code_grant_details.token_endpoint #=> String
|
|
6226
|
+
# resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.read_authorization_code_grant_credentials_details.read_authorization_code_grant_details.authorization_endpoint #=> String
|
|
6227
|
+
# resp.action_connector.authentication_config.authentication_metadata.authorization_code_grant_metadata.authorization_code_grant_credentials_source #=> String, one of "PLAIN_CREDENTIALS"
|
|
6228
|
+
# resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.base_endpoint #=> String
|
|
6229
|
+
# resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.read_client_credentials_details.read_client_credentials_grant_details.client_id #=> String
|
|
6230
|
+
# resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.read_client_credentials_details.read_client_credentials_grant_details.token_endpoint #=> String
|
|
6231
|
+
# resp.action_connector.authentication_config.authentication_metadata.client_credentials_grant_metadata.client_credentials_source #=> String, one of "PLAIN_CREDENTIALS"
|
|
6232
|
+
# resp.action_connector.authentication_config.authentication_metadata.basic_auth_connection_metadata.base_endpoint #=> String
|
|
6233
|
+
# resp.action_connector.authentication_config.authentication_metadata.basic_auth_connection_metadata.username #=> String
|
|
6234
|
+
# resp.action_connector.authentication_config.authentication_metadata.api_key_connection_metadata.base_endpoint #=> String
|
|
6235
|
+
# resp.action_connector.authentication_config.authentication_metadata.api_key_connection_metadata.email #=> String
|
|
6236
|
+
# resp.action_connector.authentication_config.authentication_metadata.none_connection_metadata.base_endpoint #=> String
|
|
6237
|
+
# resp.action_connector.authentication_config.authentication_metadata.iam_connection_metadata.role_arn #=> String
|
|
6238
|
+
# resp.action_connector.authentication_config.authentication_metadata.iam_connection_metadata.source_arn #=> String
|
|
6239
|
+
# resp.action_connector.enabled_actions #=> Array
|
|
6240
|
+
# resp.action_connector.enabled_actions[0] #=> String
|
|
6241
|
+
# resp.action_connector.vpc_connection_arn #=> String
|
|
6242
|
+
# resp.request_id #=> String
|
|
6243
|
+
# resp.status #=> Integer
|
|
6244
|
+
#
|
|
6245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeActionConnector AWS API Documentation
|
|
6246
|
+
#
|
|
6247
|
+
# @overload describe_action_connector(params = {})
|
|
6248
|
+
# @param [Hash] params ({})
|
|
6249
|
+
def describe_action_connector(params = {}, options = {})
|
|
6250
|
+
req = build_request(:describe_action_connector, params)
|
|
6251
|
+
req.send_request(options)
|
|
6252
|
+
end
|
|
6253
|
+
|
|
6254
|
+
# Retrieves the permissions configuration for an action connector,
|
|
6255
|
+
# showing which users, groups, and namespaces have access and what
|
|
6256
|
+
# operations they can perform.
|
|
6257
|
+
#
|
|
6258
|
+
# @option params [required, String] :aws_account_id
|
|
6259
|
+
# The Amazon Web Services account ID that contains the action connector.
|
|
6260
|
+
#
|
|
6261
|
+
# @option params [required, String] :action_connector_id
|
|
6262
|
+
# The unique identifier of the action connector whose permissions you
|
|
6263
|
+
# want to describe.
|
|
6264
|
+
#
|
|
6265
|
+
# @return [Types::DescribeActionConnectorPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6266
|
+
#
|
|
6267
|
+
# * {Types::DescribeActionConnectorPermissionsResponse#arn #arn} => String
|
|
6268
|
+
# * {Types::DescribeActionConnectorPermissionsResponse#action_connector_id #action_connector_id} => String
|
|
6269
|
+
# * {Types::DescribeActionConnectorPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
|
6270
|
+
# * {Types::DescribeActionConnectorPermissionsResponse#request_id #request_id} => String
|
|
6271
|
+
# * {Types::DescribeActionConnectorPermissionsResponse#status #status} => Integer
|
|
6272
|
+
#
|
|
6273
|
+
# @example Request syntax with placeholder values
|
|
6274
|
+
#
|
|
6275
|
+
# resp = client.describe_action_connector_permissions({
|
|
6276
|
+
# aws_account_id: "AwsAccountId", # required
|
|
6277
|
+
# action_connector_id: "ShortRestrictiveResourceId", # required
|
|
6278
|
+
# })
|
|
6279
|
+
#
|
|
6280
|
+
# @example Response structure
|
|
6281
|
+
#
|
|
6282
|
+
# resp.arn #=> String
|
|
6283
|
+
# resp.action_connector_id #=> String
|
|
6284
|
+
# resp.permissions #=> Array
|
|
6285
|
+
# resp.permissions[0].principal #=> String
|
|
6286
|
+
# resp.permissions[0].actions #=> Array
|
|
6287
|
+
# resp.permissions[0].actions[0] #=> String
|
|
6288
|
+
# resp.request_id #=> String
|
|
6289
|
+
# resp.status #=> Integer
|
|
6290
|
+
#
|
|
6291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeActionConnectorPermissions AWS API Documentation
|
|
6292
|
+
#
|
|
6293
|
+
# @overload describe_action_connector_permissions(params = {})
|
|
6294
|
+
# @param [Hash] params ({})
|
|
6295
|
+
def describe_action_connector_permissions(params = {}, options = {})
|
|
6296
|
+
req = build_request(:describe_action_connector_permissions, params)
|
|
6297
|
+
req.send_request(options)
|
|
6298
|
+
end
|
|
6299
|
+
|
|
5919
6300
|
# Provides a summary of the metadata for an analysis.
|
|
5920
6301
|
#
|
|
5921
6302
|
# @option params [required, String] :aws_account_id
|
|
@@ -6333,6 +6714,9 @@ module Aws::QuickSight
|
|
|
6333
6714
|
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
|
6334
6715
|
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
|
6335
6716
|
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
|
|
6717
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.role_arn #=> String
|
|
6718
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.bucket_url #=> String
|
|
6719
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.metadata_files_location #=> String
|
|
6336
6720
|
# resp.override_parameters.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
|
|
6337
6721
|
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
|
|
6338
6722
|
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
|
|
@@ -6379,6 +6763,16 @@ module Aws::QuickSight
|
|
|
6379
6763
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.database #=> String
|
|
6380
6764
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
|
6381
6765
|
# resp.override_parameters.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
|
|
6766
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
|
|
6767
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.username_field_xpath #=> String
|
|
6768
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.password_field_xpath #=> String
|
|
6769
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.username_button_xpath #=> String
|
|
6770
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.password_button_xpath #=> String
|
|
6771
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.login_page_url #=> String
|
|
6772
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_host_name #=> String
|
|
6773
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_port_number #=> Integer
|
|
6774
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.confluence_parameters.confluence_url #=> String
|
|
6775
|
+
# resp.override_parameters.data_sources[0].data_source_parameters.q_business_parameters.application_arn #=> String
|
|
6382
6776
|
# resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
|
6383
6777
|
# resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
|
6384
6778
|
# resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
|
|
@@ -6586,6 +6980,14 @@ module Aws::QuickSight
|
|
|
6586
6980
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
|
6587
6981
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
|
6588
6982
|
# resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
|
|
6983
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
|
|
6984
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
|
|
6985
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
|
|
6986
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
|
|
6987
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
|
|
6988
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
|
|
6989
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
|
|
6990
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
|
|
6589
6991
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
|
6590
6992
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
|
6591
6993
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
|
@@ -6708,6 +7110,14 @@ module Aws::QuickSight
|
|
|
6708
7110
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
|
6709
7111
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
|
6710
7112
|
# resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
|
|
7113
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
|
|
7114
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
|
|
7115
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
|
|
7116
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
|
|
7117
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
|
|
7118
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
|
|
7119
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
|
|
7120
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
|
|
6711
7121
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
|
6712
7122
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
|
6713
7123
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
|
@@ -6779,6 +7189,18 @@ module Aws::QuickSight
|
|
|
6779
7189
|
# resp.custom_permissions.capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
|
|
6780
7190
|
# resp.custom_permissions.capabilities.dashboard #=> String, one of "DENY"
|
|
6781
7191
|
# resp.custom_permissions.capabilities.analysis #=> String, one of "DENY"
|
|
7192
|
+
# resp.custom_permissions.capabilities.automate #=> String, one of "DENY"
|
|
7193
|
+
# resp.custom_permissions.capabilities.flow #=> String, one of "DENY"
|
|
7194
|
+
# resp.custom_permissions.capabilities.publish_without_approval #=> String, one of "DENY"
|
|
7195
|
+
# resp.custom_permissions.capabilities.use_bedrock_models #=> String, one of "DENY"
|
|
7196
|
+
# resp.custom_permissions.capabilities.perform_flow_ui_task #=> String, one of "DENY"
|
|
7197
|
+
# resp.custom_permissions.capabilities.use_agent_web_search #=> String, one of "DENY"
|
|
7198
|
+
# resp.custom_permissions.capabilities.knowledge_base #=> String, one of "DENY"
|
|
7199
|
+
# resp.custom_permissions.capabilities.action #=> String, one of "DENY"
|
|
7200
|
+
# resp.custom_permissions.capabilities.space #=> String, one of "DENY"
|
|
7201
|
+
# resp.custom_permissions.capabilities.chat_agent #=> String, one of "DENY"
|
|
7202
|
+
# resp.custom_permissions.capabilities.create_chat_agents #=> String, one of "DENY"
|
|
7203
|
+
# resp.custom_permissions.capabilities.research #=> String, one of "DENY"
|
|
6782
7204
|
# resp.request_id #=> String
|
|
6783
7205
|
#
|
|
6784
7206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeCustomPermissions AWS API Documentation
|
|
@@ -7484,7 +7906,7 @@ module Aws::QuickSight
|
|
|
7484
7906
|
# resp.data_source.arn #=> String
|
|
7485
7907
|
# resp.data_source.data_source_id #=> String
|
|
7486
7908
|
# resp.data_source.name #=> String
|
|
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"
|
|
7909
|
+
# 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", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
|
|
7488
7910
|
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
7489
7911
|
# resp.data_source.created_time #=> Time
|
|
7490
7912
|
# resp.data_source.last_updated_time #=> Time
|
|
@@ -7531,6 +7953,9 @@ module Aws::QuickSight
|
|
|
7531
7953
|
# resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
|
7532
7954
|
# resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
|
7533
7955
|
# resp.data_source.data_source_parameters.s3_parameters.role_arn #=> String
|
|
7956
|
+
# resp.data_source.data_source_parameters.s3_knowledge_base_parameters.role_arn #=> String
|
|
7957
|
+
# resp.data_source.data_source_parameters.s3_knowledge_base_parameters.bucket_url #=> String
|
|
7958
|
+
# resp.data_source.data_source_parameters.s3_knowledge_base_parameters.metadata_files_location #=> String
|
|
7534
7959
|
# resp.data_source.data_source_parameters.service_now_parameters.site_base_url #=> String
|
|
7535
7960
|
# resp.data_source.data_source_parameters.snowflake_parameters.host #=> String
|
|
7536
7961
|
# resp.data_source.data_source_parameters.snowflake_parameters.database #=> String
|
|
@@ -7577,6 +8002,16 @@ module Aws::QuickSight
|
|
|
7577
8002
|
# resp.data_source.data_source_parameters.impala_parameters.database #=> String
|
|
7578
8003
|
# resp.data_source.data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
|
7579
8004
|
# resp.data_source.data_source_parameters.custom_connection_parameters.connection_type #=> String
|
|
8005
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
|
|
8006
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.username_field_xpath #=> String
|
|
8007
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.password_field_xpath #=> String
|
|
8008
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.username_button_xpath #=> String
|
|
8009
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.password_button_xpath #=> String
|
|
8010
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.login_page_url #=> String
|
|
8011
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.web_proxy_host_name #=> String
|
|
8012
|
+
# resp.data_source.data_source_parameters.web_crawler_parameters.web_proxy_port_number #=> Integer
|
|
8013
|
+
# resp.data_source.data_source_parameters.confluence_parameters.confluence_url #=> String
|
|
8014
|
+
# resp.data_source.data_source_parameters.q_business_parameters.application_arn #=> String
|
|
7580
8015
|
# resp.data_source.alternate_data_source_parameters #=> Array
|
|
7581
8016
|
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
|
7582
8017
|
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
|
@@ -7621,6 +8056,9 @@ module Aws::QuickSight
|
|
|
7621
8056
|
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
|
7622
8057
|
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
|
7623
8058
|
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.role_arn #=> String
|
|
8059
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_knowledge_base_parameters.role_arn #=> String
|
|
8060
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_knowledge_base_parameters.bucket_url #=> String
|
|
8061
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_knowledge_base_parameters.metadata_files_location #=> String
|
|
7624
8062
|
# resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
|
7625
8063
|
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
|
7626
8064
|
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
|
@@ -7667,6 +8105,16 @@ module Aws::QuickSight
|
|
|
7667
8105
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.database #=> String
|
|
7668
8106
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
|
|
7669
8107
|
# resp.data_source.alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
|
|
8108
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
|
|
8109
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.username_field_xpath #=> String
|
|
8110
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.password_field_xpath #=> String
|
|
8111
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.username_button_xpath #=> String
|
|
8112
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.password_button_xpath #=> String
|
|
8113
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.login_page_url #=> String
|
|
8114
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_host_name #=> String
|
|
8115
|
+
# resp.data_source.alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_port_number #=> Integer
|
|
8116
|
+
# resp.data_source.alternate_data_source_parameters[0].confluence_parameters.confluence_url #=> String
|
|
8117
|
+
# resp.data_source.alternate_data_source_parameters[0].q_business_parameters.application_arn #=> String
|
|
7670
8118
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
|
7671
8119
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
|
7672
8120
|
# 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"
|
|
@@ -7728,15 +8176,15 @@ module Aws::QuickSight
|
|
|
7728
8176
|
req.send_request(options)
|
|
7729
8177
|
end
|
|
7730
8178
|
|
|
7731
|
-
# Describes a Amazon Q Business application that is linked to an
|
|
7732
|
-
#
|
|
8179
|
+
# Describes a Amazon Q Business application that is linked to an Quick
|
|
8180
|
+
# Sight account.
|
|
7733
8181
|
#
|
|
7734
8182
|
# @option params [required, String] :aws_account_id
|
|
7735
|
-
# The ID of the
|
|
8183
|
+
# The ID of the Quick Sight account that is linked to the Amazon Q
|
|
7736
8184
|
# Business application that you want described.
|
|
7737
8185
|
#
|
|
7738
8186
|
# @option params [String] :namespace
|
|
7739
|
-
# The
|
|
8187
|
+
# The Quick Sight namespace that contains the linked Amazon Q Business
|
|
7740
8188
|
# application. If this field is left blank, the default namespace is
|
|
7741
8189
|
# used. Currently, the default namespace is the only valid value for
|
|
7742
8190
|
# this parameter.
|
|
@@ -7933,7 +8381,7 @@ module Aws::QuickSight
|
|
|
7933
8381
|
req.send_request(options)
|
|
7934
8382
|
end
|
|
7935
8383
|
|
|
7936
|
-
# Returns an Amazon
|
|
8384
|
+
# Returns an Amazon Quick Sight group's description and Amazon Resource
|
|
7937
8385
|
# Name (ARN).
|
|
7938
8386
|
#
|
|
7939
8387
|
# @option params [required, String] :group_name
|
|
@@ -7942,7 +8390,7 @@ module Aws::QuickSight
|
|
|
7942
8390
|
# @option params [required, String] :aws_account_id
|
|
7943
8391
|
# The ID for the Amazon Web Services account that the group is in.
|
|
7944
8392
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
7945
|
-
# contains your Amazon
|
|
8393
|
+
# contains your Amazon Quick Sight account.
|
|
7946
8394
|
#
|
|
7947
8395
|
# @option params [required, String] :namespace
|
|
7948
8396
|
# The namespace of the group that you want described.
|
|
@@ -7992,7 +8440,7 @@ module Aws::QuickSight
|
|
|
7992
8440
|
# @option params [required, String] :aws_account_id
|
|
7993
8441
|
# The ID for the Amazon Web Services account that the group is in.
|
|
7994
8442
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
7995
|
-
# contains your Amazon
|
|
8443
|
+
# contains your Amazon Quick Sight account.
|
|
7996
8444
|
#
|
|
7997
8445
|
# @option params [required, String] :namespace
|
|
7998
8446
|
# The namespace that includes the group you are searching within.
|
|
@@ -8174,7 +8622,7 @@ module Aws::QuickSight
|
|
|
8174
8622
|
req.send_request(options)
|
|
8175
8623
|
end
|
|
8176
8624
|
|
|
8177
|
-
# Describes all customer managed key registrations in a
|
|
8625
|
+
# Describes all customer managed key registrations in a Quick Sight
|
|
8178
8626
|
# account.
|
|
8179
8627
|
#
|
|
8180
8628
|
# @option params [required, String] :aws_account_id
|
|
@@ -8222,8 +8670,8 @@ module Aws::QuickSight
|
|
|
8222
8670
|
# Describes the current namespace.
|
|
8223
8671
|
#
|
|
8224
8672
|
# @option params [required, String] :aws_account_id
|
|
8225
|
-
# The ID for the Amazon Web Services account that contains the
|
|
8226
|
-
#
|
|
8673
|
+
# The ID for the Amazon Web Services account that contains the Quick
|
|
8674
|
+
# Sight namespace that you want to describe.
|
|
8227
8675
|
#
|
|
8228
8676
|
# @option params [required, String] :namespace
|
|
8229
8677
|
# The namespace that you want to describe.
|
|
@@ -8297,11 +8745,11 @@ module Aws::QuickSight
|
|
|
8297
8745
|
req.send_request(options)
|
|
8298
8746
|
end
|
|
8299
8747
|
|
|
8300
|
-
# Describes the state of a
|
|
8748
|
+
# Describes the state of a Quick Sight Q Search configuration.
|
|
8301
8749
|
#
|
|
8302
8750
|
# @option params [required, String] :aws_account_id
|
|
8303
|
-
# The ID of the Amazon Web Services account that contains the
|
|
8304
|
-
# Q Search configuration that the user wants described.
|
|
8751
|
+
# The ID of the Amazon Web Services account that contains the Quick
|
|
8752
|
+
# Sight Q Search configuration that the user wants described.
|
|
8305
8753
|
#
|
|
8306
8754
|
# @return [Types::DescribeQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8307
8755
|
#
|
|
@@ -8388,8 +8836,8 @@ module Aws::QuickSight
|
|
|
8388
8836
|
# @option params [required, String] :aws_account_id
|
|
8389
8837
|
# The ID for the Amazon Web Services account that you want to create a
|
|
8390
8838
|
# group in. The Amazon Web Services account ID that you provide must be
|
|
8391
|
-
# the same Amazon Web Services account that contains your Amazon
|
|
8392
|
-
#
|
|
8839
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
|
8840
|
+
# Sight account.
|
|
8393
8841
|
#
|
|
8394
8842
|
# @option params [required, String] :namespace
|
|
8395
8843
|
# The namespace that contains the role.
|
|
@@ -9217,7 +9665,7 @@ module Aws::QuickSight
|
|
|
9217
9665
|
# @option params [required, String] :aws_account_id
|
|
9218
9666
|
# The ID for the Amazon Web Services account that the user is in.
|
|
9219
9667
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
9220
|
-
# contains your Amazon
|
|
9668
|
+
# contains your Amazon Quick Sight account.
|
|
9221
9669
|
#
|
|
9222
9670
|
# @option params [required, String] :namespace
|
|
9223
9671
|
# The namespace. Currently, you should set this to `default`.
|
|
@@ -9359,9 +9807,9 @@ module Aws::QuickSight
|
|
|
9359
9807
|
# \[15-600\] minutes range.
|
|
9360
9808
|
#
|
|
9361
9809
|
# @option params [required, String] :namespace
|
|
9362
|
-
# The
|
|
9363
|
-
# If you are not using an Amazon QuickSight custom
|
|
9364
|
-
# to `default`.
|
|
9810
|
+
# The Amazon Quick Sight namespace that the anonymous user virtually
|
|
9811
|
+
# belongs to. If you are not using an Amazon QuickSight custom
|
|
9812
|
+
# namespace, set this to `default`.
|
|
9365
9813
|
#
|
|
9366
9814
|
# @option params [Array<Types::SessionTag>] :session_tags
|
|
9367
9815
|
# The session tags used for row-level security. Before you use this
|
|
@@ -9371,15 +9819,15 @@ module Aws::QuickSight
|
|
|
9371
9819
|
#
|
|
9372
9820
|
# These are not the tags used for the Amazon Web Services resource
|
|
9373
9821
|
# tagging feature. For more information, see [Using Row-Level Security
|
|
9374
|
-
# (RLS) with Tags][1]in the *Amazon
|
|
9822
|
+
# (RLS) with Tags][1]in the *Amazon Quick Sight User Guide*.
|
|
9375
9823
|
#
|
|
9376
9824
|
#
|
|
9377
9825
|
#
|
|
9378
9826
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
|
9379
9827
|
#
|
|
9380
9828
|
# @option params [required, Array<String>] :authorized_resource_arns
|
|
9381
|
-
# The Amazon Resource Names (ARNs) for the
|
|
9382
|
-
# user is authorized to access during the lifetime of the session.
|
|
9829
|
+
# The Amazon Resource Names (ARNs) for the Quick Sight resources that
|
|
9830
|
+
# the user is authorized to access during the lifetime of the session.
|
|
9383
9831
|
#
|
|
9384
9832
|
# If you choose `Dashboard` embedding experience, pass the list of
|
|
9385
9833
|
# dashboard ARNs in the account that you want the user to be able to
|
|
@@ -9396,10 +9844,10 @@ module Aws::QuickSight
|
|
|
9396
9844
|
# @option params [Array<String>] :allowed_domains
|
|
9397
9845
|
# The domains that you want to add to the allow list for access to the
|
|
9398
9846
|
# generated URL that is then embedded. This optional parameter overrides
|
|
9399
|
-
# the static domains that are configured in the Manage
|
|
9400
|
-
# in the
|
|
9401
|
-
# you include in this parameter. You can list up to three domains
|
|
9402
|
-
# subdomains in each API call.
|
|
9847
|
+
# the static domains that are configured in the Manage Quick Sight menu
|
|
9848
|
+
# in the Amazon Quick Sight console. Instead, it allows only the domains
|
|
9849
|
+
# that you include in this parameter. You can list up to three domains
|
|
9850
|
+
# or subdomains in each API call.
|
|
9403
9851
|
#
|
|
9404
9852
|
# To include all subdomains under a specific domain to the allow list,
|
|
9405
9853
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
|
@@ -9516,17 +9964,17 @@ module Aws::QuickSight
|
|
|
9516
9964
|
#
|
|
9517
9965
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
|
9518
9966
|
# The experience that you want to embed. For registered users, you can
|
|
9519
|
-
# embed QuickSight dashboards,
|
|
9520
|
-
# search bar, the
|
|
9521
|
-
# entire
|
|
9967
|
+
# embed QuickSight dashboards, Amazon Quick Sight visuals, the Amazon
|
|
9968
|
+
# Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A
|
|
9969
|
+
# experience, or the entire Amazon Quick Sight console.
|
|
9522
9970
|
#
|
|
9523
9971
|
# @option params [Array<String>] :allowed_domains
|
|
9524
9972
|
# The domains that you want to add to the allow list for access to the
|
|
9525
9973
|
# generated URL that is then embedded. This optional parameter overrides
|
|
9526
|
-
# the static domains that are configured in the Manage
|
|
9527
|
-
# in the
|
|
9528
|
-
# you include in this parameter. You can list up to three domains
|
|
9529
|
-
# subdomains in each API call.
|
|
9974
|
+
# the static domains that are configured in the Manage Quick Sight menu
|
|
9975
|
+
# in the Amazon Quick Sight console. Instead, it allows only the domains
|
|
9976
|
+
# that you include in this parameter. You can list up to three domains
|
|
9977
|
+
# or subdomains in each API call.
|
|
9530
9978
|
#
|
|
9531
9979
|
# To include all subdomains under a specific domain to the allow list,
|
|
9532
9980
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
|
@@ -9639,9 +10087,9 @@ module Aws::QuickSight
|
|
|
9639
10087
|
req.send_request(options)
|
|
9640
10088
|
end
|
|
9641
10089
|
|
|
9642
|
-
# Generates an embed URL that you can use to embed an
|
|
10090
|
+
# Generates an embed URL that you can use to embed an Amazon Quick Sight
|
|
9643
10091
|
# experience in your website. This action can be used for any type of
|
|
9644
|
-
# user that is registered in an
|
|
10092
|
+
# user that is registered in an Amazon Quick Sight account that uses IAM
|
|
9645
10093
|
# Identity Center for authentication. This API requires
|
|
9646
10094
|
# [identity-enhanced IAM Role sessions][1] for the authenticated user
|
|
9647
10095
|
# that the API call is being made for.
|
|
@@ -9650,9 +10098,9 @@ module Aws::QuickSight
|
|
|
9650
10098
|
# user is authenticated and receives the embed URL that is specific to
|
|
9651
10099
|
# that user. The IAM Identity Center application that the user has
|
|
9652
10100
|
# logged into needs to have [trusted Identity Propagation enabled for
|
|
9653
|
-
#
|
|
9654
|
-
# you use this action, make sure that you have configured the
|
|
9655
|
-
#
|
|
10101
|
+
# Amazon Quick Sight][3] with the scope value set to `quicksight:read`.
|
|
10102
|
+
# Before you use this action, make sure that you have configured the
|
|
10103
|
+
# relevant Amazon Quick Sight resource and permissions.
|
|
9656
10104
|
#
|
|
9657
10105
|
#
|
|
9658
10106
|
#
|
|
@@ -9668,7 +10116,7 @@ module Aws::QuickSight
|
|
|
9668
10116
|
#
|
|
9669
10117
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
|
9670
10118
|
# The type of experience you want to embed. For registered users, you
|
|
9671
|
-
# can embed QuickSight dashboards or the
|
|
10119
|
+
# can embed QuickSight dashboards or the Amazon Quick Sight console.
|
|
9672
10120
|
#
|
|
9673
10121
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
|
9674
10122
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
|
@@ -9786,9 +10234,9 @@ module Aws::QuickSight
|
|
|
9786
10234
|
end
|
|
9787
10235
|
|
|
9788
10236
|
# Generates a temporary session URL and authorization code(bearer token)
|
|
9789
|
-
# that you can use to embed an
|
|
9790
|
-
# website or application. Before you use this command, make sure
|
|
9791
|
-
# you have configured the dashboards and permissions.
|
|
10237
|
+
# that you can use to embed an Amazon Quick Sight read-only dashboard in
|
|
10238
|
+
# your website or application. Before you use this command, make sure
|
|
10239
|
+
# that you have configured the dashboards and permissions.
|
|
9792
10240
|
#
|
|
9793
10241
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
|
9794
10242
|
# not from the user's browser. The following rules apply to the
|
|
@@ -9846,11 +10294,11 @@ module Aws::QuickSight
|
|
|
9846
10294
|
# Adds persistence of state for the user session in an embedded
|
|
9847
10295
|
# dashboard. Persistence applies to the sheet and the parameter
|
|
9848
10296
|
# settings. These are control settings that the dashboard subscriber
|
|
9849
|
-
# (
|
|
9850
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
|
9851
|
-
# the same dashboard URL. The state is stored in
|
|
9852
|
-
# browser cookie. If this is set to FALSE, the state of
|
|
9853
|
-
# is not persisted. The default is `FALSE`.
|
|
10297
|
+
# (Amazon Quick Sight reader) chooses while viewing the dashboard. If
|
|
10298
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
|
10299
|
+
# reopens the same dashboard URL. The state is stored in Amazon Quick
|
|
10300
|
+
# Sight, not in a browser cookie. If this is set to FALSE, the state of
|
|
10301
|
+
# the user session is not persisted. The default is `FALSE`.
|
|
9854
10302
|
#
|
|
9855
10303
|
# @option params [String] :user_arn
|
|
9856
10304
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
|
@@ -9870,9 +10318,9 @@ module Aws::QuickSight
|
|
|
9870
10318
|
# role-based sessions.
|
|
9871
10319
|
#
|
|
9872
10320
|
# @option params [String] :namespace
|
|
9873
|
-
# The
|
|
9874
|
-
# request. If you're not using a custom namespace, set `Namespace
|
|
9875
|
-
# default`.
|
|
10321
|
+
# The Amazon Quick Sight namespace that contains the dashboard IDs in
|
|
10322
|
+
# this request. If you're not using a custom namespace, set `Namespace
|
|
10323
|
+
# = default`.
|
|
9876
10324
|
#
|
|
9877
10325
|
# @option params [Array<String>] :additional_dashboard_ids
|
|
9878
10326
|
# A list of one or more dashboard IDs that you want anonymous users to
|
|
@@ -9918,15 +10366,113 @@ module Aws::QuickSight
|
|
|
9918
10366
|
req.send_request(options)
|
|
9919
10367
|
end
|
|
9920
10368
|
|
|
10369
|
+
# Retrieves the metadata of a flow, not including its definition
|
|
10370
|
+
# specifying the steps.
|
|
10371
|
+
#
|
|
10372
|
+
# @option params [required, String] :aws_account_id
|
|
10373
|
+
# The ID of the Amazon Web Services account that contains the flow that
|
|
10374
|
+
# you are getting metadata for.
|
|
10375
|
+
#
|
|
10376
|
+
# @option params [required, String] :flow_id
|
|
10377
|
+
# The unique identifier of the flow.
|
|
10378
|
+
#
|
|
10379
|
+
# @return [Types::GetFlowMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10380
|
+
#
|
|
10381
|
+
# * {Types::GetFlowMetadataOutput#arn #arn} => String
|
|
10382
|
+
# * {Types::GetFlowMetadataOutput#flow_id #flow_id} => String
|
|
10383
|
+
# * {Types::GetFlowMetadataOutput#name #name} => String
|
|
10384
|
+
# * {Types::GetFlowMetadataOutput#description #description} => String
|
|
10385
|
+
# * {Types::GetFlowMetadataOutput#publish_state #publish_state} => String
|
|
10386
|
+
# * {Types::GetFlowMetadataOutput#user_count #user_count} => Integer
|
|
10387
|
+
# * {Types::GetFlowMetadataOutput#run_count #run_count} => Integer
|
|
10388
|
+
# * {Types::GetFlowMetadataOutput#created_time #created_time} => Time
|
|
10389
|
+
# * {Types::GetFlowMetadataOutput#last_updated_time #last_updated_time} => Time
|
|
10390
|
+
# * {Types::GetFlowMetadataOutput#request_id #request_id} => String
|
|
10391
|
+
# * {Types::GetFlowMetadataOutput#status #status} => Integer
|
|
10392
|
+
#
|
|
10393
|
+
# @example Request syntax with placeholder values
|
|
10394
|
+
#
|
|
10395
|
+
# resp = client.get_flow_metadata({
|
|
10396
|
+
# aws_account_id: "AccountId", # required
|
|
10397
|
+
# flow_id: "FlowId", # required
|
|
10398
|
+
# })
|
|
10399
|
+
#
|
|
10400
|
+
# @example Response structure
|
|
10401
|
+
#
|
|
10402
|
+
# resp.arn #=> String
|
|
10403
|
+
# resp.flow_id #=> String
|
|
10404
|
+
# resp.name #=> String
|
|
10405
|
+
# resp.description #=> String
|
|
10406
|
+
# resp.publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
|
|
10407
|
+
# resp.user_count #=> Integer
|
|
10408
|
+
# resp.run_count #=> Integer
|
|
10409
|
+
# resp.created_time #=> Time
|
|
10410
|
+
# resp.last_updated_time #=> Time
|
|
10411
|
+
# resp.request_id #=> String
|
|
10412
|
+
# resp.status #=> Integer
|
|
10413
|
+
#
|
|
10414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetFlowMetadata AWS API Documentation
|
|
10415
|
+
#
|
|
10416
|
+
# @overload get_flow_metadata(params = {})
|
|
10417
|
+
# @param [Hash] params ({})
|
|
10418
|
+
def get_flow_metadata(params = {}, options = {})
|
|
10419
|
+
req = build_request(:get_flow_metadata, params)
|
|
10420
|
+
req.send_request(options)
|
|
10421
|
+
end
|
|
10422
|
+
|
|
10423
|
+
# Get permissions for a flow.
|
|
10424
|
+
#
|
|
10425
|
+
# @option params [required, String] :aws_account_id
|
|
10426
|
+
# The ID of the Amazon Web Services account that contains the flow that
|
|
10427
|
+
# you are getting permissions for.
|
|
10428
|
+
#
|
|
10429
|
+
# @option params [required, String] :flow_id
|
|
10430
|
+
# The unique identifier of the flow to get permissions from.
|
|
10431
|
+
#
|
|
10432
|
+
# @return [Types::GetFlowPermissionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10433
|
+
#
|
|
10434
|
+
# * {Types::GetFlowPermissionsOutput#arn #arn} => String
|
|
10435
|
+
# * {Types::GetFlowPermissionsOutput#flow_id #flow_id} => String
|
|
10436
|
+
# * {Types::GetFlowPermissionsOutput#permissions #permissions} => Array<Types::Permission>
|
|
10437
|
+
# * {Types::GetFlowPermissionsOutput#request_id #request_id} => String
|
|
10438
|
+
# * {Types::GetFlowPermissionsOutput#status #status} => Integer
|
|
10439
|
+
#
|
|
10440
|
+
# @example Request syntax with placeholder values
|
|
10441
|
+
#
|
|
10442
|
+
# resp = client.get_flow_permissions({
|
|
10443
|
+
# aws_account_id: "AccountId", # required
|
|
10444
|
+
# flow_id: "FlowId", # required
|
|
10445
|
+
# })
|
|
10446
|
+
#
|
|
10447
|
+
# @example Response structure
|
|
10448
|
+
#
|
|
10449
|
+
# resp.arn #=> String
|
|
10450
|
+
# resp.flow_id #=> String
|
|
10451
|
+
# resp.permissions #=> Array
|
|
10452
|
+
# resp.permissions[0].actions #=> Array
|
|
10453
|
+
# resp.permissions[0].actions[0] #=> String
|
|
10454
|
+
# resp.permissions[0].principal #=> String
|
|
10455
|
+
# resp.request_id #=> String
|
|
10456
|
+
# resp.status #=> Integer
|
|
10457
|
+
#
|
|
10458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetFlowPermissions AWS API Documentation
|
|
10459
|
+
#
|
|
10460
|
+
# @overload get_flow_permissions(params = {})
|
|
10461
|
+
# @param [Hash] params ({})
|
|
10462
|
+
def get_flow_permissions(params = {}, options = {})
|
|
10463
|
+
req = build_request(:get_flow_permissions, params)
|
|
10464
|
+
req.send_request(options)
|
|
10465
|
+
end
|
|
10466
|
+
|
|
9921
10467
|
# Generates a session URL and authorization code that you can use to
|
|
9922
|
-
# embed the Amazon
|
|
9923
|
-
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
|
10468
|
+
# embed the Amazon Amazon Quick Sight console in your web server code.
|
|
10469
|
+
# Use `GetSessionEmbedUrl` where you want to provide an authoring portal
|
|
9924
10470
|
# that allows users to create data sources, datasets, analyses, and
|
|
9925
|
-
# dashboards. The users who access an embedded
|
|
9926
|
-
# belong to the author or admin security cohort. If you
|
|
9927
|
-
# permissions to some of these features, add a custom
|
|
9928
|
-
# profile to the user with the ` UpdateUser ` API operation.
|
|
9929
|
-
# RegisterUser ` API operation to add a new user with a custom
|
|
10471
|
+
# dashboards. The users who access an embedded Amazon Quick Sight
|
|
10472
|
+
# console need belong to the author or admin security cohort. If you
|
|
10473
|
+
# want to restrict permissions to some of these features, add a custom
|
|
10474
|
+
# permissions profile to the user with the ` UpdateUser ` API operation.
|
|
10475
|
+
# Use ` RegisterUser ` API operation to add a new user with a custom
|
|
9930
10476
|
# permission profile attached. For more information, see the following
|
|
9931
10477
|
# sections in the *Amazon QuickSight User Guide*:
|
|
9932
10478
|
#
|
|
@@ -9940,8 +10486,8 @@ module Aws::QuickSight
|
|
|
9940
10486
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
|
9941
10487
|
#
|
|
9942
10488
|
# @option params [required, String] :aws_account_id
|
|
9943
|
-
# The ID for the Amazon Web Services account associated with your
|
|
9944
|
-
#
|
|
10489
|
+
# The ID for the Amazon Web Services account associated with your Amazon
|
|
10490
|
+
# Quick Sight subscription.
|
|
9945
10491
|
#
|
|
9946
10492
|
# @option params [String] :entry_point
|
|
9947
10493
|
# The URL you use to access the embedded session. The entry point URL is
|
|
@@ -9956,10 +10502,10 @@ module Aws::QuickSight
|
|
|
9956
10502
|
# * `/start/favorites`
|
|
9957
10503
|
#
|
|
9958
10504
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
|
9959
|
-
# key from the
|
|
10505
|
+
# key from the Amazon Quick Sight console URL of the dashboard
|
|
9960
10506
|
#
|
|
9961
10507
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
|
9962
|
-
# from the
|
|
10508
|
+
# from the Amazon Quick Sight console URL of the analysis
|
|
9963
10509
|
#
|
|
9964
10510
|
# @option params [Integer] :session_lifetime_in_minutes
|
|
9965
10511
|
# How many minutes the session is valid. The session lifetime must be
|
|
@@ -10012,7 +10558,65 @@ module Aws::QuickSight
|
|
|
10012
10558
|
req.send_request(options)
|
|
10013
10559
|
end
|
|
10014
10560
|
|
|
10015
|
-
# Lists
|
|
10561
|
+
# Lists all action connectors in the specified Amazon Web Services
|
|
10562
|
+
# account. Returns summary information for each connector including its
|
|
10563
|
+
# name, type, creation time, and status.
|
|
10564
|
+
#
|
|
10565
|
+
# @option params [required, String] :aws_account_id
|
|
10566
|
+
# The Amazon Web Services account ID for which to list action
|
|
10567
|
+
# connectors.
|
|
10568
|
+
#
|
|
10569
|
+
# @option params [Integer] :max_results
|
|
10570
|
+
# The maximum number of action connectors to return in a single
|
|
10571
|
+
# response. Valid range is 1 to 100.
|
|
10572
|
+
#
|
|
10573
|
+
# @option params [String] :next_token
|
|
10574
|
+
# A pagination token to retrieve the next set of results. Use the token
|
|
10575
|
+
# returned from a previous call to continue listing action connectors.
|
|
10576
|
+
#
|
|
10577
|
+
# @return [Types::ListActionConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10578
|
+
#
|
|
10579
|
+
# * {Types::ListActionConnectorsResponse#action_connector_summaries #action_connector_summaries} => Array<Types::ActionConnectorSummary>
|
|
10580
|
+
# * {Types::ListActionConnectorsResponse#next_token #next_token} => String
|
|
10581
|
+
# * {Types::ListActionConnectorsResponse#request_id #request_id} => String
|
|
10582
|
+
# * {Types::ListActionConnectorsResponse#status #status} => Integer
|
|
10583
|
+
#
|
|
10584
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
10585
|
+
#
|
|
10586
|
+
# @example Request syntax with placeholder values
|
|
10587
|
+
#
|
|
10588
|
+
# resp = client.list_action_connectors({
|
|
10589
|
+
# aws_account_id: "AwsAccountId", # required
|
|
10590
|
+
# max_results: 1,
|
|
10591
|
+
# next_token: "String",
|
|
10592
|
+
# })
|
|
10593
|
+
#
|
|
10594
|
+
# @example Response structure
|
|
10595
|
+
#
|
|
10596
|
+
# resp.action_connector_summaries #=> Array
|
|
10597
|
+
# resp.action_connector_summaries[0].arn #=> String
|
|
10598
|
+
# resp.action_connector_summaries[0].action_connector_id #=> String
|
|
10599
|
+
# resp.action_connector_summaries[0].type #=> String, one of "GENERIC_HTTP", "SERVICENOW_NOW_PLATFORM", "SALESFORCE_CRM", "MICROSOFT_OUTLOOK", "PAGERDUTY_ADVANCE", "JIRA_CLOUD", "ATLASSIAN_CONFLUENCE", "AMAZON_S3", "AMAZON_BEDROCK_AGENT_RUNTIME", "AMAZON_BEDROCK_RUNTIME", "AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME", "AMAZON_TEXTRACT", "AMAZON_COMPREHEND", "AMAZON_COMPREHEND_MEDICAL", "MICROSOFT_ONEDRIVE", "MICROSOFT_SHAREPOINT", "MICROSOFT_TEAMS", "SAP_BUSINESSPARTNER", "SAP_PRODUCTMASTERDATA", "SAP_PHYSICALINVENTORY", "SAP_BILLOFMATERIALS", "SAP_MATERIALSTOCK", "ZENDESK_SUITE", "SMARTSHEET", "SLACK", "ASANA", "BAMBOO_HR"
|
|
10600
|
+
# resp.action_connector_summaries[0].name #=> String
|
|
10601
|
+
# resp.action_connector_summaries[0].created_time #=> Time
|
|
10602
|
+
# resp.action_connector_summaries[0].last_updated_time #=> Time
|
|
10603
|
+
# resp.action_connector_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
10604
|
+
# resp.action_connector_summaries[0].error.message #=> String
|
|
10605
|
+
# resp.action_connector_summaries[0].error.type #=> String, one of "INTERNAL_FAILURE"
|
|
10606
|
+
# resp.next_token #=> String
|
|
10607
|
+
# resp.request_id #=> String
|
|
10608
|
+
# resp.status #=> Integer
|
|
10609
|
+
#
|
|
10610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListActionConnectors AWS API Documentation
|
|
10611
|
+
#
|
|
10612
|
+
# @overload list_action_connectors(params = {})
|
|
10613
|
+
# @param [Hash] params ({})
|
|
10614
|
+
def list_action_connectors(params = {}, options = {})
|
|
10615
|
+
req = build_request(:list_action_connectors, params)
|
|
10616
|
+
req.send_request(options)
|
|
10617
|
+
end
|
|
10618
|
+
|
|
10619
|
+
# Lists Amazon Quick Sight analyses that exist in the specified Amazon
|
|
10016
10620
|
# Web Services account.
|
|
10017
10621
|
#
|
|
10018
10622
|
# @option params [required, String] :aws_account_id
|
|
@@ -10176,7 +10780,7 @@ module Aws::QuickSight
|
|
|
10176
10780
|
req.send_request(options)
|
|
10177
10781
|
end
|
|
10178
10782
|
|
|
10179
|
-
# Lists all brands in an
|
|
10783
|
+
# Lists all brands in an Quick Sight account.
|
|
10180
10784
|
#
|
|
10181
10785
|
# @option params [required, String] :aws_account_id
|
|
10182
10786
|
# The ID of the Amazon Web Services account that owns the brands that
|
|
@@ -10286,6 +10890,18 @@ module Aws::QuickSight
|
|
|
10286
10890
|
# resp.custom_permissions_list[0].capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
|
|
10287
10891
|
# resp.custom_permissions_list[0].capabilities.dashboard #=> String, one of "DENY"
|
|
10288
10892
|
# resp.custom_permissions_list[0].capabilities.analysis #=> String, one of "DENY"
|
|
10893
|
+
# resp.custom_permissions_list[0].capabilities.automate #=> String, one of "DENY"
|
|
10894
|
+
# resp.custom_permissions_list[0].capabilities.flow #=> String, one of "DENY"
|
|
10895
|
+
# resp.custom_permissions_list[0].capabilities.publish_without_approval #=> String, one of "DENY"
|
|
10896
|
+
# resp.custom_permissions_list[0].capabilities.use_bedrock_models #=> String, one of "DENY"
|
|
10897
|
+
# resp.custom_permissions_list[0].capabilities.perform_flow_ui_task #=> String, one of "DENY"
|
|
10898
|
+
# resp.custom_permissions_list[0].capabilities.use_agent_web_search #=> String, one of "DENY"
|
|
10899
|
+
# resp.custom_permissions_list[0].capabilities.knowledge_base #=> String, one of "DENY"
|
|
10900
|
+
# resp.custom_permissions_list[0].capabilities.action #=> String, one of "DENY"
|
|
10901
|
+
# resp.custom_permissions_list[0].capabilities.space #=> String, one of "DENY"
|
|
10902
|
+
# resp.custom_permissions_list[0].capabilities.chat_agent #=> String, one of "DENY"
|
|
10903
|
+
# resp.custom_permissions_list[0].capabilities.create_chat_agents #=> String, one of "DENY"
|
|
10904
|
+
# resp.custom_permissions_list[0].capabilities.research #=> String, one of "DENY"
|
|
10289
10905
|
# resp.next_token #=> String
|
|
10290
10906
|
# resp.request_id #=> String
|
|
10291
10907
|
#
|
|
@@ -10298,7 +10914,7 @@ module Aws::QuickSight
|
|
|
10298
10914
|
req.send_request(options)
|
|
10299
10915
|
end
|
|
10300
10916
|
|
|
10301
|
-
# Lists all the versions of the dashboards in the
|
|
10917
|
+
# Lists all the versions of the dashboards in the Amazon Quick Sight
|
|
10302
10918
|
# subscription.
|
|
10303
10919
|
#
|
|
10304
10920
|
# @option params [required, String] :aws_account_id
|
|
@@ -10507,7 +11123,7 @@ module Aws::QuickSight
|
|
|
10507
11123
|
# resp.data_sources[0].arn #=> String
|
|
10508
11124
|
# resp.data_sources[0].data_source_id #=> String
|
|
10509
11125
|
# resp.data_sources[0].name #=> String
|
|
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"
|
|
11126
|
+
# 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", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
|
|
10511
11127
|
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
10512
11128
|
# resp.data_sources[0].created_time #=> Time
|
|
10513
11129
|
# resp.data_sources[0].last_updated_time #=> Time
|
|
@@ -10554,6 +11170,9 @@ module Aws::QuickSight
|
|
|
10554
11170
|
# resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
|
10555
11171
|
# resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
|
10556
11172
|
# resp.data_sources[0].data_source_parameters.s3_parameters.role_arn #=> String
|
|
11173
|
+
# resp.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.role_arn #=> String
|
|
11174
|
+
# resp.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.bucket_url #=> String
|
|
11175
|
+
# resp.data_sources[0].data_source_parameters.s3_knowledge_base_parameters.metadata_files_location #=> String
|
|
10557
11176
|
# resp.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
|
|
10558
11177
|
# resp.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
|
|
10559
11178
|
# resp.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
|
|
@@ -10600,6 +11219,16 @@ module Aws::QuickSight
|
|
|
10600
11219
|
# resp.data_sources[0].data_source_parameters.impala_parameters.database #=> String
|
|
10601
11220
|
# resp.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
|
10602
11221
|
# resp.data_sources[0].data_source_parameters.custom_connection_parameters.connection_type #=> String
|
|
11222
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
|
|
11223
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.username_field_xpath #=> String
|
|
11224
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.password_field_xpath #=> String
|
|
11225
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.username_button_xpath #=> String
|
|
11226
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.password_button_xpath #=> String
|
|
11227
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.login_page_url #=> String
|
|
11228
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_host_name #=> String
|
|
11229
|
+
# resp.data_sources[0].data_source_parameters.web_crawler_parameters.web_proxy_port_number #=> Integer
|
|
11230
|
+
# resp.data_sources[0].data_source_parameters.confluence_parameters.confluence_url #=> String
|
|
11231
|
+
# resp.data_sources[0].data_source_parameters.q_business_parameters.application_arn #=> String
|
|
10603
11232
|
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
|
10604
11233
|
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
|
10605
11234
|
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
|
@@ -10644,6 +11273,9 @@ module Aws::QuickSight
|
|
|
10644
11273
|
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
|
10645
11274
|
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
|
10646
11275
|
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.role_arn #=> String
|
|
11276
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_knowledge_base_parameters.role_arn #=> String
|
|
11277
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_knowledge_base_parameters.bucket_url #=> String
|
|
11278
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_knowledge_base_parameters.metadata_files_location #=> String
|
|
10647
11279
|
# resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
|
10648
11280
|
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
|
10649
11281
|
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
|
@@ -10690,6 +11322,16 @@ module Aws::QuickSight
|
|
|
10690
11322
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.database #=> String
|
|
10691
11323
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
|
|
10692
11324
|
# resp.data_sources[0].alternate_data_source_parameters[0].custom_connection_parameters.connection_type #=> String
|
|
11325
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.web_crawler_auth_type #=> String, one of "NO_AUTH", "BASIC_AUTH", "FORM", "SAML"
|
|
11326
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.username_field_xpath #=> String
|
|
11327
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.password_field_xpath #=> String
|
|
11328
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.username_button_xpath #=> String
|
|
11329
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.password_button_xpath #=> String
|
|
11330
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.login_page_url #=> String
|
|
11331
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_host_name #=> String
|
|
11332
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].web_crawler_parameters.web_proxy_port_number #=> Integer
|
|
11333
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].confluence_parameters.confluence_url #=> String
|
|
11334
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].q_business_parameters.application_arn #=> String
|
|
10693
11335
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
|
10694
11336
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
|
10695
11337
|
# 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"
|
|
@@ -10708,6 +11350,65 @@ module Aws::QuickSight
|
|
|
10708
11350
|
req.send_request(options)
|
|
10709
11351
|
end
|
|
10710
11352
|
|
|
11353
|
+
# Lists flows in an Amazon Web Services account.
|
|
11354
|
+
#
|
|
11355
|
+
# @option params [required, String] :aws_account_id
|
|
11356
|
+
# The ID of the Amazon Web Services account that contains the flow list
|
|
11357
|
+
# that you are getting.
|
|
11358
|
+
#
|
|
11359
|
+
# @option params [String] :next_token
|
|
11360
|
+
# The token to request the next set of results, or null if you want to
|
|
11361
|
+
# retrieve the first set.
|
|
11362
|
+
#
|
|
11363
|
+
# @option params [Integer] :max_results
|
|
11364
|
+
# The maximum number of results to be returned per request.
|
|
11365
|
+
#
|
|
11366
|
+
# @return [Types::ListFlowsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
11367
|
+
#
|
|
11368
|
+
# * {Types::ListFlowsOutput#flow_summary_list #flow_summary_list} => Array<Types::FlowSummary>
|
|
11369
|
+
# * {Types::ListFlowsOutput#next_token #next_token} => String
|
|
11370
|
+
# * {Types::ListFlowsOutput#request_id #request_id} => String
|
|
11371
|
+
# * {Types::ListFlowsOutput#status #status} => Integer
|
|
11372
|
+
#
|
|
11373
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
11374
|
+
#
|
|
11375
|
+
# @example Request syntax with placeholder values
|
|
11376
|
+
#
|
|
11377
|
+
# resp = client.list_flows({
|
|
11378
|
+
# aws_account_id: "AccountId", # required
|
|
11379
|
+
# next_token: "String",
|
|
11380
|
+
# max_results: 1,
|
|
11381
|
+
# })
|
|
11382
|
+
#
|
|
11383
|
+
# @example Response structure
|
|
11384
|
+
#
|
|
11385
|
+
# resp.flow_summary_list #=> Array
|
|
11386
|
+
# resp.flow_summary_list[0].arn #=> String
|
|
11387
|
+
# resp.flow_summary_list[0].flow_id #=> String
|
|
11388
|
+
# resp.flow_summary_list[0].name #=> String
|
|
11389
|
+
# resp.flow_summary_list[0].description #=> String
|
|
11390
|
+
# resp.flow_summary_list[0].created_time #=> Time
|
|
11391
|
+
# resp.flow_summary_list[0].created_by #=> String
|
|
11392
|
+
# resp.flow_summary_list[0].last_updated_time #=> Time
|
|
11393
|
+
# resp.flow_summary_list[0].last_updated_by #=> String
|
|
11394
|
+
# resp.flow_summary_list[0].publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
|
|
11395
|
+
# resp.flow_summary_list[0].run_count #=> Integer
|
|
11396
|
+
# resp.flow_summary_list[0].user_count #=> Integer
|
|
11397
|
+
# resp.flow_summary_list[0].last_published_by #=> String
|
|
11398
|
+
# resp.flow_summary_list[0].last_published_at #=> Time
|
|
11399
|
+
# resp.next_token #=> String
|
|
11400
|
+
# resp.request_id #=> String
|
|
11401
|
+
# resp.status #=> Integer
|
|
11402
|
+
#
|
|
11403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFlows AWS API Documentation
|
|
11404
|
+
#
|
|
11405
|
+
# @overload list_flows(params = {})
|
|
11406
|
+
# @param [Hash] params ({})
|
|
11407
|
+
def list_flows(params = {}, options = {})
|
|
11408
|
+
req = build_request(:list_flows, params)
|
|
11409
|
+
req.send_request(options)
|
|
11410
|
+
end
|
|
11411
|
+
|
|
10711
11412
|
# List all assets (`DASHBOARD`, `ANALYSIS`, and `DATASET`) in a folder.
|
|
10712
11413
|
#
|
|
10713
11414
|
# @option params [required, String] :aws_account_id
|
|
@@ -10876,7 +11577,7 @@ module Aws::QuickSight
|
|
|
10876
11577
|
# @option params [required, String] :aws_account_id
|
|
10877
11578
|
# The ID for the Amazon Web Services account that the group is in.
|
|
10878
11579
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
10879
|
-
# contains your Amazon
|
|
11580
|
+
# contains your Amazon Quick Sight account.
|
|
10880
11581
|
#
|
|
10881
11582
|
# @option params [required, String] :namespace
|
|
10882
11583
|
# The namespace of the group that you want a list of users from.
|
|
@@ -10918,12 +11619,12 @@ module Aws::QuickSight
|
|
|
10918
11619
|
req.send_request(options)
|
|
10919
11620
|
end
|
|
10920
11621
|
|
|
10921
|
-
# Lists all user groups in Amazon
|
|
11622
|
+
# Lists all user groups in Amazon Quick Sight.
|
|
10922
11623
|
#
|
|
10923
11624
|
# @option params [required, String] :aws_account_id
|
|
10924
11625
|
# The ID for the Amazon Web Services account that the group is in.
|
|
10925
11626
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
10926
|
-
# contains your Amazon
|
|
11627
|
+
# contains your Amazon Quick Sight account.
|
|
10927
11628
|
#
|
|
10928
11629
|
# @option params [String] :next_token
|
|
10929
11630
|
# A pagination token that can be used in a subsequent request.
|
|
@@ -10972,7 +11673,7 @@ module Aws::QuickSight
|
|
|
10972
11673
|
req.send_request(options)
|
|
10973
11674
|
end
|
|
10974
11675
|
|
|
10975
|
-
# Lists the IAM policy assignments in the current Amazon
|
|
11676
|
+
# Lists the IAM policy assignments in the current Amazon Quick Sight
|
|
10976
11677
|
# account.
|
|
10977
11678
|
#
|
|
10978
11679
|
# @option params [required, String] :aws_account_id
|
|
@@ -11087,10 +11788,10 @@ module Aws::QuickSight
|
|
|
11087
11788
|
req.send_request(options)
|
|
11088
11789
|
end
|
|
11089
11790
|
|
|
11090
|
-
# Lists all services and authorized targets that the
|
|
11791
|
+
# Lists all services and authorized targets that the Quick Sight IAM
|
|
11091
11792
|
# Identity Center application can access.
|
|
11092
11793
|
#
|
|
11093
|
-
# This operation is only supported for
|
|
11794
|
+
# This operation is only supported for Quick Sight accounts that use IAM
|
|
11094
11795
|
# Identity Center.
|
|
11095
11796
|
#
|
|
11096
11797
|
# @option params [required, String] :aws_account_id
|
|
@@ -11207,8 +11908,8 @@ module Aws::QuickSight
|
|
|
11207
11908
|
# This operation doesn't list deleted namespaces.
|
|
11208
11909
|
#
|
|
11209
11910
|
# @option params [required, String] :aws_account_id
|
|
11210
|
-
# The ID for the Amazon Web Services account that contains the
|
|
11211
|
-
#
|
|
11911
|
+
# The ID for the Amazon Web Services account that contains the Quick
|
|
11912
|
+
# Sight namespaces that you want to list.
|
|
11212
11913
|
#
|
|
11213
11914
|
# @option params [String] :next_token
|
|
11214
11915
|
# A unique pagination token that can be used in a subsequent request.
|
|
@@ -11325,8 +12026,8 @@ module Aws::QuickSight
|
|
|
11325
12026
|
# @option params [required, String] :aws_account_id
|
|
11326
12027
|
# The ID for the Amazon Web Services account that you want to create a
|
|
11327
12028
|
# group in. The Amazon Web Services account ID that you provide must be
|
|
11328
|
-
# the same Amazon Web Services account that contains your Amazon
|
|
11329
|
-
#
|
|
12029
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
|
12030
|
+
# Sight account.
|
|
11330
12031
|
#
|
|
11331
12032
|
# @option params [required, String] :namespace
|
|
11332
12033
|
# The namespace that includes the role.
|
|
@@ -11455,8 +12156,8 @@ module Aws::QuickSight
|
|
|
11455
12156
|
req.send_request(options)
|
|
11456
12157
|
end
|
|
11457
12158
|
|
|
11458
|
-
# Lists all the versions of the templates in the current Amazon
|
|
11459
|
-
#
|
|
12159
|
+
# Lists all the versions of the templates in the current Amazon Quick
|
|
12160
|
+
# Sight account.
|
|
11460
12161
|
#
|
|
11461
12162
|
# @option params [required, String] :aws_account_id
|
|
11462
12163
|
# The ID of the Amazon Web Services account that contains the templates
|
|
@@ -11511,7 +12212,7 @@ module Aws::QuickSight
|
|
|
11511
12212
|
req.send_request(options)
|
|
11512
12213
|
end
|
|
11513
12214
|
|
|
11514
|
-
# Lists all the templates in the current Amazon
|
|
12215
|
+
# Lists all the templates in the current Amazon Quick Sight account.
|
|
11515
12216
|
#
|
|
11516
12217
|
# @option params [required, String] :aws_account_id
|
|
11517
12218
|
# The ID of the Amazon Web Services account that contains the templates
|
|
@@ -11690,10 +12391,10 @@ module Aws::QuickSight
|
|
|
11690
12391
|
# * `ALL (default)`- Display all existing themes.
|
|
11691
12392
|
#
|
|
11692
12393
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
|
11693
|
-
#
|
|
12394
|
+
# Quick Sight.
|
|
11694
12395
|
#
|
|
11695
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
|
11696
|
-
#
|
|
12396
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by Quick
|
|
12397
|
+
# Sight.
|
|
11697
12398
|
#
|
|
11698
12399
|
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
11699
12400
|
#
|
|
@@ -12309,17 +13010,17 @@ module Aws::QuickSight
|
|
|
12309
13010
|
req.send_request(options)
|
|
12310
13011
|
end
|
|
12311
13012
|
|
|
12312
|
-
# Lists the Amazon
|
|
12313
|
-
# member of.
|
|
13013
|
+
# Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is
|
|
13014
|
+
# a member of.
|
|
12314
13015
|
#
|
|
12315
13016
|
# @option params [required, String] :user_name
|
|
12316
|
-
# The Amazon
|
|
13017
|
+
# The Amazon Quick Sight user name that you want to list group
|
|
12317
13018
|
# memberships for.
|
|
12318
13019
|
#
|
|
12319
13020
|
# @option params [required, String] :aws_account_id
|
|
12320
13021
|
# The Amazon Web Services account ID that the user is in. Currently, you
|
|
12321
13022
|
# use the ID for the Amazon Web Services account that contains your
|
|
12322
|
-
# Amazon
|
|
13023
|
+
# Amazon Quick Sight account.
|
|
12323
13024
|
#
|
|
12324
13025
|
# @option params [required, String] :namespace
|
|
12325
13026
|
# The namespace. Currently, you should set this to `default`.
|
|
@@ -12369,13 +13070,13 @@ module Aws::QuickSight
|
|
|
12369
13070
|
req.send_request(options)
|
|
12370
13071
|
end
|
|
12371
13072
|
|
|
12372
|
-
# Returns a list of all of the Amazon
|
|
12373
|
-
# account.
|
|
13073
|
+
# Returns a list of all of the Amazon Quick Sight users belonging to
|
|
13074
|
+
# this account.
|
|
12374
13075
|
#
|
|
12375
13076
|
# @option params [required, String] :aws_account_id
|
|
12376
13077
|
# The ID for the Amazon Web Services account that the user is in.
|
|
12377
13078
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
12378
|
-
# contains your Amazon
|
|
13079
|
+
# contains your Amazon Quick Sight account.
|
|
12379
13080
|
#
|
|
12380
13081
|
# @option params [String] :next_token
|
|
12381
13082
|
# A pagination token that can be used in a subsequent request.
|
|
@@ -12656,30 +13357,30 @@ module Aws::QuickSight
|
|
|
12656
13357
|
req.send_request(options)
|
|
12657
13358
|
end
|
|
12658
13359
|
|
|
12659
|
-
# Creates an Amazon
|
|
13360
|
+
# Creates an Amazon Quick Sight user whose identity is associated with
|
|
12660
13361
|
# the Identity and Access Management (IAM) identity or role specified in
|
|
12661
|
-
# the request. When you register a new user from the
|
|
12662
|
-
#
|
|
12663
|
-
# registration URL to create their account.
|
|
12664
|
-
# registration email to users who are registered from the
|
|
13362
|
+
# the request. When you register a new user from the Quick Sight API,
|
|
13363
|
+
# Quick Sight generates a registration URL. The user accesses this
|
|
13364
|
+
# registration URL to create their account. Quick Sight doesn't send a
|
|
13365
|
+
# registration email to users who are registered from the Quick Sight
|
|
12665
13366
|
# API. If you want new users to receive a registration email, then add
|
|
12666
|
-
# those users in the
|
|
12667
|
-
# registering a new user in the
|
|
12668
|
-
# to access
|
|
13367
|
+
# those users in the Quick Sight console. For more information on
|
|
13368
|
+
# registering a new user in the Quick Sight console, see [ Inviting
|
|
13369
|
+
# users to access Quick Sight][1].
|
|
12669
13370
|
#
|
|
12670
13371
|
#
|
|
12671
13372
|
#
|
|
12672
13373
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users
|
|
12673
13374
|
#
|
|
12674
13375
|
# @option params [required, String] :identity_type
|
|
12675
|
-
# The identity type that your
|
|
13376
|
+
# The identity type that your Quick Sight account uses to manage the
|
|
12676
13377
|
# identity of users.
|
|
12677
13378
|
#
|
|
12678
13379
|
# @option params [required, String] :email
|
|
12679
13380
|
# The email address of the user that you want to register.
|
|
12680
13381
|
#
|
|
12681
13382
|
# @option params [required, String] :user_role
|
|
12682
|
-
# The Amazon
|
|
13383
|
+
# The Amazon Quick Sight role for the user. The user role can be one of
|
|
12683
13384
|
# the following:
|
|
12684
13385
|
#
|
|
12685
13386
|
# * `READER`: A user who has read-only access to dashboards.
|
|
@@ -12687,11 +13388,11 @@ module Aws::QuickSight
|
|
|
12687
13388
|
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
|
12688
13389
|
# and dashboards.
|
|
12689
13390
|
#
|
|
12690
|
-
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
|
12691
|
-
#
|
|
13391
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon Quick
|
|
13392
|
+
# Sight settings.
|
|
12692
13393
|
#
|
|
12693
13394
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
|
12694
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
|
13395
|
+
# Reader role. Reader Pros have access to Amazon Q in Quick Sight, can
|
|
12695
13396
|
# build stories with Amazon Q, and can generate executive summaries
|
|
12696
13397
|
# from dashboards.
|
|
12697
13398
|
#
|
|
@@ -12701,7 +13402,7 @@ module Aws::QuickSight
|
|
|
12701
13402
|
# Q&A, and generate executive summaries from dashboards.
|
|
12702
13403
|
#
|
|
12703
13404
|
# * `ADMIN_PRO`: Admin Pros are Author Pros who can also manage Amazon
|
|
12704
|
-
#
|
|
13405
|
+
# Quick Sight administrative settings. Admin Pro users are billed at
|
|
12705
13406
|
# Author Pro pricing.
|
|
12706
13407
|
#
|
|
12707
13408
|
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
|
@@ -12710,13 +13411,13 @@ module Aws::QuickSight
|
|
|
12710
13411
|
#
|
|
12711
13412
|
# @option params [String] :iam_arn
|
|
12712
13413
|
# The ARN of the IAM user or role that you are registering with Amazon
|
|
12713
|
-
#
|
|
13414
|
+
# Quick Sight.
|
|
12714
13415
|
#
|
|
12715
13416
|
# @option params [String] :session_name
|
|
12716
13417
|
# You need to use this parameter only when you register one or more
|
|
12717
13418
|
# users using an assumed IAM role. You don't need to provide the
|
|
12718
13419
|
# session name for other scenarios, for example when you are registering
|
|
12719
|
-
# an IAM user or an Amazon
|
|
13420
|
+
# an IAM user or an Amazon Quick Sight user. You can register multiple
|
|
12720
13421
|
# users using the same IAM role if each user has a different session
|
|
12721
13422
|
# name. For more information on assuming IAM roles, see [ `assume-role`
|
|
12722
13423
|
# ][1] in the *CLI Reference.*
|
|
@@ -12728,13 +13429,13 @@ module Aws::QuickSight
|
|
|
12728
13429
|
# @option params [required, String] :aws_account_id
|
|
12729
13430
|
# The ID for the Amazon Web Services account that the user is in.
|
|
12730
13431
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
12731
|
-
# contains your Amazon
|
|
13432
|
+
# contains your Amazon Quick Sight account.
|
|
12732
13433
|
#
|
|
12733
13434
|
# @option params [required, String] :namespace
|
|
12734
13435
|
# The namespace. Currently, you should set this to `default`.
|
|
12735
13436
|
#
|
|
12736
13437
|
# @option params [String] :user_name
|
|
12737
|
-
# The Amazon
|
|
13438
|
+
# The Amazon Quick Sight user name that you want to create for the user
|
|
12738
13439
|
# you are registering.
|
|
12739
13440
|
#
|
|
12740
13441
|
# @option params [String] :custom_permissions_name
|
|
@@ -12756,21 +13457,22 @@ module Aws::QuickSight
|
|
|
12756
13457
|
#
|
|
12757
13458
|
# A set of custom permissions includes any combination of these
|
|
12758
13459
|
# restrictions. Currently, you need to create the profile names for
|
|
12759
|
-
# custom permission sets by using the
|
|
13460
|
+
# custom permission sets by using the Quick Sight console. Then, you use
|
|
12760
13461
|
# the `RegisterUser` API operation to assign the named set of
|
|
12761
|
-
# permissions to a
|
|
13462
|
+
# permissions to a Quick Sight user.
|
|
12762
13463
|
#
|
|
12763
|
-
#
|
|
13464
|
+
# Quick Sight custom permissions are applied through IAM policies.
|
|
12764
13465
|
# Therefore, they override the permissions typically granted by
|
|
12765
|
-
# assigning
|
|
12766
|
-
#
|
|
13466
|
+
# assigning Quick Sight users to one of the default security cohorts in
|
|
13467
|
+
# Quick Sight (admin, author, reader, admin pro, author pro, reader
|
|
13468
|
+
# pro).
|
|
12767
13469
|
#
|
|
12768
|
-
# This feature is available only to
|
|
13470
|
+
# This feature is available only to Quick Sight Enterprise edition
|
|
12769
13471
|
# subscriptions.
|
|
12770
13472
|
#
|
|
12771
13473
|
# @option params [String] :external_login_federation_provider_type
|
|
12772
13474
|
# The type of supported external login provider that provides identity
|
|
12773
|
-
# to let a user federate into Amazon
|
|
13475
|
+
# to let a user federate into Amazon Quick Sight with an associated
|
|
12774
13476
|
# Identity and Access Management(IAM) role. The type of supported
|
|
12775
13477
|
# external login provider can be one of the following.
|
|
12776
13478
|
#
|
|
@@ -12785,7 +13487,7 @@ module Aws::QuickSight
|
|
|
12785
13487
|
#
|
|
12786
13488
|
# @option params [String] :custom_federation_provider_url
|
|
12787
13489
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
|
12788
|
-
# identity to let a user federate into
|
|
13490
|
+
# identity to let a user federate into Quick Sight with an associated
|
|
12789
13491
|
# Identity and Access Management(IAM) role. This parameter should only
|
|
12790
13492
|
# be used when `ExternalLoginFederationProviderType` parameter is set to
|
|
12791
13493
|
# `CUSTOM_OIDC`.
|
|
@@ -12902,6 +13604,75 @@ module Aws::QuickSight
|
|
|
12902
13604
|
req.send_request(options)
|
|
12903
13605
|
end
|
|
12904
13606
|
|
|
13607
|
+
# Searches for action connectors in the specified Amazon Web Services
|
|
13608
|
+
# account using filters. You can search by connector name, type, or user
|
|
13609
|
+
# permissions.
|
|
13610
|
+
#
|
|
13611
|
+
# @option params [required, String] :aws_account_id
|
|
13612
|
+
# The Amazon Web Services account ID in which to search for action
|
|
13613
|
+
# connectors.
|
|
13614
|
+
#
|
|
13615
|
+
# @option params [Integer] :max_results
|
|
13616
|
+
# The maximum number of action connectors to return in a single
|
|
13617
|
+
# response. Valid range is 1 to 100.
|
|
13618
|
+
#
|
|
13619
|
+
# @option params [String] :next_token
|
|
13620
|
+
# A pagination token to retrieve the next set of results. Use the token
|
|
13621
|
+
# returned from a previous call to continue searching.
|
|
13622
|
+
#
|
|
13623
|
+
# @option params [required, Array<Types::ActionConnectorSearchFilter>] :filters
|
|
13624
|
+
# The search filters to apply. You can filter by connector name, type,
|
|
13625
|
+
# or user permissions. Maximum of one filter is supported.
|
|
13626
|
+
#
|
|
13627
|
+
# @return [Types::SearchActionConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13628
|
+
#
|
|
13629
|
+
# * {Types::SearchActionConnectorsResponse#next_token #next_token} => String
|
|
13630
|
+
# * {Types::SearchActionConnectorsResponse#request_id #request_id} => String
|
|
13631
|
+
# * {Types::SearchActionConnectorsResponse#status #status} => Integer
|
|
13632
|
+
# * {Types::SearchActionConnectorsResponse#action_connector_summaries #action_connector_summaries} => Array<Types::ActionConnectorSummary>
|
|
13633
|
+
#
|
|
13634
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
13635
|
+
#
|
|
13636
|
+
# @example Request syntax with placeholder values
|
|
13637
|
+
#
|
|
13638
|
+
# resp = client.search_action_connectors({
|
|
13639
|
+
# aws_account_id: "AwsAccountId", # required
|
|
13640
|
+
# max_results: 1,
|
|
13641
|
+
# next_token: "String",
|
|
13642
|
+
# filters: [ # required
|
|
13643
|
+
# {
|
|
13644
|
+
# name: "ACTION_CONNECTOR_NAME", # required, accepts ACTION_CONNECTOR_NAME, ACTION_CONNECTOR_TYPE, QUICKSIGHT_OWNER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
|
13645
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
|
13646
|
+
# value: "String", # required
|
|
13647
|
+
# },
|
|
13648
|
+
# ],
|
|
13649
|
+
# })
|
|
13650
|
+
#
|
|
13651
|
+
# @example Response structure
|
|
13652
|
+
#
|
|
13653
|
+
# resp.next_token #=> String
|
|
13654
|
+
# resp.request_id #=> String
|
|
13655
|
+
# resp.status #=> Integer
|
|
13656
|
+
# resp.action_connector_summaries #=> Array
|
|
13657
|
+
# resp.action_connector_summaries[0].arn #=> String
|
|
13658
|
+
# resp.action_connector_summaries[0].action_connector_id #=> String
|
|
13659
|
+
# resp.action_connector_summaries[0].type #=> String, one of "GENERIC_HTTP", "SERVICENOW_NOW_PLATFORM", "SALESFORCE_CRM", "MICROSOFT_OUTLOOK", "PAGERDUTY_ADVANCE", "JIRA_CLOUD", "ATLASSIAN_CONFLUENCE", "AMAZON_S3", "AMAZON_BEDROCK_AGENT_RUNTIME", "AMAZON_BEDROCK_RUNTIME", "AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME", "AMAZON_TEXTRACT", "AMAZON_COMPREHEND", "AMAZON_COMPREHEND_MEDICAL", "MICROSOFT_ONEDRIVE", "MICROSOFT_SHAREPOINT", "MICROSOFT_TEAMS", "SAP_BUSINESSPARTNER", "SAP_PRODUCTMASTERDATA", "SAP_PHYSICALINVENTORY", "SAP_BILLOFMATERIALS", "SAP_MATERIALSTOCK", "ZENDESK_SUITE", "SMARTSHEET", "SLACK", "ASANA", "BAMBOO_HR"
|
|
13660
|
+
# resp.action_connector_summaries[0].name #=> String
|
|
13661
|
+
# resp.action_connector_summaries[0].created_time #=> Time
|
|
13662
|
+
# resp.action_connector_summaries[0].last_updated_time #=> Time
|
|
13663
|
+
# resp.action_connector_summaries[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
13664
|
+
# resp.action_connector_summaries[0].error.message #=> String
|
|
13665
|
+
# resp.action_connector_summaries[0].error.type #=> String, one of "INTERNAL_FAILURE"
|
|
13666
|
+
#
|
|
13667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchActionConnectors AWS API Documentation
|
|
13668
|
+
#
|
|
13669
|
+
# @overload search_action_connectors(params = {})
|
|
13670
|
+
# @param [Hash] params ({})
|
|
13671
|
+
def search_action_connectors(params = {}, options = {})
|
|
13672
|
+
req = build_request(:search_action_connectors, params)
|
|
13673
|
+
req.send_request(options)
|
|
13674
|
+
end
|
|
13675
|
+
|
|
12905
13676
|
# Searches for analyses that belong to the user specified in the filter.
|
|
12906
13677
|
#
|
|
12907
13678
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
|
@@ -13154,7 +13925,7 @@ module Aws::QuickSight
|
|
|
13154
13925
|
# resp.data_source_summaries[0].arn #=> String
|
|
13155
13926
|
# resp.data_source_summaries[0].data_source_id #=> String
|
|
13156
13927
|
# resp.data_source_summaries[0].name #=> String
|
|
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"
|
|
13928
|
+
# 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", "GOOGLE_DRIVE", "CONFLUENCE", "SHAREPOINT", "ONE_DRIVE", "WEB_CRAWLER", "S3_KNOWLEDGE_BASE", "QBUSINESS"
|
|
13158
13929
|
# resp.data_source_summaries[0].created_time #=> Time
|
|
13159
13930
|
# resp.data_source_summaries[0].last_updated_time #=> Time
|
|
13160
13931
|
# resp.next_token #=> String
|
|
@@ -13170,6 +13941,76 @@ module Aws::QuickSight
|
|
|
13170
13941
|
req.send_request(options)
|
|
13171
13942
|
end
|
|
13172
13943
|
|
|
13944
|
+
# Search for the flows in an Amazon Web Services account.
|
|
13945
|
+
#
|
|
13946
|
+
# @option params [required, String] :aws_account_id
|
|
13947
|
+
# The ID of the Amazon Web Services account where you are searching for
|
|
13948
|
+
# flows from.
|
|
13949
|
+
#
|
|
13950
|
+
# @option params [required, Array<Types::SearchFlowsFilter>] :filters
|
|
13951
|
+
# The filters applied to the search when searching for flows in the
|
|
13952
|
+
# Amazon Web Services account.
|
|
13953
|
+
#
|
|
13954
|
+
# @option params [String] :next_token
|
|
13955
|
+
# The token to request the next set of results, or null if you want to
|
|
13956
|
+
# retrieve the first set.
|
|
13957
|
+
#
|
|
13958
|
+
# @option params [Integer] :max_results
|
|
13959
|
+
# The maximum number of results to be returned per request.
|
|
13960
|
+
#
|
|
13961
|
+
# @return [Types::SearchFlowsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13962
|
+
#
|
|
13963
|
+
# * {Types::SearchFlowsOutput#flow_summary_list #flow_summary_list} => Array<Types::FlowSummary>
|
|
13964
|
+
# * {Types::SearchFlowsOutput#next_token #next_token} => String
|
|
13965
|
+
# * {Types::SearchFlowsOutput#request_id #request_id} => String
|
|
13966
|
+
# * {Types::SearchFlowsOutput#status #status} => Integer
|
|
13967
|
+
#
|
|
13968
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
13969
|
+
#
|
|
13970
|
+
# @example Request syntax with placeholder values
|
|
13971
|
+
#
|
|
13972
|
+
# resp = client.search_flows({
|
|
13973
|
+
# aws_account_id: "AccountId", # required
|
|
13974
|
+
# filters: [ # required
|
|
13975
|
+
# {
|
|
13976
|
+
# name: "assetName", # required, accepts assetName, assetDescription, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER
|
|
13977
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
|
13978
|
+
# value: "String", # required
|
|
13979
|
+
# },
|
|
13980
|
+
# ],
|
|
13981
|
+
# next_token: "String",
|
|
13982
|
+
# max_results: 1,
|
|
13983
|
+
# })
|
|
13984
|
+
#
|
|
13985
|
+
# @example Response structure
|
|
13986
|
+
#
|
|
13987
|
+
# resp.flow_summary_list #=> Array
|
|
13988
|
+
# resp.flow_summary_list[0].arn #=> String
|
|
13989
|
+
# resp.flow_summary_list[0].flow_id #=> String
|
|
13990
|
+
# resp.flow_summary_list[0].name #=> String
|
|
13991
|
+
# resp.flow_summary_list[0].description #=> String
|
|
13992
|
+
# resp.flow_summary_list[0].created_time #=> Time
|
|
13993
|
+
# resp.flow_summary_list[0].created_by #=> String
|
|
13994
|
+
# resp.flow_summary_list[0].last_updated_time #=> Time
|
|
13995
|
+
# resp.flow_summary_list[0].last_updated_by #=> String
|
|
13996
|
+
# resp.flow_summary_list[0].publish_state #=> String, one of "PUBLISHED", "DRAFT", "PENDING_APPROVAL"
|
|
13997
|
+
# resp.flow_summary_list[0].run_count #=> Integer
|
|
13998
|
+
# resp.flow_summary_list[0].user_count #=> Integer
|
|
13999
|
+
# resp.flow_summary_list[0].last_published_by #=> String
|
|
14000
|
+
# resp.flow_summary_list[0].last_published_at #=> Time
|
|
14001
|
+
# resp.next_token #=> String
|
|
14002
|
+
# resp.request_id #=> String
|
|
14003
|
+
# resp.status #=> Integer
|
|
14004
|
+
#
|
|
14005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFlows AWS API Documentation
|
|
14006
|
+
#
|
|
14007
|
+
# @overload search_flows(params = {})
|
|
14008
|
+
# @param [Hash] params ({})
|
|
14009
|
+
def search_flows(params = {}, options = {})
|
|
14010
|
+
req = build_request(:search_flows, params)
|
|
14011
|
+
req.send_request(options)
|
|
14012
|
+
end
|
|
14013
|
+
|
|
13173
14014
|
# Searches the subfolders in a folder.
|
|
13174
14015
|
#
|
|
13175
14016
|
# @option params [required, String] :aws_account_id
|
|
@@ -13235,13 +14076,13 @@ module Aws::QuickSight
|
|
|
13235
14076
|
req.send_request(options)
|
|
13236
14077
|
end
|
|
13237
14078
|
|
|
13238
|
-
# Use the `SearchGroups` operation to search groups in a specified
|
|
13239
|
-
#
|
|
14079
|
+
# Use the `SearchGroups` operation to search groups in a specified Quick
|
|
14080
|
+
# Sight namespace using the supplied filters.
|
|
13240
14081
|
#
|
|
13241
14082
|
# @option params [required, String] :aws_account_id
|
|
13242
14083
|
# The ID for the Amazon Web Services account that the group is in.
|
|
13243
14084
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
13244
|
-
# contains your Amazon
|
|
14085
|
+
# contains your Amazon Quick Sight account.
|
|
13245
14086
|
#
|
|
13246
14087
|
# @option params [String] :next_token
|
|
13247
14088
|
# A pagination token that can be used in a subsequent request.
|
|
@@ -13363,14 +14204,14 @@ module Aws::QuickSight
|
|
|
13363
14204
|
|
|
13364
14205
|
# Starts an Asset Bundle export job.
|
|
13365
14206
|
#
|
|
13366
|
-
# An Asset Bundle export job exports specified
|
|
13367
|
-
# can also choose to export any asset dependencies in the
|
|
13368
|
-
# Export jobs run asynchronously and can be polled with a
|
|
14207
|
+
# An Asset Bundle export job exports specified Amazon Quick Sight
|
|
14208
|
+
# assets. You can also choose to export any asset dependencies in the
|
|
14209
|
+
# same job. Export jobs run asynchronously and can be polled with a
|
|
13369
14210
|
# `DescribeAssetBundleExportJob` API call. When a job is successfully
|
|
13370
14211
|
# completed, a download URL that contains the exported assets is
|
|
13371
14212
|
# returned. The URL is valid for 5 minutes and can be refreshed with a
|
|
13372
|
-
# `DescribeAssetBundleExportJob` API call. Each
|
|
13373
|
-
# run up to 5 export jobs concurrently.
|
|
14213
|
+
# `DescribeAssetBundleExportJob` API call. Each Amazon Quick Sight
|
|
14214
|
+
# account can run up to 5 export jobs concurrently.
|
|
13374
14215
|
#
|
|
13375
14216
|
# The API caller must have the necessary permissions in their IAM role
|
|
13376
14217
|
# to access each resource before the resources can be exported.
|
|
@@ -13545,12 +14386,13 @@ module Aws::QuickSight
|
|
|
13545
14386
|
|
|
13546
14387
|
# Starts an Asset Bundle import job.
|
|
13547
14388
|
#
|
|
13548
|
-
# An Asset Bundle import job imports specified
|
|
13549
|
-
#
|
|
13550
|
-
# specified configuration overrides. The assets that
|
|
13551
|
-
# the bundle file that you provide are used to create
|
|
13552
|
-
# existing asset in your
|
|
13553
|
-
# run up to 5 import jobs
|
|
14389
|
+
# An Asset Bundle import job imports specified Amazon Quick Sight assets
|
|
14390
|
+
# into an Amazon Quick Sight account. You can also choose to import a
|
|
14391
|
+
# naming prefix and specified configuration overrides. The assets that
|
|
14392
|
+
# are contained in the bundle file that you provide are used to create
|
|
14393
|
+
# or update a new or existing asset in your Amazon Quick Sight account.
|
|
14394
|
+
# Each Amazon Quick Sight account can run up to 5 import jobs
|
|
14395
|
+
# concurrently.
|
|
13554
14396
|
#
|
|
13555
14397
|
# The API caller must have the necessary `"create"`, `"describe"`, and
|
|
13556
14398
|
# `"update"` permissions in their IAM role to access each resource type
|
|
@@ -13580,7 +14422,7 @@ module Aws::QuickSight
|
|
|
13580
14422
|
#
|
|
13581
14423
|
# If you choose `DO_NOTHING`, failed import jobs will not attempt to
|
|
13582
14424
|
# roll back any asset changes caused by the failed job, possibly keeping
|
|
13583
|
-
# the
|
|
14425
|
+
# the Amazon Quick Sight account in an inconsistent state.
|
|
13584
14426
|
#
|
|
13585
14427
|
# @option params [Types::AssetBundleImportJobOverridePermissions] :override_permissions
|
|
13586
14428
|
# Optional permission overrides that are applied to the resource
|
|
@@ -13715,6 +14557,11 @@ module Aws::QuickSight
|
|
|
13715
14557
|
# },
|
|
13716
14558
|
# role_arn: "RoleArn",
|
|
13717
14559
|
# },
|
|
14560
|
+
# s3_knowledge_base_parameters: {
|
|
14561
|
+
# role_arn: "RoleArn",
|
|
14562
|
+
# bucket_url: "S3Bucket", # required
|
|
14563
|
+
# metadata_files_location: "MetadataFilesLocation",
|
|
14564
|
+
# },
|
|
13718
14565
|
# service_now_parameters: {
|
|
13719
14566
|
# site_base_url: "SiteBaseUrl", # required
|
|
13720
14567
|
# },
|
|
@@ -13797,6 +14644,22 @@ module Aws::QuickSight
|
|
|
13797
14644
|
# custom_connection_parameters: {
|
|
13798
14645
|
# connection_type: "String",
|
|
13799
14646
|
# },
|
|
14647
|
+
# web_crawler_parameters: {
|
|
14648
|
+
# web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
|
|
14649
|
+
# username_field_xpath: "XpathFields",
|
|
14650
|
+
# password_field_xpath: "XpathFields",
|
|
14651
|
+
# username_button_xpath: "XpathFields",
|
|
14652
|
+
# password_button_xpath: "XpathFields",
|
|
14653
|
+
# login_page_url: "SiteBaseUrl",
|
|
14654
|
+
# web_proxy_host_name: "Host",
|
|
14655
|
+
# web_proxy_port_number: 1,
|
|
14656
|
+
# },
|
|
14657
|
+
# confluence_parameters: {
|
|
14658
|
+
# confluence_url: "SiteBaseUrl", # required
|
|
14659
|
+
# },
|
|
14660
|
+
# q_business_parameters: {
|
|
14661
|
+
# application_arn: "ApplicationArn", # required
|
|
14662
|
+
# },
|
|
13800
14663
|
# },
|
|
13801
14664
|
# vpc_connection_properties: {
|
|
13802
14665
|
# vpc_connection_arn: "Arn", # required
|
|
@@ -14045,14 +14908,14 @@ module Aws::QuickSight
|
|
|
14045
14908
|
#
|
|
14046
14909
|
# **StartDashboardSnapshotJob API throttling**
|
|
14047
14910
|
#
|
|
14048
|
-
#
|
|
14911
|
+
# Quick Sight utilizes API throttling to create a more consistent user
|
|
14049
14912
|
# experience within a time span for customers when they call the
|
|
14050
14913
|
# `StartDashboardSnapshotJob`. By default, 12 jobs can run
|
|
14051
14914
|
# simlutaneously in one Amazon Web Services account and users can submit
|
|
14052
14915
|
# up 10 API requests per second before an account is throttled. If an
|
|
14053
14916
|
# overwhelming number of API requests are made by the same user in a
|
|
14054
|
-
# short period of time,
|
|
14055
|
-
# optimal experience and reliability for all
|
|
14917
|
+
# short period of time, Quick Sight throttles the API calls to maintin
|
|
14918
|
+
# an optimal experience and reliability for all Quick Sight users.
|
|
14056
14919
|
#
|
|
14057
14920
|
# **Common throttling scenarios**
|
|
14058
14921
|
#
|
|
@@ -14068,7 +14931,7 @@ module Aws::QuickSight
|
|
|
14068
14931
|
#
|
|
14069
14932
|
# * **A large number of API requests are submitted on an Amazon Web
|
|
14070
14933
|
# Services account.** When a user makes more than 10 API calls to the
|
|
14071
|
-
#
|
|
14934
|
+
# Quick Sight API in one second, a `ThrottlingException` is returned.
|
|
14072
14935
|
#
|
|
14073
14936
|
# If your use case requires a higher throttling limit, contact your
|
|
14074
14937
|
# account admin or [Amazon Web ServicesSupport][1] to explore options to
|
|
@@ -14080,7 +14943,7 @@ module Aws::QuickSight
|
|
|
14080
14943
|
# the degree of frequency and parallelism of API calls as much as you
|
|
14081
14944
|
# can to avoid throttling. You can also perform a timing test to
|
|
14082
14945
|
# calculate an estimate for the total processing time of your projected
|
|
14083
|
-
# load that stays within the throttling limits of the
|
|
14946
|
+
# load that stays within the throttling limits of the Quick Sight APIs.
|
|
14084
14947
|
# For example, if your projected traffic is 100 snapshot jobs before
|
|
14085
14948
|
# 12:00 PM per day, start 12 jobs in parallel and measure the amount of
|
|
14086
14949
|
# time it takes to proccess all 12 jobs. Once you obtain the result,
|
|
@@ -14128,7 +14991,7 @@ module Aws::QuickSight
|
|
|
14128
14991
|
# @option params [required, Types::SnapshotUserConfiguration] :user_configuration
|
|
14129
14992
|
# A structure that contains information about the anonymous users that
|
|
14130
14993
|
# the generated snapshot is for. This API will not return information
|
|
14131
|
-
# about registered
|
|
14994
|
+
# about registered Amazon Quick Sight.
|
|
14132
14995
|
#
|
|
14133
14996
|
# @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
|
|
14134
14997
|
# A structure that describes the configuration of the dashboard
|
|
@@ -14238,9 +15101,10 @@ module Aws::QuickSight
|
|
|
14238
15101
|
# Only one job can run simultaneously in a given schedule. Repeated
|
|
14239
15102
|
# requests are skipped with a `202` HTTP status code.
|
|
14240
15103
|
#
|
|
14241
|
-
# For more information, see [Scheduling and sending
|
|
14242
|
-
# by email][1] and [Configuring email report settings for a
|
|
14243
|
-
# dashboard][2] in the *Amazon
|
|
15104
|
+
# For more information, see [Scheduling and sending Amazon Quick Sight
|
|
15105
|
+
# reports by email][1] and [Configuring email report settings for a
|
|
15106
|
+
# Amazon Quick Sight dashboard][2] in the *Amazon Quick Sight User
|
|
15107
|
+
# Guide*.
|
|
14244
15108
|
#
|
|
14245
15109
|
#
|
|
14246
15110
|
#
|
|
@@ -14257,9 +15121,9 @@ module Aws::QuickSight
|
|
|
14257
15121
|
#
|
|
14258
15122
|
# @option params [required, String] :schedule_id
|
|
14259
15123
|
# The ID of the schedule that you want to start a snapshot job schedule
|
|
14260
|
-
# for. The schedule ID can be found in the
|
|
14261
|
-
# **Schedules** pane of the dashboard that the schedule is
|
|
14262
|
-
# for.
|
|
15124
|
+
# for. The schedule ID can be found in the Amazon Quick Sight console in
|
|
15125
|
+
# the **Schedules** pane of the dashboard that the schedule is
|
|
15126
|
+
# configured for.
|
|
14263
15127
|
#
|
|
14264
15128
|
# @return [Types::StartDashboardSnapshotJobScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14265
15129
|
#
|
|
@@ -14288,8 +15152,8 @@ module Aws::QuickSight
|
|
|
14288
15152
|
req.send_request(options)
|
|
14289
15153
|
end
|
|
14290
15154
|
|
|
14291
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
|
14292
|
-
# resource.
|
|
15155
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
|
15156
|
+
# Quick Sight resource.
|
|
14293
15157
|
#
|
|
14294
15158
|
# Tags can help you organize and categorize your resources. You can also
|
|
14295
15159
|
# use them to scope user permissions, by granting a user permission to
|
|
@@ -14300,20 +15164,20 @@ module Aws::QuickSight
|
|
|
14300
15164
|
# key that is already associated with the resource, the new tag value
|
|
14301
15165
|
# that you specify replaces the previous value for that tag.
|
|
14302
15166
|
#
|
|
14303
|
-
# You can associate as many as 50 tags with a resource.
|
|
14304
|
-
# supports tagging on data set, data source, dashboard, template,
|
|
14305
|
-
# and user.
|
|
15167
|
+
# You can associate as many as 50 tags with a resource. Amazon Quick
|
|
15168
|
+
# Sight supports tagging on data set, data source, dashboard, template,
|
|
15169
|
+
# topic, and user.
|
|
14306
15170
|
#
|
|
14307
|
-
# Tagging for
|
|
14308
|
-
# Amazon Web Services services, except for the following:
|
|
15171
|
+
# Tagging for Amazon Quick Sight works in a similar way to tagging for
|
|
15172
|
+
# other Amazon Web Services services, except for the following:
|
|
14309
15173
|
#
|
|
14310
|
-
# * Tags are used to track costs for users in
|
|
14311
|
-
# other resources that
|
|
14312
|
-
# capacoty (SPICE), session usage, alert
|
|
14313
|
-
# units.
|
|
15174
|
+
# * Tags are used to track costs for users in Amazon Quick Sight. You
|
|
15175
|
+
# can't tag other resources that Amazon Quick Sight costs are based
|
|
15176
|
+
# on, such as storage capacoty (SPICE), session usage, alert
|
|
15177
|
+
# consumption, or reporting units.
|
|
14314
15178
|
#
|
|
14315
|
-
# *
|
|
14316
|
-
# Groups.
|
|
15179
|
+
# * Amazon Quick Sight doesn't currently support the tag editor for
|
|
15180
|
+
# Resource Groups.
|
|
14317
15181
|
#
|
|
14318
15182
|
# @option params [required, String] :resource_arn
|
|
14319
15183
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
|
@@ -14424,12 +15288,11 @@ module Aws::QuickSight
|
|
|
14424
15288
|
req.send_request(options)
|
|
14425
15289
|
end
|
|
14426
15290
|
|
|
14427
|
-
# Updates Amazon
|
|
14428
|
-
#
|
|
14429
|
-
# a theme.
|
|
15291
|
+
# Updates Amazon Quick Sight customizations. Currently, the only
|
|
15292
|
+
# customization that you can use is a theme.
|
|
14430
15293
|
#
|
|
14431
15294
|
# You can use customizations for your Amazon Web Services account or, if
|
|
14432
|
-
# you specify a namespace, for a
|
|
15295
|
+
# you specify a namespace, for a Quick Sight namespace instead.
|
|
14433
15296
|
# Customizations that apply to a namespace override customizations that
|
|
14434
15297
|
# apply to an Amazon Web Services account. To find out which
|
|
14435
15298
|
# customizations apply, use the `DescribeAccountCustomization` API
|
|
@@ -14437,14 +15300,13 @@ module Aws::QuickSight
|
|
|
14437
15300
|
#
|
|
14438
15301
|
# @option params [required, String] :aws_account_id
|
|
14439
15302
|
# The ID for the Amazon Web Services account that you want to update
|
|
14440
|
-
#
|
|
15303
|
+
# Quick Sight customizations for.
|
|
14441
15304
|
#
|
|
14442
15305
|
# @option params [String] :namespace
|
|
14443
|
-
# The namespace that you want to update
|
|
15306
|
+
# The namespace that you want to update Quick Sight customizations for.
|
|
14444
15307
|
#
|
|
14445
15308
|
# @option params [required, Types::AccountCustomization] :account_customization
|
|
14446
|
-
# The
|
|
14447
|
-
# Web Services Region.
|
|
15309
|
+
# The Quick Sight customizations you're updating.
|
|
14448
15310
|
#
|
|
14449
15311
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14450
15312
|
#
|
|
@@ -14485,25 +15347,26 @@ module Aws::QuickSight
|
|
|
14485
15347
|
req.send_request(options)
|
|
14486
15348
|
end
|
|
14487
15349
|
|
|
14488
|
-
# Updates the Amazon
|
|
15350
|
+
# Updates the Amazon Quick Sight settings in your Amazon Web Services
|
|
14489
15351
|
# account.
|
|
14490
15352
|
#
|
|
14491
15353
|
# @option params [required, String] :aws_account_id
|
|
14492
|
-
# The ID for the Amazon Web Services account that contains the
|
|
14493
|
-
#
|
|
15354
|
+
# The ID for the Amazon Web Services account that contains the Quick
|
|
15355
|
+
# Sight settings that you want to list.
|
|
14494
15356
|
#
|
|
14495
15357
|
# @option params [required, String] :default_namespace
|
|
14496
15358
|
# The default namespace for this Amazon Web Services account. Currently,
|
|
14497
15359
|
# the default is `default`. IAM users that register for the first time
|
|
14498
|
-
# with
|
|
14499
|
-
# the default namespace.
|
|
15360
|
+
# with Amazon Quick Sight provide an email address that becomes
|
|
15361
|
+
# associated with the default namespace.
|
|
14500
15362
|
#
|
|
14501
15363
|
# @option params [String] :notification_email
|
|
14502
|
-
# The email address that you want
|
|
14503
|
-
# regarding your Amazon Web Services account or
|
|
15364
|
+
# The email address that you want Quick Sight to send notifications to
|
|
15365
|
+
# regarding your Amazon Web Services account or Quick Sight
|
|
15366
|
+
# subscription.
|
|
14504
15367
|
#
|
|
14505
15368
|
# @option params [Boolean] :termination_protection_enabled
|
|
14506
|
-
# A boolean value that determines whether or not an
|
|
15369
|
+
# A boolean value that determines whether or not an Quick Sight account
|
|
14507
15370
|
# can be deleted. A `True` value doesn't allow the account to be
|
|
14508
15371
|
# deleted and results in an error message if a user tries to make a
|
|
14509
15372
|
# `DeleteAccountSubscription` request. A `False` value will allow the
|
|
@@ -14537,7 +15400,183 @@ module Aws::QuickSight
|
|
|
14537
15400
|
req.send_request(options)
|
|
14538
15401
|
end
|
|
14539
15402
|
|
|
14540
|
-
# Updates an
|
|
15403
|
+
# Updates an existing action connector with new configuration details,
|
|
15404
|
+
# authentication settings, or enabled actions. You can modify the
|
|
15405
|
+
# connector's name, description, authentication configuration, and
|
|
15406
|
+
# which actions are enabled. For more information,
|
|
15407
|
+
# [https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html][1].
|
|
15408
|
+
#
|
|
15409
|
+
#
|
|
15410
|
+
#
|
|
15411
|
+
# [1]: https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html
|
|
15412
|
+
#
|
|
15413
|
+
# @option params [required, String] :aws_account_id
|
|
15414
|
+
# The Amazon Web Services account ID that contains the action connector
|
|
15415
|
+
# to update.
|
|
15416
|
+
#
|
|
15417
|
+
# @option params [required, String] :action_connector_id
|
|
15418
|
+
# The unique identifier of the action connector to update.
|
|
15419
|
+
#
|
|
15420
|
+
# @option params [required, String] :name
|
|
15421
|
+
# The new name for the action connector.
|
|
15422
|
+
#
|
|
15423
|
+
# @option params [required, Types::AuthConfig] :authentication_config
|
|
15424
|
+
# The updated authentication configuration for connecting to the
|
|
15425
|
+
# external service.
|
|
15426
|
+
#
|
|
15427
|
+
# @option params [String] :description
|
|
15428
|
+
# The updated description of the action connector.
|
|
15429
|
+
#
|
|
15430
|
+
# @option params [String] :vpc_connection_arn
|
|
15431
|
+
# The updated ARN of the VPC connection to use for secure connectivity.
|
|
15432
|
+
#
|
|
15433
|
+
# @return [Types::UpdateActionConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15434
|
+
#
|
|
15435
|
+
# * {Types::UpdateActionConnectorResponse#arn #arn} => String
|
|
15436
|
+
# * {Types::UpdateActionConnectorResponse#action_connector_id #action_connector_id} => String
|
|
15437
|
+
# * {Types::UpdateActionConnectorResponse#request_id #request_id} => String
|
|
15438
|
+
# * {Types::UpdateActionConnectorResponse#update_status #update_status} => String
|
|
15439
|
+
# * {Types::UpdateActionConnectorResponse#status #status} => Integer
|
|
15440
|
+
#
|
|
15441
|
+
# @example Request syntax with placeholder values
|
|
15442
|
+
#
|
|
15443
|
+
# resp = client.update_action_connector({
|
|
15444
|
+
# aws_account_id: "AwsAccountId", # required
|
|
15445
|
+
# action_connector_id: "ShortRestrictiveResourceId", # required
|
|
15446
|
+
# name: "ActionConnectorName", # required
|
|
15447
|
+
# authentication_config: { # required
|
|
15448
|
+
# authentication_type: "BASIC", # required, accepts BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, NONE, IAM, OAUTH2_AUTHORIZATION_CODE
|
|
15449
|
+
# authentication_metadata: { # required
|
|
15450
|
+
# authorization_code_grant_metadata: {
|
|
15451
|
+
# base_endpoint: "Endpoint", # required
|
|
15452
|
+
# redirect_url: "Endpoint", # required
|
|
15453
|
+
# authorization_code_grant_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
|
|
15454
|
+
# authorization_code_grant_credentials_details: {
|
|
15455
|
+
# authorization_code_grant_details: {
|
|
15456
|
+
# client_id: "ClientId", # required
|
|
15457
|
+
# client_secret: "ClientSecret", # required
|
|
15458
|
+
# token_endpoint: "Endpoint", # required
|
|
15459
|
+
# authorization_endpoint: "Endpoint", # required
|
|
15460
|
+
# },
|
|
15461
|
+
# },
|
|
15462
|
+
# },
|
|
15463
|
+
# client_credentials_grant_metadata: {
|
|
15464
|
+
# base_endpoint: "Endpoint", # required
|
|
15465
|
+
# client_credentials_source: "PLAIN_CREDENTIALS", # accepts PLAIN_CREDENTIALS
|
|
15466
|
+
# client_credentials_details: {
|
|
15467
|
+
# client_credentials_grant_details: {
|
|
15468
|
+
# client_id: "ClientId", # required
|
|
15469
|
+
# client_secret: "ClientSecret", # required
|
|
15470
|
+
# token_endpoint: "Endpoint", # required
|
|
15471
|
+
# },
|
|
15472
|
+
# },
|
|
15473
|
+
# },
|
|
15474
|
+
# basic_auth_connection_metadata: {
|
|
15475
|
+
# base_endpoint: "Endpoint", # required
|
|
15476
|
+
# username: "ActionUserName", # required
|
|
15477
|
+
# password: "ActionPassword", # required
|
|
15478
|
+
# },
|
|
15479
|
+
# api_key_connection_metadata: {
|
|
15480
|
+
# base_endpoint: "Endpoint", # required
|
|
15481
|
+
# api_key: "APIKey", # required
|
|
15482
|
+
# email: "Email",
|
|
15483
|
+
# },
|
|
15484
|
+
# none_connection_metadata: {
|
|
15485
|
+
# base_endpoint: "Endpoint", # required
|
|
15486
|
+
# },
|
|
15487
|
+
# iam_connection_metadata: {
|
|
15488
|
+
# role_arn: "RoleArn", # required
|
|
15489
|
+
# },
|
|
15490
|
+
# },
|
|
15491
|
+
# },
|
|
15492
|
+
# description: "ActionConnectorDescription",
|
|
15493
|
+
# vpc_connection_arn: "Arn",
|
|
15494
|
+
# })
|
|
15495
|
+
#
|
|
15496
|
+
# @example Response structure
|
|
15497
|
+
#
|
|
15498
|
+
# resp.arn #=> String
|
|
15499
|
+
# resp.action_connector_id #=> String
|
|
15500
|
+
# resp.request_id #=> String
|
|
15501
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
|
15502
|
+
# resp.status #=> Integer
|
|
15503
|
+
#
|
|
15504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateActionConnector AWS API Documentation
|
|
15505
|
+
#
|
|
15506
|
+
# @overload update_action_connector(params = {})
|
|
15507
|
+
# @param [Hash] params ({})
|
|
15508
|
+
def update_action_connector(params = {}, options = {})
|
|
15509
|
+
req = build_request(:update_action_connector, params)
|
|
15510
|
+
req.send_request(options)
|
|
15511
|
+
end
|
|
15512
|
+
|
|
15513
|
+
# Updates the permissions for an action connector by granting or
|
|
15514
|
+
# revoking access for specific users and groups. You can control who can
|
|
15515
|
+
# view, use, or manage the action connector.
|
|
15516
|
+
#
|
|
15517
|
+
# @option params [required, String] :aws_account_id
|
|
15518
|
+
# The Amazon Web Services account ID that contains the action connector.
|
|
15519
|
+
#
|
|
15520
|
+
# @option params [required, String] :action_connector_id
|
|
15521
|
+
# The unique identifier of the action connector whose permissions you
|
|
15522
|
+
# want to update.
|
|
15523
|
+
#
|
|
15524
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
|
15525
|
+
# The permissions to grant to users and groups for this action
|
|
15526
|
+
# connector.
|
|
15527
|
+
#
|
|
15528
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
|
15529
|
+
# The permissions to revoke from users and groups for this action
|
|
15530
|
+
# connector.
|
|
15531
|
+
#
|
|
15532
|
+
# @return [Types::UpdateActionConnectorPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15533
|
+
#
|
|
15534
|
+
# * {Types::UpdateActionConnectorPermissionsResponse#arn #arn} => String
|
|
15535
|
+
# * {Types::UpdateActionConnectorPermissionsResponse#action_connector_id #action_connector_id} => String
|
|
15536
|
+
# * {Types::UpdateActionConnectorPermissionsResponse#request_id #request_id} => String
|
|
15537
|
+
# * {Types::UpdateActionConnectorPermissionsResponse#status #status} => Integer
|
|
15538
|
+
# * {Types::UpdateActionConnectorPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
|
15539
|
+
#
|
|
15540
|
+
# @example Request syntax with placeholder values
|
|
15541
|
+
#
|
|
15542
|
+
# resp = client.update_action_connector_permissions({
|
|
15543
|
+
# aws_account_id: "AwsAccountId", # required
|
|
15544
|
+
# action_connector_id: "ShortRestrictiveResourceId", # required
|
|
15545
|
+
# grant_permissions: [
|
|
15546
|
+
# {
|
|
15547
|
+
# principal: "Principal", # required
|
|
15548
|
+
# actions: ["String"], # required
|
|
15549
|
+
# },
|
|
15550
|
+
# ],
|
|
15551
|
+
# revoke_permissions: [
|
|
15552
|
+
# {
|
|
15553
|
+
# principal: "Principal", # required
|
|
15554
|
+
# actions: ["String"], # required
|
|
15555
|
+
# },
|
|
15556
|
+
# ],
|
|
15557
|
+
# })
|
|
15558
|
+
#
|
|
15559
|
+
# @example Response structure
|
|
15560
|
+
#
|
|
15561
|
+
# resp.arn #=> String
|
|
15562
|
+
# resp.action_connector_id #=> String
|
|
15563
|
+
# resp.request_id #=> String
|
|
15564
|
+
# resp.status #=> Integer
|
|
15565
|
+
# resp.permissions #=> Array
|
|
15566
|
+
# resp.permissions[0].principal #=> String
|
|
15567
|
+
# resp.permissions[0].actions #=> Array
|
|
15568
|
+
# resp.permissions[0].actions[0] #=> String
|
|
15569
|
+
#
|
|
15570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateActionConnectorPermissions AWS API Documentation
|
|
15571
|
+
#
|
|
15572
|
+
# @overload update_action_connector_permissions(params = {})
|
|
15573
|
+
# @param [Hash] params ({})
|
|
15574
|
+
def update_action_connector_permissions(params = {}, options = {})
|
|
15575
|
+
req = build_request(:update_action_connector_permissions, params)
|
|
15576
|
+
req.send_request(options)
|
|
15577
|
+
end
|
|
15578
|
+
|
|
15579
|
+
# Updates an analysis in Amazon Quick Sight
|
|
14541
15580
|
#
|
|
14542
15581
|
# @option params [required, String] :aws_account_id
|
|
14543
15582
|
# The ID of the Amazon Web Services account that contains the analysis
|
|
@@ -14549,7 +15588,7 @@ module Aws::QuickSight
|
|
|
14549
15588
|
#
|
|
14550
15589
|
# @option params [required, String] :name
|
|
14551
15590
|
# A descriptive name for the analysis that you're updating. This name
|
|
14552
|
-
# displays for the analysis in the
|
|
15591
|
+
# displays for the analysis in the Amazon Quick Sight console.
|
|
14553
15592
|
#
|
|
14554
15593
|
# @option params [Types::Parameters] :parameters
|
|
14555
15594
|
# The parameter names and override values that you want to use. An
|
|
@@ -14563,8 +15602,8 @@ module Aws::QuickSight
|
|
|
14563
15602
|
#
|
|
14564
15603
|
# @option params [String] :theme_arn
|
|
14565
15604
|
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
|
14566
|
-
# that you're creating. To see the theme in the
|
|
14567
|
-
# make sure that you have access to it.
|
|
15605
|
+
# that you're creating. To see the theme in the Amazon Quick Sight
|
|
15606
|
+
# console, make sure that you have access to it.
|
|
14568
15607
|
#
|
|
14569
15608
|
# @option params [Types::AnalysisDefinition] :definition
|
|
14570
15609
|
# The definition of an analysis.
|
|
@@ -14769,6 +15808,24 @@ module Aws::QuickSight
|
|
|
14769
15808
|
# background: "HexColor",
|
|
14770
15809
|
# },
|
|
14771
15810
|
# },
|
|
15811
|
+
# contextual_accent_palette: {
|
|
15812
|
+
# connection: {
|
|
15813
|
+
# foreground: "HexColor",
|
|
15814
|
+
# background: "HexColor",
|
|
15815
|
+
# },
|
|
15816
|
+
# visualization: {
|
|
15817
|
+
# foreground: "HexColor",
|
|
15818
|
+
# background: "HexColor",
|
|
15819
|
+
# },
|
|
15820
|
+
# insight: {
|
|
15821
|
+
# foreground: "HexColor",
|
|
15822
|
+
# background: "HexColor",
|
|
15823
|
+
# },
|
|
15824
|
+
# automation: {
|
|
15825
|
+
# foreground: "HexColor",
|
|
15826
|
+
# background: "HexColor",
|
|
15827
|
+
# },
|
|
15828
|
+
# },
|
|
14772
15829
|
# brand_element_style: {
|
|
14773
15830
|
# navbar_style: {
|
|
14774
15831
|
# global_navbar: {
|
|
@@ -14857,6 +15914,14 @@ module Aws::QuickSight
|
|
|
14857
15914
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
|
14858
15915
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
|
14859
15916
|
# resp.brand_definition.application_theme.brand_color_palette.danger.background #=> String
|
|
15917
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.foreground #=> String
|
|
15918
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.connection.background #=> String
|
|
15919
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.foreground #=> String
|
|
15920
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.visualization.background #=> String
|
|
15921
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.foreground #=> String
|
|
15922
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.insight.background #=> String
|
|
15923
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.foreground #=> String
|
|
15924
|
+
# resp.brand_definition.application_theme.contextual_accent_palette.automation.background #=> String
|
|
14860
15925
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
|
14861
15926
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
|
14862
15927
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
|
@@ -14998,6 +16063,18 @@ module Aws::QuickSight
|
|
|
14998
16063
|
# include_content_in_scheduled_reports_email: "DENY", # accepts DENY
|
|
14999
16064
|
# dashboard: "DENY", # accepts DENY
|
|
15000
16065
|
# analysis: "DENY", # accepts DENY
|
|
16066
|
+
# automate: "DENY", # accepts DENY
|
|
16067
|
+
# flow: "DENY", # accepts DENY
|
|
16068
|
+
# publish_without_approval: "DENY", # accepts DENY
|
|
16069
|
+
# use_bedrock_models: "DENY", # accepts DENY
|
|
16070
|
+
# perform_flow_ui_task: "DENY", # accepts DENY
|
|
16071
|
+
# use_agent_web_search: "DENY", # accepts DENY
|
|
16072
|
+
# knowledge_base: "DENY", # accepts DENY
|
|
16073
|
+
# action: "DENY", # accepts DENY
|
|
16074
|
+
# space: "DENY", # accepts DENY
|
|
16075
|
+
# chat_agent: "DENY", # accepts DENY
|
|
16076
|
+
# create_chat_agents: "DENY", # accepts DENY
|
|
16077
|
+
# research: "DENY", # accepts DENY
|
|
15001
16078
|
# },
|
|
15002
16079
|
# })
|
|
15003
16080
|
#
|
|
@@ -15044,7 +16121,7 @@ module Aws::QuickSight
|
|
|
15044
16121
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
|
15045
16122
|
# the Amazon Resource Name (ARN) of the source template. The
|
|
15046
16123
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
|
15047
|
-
# any
|
|
16124
|
+
# any Amazon Quick Sight-supported Amazon Web Services Region.
|
|
15048
16125
|
#
|
|
15049
16126
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
|
15050
16127
|
# replacement datasets for the placeholders listed in the original. The
|
|
@@ -15063,9 +16140,9 @@ module Aws::QuickSight
|
|
|
15063
16140
|
#
|
|
15064
16141
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
|
15065
16142
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
|
15066
|
-
#
|
|
15067
|
-
# which can be used for ad hoc (one-time) filtering. This
|
|
15068
|
-
# `ENABLED` by default.
|
|
16143
|
+
# Amazon Quick Sight disables the left filter pane on the published
|
|
16144
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
16145
|
+
# option is `ENABLED` by default.
|
|
15069
16146
|
#
|
|
15070
16147
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
|
15071
16148
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
|
@@ -15076,6 +16153,11 @@ module Aws::QuickSight
|
|
|
15076
16153
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
|
15077
16154
|
# by default.
|
|
15078
16155
|
#
|
|
16156
|
+
# * `AvailabilityStatus` for `QuickSuiteActionsOption` - This status can
|
|
16157
|
+
# be either `ENABLED` or `DISABLED`. Features related to Actions in
|
|
16158
|
+
# Amazon Quick Suite on dashboards are disabled when this is set to
|
|
16159
|
+
# `DISABLED`. This option is `DISABLED` by default.
|
|
16160
|
+
#
|
|
15079
16161
|
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
|
|
15080
16162
|
# be either `ENABLED` or `DISABLED`. The option to build an executive
|
|
15081
16163
|
# summary is disabled when this is set to `DISABLED`. This option is
|
|
@@ -15367,7 +16449,7 @@ module Aws::QuickSight
|
|
|
15367
16449
|
# Indicates whether you want to import the data into SPICE.
|
|
15368
16450
|
#
|
|
15369
16451
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
|
15370
|
-
# Groupings of columns that work together in certain
|
|
16452
|
+
# Groupings of columns that work together in certain Amazon Quick Sight
|
|
15371
16453
|
# features. Currently, only geospatial hierarchy is supported.
|
|
15372
16454
|
#
|
|
15373
16455
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
|
@@ -15717,21 +16799,21 @@ module Aws::QuickSight
|
|
|
15717
16799
|
# A display name for the data source.
|
|
15718
16800
|
#
|
|
15719
16801
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
|
15720
|
-
# The parameters that
|
|
15721
|
-
# source.
|
|
16802
|
+
# The parameters that Amazon Quick Sight uses to connect to your
|
|
16803
|
+
# underlying source.
|
|
15722
16804
|
#
|
|
15723
16805
|
# @option params [Types::DataSourceCredentials] :credentials
|
|
15724
|
-
# The credentials that
|
|
16806
|
+
# The credentials that Amazon Quick Sight that uses to connect to your
|
|
15725
16807
|
# underlying source. Currently, only credentials based on user name and
|
|
15726
16808
|
# password are supported.
|
|
15727
16809
|
#
|
|
15728
16810
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
|
15729
|
-
# Use this parameter only when you want
|
|
16811
|
+
# Use this parameter only when you want Amazon Quick Sight to use a VPC
|
|
15730
16812
|
# connection when connecting to your underlying source.
|
|
15731
16813
|
#
|
|
15732
16814
|
# @option params [Types::SslProperties] :ssl_properties
|
|
15733
|
-
# Secure Socket Layer (SSL) properties that apply when
|
|
15734
|
-
# connects to your underlying source.
|
|
16815
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon Quick
|
|
16816
|
+
# Sight connects to your underlying source.
|
|
15735
16817
|
#
|
|
15736
16818
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15737
16819
|
#
|
|
@@ -15826,6 +16908,11 @@ module Aws::QuickSight
|
|
|
15826
16908
|
# },
|
|
15827
16909
|
# role_arn: "RoleArn",
|
|
15828
16910
|
# },
|
|
16911
|
+
# s3_knowledge_base_parameters: {
|
|
16912
|
+
# role_arn: "RoleArn",
|
|
16913
|
+
# bucket_url: "S3Bucket", # required
|
|
16914
|
+
# metadata_files_location: "MetadataFilesLocation",
|
|
16915
|
+
# },
|
|
15829
16916
|
# service_now_parameters: {
|
|
15830
16917
|
# site_base_url: "SiteBaseUrl", # required
|
|
15831
16918
|
# },
|
|
@@ -15908,6 +16995,22 @@ module Aws::QuickSight
|
|
|
15908
16995
|
# custom_connection_parameters: {
|
|
15909
16996
|
# connection_type: "String",
|
|
15910
16997
|
# },
|
|
16998
|
+
# web_crawler_parameters: {
|
|
16999
|
+
# web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
|
|
17000
|
+
# username_field_xpath: "XpathFields",
|
|
17001
|
+
# password_field_xpath: "XpathFields",
|
|
17002
|
+
# username_button_xpath: "XpathFields",
|
|
17003
|
+
# password_button_xpath: "XpathFields",
|
|
17004
|
+
# login_page_url: "SiteBaseUrl",
|
|
17005
|
+
# web_proxy_host_name: "Host",
|
|
17006
|
+
# web_proxy_port_number: 1,
|
|
17007
|
+
# },
|
|
17008
|
+
# confluence_parameters: {
|
|
17009
|
+
# confluence_url: "SiteBaseUrl", # required
|
|
17010
|
+
# },
|
|
17011
|
+
# q_business_parameters: {
|
|
17012
|
+
# application_arn: "ApplicationArn", # required
|
|
17013
|
+
# },
|
|
15911
17014
|
# },
|
|
15912
17015
|
# credentials: {
|
|
15913
17016
|
# credential_pair: {
|
|
@@ -15993,6 +17096,11 @@ module Aws::QuickSight
|
|
|
15993
17096
|
# },
|
|
15994
17097
|
# role_arn: "RoleArn",
|
|
15995
17098
|
# },
|
|
17099
|
+
# s3_knowledge_base_parameters: {
|
|
17100
|
+
# role_arn: "RoleArn",
|
|
17101
|
+
# bucket_url: "S3Bucket", # required
|
|
17102
|
+
# metadata_files_location: "MetadataFilesLocation",
|
|
17103
|
+
# },
|
|
15996
17104
|
# service_now_parameters: {
|
|
15997
17105
|
# site_base_url: "SiteBaseUrl", # required
|
|
15998
17106
|
# },
|
|
@@ -16075,11 +17183,31 @@ module Aws::QuickSight
|
|
|
16075
17183
|
# custom_connection_parameters: {
|
|
16076
17184
|
# connection_type: "String",
|
|
16077
17185
|
# },
|
|
17186
|
+
# web_crawler_parameters: {
|
|
17187
|
+
# web_crawler_auth_type: "NO_AUTH", # required, accepts NO_AUTH, BASIC_AUTH, FORM, SAML
|
|
17188
|
+
# username_field_xpath: "XpathFields",
|
|
17189
|
+
# password_field_xpath: "XpathFields",
|
|
17190
|
+
# username_button_xpath: "XpathFields",
|
|
17191
|
+
# password_button_xpath: "XpathFields",
|
|
17192
|
+
# login_page_url: "SiteBaseUrl",
|
|
17193
|
+
# web_proxy_host_name: "Host",
|
|
17194
|
+
# web_proxy_port_number: 1,
|
|
17195
|
+
# },
|
|
17196
|
+
# confluence_parameters: {
|
|
17197
|
+
# confluence_url: "SiteBaseUrl", # required
|
|
17198
|
+
# },
|
|
17199
|
+
# q_business_parameters: {
|
|
17200
|
+
# application_arn: "ApplicationArn", # required
|
|
17201
|
+
# },
|
|
16078
17202
|
# },
|
|
16079
17203
|
# ],
|
|
16080
17204
|
# },
|
|
16081
17205
|
# copy_source_arn: "CopySourceArn",
|
|
16082
17206
|
# secret_arn: "SecretArn",
|
|
17207
|
+
# web_proxy_credentials: {
|
|
17208
|
+
# web_proxy_username: "DbUsername", # required
|
|
17209
|
+
# web_proxy_password: "Password", # required
|
|
17210
|
+
# },
|
|
16083
17211
|
# },
|
|
16084
17212
|
# vpc_connection_properties: {
|
|
16085
17213
|
# vpc_connection_arn: "Arn", # required
|
|
@@ -16165,15 +17293,15 @@ module Aws::QuickSight
|
|
|
16165
17293
|
req.send_request(options)
|
|
16166
17294
|
end
|
|
16167
17295
|
|
|
16168
|
-
# Updates a Amazon Q Business application that is linked to a
|
|
16169
|
-
# account.
|
|
17296
|
+
# Updates a Amazon Q Business application that is linked to a Quick
|
|
17297
|
+
# Sight account.
|
|
16170
17298
|
#
|
|
16171
17299
|
# @option params [required, String] :aws_account_id
|
|
16172
|
-
# The ID of the
|
|
17300
|
+
# The ID of the Quick Sight account that is connected to the Amazon Q
|
|
16173
17301
|
# Business application that you want to update.
|
|
16174
17302
|
#
|
|
16175
17303
|
# @option params [String] :namespace
|
|
16176
|
-
# The
|
|
17304
|
+
# The Quick Sight namespace that contains the linked Amazon Q Business
|
|
16177
17305
|
# application. If this field is left blank, the default namespace is
|
|
16178
17306
|
# used. Currently, the default namespace is the only valid value for
|
|
16179
17307
|
# this parameter.
|
|
@@ -16208,6 +17336,68 @@ module Aws::QuickSight
|
|
|
16208
17336
|
req.send_request(options)
|
|
16209
17337
|
end
|
|
16210
17338
|
|
|
17339
|
+
# Updates permissions against principals on a flow.
|
|
17340
|
+
#
|
|
17341
|
+
# @option params [required, String] :aws_account_id
|
|
17342
|
+
# The ID of the Amazon Web Services account that contains the flow you
|
|
17343
|
+
# are updating permissions against.
|
|
17344
|
+
#
|
|
17345
|
+
# @option params [required, String] :flow_id
|
|
17346
|
+
# The unique identifier of the flow to update permissions for.
|
|
17347
|
+
#
|
|
17348
|
+
# @option params [Array<Types::Permission>] :grant_permissions
|
|
17349
|
+
# The permissions that you want to grant on this flow.
|
|
17350
|
+
#
|
|
17351
|
+
# @option params [Array<Types::Permission>] :revoke_permissions
|
|
17352
|
+
# The permissions that you want to revoke from this flow.
|
|
17353
|
+
#
|
|
17354
|
+
# @return [Types::UpdateFlowPermissionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17355
|
+
#
|
|
17356
|
+
# * {Types::UpdateFlowPermissionsOutput#status #status} => Integer
|
|
17357
|
+
# * {Types::UpdateFlowPermissionsOutput#arn #arn} => String
|
|
17358
|
+
# * {Types::UpdateFlowPermissionsOutput#permissions #permissions} => Array<Types::Permission>
|
|
17359
|
+
# * {Types::UpdateFlowPermissionsOutput#request_id #request_id} => String
|
|
17360
|
+
# * {Types::UpdateFlowPermissionsOutput#flow_id #flow_id} => String
|
|
17361
|
+
#
|
|
17362
|
+
# @example Request syntax with placeholder values
|
|
17363
|
+
#
|
|
17364
|
+
# resp = client.update_flow_permissions({
|
|
17365
|
+
# aws_account_id: "AccountId", # required
|
|
17366
|
+
# flow_id: "FlowId", # required
|
|
17367
|
+
# grant_permissions: [
|
|
17368
|
+
# {
|
|
17369
|
+
# actions: ["ActionsListMemberString"], # required
|
|
17370
|
+
# principal: "PermissionPrincipalString", # required
|
|
17371
|
+
# },
|
|
17372
|
+
# ],
|
|
17373
|
+
# revoke_permissions: [
|
|
17374
|
+
# {
|
|
17375
|
+
# actions: ["ActionsListMemberString"], # required
|
|
17376
|
+
# principal: "PermissionPrincipalString", # required
|
|
17377
|
+
# },
|
|
17378
|
+
# ],
|
|
17379
|
+
# })
|
|
17380
|
+
#
|
|
17381
|
+
# @example Response structure
|
|
17382
|
+
#
|
|
17383
|
+
# resp.status #=> Integer
|
|
17384
|
+
# resp.arn #=> String
|
|
17385
|
+
# resp.permissions #=> Array
|
|
17386
|
+
# resp.permissions[0].actions #=> Array
|
|
17387
|
+
# resp.permissions[0].actions[0] #=> String
|
|
17388
|
+
# resp.permissions[0].principal #=> String
|
|
17389
|
+
# resp.request_id #=> String
|
|
17390
|
+
# resp.flow_id #=> String
|
|
17391
|
+
#
|
|
17392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFlowPermissions AWS API Documentation
|
|
17393
|
+
#
|
|
17394
|
+
# @overload update_flow_permissions(params = {})
|
|
17395
|
+
# @param [Hash] params ({})
|
|
17396
|
+
def update_flow_permissions(params = {}, options = {})
|
|
17397
|
+
req = build_request(:update_flow_permissions, params)
|
|
17398
|
+
req.send_request(options)
|
|
17399
|
+
end
|
|
17400
|
+
|
|
16211
17401
|
# Updates the name of a folder.
|
|
16212
17402
|
#
|
|
16213
17403
|
# @option params [required, String] :aws_account_id
|
|
@@ -16326,7 +17516,7 @@ module Aws::QuickSight
|
|
|
16326
17516
|
# @option params [required, String] :aws_account_id
|
|
16327
17517
|
# The ID for the Amazon Web Services account that the group is in.
|
|
16328
17518
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
16329
|
-
# contains your Amazon
|
|
17519
|
+
# contains your Amazon Quick Sight account.
|
|
16330
17520
|
#
|
|
16331
17521
|
# @option params [required, String] :namespace
|
|
16332
17522
|
# The namespace of the group that you want to update.
|
|
@@ -16392,12 +17582,12 @@ module Aws::QuickSight
|
|
|
16392
17582
|
# when creating the data source.
|
|
16393
17583
|
#
|
|
16394
17584
|
# @option params [String] :policy_arn
|
|
16395
|
-
# The ARN for the IAM policy to apply to the
|
|
16396
|
-
# specified in this assignment.
|
|
17585
|
+
# The ARN for the IAM policy to apply to the Amazon Quick Sight users
|
|
17586
|
+
# and groups specified in this assignment.
|
|
16397
17587
|
#
|
|
16398
17588
|
# @option params [Hash<String,Array>] :identities
|
|
16399
|
-
# The
|
|
16400
|
-
# policy to.
|
|
17589
|
+
# The Amazon Quick Sight users, groups, or both that you want to assign
|
|
17590
|
+
# the policy to.
|
|
16401
17591
|
#
|
|
16402
17592
|
# @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16403
17593
|
#
|
|
@@ -16444,9 +17634,9 @@ module Aws::QuickSight
|
|
|
16444
17634
|
end
|
|
16445
17635
|
|
|
16446
17636
|
# Adds or updates services and authorized targets to configure what the
|
|
16447
|
-
#
|
|
17637
|
+
# Quick Sight IAM Identity Center application can access.
|
|
16448
17638
|
#
|
|
16449
|
-
# This operation is only supported for
|
|
17639
|
+
# This operation is only supported for Quick Sight accounts using IAM
|
|
16450
17640
|
# Identity Center
|
|
16451
17641
|
#
|
|
16452
17642
|
# @option params [required, String] :aws_account_id
|
|
@@ -16550,7 +17740,7 @@ module Aws::QuickSight
|
|
|
16550
17740
|
req.send_request(options)
|
|
16551
17741
|
end
|
|
16552
17742
|
|
|
16553
|
-
# Updates a customer managed key in a
|
|
17743
|
+
# Updates a customer managed key in a Quick Sight account.
|
|
16554
17744
|
#
|
|
16555
17745
|
# @option params [required, String] :aws_account_id
|
|
16556
17746
|
# The ID of the Amazon Web Services account that contains the customer
|
|
@@ -16558,7 +17748,7 @@ module Aws::QuickSight
|
|
|
16558
17748
|
#
|
|
16559
17749
|
# @option params [required, Array<Types::RegisteredCustomerManagedKey>] :key_registration
|
|
16560
17750
|
# A list of `RegisteredCustomerManagedKey` objects to be updated to the
|
|
16561
|
-
#
|
|
17751
|
+
# Quick Sight account.
|
|
16562
17752
|
#
|
|
16563
17753
|
# @return [Types::UpdateKeyRegistrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16564
17754
|
#
|
|
@@ -16599,38 +17789,38 @@ module Aws::QuickSight
|
|
|
16599
17789
|
req.send_request(options)
|
|
16600
17790
|
end
|
|
16601
17791
|
|
|
16602
|
-
# This API controls public sharing settings for your entire
|
|
17792
|
+
# This API controls public sharing settings for your entire Quick Sight
|
|
16603
17793
|
# account, affecting data security and access. When you enable public
|
|
16604
17794
|
# sharing:
|
|
16605
17795
|
#
|
|
16606
17796
|
# * Dashboards can be shared publicly
|
|
16607
17797
|
#
|
|
16608
17798
|
# * This setting affects your entire Amazon Web Services account and all
|
|
16609
|
-
#
|
|
17799
|
+
# Quick Sight users
|
|
16610
17800
|
#
|
|
16611
17801
|
# **Before proceeding:** Ensure you understand the security
|
|
16612
17802
|
# implications
|
|
16613
17803
|
# and have proper IAM permissions configured.
|
|
16614
17804
|
#
|
|
16615
17805
|
# Use the `UpdatePublicSharingSettings` operation to turn on or turn off
|
|
16616
|
-
# the public sharing settings of an
|
|
17806
|
+
# the public sharing settings of an Amazon Quick Sight dashboard.
|
|
16617
17807
|
#
|
|
16618
17808
|
# To use this operation, turn on session capacity pricing for your
|
|
16619
|
-
#
|
|
17809
|
+
# Amazon Quick Sight account.
|
|
16620
17810
|
#
|
|
16621
17811
|
# Before you can turn on public sharing on your account, make sure to
|
|
16622
17812
|
# give public sharing permissions to an administrative user in the
|
|
16623
17813
|
# Identity and Access Management (IAM) console. For more information on
|
|
16624
|
-
# using IAM with
|
|
16625
|
-
# *
|
|
17814
|
+
# using IAM with Amazon Quick Sight, see [Using QuickSight with IAM][1]
|
|
17815
|
+
# in the *Amazon Quick Sight User Guide*.
|
|
16626
17816
|
#
|
|
16627
17817
|
#
|
|
16628
17818
|
#
|
|
16629
17819
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html
|
|
16630
17820
|
#
|
|
16631
17821
|
# @option params [required, String] :aws_account_id
|
|
16632
|
-
# The Amazon Web Services account ID associated with your
|
|
16633
|
-
# subscription.
|
|
17822
|
+
# The Amazon Web Services account ID associated with your Amazon Quick
|
|
17823
|
+
# Sight subscription.
|
|
16634
17824
|
#
|
|
16635
17825
|
# @option params [Boolean] :public_sharing_enabled
|
|
16636
17826
|
# A Boolean value that indicates whether public sharing is turned on for
|
|
@@ -16669,9 +17859,9 @@ module Aws::QuickSight
|
|
|
16669
17859
|
# personalization configuration that the user wants to update.
|
|
16670
17860
|
#
|
|
16671
17861
|
# @option params [required, String] :personalization_mode
|
|
16672
|
-
# An option to allow
|
|
16673
|
-
# specific metadata, specifically location and job information, in
|
|
16674
|
-
# IAM Identity Center instance.
|
|
17862
|
+
# An option to allow Amazon Quick Sight to customize data stories with
|
|
17863
|
+
# user specific metadata, specifically location and job information, in
|
|
17864
|
+
# your IAM Identity Center instance.
|
|
16675
17865
|
#
|
|
16676
17866
|
# @return [Types::UpdateQPersonalizationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16677
17867
|
#
|
|
@@ -16701,14 +17891,14 @@ module Aws::QuickSight
|
|
|
16701
17891
|
req.send_request(options)
|
|
16702
17892
|
end
|
|
16703
17893
|
|
|
16704
|
-
# Updates the state of a
|
|
17894
|
+
# Updates the state of a Quick Sight Q Search configuration.
|
|
16705
17895
|
#
|
|
16706
17896
|
# @option params [required, String] :aws_account_id
|
|
16707
|
-
# The ID of the Amazon Web Services account that contains the
|
|
16708
|
-
# Q Search configuration that you want to update.
|
|
17897
|
+
# The ID of the Amazon Web Services account that contains the Quick
|
|
17898
|
+
# Sight Q Search configuration that you want to update.
|
|
16709
17899
|
#
|
|
16710
17900
|
# @option params [required, String] :q_search_status
|
|
16711
|
-
# The status of the
|
|
17901
|
+
# The status of the Quick Sight Q Search configuration that the user
|
|
16712
17902
|
# wants to update.
|
|
16713
17903
|
#
|
|
16714
17904
|
# @return [Types::UpdateQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -16807,8 +17997,8 @@ module Aws::QuickSight
|
|
|
16807
17997
|
# @option params [required, String] :aws_account_id
|
|
16808
17998
|
# The ID for the Amazon Web Services account that you want to create a
|
|
16809
17999
|
# group in. The Amazon Web Services account ID that you provide must be
|
|
16810
|
-
# the same Amazon Web Services account that contains your Amazon
|
|
16811
|
-
#
|
|
18000
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
|
18001
|
+
# Sight account.
|
|
16812
18002
|
#
|
|
16813
18003
|
# @option params [required, String] :namespace
|
|
16814
18004
|
# The namespace that contains the role that you want to update.
|
|
@@ -16841,7 +18031,7 @@ module Aws::QuickSight
|
|
|
16841
18031
|
req.send_request(options)
|
|
16842
18032
|
end
|
|
16843
18033
|
|
|
16844
|
-
# Updates the SPICE capacity configuration for a
|
|
18034
|
+
# Updates the SPICE capacity configuration for a Quick Sight account.
|
|
16845
18035
|
#
|
|
16846
18036
|
# @option params [required, String] :aws_account_id
|
|
16847
18037
|
# The ID of the Amazon Web Services account that contains the SPICE
|
|
@@ -16883,7 +18073,7 @@ module Aws::QuickSight
|
|
|
16883
18073
|
req.send_request(options)
|
|
16884
18074
|
end
|
|
16885
18075
|
|
|
16886
|
-
# Updates a template from an existing Amazon
|
|
18076
|
+
# Updates a template from an existing Amazon Quick Sight analysis or
|
|
16887
18077
|
# another template.
|
|
16888
18078
|
#
|
|
16889
18079
|
# @option params [required, String] :aws_account_id
|
|
@@ -16901,7 +18091,7 @@ module Aws::QuickSight
|
|
|
16901
18091
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
|
16902
18092
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
|
16903
18093
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
|
16904
|
-
# any
|
|
18094
|
+
# any Quick Sight-supported Amazon Web Services Region;.
|
|
16905
18095
|
#
|
|
16906
18096
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
|
16907
18097
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
|
@@ -17080,8 +18270,8 @@ module Aws::QuickSight
|
|
|
17080
18270
|
# The name for the theme.
|
|
17081
18271
|
#
|
|
17082
18272
|
# @option params [required, String] :base_theme_id
|
|
17083
|
-
# The theme ID, defined by Amazon
|
|
17084
|
-
# inherits from. All themes initially inherit from a default
|
|
18273
|
+
# The theme ID, defined by Amazon Quick Sight, that a custom theme
|
|
18274
|
+
# inherits from. All themes initially inherit from a default Quick Sight
|
|
17085
18275
|
# theme.
|
|
17086
18276
|
#
|
|
17087
18277
|
# @option params [String] :version_description
|
|
@@ -17727,15 +18917,15 @@ module Aws::QuickSight
|
|
|
17727
18917
|
req.send_request(options)
|
|
17728
18918
|
end
|
|
17729
18919
|
|
|
17730
|
-
# Updates an Amazon
|
|
18920
|
+
# Updates an Amazon Quick Sight user.
|
|
17731
18921
|
#
|
|
17732
18922
|
# @option params [required, String] :user_name
|
|
17733
|
-
# The Amazon
|
|
18923
|
+
# The Amazon Quick Sight user name that you want to update.
|
|
17734
18924
|
#
|
|
17735
18925
|
# @option params [required, String] :aws_account_id
|
|
17736
18926
|
# The ID for the Amazon Web Services account that the user is in.
|
|
17737
18927
|
# Currently, you use the ID for the Amazon Web Services account that
|
|
17738
|
-
# contains your Amazon
|
|
18928
|
+
# contains your Amazon Quick Sight account.
|
|
17739
18929
|
#
|
|
17740
18930
|
# @option params [required, String] :namespace
|
|
17741
18931
|
# The namespace. Currently, you should set this to `default`.
|
|
@@ -17744,7 +18934,7 @@ module Aws::QuickSight
|
|
|
17744
18934
|
# The email address of the user that you want to update.
|
|
17745
18935
|
#
|
|
17746
18936
|
# @option params [required, String] :role
|
|
17747
|
-
# The Amazon
|
|
18937
|
+
# The Amazon Quick Sight role of the user. The role can be one of the
|
|
17748
18938
|
# following default security cohorts:
|
|
17749
18939
|
#
|
|
17750
18940
|
# * `READER`: A user who has read-only access to dashboards.
|
|
@@ -17752,11 +18942,11 @@ module Aws::QuickSight
|
|
|
17752
18942
|
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
|
17753
18943
|
# and dashboards.
|
|
17754
18944
|
#
|
|
17755
|
-
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
|
17756
|
-
#
|
|
18945
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon Quick
|
|
18946
|
+
# Sight settings.
|
|
17757
18947
|
#
|
|
17758
18948
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
|
17759
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
|
18949
|
+
# Reader role. Reader Pros have access to Amazon Q in Quick Sight, can
|
|
17760
18950
|
# build stories with Amazon Q, and can generate executive summaries
|
|
17761
18951
|
# from dashboards.
|
|
17762
18952
|
#
|
|
@@ -17766,10 +18956,10 @@ module Aws::QuickSight
|
|
|
17766
18956
|
# Q&A, and generate executive summaries from dashboards.
|
|
17767
18957
|
#
|
|
17768
18958
|
# * `ADMIN_PRO`: Admin Pros are Author Pros who can also manage Amazon
|
|
17769
|
-
#
|
|
18959
|
+
# Quick Sight administrative settings. Admin Pro users are billed at
|
|
17770
18960
|
# Author Pro pricing.
|
|
17771
18961
|
#
|
|
17772
|
-
# The name of the
|
|
18962
|
+
# The name of the Quick Sight role is invisible to the user except for
|
|
17773
18963
|
# the console screens dealing with permissions.
|
|
17774
18964
|
#
|
|
17775
18965
|
# @option params [String] :custom_permissions_name
|
|
@@ -17788,16 +18978,16 @@ module Aws::QuickSight
|
|
|
17788
18978
|
#
|
|
17789
18979
|
# A set of custom permissions includes any combination of these
|
|
17790
18980
|
# restrictions. Currently, you need to create the profile names for
|
|
17791
|
-
# custom permission sets by using the
|
|
18981
|
+
# custom permission sets by using the Quick Sight console. Then, you use
|
|
17792
18982
|
# the `RegisterUser` API operation to assign the named set of
|
|
17793
|
-
# permissions to a
|
|
18983
|
+
# permissions to a Quick Sight user.
|
|
17794
18984
|
#
|
|
17795
|
-
#
|
|
18985
|
+
# Quick Sight custom permissions are applied through IAM policies.
|
|
17796
18986
|
# Therefore, they override the permissions typically granted by
|
|
17797
|
-
# assigning
|
|
17798
|
-
#
|
|
18987
|
+
# assigning Quick Sight users to one of the default security cohorts in
|
|
18988
|
+
# Quick Sight (admin, author, reader).
|
|
17799
18989
|
#
|
|
17800
|
-
# This feature is available only to
|
|
18990
|
+
# This feature is available only to Quick Sight Enterprise edition
|
|
17801
18991
|
# subscriptions.
|
|
17802
18992
|
#
|
|
17803
18993
|
# @option params [Boolean] :unapply_custom_permissions
|
|
@@ -17809,8 +18999,8 @@ module Aws::QuickSight
|
|
|
17809
18999
|
#
|
|
17810
19000
|
# @option params [String] :external_login_federation_provider_type
|
|
17811
19001
|
# The type of supported external login provider that provides identity
|
|
17812
|
-
# to let a user federate into
|
|
17813
|
-
# Access Management(IAM) role. The type of supported external login
|
|
19002
|
+
# to let a user federate into Quick Sight with an associated Identity
|
|
19003
|
+
# and Access Management(IAM) role. The type of supported external login
|
|
17814
19004
|
# provider can be one of the following.
|
|
17815
19005
|
#
|
|
17816
19006
|
# * `COGNITO`: Amazon Cognito. The provider URL is
|
|
@@ -17828,7 +19018,7 @@ module Aws::QuickSight
|
|
|
17828
19018
|
#
|
|
17829
19019
|
# @option params [String] :custom_federation_provider_url
|
|
17830
19020
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
|
17831
|
-
# identity to let a user federate into
|
|
19021
|
+
# identity to let a user federate into Quick Sight with an associated
|
|
17832
19022
|
# Identity and Access Management(IAM) role. This parameter should only
|
|
17833
19023
|
# be used when `ExternalLoginFederationProviderType` parameter is set to
|
|
17834
19024
|
# `CUSTOM_OIDC`.
|
|
@@ -18010,7 +19200,7 @@ module Aws::QuickSight
|
|
|
18010
19200
|
tracer: tracer
|
|
18011
19201
|
)
|
|
18012
19202
|
context[:gem_name] = 'aws-sdk-quicksight'
|
|
18013
|
-
context[:gem_version] = '1.
|
|
19203
|
+
context[:gem_version] = '1.161.0'
|
|
18014
19204
|
Seahorse::Client::Request.new(handlers, context)
|
|
18015
19205
|
end
|
|
18016
19206
|
|