aws-sdk-quicksight 1.160.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +1648 -444
- data/lib/aws-sdk-quicksight/client_api.rb +725 -0
- data/lib/aws-sdk-quicksight/types.rb +2715 -620
- 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
|
1385
|
+
# Creates Amazon Quick Sight customizations. Currently, you can add a
|
1386
1386
|
# custom default theme by using the `CreateAccountCustomization` or
|
1387
1387
|
# `UpdateAccountCustomization` API operation. To further customize
|
1388
|
-
#
|
1389
|
-
# users, see [Customizing
|
1390
|
-
# Guide.*
|
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,13 +1411,13 @@ 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
|
1420
|
+
# The Quick Sight customizations you're adding. You can add these to an
|
1421
1421
|
# Amazon Web Services account and a QuickSight namespace.
|
1422
1422
|
#
|
1423
1423
|
# For example, you can add a default theme by setting
|
@@ -1476,7 +1476,8 @@ module Aws::QuickSight
|
|
1476
1476
|
req.send_request(options)
|
1477
1477
|
end
|
1478
1478
|
|
1479
|
-
# Creates an
|
1479
|
+
# Creates an Amazon Quick Sight account, or subscribes to Amazon Quick
|
1480
|
+
# Sight Q.
|
1480
1481
|
#
|
1481
1482
|
# The Amazon Web Services Region for the account is derived from what is
|
1482
1483
|
# configured in the CLI or SDK.
|
@@ -1484,10 +1485,10 @@ module Aws::QuickSight
|
|
1484
1485
|
# Before you use this operation, make sure that you can connect to an
|
1485
1486
|
# existing Amazon Web Services account. If you don't have an Amazon Web
|
1486
1487
|
# Services account, see [Sign up for Amazon Web Services][1] in the
|
1487
|
-
# *Amazon
|
1488
|
-
# needs to have the correct Identity and Access Management
|
1489
|
-
# permissions. For more information, see [IAM Policy Examples for
|
1490
|
-
#
|
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*.
|
1491
1492
|
#
|
1492
1493
|
# If your IAM policy includes both the `Subscribe` and
|
1493
1494
|
# `CreateAccountSubscription` actions, make sure that both actions are
|
@@ -1496,15 +1497,15 @@ module Aws::QuickSight
|
|
1496
1497
|
#
|
1497
1498
|
# You can't pass an existing IAM role to access other Amazon Web
|
1498
1499
|
# Services services using this API operation. To pass your existing IAM
|
1499
|
-
# role to
|
1500
|
-
# *
|
1500
|
+
# role to Amazon Quick Sight, see [Passing IAM roles to Amazon Quick
|
1501
|
+
# Sight][3] in the *Amazon Quick Sight User Guide*.
|
1501
1502
|
#
|
1502
1503
|
# You can't set default resource access on the new account from the
|
1503
|
-
#
|
1504
|
-
#
|
1504
|
+
# Amazon Quick Sight API. Instead, add default resource access from the
|
1505
|
+
# Amazon Quick Sight console. For more information about setting default
|
1505
1506
|
# resource access to Amazon Web Services services, see [Setting default
|
1506
|
-
# resource access to Amazon Web Services services][4] in the *
|
1507
|
-
# User Guide*.
|
1507
|
+
# resource access to Amazon Web Services services][4] in the *Amazon
|
1508
|
+
# Quick Sight User Guide*.
|
1508
1509
|
#
|
1509
1510
|
#
|
1510
1511
|
#
|
@@ -1514,7 +1515,7 @@ module Aws::QuickSight
|
|
1514
1515
|
# [4]: https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html
|
1515
1516
|
#
|
1516
1517
|
# @option params [String] :edition
|
1517
|
-
# The edition of
|
1518
|
+
# The edition of Amazon Quick Sight that you want your account to have.
|
1518
1519
|
# Currently, you can choose from `ENTERPRISE` or `ENTERPRISE_AND_Q`.
|
1519
1520
|
#
|
1520
1521
|
# If you choose `ENTERPRISE_AND_Q`, the following parameters are
|
@@ -1529,7 +1530,7 @@ module Aws::QuickSight
|
|
1529
1530
|
# * `ContactNumber`
|
1530
1531
|
#
|
1531
1532
|
# @option params [required, String] :authentication_method
|
1532
|
-
# The method that you want to use to authenticate your
|
1533
|
+
# The method that you want to use to authenticate your Quick Sight
|
1533
1534
|
# account.
|
1534
1535
|
#
|
1535
1536
|
# If you choose `ACTIVE_DIRECTORY`, provide an `ActiveDirectoryName` and
|
@@ -1540,43 +1541,44 @@ module Aws::QuickSight
|
|
1540
1541
|
#
|
1541
1542
|
# @option params [required, String] :aws_account_id
|
1542
1543
|
# The Amazon Web Services account ID of the account that you're using
|
1543
|
-
# to create your
|
1544
|
+
# to create your Quick Sight account.
|
1544
1545
|
#
|
1545
1546
|
# @option params [required, String] :account_name
|
1546
|
-
# The name of your
|
1547
|
-
# Amazon Web Services, and it appears only when users sign in.
|
1548
|
-
# can't change `AccountName` value after the
|
1549
|
-
# 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.
|
1550
1551
|
#
|
1551
1552
|
# @option params [required, String] :notification_email
|
1552
|
-
# The email address that you want
|
1553
|
-
# 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.
|
1554
1555
|
#
|
1555
1556
|
# @option params [String] :active_directory_name
|
1556
1557
|
# The name of your Active Directory. This field is required if
|
1557
1558
|
# `ACTIVE_DIRECTORY` is the selected authentication method of the new
|
1558
|
-
#
|
1559
|
+
# Quick Sight account.
|
1559
1560
|
#
|
1560
1561
|
# @option params [String] :realm
|
1561
|
-
# The realm of the Active Directory that is associated with your
|
1562
|
-
#
|
1563
|
-
#
|
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.
|
1564
1565
|
#
|
1565
1566
|
# @option params [String] :directory_id
|
1566
|
-
# The ID of the Active Directory that is associated with your
|
1567
|
-
# account.
|
1567
|
+
# The ID of the Active Directory that is associated with your Quick
|
1568
|
+
# Sight account.
|
1568
1569
|
#
|
1569
1570
|
# @option params [Array<String>] :admin_group
|
1570
1571
|
# The admin group associated with your Active Directory or IAM Identity
|
1571
1572
|
# Center account. Either this field or the `AdminProGroup` field is
|
1572
1573
|
# required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
1573
|
-
# selected authentication method of the new
|
1574
|
+
# selected authentication method of the new Quick Sight account.
|
1574
1575
|
#
|
1575
|
-
# For more information about using IAM Identity Center in
|
1576
|
-
# see [Using IAM Identity Center with
|
1577
|
-
# in the
|
1578
|
-
#
|
1579
|
-
# 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.
|
1580
1582
|
#
|
1581
1583
|
#
|
1582
1584
|
#
|
@@ -1587,11 +1589,12 @@ module Aws::QuickSight
|
|
1587
1589
|
# The author group associated with your Active Directory or IAM Identity
|
1588
1590
|
# Center account.
|
1589
1591
|
#
|
1590
|
-
# For more information about using IAM Identity Center in
|
1591
|
-
# see [Using IAM Identity Center with
|
1592
|
-
# in the
|
1593
|
-
#
|
1594
|
-
# 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.
|
1595
1598
|
#
|
1596
1599
|
#
|
1597
1600
|
#
|
@@ -1602,11 +1605,12 @@ module Aws::QuickSight
|
|
1602
1605
|
# The reader group associated with your Active Directory or IAM Identity
|
1603
1606
|
# Center account.
|
1604
1607
|
#
|
1605
|
-
# For more information about using IAM Identity Center in
|
1606
|
-
# see [Using IAM Identity Center with
|
1607
|
-
# in the
|
1608
|
-
#
|
1609
|
-
# 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.
|
1610
1614
|
#
|
1611
1615
|
#
|
1612
1616
|
#
|
@@ -1617,13 +1621,14 @@ module Aws::QuickSight
|
|
1617
1621
|
# The admin pro group associated with your Active Directory or IAM
|
1618
1622
|
# Identity Center account. Either this field or the `AdminGroup` field
|
1619
1623
|
# is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the
|
1620
|
-
# selected authentication method of the new
|
1624
|
+
# selected authentication method of the new Quick Sight account.
|
1621
1625
|
#
|
1622
|
-
# For more information about using IAM Identity Center in
|
1623
|
-
# see [Using IAM Identity Center with
|
1624
|
-
# in the
|
1625
|
-
#
|
1626
|
-
# 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.
|
1627
1632
|
#
|
1628
1633
|
#
|
1629
1634
|
#
|
@@ -1634,11 +1639,12 @@ module Aws::QuickSight
|
|
1634
1639
|
# The author pro group associated with your Active Directory or IAM
|
1635
1640
|
# Identity Center account.
|
1636
1641
|
#
|
1637
|
-
# For more information about using IAM Identity Center in
|
1638
|
-
# see [Using IAM Identity Center with
|
1639
|
-
# in the
|
1640
|
-
#
|
1641
|
-
# 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.
|
1642
1648
|
#
|
1643
1649
|
#
|
1644
1650
|
#
|
@@ -1649,11 +1655,12 @@ module Aws::QuickSight
|
|
1649
1655
|
# The reader pro group associated with your Active Directory or IAM
|
1650
1656
|
# Identity Center account.
|
1651
1657
|
#
|
1652
|
-
# For more information about using IAM Identity Center in
|
1653
|
-
# see [Using IAM Identity Center with
|
1654
|
-
# in the
|
1655
|
-
#
|
1656
|
-
# 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.
|
1657
1664
|
#
|
1658
1665
|
#
|
1659
1666
|
#
|
@@ -1661,25 +1668,28 @@ module Aws::QuickSight
|
|
1661
1668
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
|
1662
1669
|
#
|
1663
1670
|
# @option params [String] :first_name
|
1664
|
-
# The first name of the author of the
|
1665
|
-
# future communications. This field is required if
|
1666
|
-
# 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.
|
1667
1675
|
#
|
1668
1676
|
# @option params [String] :last_name
|
1669
|
-
# The last name of the author of the
|
1670
|
-
# future communications. This field is required if
|
1671
|
-
# 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.
|
1672
1681
|
#
|
1673
1682
|
# @option params [String] :email_address
|
1674
|
-
# The email address of the author of the
|
1675
|
-
# future communications. This field is required if
|
1676
|
-
# 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.
|
1677
1687
|
#
|
1678
1688
|
# @option params [String] :contact_number
|
1679
|
-
# A 10-digit phone number for the author of the
|
1680
|
-
# use for future communications. This field is required if
|
1681
|
-
# `ENTERPPRISE_AND_Q` is the selected edition of the new
|
1682
|
-
# 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.
|
1683
1693
|
#
|
1684
1694
|
# @option params [String] :iam_identity_center_instance_arn
|
1685
1695
|
# The Amazon Resource Name (ARN) for the IAM Identity Center instance.
|
@@ -1732,7 +1742,142 @@ module Aws::QuickSight
|
|
1732
1742
|
req.send_request(options)
|
1733
1743
|
end
|
1734
1744
|
|
1735
|
-
# 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
|
1736
1881
|
# either from a template or from an `AnalysisDefinition`.
|
1737
1882
|
#
|
1738
1883
|
# @option params [required, String] :aws_account_id
|
@@ -1745,7 +1890,7 @@ module Aws::QuickSight
|
|
1745
1890
|
#
|
1746
1891
|
# @option params [required, String] :name
|
1747
1892
|
# A descriptive name for the analysis that you're creating. This name
|
1748
|
-
# displays for the analysis in the
|
1893
|
+
# displays for the analysis in the Amazon Quick Sight console.
|
1749
1894
|
#
|
1750
1895
|
# @option params [Types::Parameters] :parameters
|
1751
1896
|
# The parameter names and override values that you want to use. An
|
@@ -1771,8 +1916,8 @@ module Aws::QuickSight
|
|
1771
1916
|
#
|
1772
1917
|
# @option params [String] :theme_arn
|
1773
1918
|
# The ARN for the theme to apply to the analysis that you're creating.
|
1774
|
-
# To see the theme in the
|
1775
|
-
# access to it.
|
1919
|
+
# To see the theme in the Amazon Quick Sight console, make sure that you
|
1920
|
+
# have access to it.
|
1776
1921
|
#
|
1777
1922
|
# @option params [Array<Types::Tag>] :tags
|
1778
1923
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -1793,8 +1938,8 @@ module Aws::QuickSight
|
|
1793
1938
|
# errors.
|
1794
1939
|
#
|
1795
1940
|
# @option params [Array<String>] :folder_arns
|
1796
|
-
# When you create the analysis,
|
1797
|
-
# folders.
|
1941
|
+
# When you create the analysis, Amazon Quick Sight adds the analysis to
|
1942
|
+
# these folders.
|
1798
1943
|
#
|
1799
1944
|
# @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1800
1945
|
#
|
@@ -1821,7 +1966,7 @@ module Aws::QuickSight
|
|
1821
1966
|
req.send_request(options)
|
1822
1967
|
end
|
1823
1968
|
|
1824
|
-
# Creates an
|
1969
|
+
# Creates an Quick Sight brand.
|
1825
1970
|
#
|
1826
1971
|
# @option params [required, String] :aws_account_id
|
1827
1972
|
# The ID of the Amazon Web Services account that owns the brand.
|
@@ -1888,6 +2033,24 @@ module Aws::QuickSight
|
|
1888
2033
|
# background: "HexColor",
|
1889
2034
|
# },
|
1890
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
|
+
# },
|
1891
2054
|
# brand_element_style: {
|
1892
2055
|
# navbar_style: {
|
1893
2056
|
# global_navbar: {
|
@@ -1982,6 +2145,14 @@ module Aws::QuickSight
|
|
1982
2145
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
1983
2146
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
1984
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
|
1985
2156
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
1986
2157
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
1987
2158
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
@@ -2053,6 +2224,18 @@ module Aws::QuickSight
|
|
2053
2224
|
# include_content_in_scheduled_reports_email: "DENY", # accepts DENY
|
2054
2225
|
# dashboard: "DENY", # accepts DENY
|
2055
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
|
2056
2239
|
# },
|
2057
2240
|
# tags: [
|
2058
2241
|
# {
|
@@ -2081,12 +2264,12 @@ module Aws::QuickSight
|
|
2081
2264
|
# `DashboardDefinition`. To first create a template, see the `
|
2082
2265
|
# CreateTemplate ` API operation.
|
2083
2266
|
#
|
2084
|
-
# A dashboard is an entity in
|
2085
|
-
# reports, created from analyses. You can share
|
2086
|
-
# With the right permissions, you can create scheduled
|
2087
|
-
# from them. If you have the correct permissions, you can
|
2088
|
-
# dashboard from a template that exists in a different Amazon
|
2089
|
-
# 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.
|
2090
2273
|
#
|
2091
2274
|
# @option params [required, String] :aws_account_id
|
2092
2275
|
# The ID of the Amazon Web Services account where you want to create the
|
@@ -2119,7 +2302,7 @@ module Aws::QuickSight
|
|
2119
2302
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
2120
2303
|
# the Amazon Resource Name (ARN) of the source template. The
|
2121
2304
|
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
2122
|
-
# any
|
2305
|
+
# any Amazon Quick Sight-supported Amazon Web Services Region.
|
2123
2306
|
#
|
2124
2307
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
2125
2308
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -2140,9 +2323,9 @@ module Aws::QuickSight
|
|
2140
2323
|
#
|
2141
2324
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
2142
2325
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
2143
|
-
#
|
2144
|
-
# which can be used for ad hoc (one-time) filtering. This
|
2145
|
-
# `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.
|
2146
2329
|
#
|
2147
2330
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
2148
2331
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -2153,6 +2336,11 @@ module Aws::QuickSight
|
|
2153
2336
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
2154
2337
|
# by default.
|
2155
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
|
+
#
|
2156
2344
|
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
|
2157
2345
|
# be either `ENABLED` or `DISABLED`. The option to build an executive
|
2158
2346
|
# summary is disabled when this is set to `DISABLED`. This option is
|
@@ -2184,8 +2372,8 @@ module Aws::QuickSight
|
|
2184
2372
|
# errors.
|
2185
2373
|
#
|
2186
2374
|
# @option params [Array<String>] :folder_arns
|
2187
|
-
# When you create the dashboard,
|
2188
|
-
# folders.
|
2375
|
+
# When you create the dashboard, Amazon Quick Sight adds the dashboard
|
2376
|
+
# to these folders.
|
2189
2377
|
#
|
2190
2378
|
# @option params [Types::LinkSharingConfiguration] :link_sharing_configuration
|
2191
2379
|
# A structure that contains the permissions of a shareable link to the
|
@@ -2247,7 +2435,7 @@ module Aws::QuickSight
|
|
2247
2435
|
# Indicates whether you want to import the data into SPICE.
|
2248
2436
|
#
|
2249
2437
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
2250
|
-
# Groupings of columns that work together in certain
|
2438
|
+
# Groupings of columns that work together in certain Amazon Quick Sight
|
2251
2439
|
# features. Currently, only geospatial hierarchy is supported.
|
2252
2440
|
#
|
2253
2441
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -2281,8 +2469,8 @@ module Aws::QuickSight
|
|
2281
2469
|
# The parameter declarations of the dataset.
|
2282
2470
|
#
|
2283
2471
|
# @option params [Array<String>] :folder_arns
|
2284
|
-
# When you create the dataset,
|
2285
|
-
# folders.
|
2472
|
+
# When you create the dataset, Amazon Quick Sight adds the dataset to
|
2473
|
+
# these folders.
|
2286
2474
|
#
|
2287
2475
|
# @option params [Types::PerformanceConfiguration] :performance_configuration
|
2288
2476
|
# The configuration for the performance optimization of the dataset that
|
@@ -2572,32 +2760,32 @@ module Aws::QuickSight
|
|
2572
2760
|
# Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.
|
2573
2761
|
#
|
2574
2762
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
2575
|
-
# The parameters that
|
2576
|
-
# source.
|
2763
|
+
# The parameters that Amazon Quick Sight uses to connect to your
|
2764
|
+
# underlying source.
|
2577
2765
|
#
|
2578
2766
|
# @option params [Types::DataSourceCredentials] :credentials
|
2579
|
-
# The credentials
|
2580
|
-
# source. Currently, only credentials based on user name and
|
2581
|
-
# 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.
|
2582
2770
|
#
|
2583
2771
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
2584
2772
|
# A list of resource permissions on the data source.
|
2585
2773
|
#
|
2586
2774
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
2587
|
-
# Use this parameter only when you want
|
2775
|
+
# Use this parameter only when you want Amazon Quick Sight to use a VPC
|
2588
2776
|
# connection when connecting to your underlying source.
|
2589
2777
|
#
|
2590
2778
|
# @option params [Types::SslProperties] :ssl_properties
|
2591
|
-
# Secure Socket Layer (SSL) properties that apply when
|
2592
|
-
# connects to your underlying source.
|
2779
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon Quick
|
2780
|
+
# Sight connects to your underlying source.
|
2593
2781
|
#
|
2594
2782
|
# @option params [Array<Types::Tag>] :tags
|
2595
2783
|
# Contains a map of the key-value pairs for the resource tag or tags
|
2596
2784
|
# assigned to the data source.
|
2597
2785
|
#
|
2598
2786
|
# @option params [Array<String>] :folder_arns
|
2599
|
-
# When you create the data source,
|
2600
|
-
# these folders.
|
2787
|
+
# When you create the data source, Amazon Quick Sight adds the data
|
2788
|
+
# source to these folders.
|
2601
2789
|
#
|
2602
2790
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2603
2791
|
#
|
@@ -2613,7 +2801,7 @@ module Aws::QuickSight
|
|
2613
2801
|
# aws_account_id: "AwsAccountId", # required
|
2614
2802
|
# data_source_id: "ResourceId", # required
|
2615
2803
|
# name: "ResourceName", # required
|
2616
|
-
# 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
|
2617
2805
|
# data_source_parameters: {
|
2618
2806
|
# amazon_elasticsearch_parameters: {
|
2619
2807
|
# domain: "Domain", # required
|
@@ -2693,6 +2881,11 @@ module Aws::QuickSight
|
|
2693
2881
|
# },
|
2694
2882
|
# role_arn: "RoleArn",
|
2695
2883
|
# },
|
2884
|
+
# s3_knowledge_base_parameters: {
|
2885
|
+
# role_arn: "RoleArn",
|
2886
|
+
# bucket_url: "S3Bucket", # required
|
2887
|
+
# metadata_files_location: "MetadataFilesLocation",
|
2888
|
+
# },
|
2696
2889
|
# service_now_parameters: {
|
2697
2890
|
# site_base_url: "SiteBaseUrl", # required
|
2698
2891
|
# },
|
@@ -2775,6 +2968,22 @@ module Aws::QuickSight
|
|
2775
2968
|
# custom_connection_parameters: {
|
2776
2969
|
# connection_type: "String",
|
2777
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
|
+
# },
|
2778
2987
|
# },
|
2779
2988
|
# credentials: {
|
2780
2989
|
# credential_pair: {
|
@@ -2860,6 +3069,11 @@ module Aws::QuickSight
|
|
2860
3069
|
# },
|
2861
3070
|
# role_arn: "RoleArn",
|
2862
3071
|
# },
|
3072
|
+
# s3_knowledge_base_parameters: {
|
3073
|
+
# role_arn: "RoleArn",
|
3074
|
+
# bucket_url: "S3Bucket", # required
|
3075
|
+
# metadata_files_location: "MetadataFilesLocation",
|
3076
|
+
# },
|
2863
3077
|
# service_now_parameters: {
|
2864
3078
|
# site_base_url: "SiteBaseUrl", # required
|
2865
3079
|
# },
|
@@ -2942,11 +3156,31 @@ module Aws::QuickSight
|
|
2942
3156
|
# custom_connection_parameters: {
|
2943
3157
|
# connection_type: "String",
|
2944
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
|
+
# },
|
2945
3175
|
# },
|
2946
3176
|
# ],
|
2947
3177
|
# },
|
2948
3178
|
# copy_source_arn: "CopySourceArn",
|
2949
3179
|
# secret_arn: "SecretArn",
|
3180
|
+
# web_proxy_credentials: {
|
3181
|
+
# web_proxy_username: "DbUsername", # required
|
3182
|
+
# web_proxy_password: "Password", # required
|
3183
|
+
# },
|
2950
3184
|
# },
|
2951
3185
|
# permissions: [
|
2952
3186
|
# {
|
@@ -3112,7 +3346,7 @@ module Aws::QuickSight
|
|
3112
3346
|
req.send_request(options)
|
3113
3347
|
end
|
3114
3348
|
|
3115
|
-
# Use the `CreateGroup` operation to create a group in
|
3349
|
+
# Use the `CreateGroup` operation to create a group in Quick Sight. You
|
3116
3350
|
# can create up to 10,000 groups in a namespace. If you want to create
|
3117
3351
|
# more than 10,000 groups in a namespace, contact Amazon Web Services
|
3118
3352
|
# Support.
|
@@ -3132,7 +3366,7 @@ module Aws::QuickSight
|
|
3132
3366
|
# @option params [required, String] :aws_account_id
|
3133
3367
|
# The ID for the Amazon Web Services account that the group is in.
|
3134
3368
|
# Currently, you use the ID for the Amazon Web Services account that
|
3135
|
-
# contains your Amazon
|
3369
|
+
# contains your Amazon Quick Sight account.
|
3136
3370
|
#
|
3137
3371
|
# @option params [required, String] :namespace
|
3138
3372
|
# The namespace that you want the group to be a part of.
|
@@ -3170,7 +3404,7 @@ module Aws::QuickSight
|
|
3170
3404
|
req.send_request(options)
|
3171
3405
|
end
|
3172
3406
|
|
3173
|
-
# Adds an Amazon
|
3407
|
+
# Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
|
3174
3408
|
#
|
3175
3409
|
# @option params [required, String] :member_name
|
3176
3410
|
# The name of the user that you want to add to the group membership.
|
@@ -3181,7 +3415,7 @@ module Aws::QuickSight
|
|
3181
3415
|
# @option params [required, String] :aws_account_id
|
3182
3416
|
# The ID for the Amazon Web Services account that the group is in.
|
3183
3417
|
# Currently, you use the ID for the Amazon Web Services account that
|
3184
|
-
# contains your Amazon
|
3418
|
+
# contains your Amazon Quick Sight account.
|
3185
3419
|
#
|
3186
3420
|
# @option params [required, String] :namespace
|
3187
3421
|
# The namespace that you want the user to be a part of.
|
@@ -3219,13 +3453,13 @@ module Aws::QuickSight
|
|
3219
3453
|
|
3220
3454
|
# Creates an assignment with one specified IAM policy, identified by its
|
3221
3455
|
# Amazon Resource Name (ARN). This policy assignment is attached to the
|
3222
|
-
# specified groups or users of Amazon
|
3456
|
+
# specified groups or users of Amazon Quick Sight. Assignment names are
|
3223
3457
|
# unique per Amazon Web Services account. To avoid overwriting rules in
|
3224
3458
|
# other namespaces, use assignment names that are unique.
|
3225
3459
|
#
|
3226
3460
|
# @option params [required, String] :aws_account_id
|
3227
3461
|
# The ID of the Amazon Web Services account where you want to assign an
|
3228
|
-
# IAM policy to
|
3462
|
+
# IAM policy to Amazon Quick Sight users or groups.
|
3229
3463
|
#
|
3230
3464
|
# @option params [required, String] :assignment_name
|
3231
3465
|
# The name of the assignment, also called a rule. The name must be
|
@@ -3244,12 +3478,12 @@ module Aws::QuickSight
|
|
3244
3478
|
# when creating the data source.
|
3245
3479
|
#
|
3246
3480
|
# @option params [String] :policy_arn
|
3247
|
-
# The ARN for the IAM policy to apply to the
|
3248
|
-
# 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.
|
3249
3483
|
#
|
3250
3484
|
# @option params [Hash<String,Array>] :identities
|
3251
|
-
# The
|
3252
|
-
# policy to.
|
3485
|
+
# The Amazon Quick Sight users, groups, or both that you want to assign
|
3486
|
+
# the policy to.
|
3253
3487
|
#
|
3254
3488
|
# @option params [required, String] :namespace
|
3255
3489
|
# The namespace that contains the assignment.
|
@@ -3361,21 +3595,21 @@ module Aws::QuickSight
|
|
3361
3595
|
end
|
3362
3596
|
|
3363
3597
|
# (Enterprise edition only) Creates a new namespace for you to use with
|
3364
|
-
# Amazon
|
3365
|
-
#
|
3366
|
-
# A namespace allows you to isolate the
|
3367
|
-
# are registered for that namespace. Users that access the
|
3368
|
-
# share assets only with other users or groups in the same
|
3369
|
-
# They can't see users and groups in other namespaces. You
|
3370
|
-
# namespace after your Amazon Web Services account is
|
3371
|
-
#
|
3372
|
-
# Services account. By default, there is a limit of 100
|
3373
|
-
# Amazon Web Services account. To increase your limit,
|
3374
|
-
# 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.
|
3375
3609
|
#
|
3376
3610
|
# @option params [required, String] :aws_account_id
|
3377
3611
|
# The ID for the Amazon Web Services account that you want to create the
|
3378
|
-
#
|
3612
|
+
# Quick Sight namespace in.
|
3379
3613
|
#
|
3380
3614
|
# @option params [required, String] :namespace
|
3381
3615
|
# The name that you want to use to describe the new namespace.
|
@@ -3488,7 +3722,7 @@ module Aws::QuickSight
|
|
3488
3722
|
req.send_request(options)
|
3489
3723
|
end
|
3490
3724
|
|
3491
|
-
# Use `CreateRoleMembership` to add an existing
|
3725
|
+
# Use `CreateRoleMembership` to add an existing Quick Sight group to an
|
3492
3726
|
# existing role.
|
3493
3727
|
#
|
3494
3728
|
# @option params [required, String] :member_name
|
@@ -3497,8 +3731,8 @@ module Aws::QuickSight
|
|
3497
3731
|
# @option params [required, String] :aws_account_id
|
3498
3732
|
# The ID for the Amazon Web Services account that you want to create a
|
3499
3733
|
# group in. The Amazon Web Services account ID that you provide must be
|
3500
|
-
# the same Amazon Web Services account that contains your Amazon
|
3501
|
-
#
|
3734
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
3735
|
+
# Sight account.
|
3502
3736
|
#
|
3503
3737
|
# @option params [required, String] :namespace
|
3504
3738
|
# The namespace that the role belongs to.
|
@@ -3535,12 +3769,12 @@ module Aws::QuickSight
|
|
3535
3769
|
end
|
3536
3770
|
|
3537
3771
|
# Creates a template either from a `TemplateDefinition` or from an
|
3538
|
-
# existing
|
3772
|
+
# existing Quick Sight analysis or template. You can use the resulting
|
3539
3773
|
# template to create additional dashboards, templates, or analyses.
|
3540
3774
|
#
|
3541
|
-
# A *template* is an entity in
|
3542
|
-
# required to create an analysis and that you can use to create
|
3543
|
-
# 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
|
3544
3778
|
# placeholders to replace the dataset associated with the analysis. You
|
3545
3779
|
# can use templates to create dashboards by replacing dataset
|
3546
3780
|
# placeholders with datasets that follow the same schema that was used
|
@@ -3549,7 +3783,7 @@ module Aws::QuickSight
|
|
3549
3783
|
# @option params [required, String] :aws_account_id
|
3550
3784
|
# The ID for the Amazon Web Services account that the group is in. You
|
3551
3785
|
# use the ID for the Amazon Web Services account that contains your
|
3552
|
-
# Amazon
|
3786
|
+
# Amazon Quick Sight account.
|
3553
3787
|
#
|
3554
3788
|
# @option params [required, String] :template_id
|
3555
3789
|
# An ID for the template that you want to create. This template is
|
@@ -3570,7 +3804,7 @@ module Aws::QuickSight
|
|
3570
3804
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
3571
3805
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
3572
3806
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
3573
|
-
# any
|
3807
|
+
# any Quick Sight-supported Amazon Web Services Region.
|
3574
3808
|
#
|
3575
3809
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
3576
3810
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -3644,7 +3878,7 @@ module Aws::QuickSight
|
|
3644
3878
|
# @option params [required, String] :alias_name
|
3645
3879
|
# The name that you want to give to the template alias that you're
|
3646
3880
|
# creating. Don't start the alias name with the `$` character. Alias
|
3647
|
-
# names that start with `$` are reserved by
|
3881
|
+
# names that start with `$` are reserved by Quick Sight.
|
3648
3882
|
#
|
3649
3883
|
# @option params [required, Integer] :template_version_number
|
3650
3884
|
# The version number of the template.
|
@@ -3685,7 +3919,8 @@ module Aws::QuickSight
|
|
3685
3919
|
#
|
3686
3920
|
# A *theme* is set of configuration options for color and layout. Themes
|
3687
3921
|
# apply to analyses and dashboards. For more information, see [Using
|
3688
|
-
# Themes in Amazon
|
3922
|
+
# Themes in Amazon Quick Sight][1] in the *Amazon Quick Sight User
|
3923
|
+
# Guide*.
|
3689
3924
|
#
|
3690
3925
|
#
|
3691
3926
|
#
|
@@ -3704,7 +3939,7 @@ module Aws::QuickSight
|
|
3704
3939
|
#
|
3705
3940
|
# @option params [required, String] :base_theme_id
|
3706
3941
|
# The ID of the theme that a custom theme will inherit from. All themes
|
3707
|
-
# inherit from one of the starting themes defined by Amazon
|
3942
|
+
# inherit from one of the starting themes defined by Amazon Quick Sight.
|
3708
3943
|
# For a list of the starting themes, use `ListThemes` or choose
|
3709
3944
|
# **Themes** from within an analysis.
|
3710
3945
|
#
|
@@ -3832,7 +4067,7 @@ module Aws::QuickSight
|
|
3832
4067
|
# @option params [required, String] :alias_name
|
3833
4068
|
# The name that you want to give to the theme alias that you are
|
3834
4069
|
# creating. The alias name can't begin with a `$`. Alias names that
|
3835
|
-
# start with `$` are reserved by Amazon
|
4070
|
+
# start with `$` are reserved by Amazon Quick Sight.
|
3836
4071
|
#
|
3837
4072
|
# @option params [required, Integer] :theme_version_number
|
3838
4073
|
# The version number of the theme.
|
@@ -4333,7 +4568,7 @@ module Aws::QuickSight
|
|
4333
4568
|
req.send_request(options)
|
4334
4569
|
end
|
4335
4570
|
|
4336
|
-
# This API permanently deletes all
|
4571
|
+
# This API permanently deletes all Quick Sight customizations for the
|
4337
4572
|
# specified Amazon Web Services account and namespace. When you delete
|
4338
4573
|
# account customizations:
|
4339
4574
|
#
|
@@ -4342,22 +4577,22 @@ module Aws::QuickSight
|
|
4342
4577
|
#
|
4343
4578
|
# * This action cannot be undone through the API
|
4344
4579
|
#
|
4345
|
-
# * Users will see default
|
4580
|
+
# * Users will see default Quick Sight styling after customizations are
|
4346
4581
|
# deleted
|
4347
4582
|
#
|
4348
4583
|
# **Before proceeding:** Ensure you have backups of any custom themes
|
4349
4584
|
# or
|
4350
4585
|
# branding elements you may want to recreate.
|
4351
4586
|
#
|
4352
|
-
# Deletes all Amazon
|
4353
|
-
# Web Services account and
|
4587
|
+
# Deletes all Amazon Quick Sight customizations for the specified Amazon
|
4588
|
+
# Web Services account and Quick Sight namespace.
|
4354
4589
|
#
|
4355
4590
|
# @option params [required, String] :aws_account_id
|
4356
4591
|
# The ID for the Amazon Web Services account that you want to delete
|
4357
|
-
#
|
4592
|
+
# Quick Sight customizations from.
|
4358
4593
|
#
|
4359
4594
|
# @option params [String] :namespace
|
4360
|
-
# The
|
4595
|
+
# The Quick Sight namespace that you're deleting the customizations
|
4361
4596
|
# from.
|
4362
4597
|
#
|
4363
4598
|
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4386,13 +4621,13 @@ module Aws::QuickSight
|
|
4386
4621
|
req.send_request(options)
|
4387
4622
|
end
|
4388
4623
|
|
4389
|
-
# Deleting your
|
4624
|
+
# Deleting your Quick Sight account subscription has permanent,
|
4390
4625
|
# irreversible consequences across all Amazon Web Services regions:
|
4391
4626
|
#
|
4392
4627
|
# * Global deletion – Running this operation from any single region
|
4393
4628
|
# will
|
4394
|
-
# delete your
|
4395
|
-
# 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.
|
4396
4631
|
#
|
4397
4632
|
# * Complete data loss – All dashboards, analyses, datasets, data
|
4398
4633
|
# sources, and custom visuals will be permanently deleted across all
|
@@ -4406,18 +4641,18 @@ module Aws::QuickSight
|
|
4406
4641
|
# resources will become inaccessible to other users and external
|
4407
4642
|
# recipients.
|
4408
4643
|
#
|
4409
|
-
# * User access terminated – All
|
4644
|
+
# * User access terminated – All Quick Sight users in your account will
|
4410
4645
|
# lose access immediately, including authors, readers, and
|
4411
4646
|
# administrators.
|
4412
4647
|
#
|
4413
|
-
# * **No recovery possible** – Once deleted, your
|
4414
|
-
# all associated data cannot be restored.
|
4648
|
+
# * **No recovery possible** – Once deleted, your Quick Sight account
|
4649
|
+
# and all associated data cannot be restored.
|
4415
4650
|
#
|
4416
4651
|
# Consider exporting critical dashboards and data before proceeding
|
4417
4652
|
# with
|
4418
4653
|
# account deletion.
|
4419
4654
|
#
|
4420
|
-
# Use the `DeleteAccountSubscription` operation to delete an
|
4655
|
+
# Use the `DeleteAccountSubscription` operation to delete an Quick Sight
|
4421
4656
|
# account. This operation will result in an error message if you have
|
4422
4657
|
# configured your account termination protection settings to `True`. To
|
4423
4658
|
# change this setting and delete your account, call the
|
@@ -4454,12 +4689,55 @@ module Aws::QuickSight
|
|
4454
4689
|
req.send_request(options)
|
4455
4690
|
end
|
4456
4691
|
|
4457
|
-
#
|
4458
|
-
#
|
4459
|
-
#
|
4460
|
-
#
|
4461
|
-
#
|
4462
|
-
#
|
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.
|
4463
4741
|
#
|
4464
4742
|
# At any time before recovery window ends, you can use the
|
4465
4743
|
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
@@ -4468,8 +4746,9 @@ module Aws::QuickSight
|
|
4468
4746
|
# make a template from it.
|
4469
4747
|
#
|
4470
4748
|
# An analysis that's scheduled for deletion isn't accessible in the
|
4471
|
-
#
|
4472
|
-
# 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.
|
4473
4752
|
#
|
4474
4753
|
# @option params [required, String] :aws_account_id
|
4475
4754
|
# The ID of the Amazon Web Services account where you want to delete an
|
@@ -4479,10 +4758,10 @@ module Aws::QuickSight
|
|
4479
4758
|
# The ID of the analysis that you're deleting.
|
4480
4759
|
#
|
4481
4760
|
# @option params [Integer] :recovery_window_in_days
|
4482
|
-
# A value that specifies the number of days that
|
4483
|
-
# it deletes the analysis. You can't use this parameter
|
4484
|
-
# `ForceDeleteWithoutRecovery` option in the same API call. The
|
4485
|
-
# 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.
|
4486
4765
|
#
|
4487
4766
|
# @option params [Boolean] :force_delete_without_recovery
|
4488
4767
|
# This option defaults to the value `NoForceDeleteWithoutRecovery`. To
|
@@ -4523,7 +4802,7 @@ module Aws::QuickSight
|
|
4523
4802
|
req.send_request(options)
|
4524
4803
|
end
|
4525
4804
|
|
4526
|
-
# This API permanently deletes the specified
|
4805
|
+
# This API permanently deletes the specified Quick Sight brand. When you
|
4527
4806
|
# delete a brand:
|
4528
4807
|
#
|
4529
4808
|
# * The brand and all its associated branding elements are permanently
|
@@ -4537,7 +4816,7 @@ module Aws::QuickSight
|
|
4537
4816
|
# **Before proceeding:** Verify that the brand is no longer needed and
|
4538
4817
|
# consider the impact on any applications currently using this brand.
|
4539
4818
|
#
|
4540
|
-
# Deletes an
|
4819
|
+
# Deletes an Quick Sight brand.
|
4541
4820
|
#
|
4542
4821
|
# @option params [required, String] :aws_account_id
|
4543
4822
|
# The ID of the Amazon Web Services account that owns the brand.
|
@@ -4792,15 +5071,15 @@ module Aws::QuickSight
|
|
4792
5071
|
req.send_request(options)
|
4793
5072
|
end
|
4794
5073
|
|
4795
|
-
# Deletes a linked Amazon Q Business application from an
|
5074
|
+
# Deletes a linked Amazon Q Business application from an Quick Sight
|
4796
5075
|
# account
|
4797
5076
|
#
|
4798
5077
|
# @option params [required, String] :aws_account_id
|
4799
|
-
# The ID of the
|
5078
|
+
# The ID of the Quick Sight account that you want to disconnect from a
|
4800
5079
|
# Amazon Q Business application.
|
4801
5080
|
#
|
4802
5081
|
# @option params [String] :namespace
|
4803
|
-
# The
|
5082
|
+
# The Quick Sight namespace that you want to delete a linked Amazon Q
|
4804
5083
|
# Business application from. If this field is left blank, the Amazon Q
|
4805
5084
|
# Business application is deleted from the default namespace. Currently,
|
4806
5085
|
# the default namespace is the only valid value for this parameter.
|
@@ -4912,7 +5191,7 @@ module Aws::QuickSight
|
|
4912
5191
|
req.send_request(options)
|
4913
5192
|
end
|
4914
5193
|
|
4915
|
-
# Removes a user group from Amazon
|
5194
|
+
# Removes a user group from Amazon Quick Sight.
|
4916
5195
|
#
|
4917
5196
|
# @option params [required, String] :group_name
|
4918
5197
|
# The name of the group that you want to delete.
|
@@ -4920,7 +5199,7 @@ module Aws::QuickSight
|
|
4920
5199
|
# @option params [required, String] :aws_account_id
|
4921
5200
|
# The ID for the Amazon Web Services account that the group is in.
|
4922
5201
|
# Currently, you use the ID for the Amazon Web Services account that
|
4923
|
-
# contains your Amazon
|
5202
|
+
# contains your Amazon Quick Sight account.
|
4924
5203
|
#
|
4925
5204
|
# @option params [required, String] :namespace
|
4926
5205
|
# The namespace of the group that you want to delete.
|
@@ -4965,7 +5244,7 @@ module Aws::QuickSight
|
|
4965
5244
|
# @option params [required, String] :aws_account_id
|
4966
5245
|
# The ID for the Amazon Web Services account that the group is in.
|
4967
5246
|
# Currently, you use the ID for the Amazon Web Services account that
|
4968
|
-
# contains your Amazon
|
5247
|
+
# contains your Amazon Quick Sight account.
|
4969
5248
|
#
|
4970
5249
|
# @option params [required, String] :namespace
|
4971
5250
|
# The namespace of the group that you want to remove a user from.
|
@@ -5040,9 +5319,9 @@ module Aws::QuickSight
|
|
5040
5319
|
end
|
5041
5320
|
|
5042
5321
|
# Deletes all access scopes and authorized targets that are associated
|
5043
|
-
# with a service from the
|
5322
|
+
# with a service from the Quick Sight IAM Identity Center application.
|
5044
5323
|
#
|
5045
|
-
# This operation is only supported for
|
5324
|
+
# This operation is only supported for Quick Sight accounts that use IAM
|
5046
5325
|
# Identity Center.
|
5047
5326
|
#
|
5048
5327
|
# @option params [required, String] :aws_account_id
|
@@ -5087,7 +5366,7 @@ module Aws::QuickSight
|
|
5087
5366
|
#
|
5088
5367
|
# @option params [required, String] :aws_account_id
|
5089
5368
|
# The ID for the Amazon Web Services account that you want to delete the
|
5090
|
-
#
|
5369
|
+
# Quick Sight namespace from.
|
5091
5370
|
#
|
5092
5371
|
# @option params [required, String] :namespace
|
5093
5372
|
# The namespace that you want to delete.
|
@@ -5168,7 +5447,7 @@ module Aws::QuickSight
|
|
5168
5447
|
# @option params [required, String] :aws_account_id
|
5169
5448
|
# The ID for the Amazon Web Services account that the group is in.
|
5170
5449
|
# Currently, you use the ID for the Amazon Web Services account that
|
5171
|
-
# contains your Amazon
|
5450
|
+
# contains your Amazon Quick Sight account.
|
5172
5451
|
#
|
5173
5452
|
# @option params [required, String] :namespace
|
5174
5453
|
# The namespace that includes the role.
|
@@ -5211,8 +5490,8 @@ module Aws::QuickSight
|
|
5211
5490
|
# @option params [required, String] :aws_account_id
|
5212
5491
|
# The ID for the Amazon Web Services account that you want to create a
|
5213
5492
|
# group in. The Amazon Web Services account ID that you provide must be
|
5214
|
-
# the same Amazon Web Services account that contains your Amazon
|
5215
|
-
#
|
5493
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
5494
|
+
# Sight account.
|
5216
5495
|
#
|
5217
5496
|
# @option params [required, String] :namespace
|
5218
5497
|
# The namespace that contains the role.
|
@@ -5518,7 +5797,7 @@ module Aws::QuickSight
|
|
5518
5797
|
req.send_request(options)
|
5519
5798
|
end
|
5520
5799
|
|
5521
|
-
# Deletes the Amazon
|
5800
|
+
# Deletes the Amazon Quick Sight user that is associated with the
|
5522
5801
|
# identity of the IAM user or role that's making the call. The IAM user
|
5523
5802
|
# isn't deleted as a result of this call.
|
5524
5803
|
#
|
@@ -5528,7 +5807,7 @@ module Aws::QuickSight
|
|
5528
5807
|
# @option params [required, String] :aws_account_id
|
5529
5808
|
# The ID for the Amazon Web Services account that the user is in.
|
5530
5809
|
# Currently, you use the ID for the Amazon Web Services account that
|
5531
|
-
# contains your Amazon
|
5810
|
+
# contains your Amazon Quick Sight account.
|
5532
5811
|
#
|
5533
5812
|
# @option params [required, String] :namespace
|
5534
5813
|
# The namespace. Currently, you should set this to `default`.
|
@@ -5568,7 +5847,7 @@ module Aws::QuickSight
|
|
5568
5847
|
# @option params [required, String] :aws_account_id
|
5569
5848
|
# The ID for the Amazon Web Services account that the user is in.
|
5570
5849
|
# Currently, you use the ID for the Amazon Web Services account that
|
5571
|
-
# contains your Amazon
|
5850
|
+
# contains your Amazon Quick Sight account.
|
5572
5851
|
#
|
5573
5852
|
# @option params [required, String] :namespace
|
5574
5853
|
# The namespace. Currently, you should set this to `default`.
|
@@ -5720,7 +5999,7 @@ module Aws::QuickSight
|
|
5720
5999
|
end
|
5721
6000
|
|
5722
6001
|
# Describes the customizations associated with the provided Amazon Web
|
5723
|
-
# Services account and Amazon
|
6002
|
+
# Services account and Amazon Quick Sight namespace. The Quick Sight
|
5724
6003
|
# console evaluates which customizations to apply by running this API
|
5725
6004
|
# operation with the `Resolved` flag included.
|
5726
6005
|
#
|
@@ -5730,15 +6009,15 @@ module Aws::QuickSight
|
|
5730
6009
|
# * `Amazon Web Services account` - The Amazon Web Services account
|
5731
6010
|
# exists at the top of the hierarchy. It has the potential to use all
|
5732
6011
|
# of the Amazon Web Services Regions and Amazon Web Services Services.
|
5733
|
-
# When you subscribe to
|
5734
|
-
# Region to use as your home Region. That's where your free
|
5735
|
-
# capacity is located. You can use
|
5736
|
-
# Web Services Region.
|
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.
|
5737
6016
|
#
|
5738
|
-
# * `Amazon Web Services Region` - You can sign in to
|
6017
|
+
# * `Amazon Web Services Region` - You can sign in to Quick Sight in any
|
5739
6018
|
# Amazon Web Services Region. If you have a user directory, it resides
|
5740
6019
|
# in us-east-1, which is US East (N. Virginia). Generally speaking,
|
5741
|
-
# these users have access to
|
6020
|
+
# these users have access to Quick Sight in any Amazon Web Services
|
5742
6021
|
# Region, unless they are constrained to a namespace.
|
5743
6022
|
#
|
5744
6023
|
# To run the command in a different Amazon Web Services Region, you
|
@@ -5752,7 +6031,7 @@ module Aws::QuickSight
|
|
5752
6031
|
# * Run `aws configure` to change your default Amazon Web Services
|
5753
6032
|
# Region. Use Enter to key the same settings for your keys. For more
|
5754
6033
|
# information, see [Configuring the CLI][3].
|
5755
|
-
# * `Namespace` - A
|
6034
|
+
# * `Namespace` - A Quick Sight namespace is a partition that contains
|
5756
6035
|
# users and assets (data sources, datasets, dashboards, and so on). To
|
5757
6036
|
# access assets that are in a specific namespace, users and groups
|
5758
6037
|
# must also be part of the same namespace. People who share a
|
@@ -5760,8 +6039,8 @@ module Aws::QuickSight
|
|
5760
6039
|
# namespaces, even if they are in the same Amazon Web Services account
|
5761
6040
|
# and Amazon Web Services Region.
|
5762
6041
|
#
|
5763
|
-
# * `Applied customizations` -
|
5764
|
-
# Amazon Web Services account or to a namespace. Settings that you
|
6042
|
+
# * `Applied customizations` - Quick Sight customizations can apply to
|
6043
|
+
# an Amazon Web Services account or to a namespace. Settings that you
|
5765
6044
|
# apply to a namespace override settings that you apply to an Amazon
|
5766
6045
|
# Web Services account.
|
5767
6046
|
#
|
@@ -5773,16 +6052,16 @@ module Aws::QuickSight
|
|
5773
6052
|
#
|
5774
6053
|
# @option params [required, String] :aws_account_id
|
5775
6054
|
# The ID for the Amazon Web Services account that you want to describe
|
5776
|
-
#
|
6055
|
+
# Quick Sight customizations for.
|
5777
6056
|
#
|
5778
6057
|
# @option params [String] :namespace
|
5779
|
-
# The
|
6058
|
+
# The Quick Sight namespace that you want to describe Quick Sight
|
5780
6059
|
# customizations for.
|
5781
6060
|
#
|
5782
6061
|
# @option params [Boolean] :resolved
|
5783
6062
|
# The `Resolved` flag works with the other parameters to determine which
|
5784
|
-
# view of
|
5785
|
-
# 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
|
5786
6065
|
# which customizations to apply to the console. Omit this flag, or set
|
5787
6066
|
# it to `no-resolved`, to reveal customizations that are configured at
|
5788
6067
|
# different levels.
|
@@ -5823,7 +6102,7 @@ module Aws::QuickSight
|
|
5823
6102
|
req.send_request(options)
|
5824
6103
|
end
|
5825
6104
|
|
5826
|
-
# Describes the settings that were used when your
|
6105
|
+
# Describes the settings that were used when your Quick Sight
|
5827
6106
|
# subscription was first created in this Amazon Web Services account.
|
5828
6107
|
#
|
5829
6108
|
# @option params [required, String] :aws_account_id
|
@@ -5863,13 +6142,13 @@ module Aws::QuickSight
|
|
5863
6142
|
end
|
5864
6143
|
|
5865
6144
|
# Use the DescribeAccountSubscription operation to receive a description
|
5866
|
-
# of an
|
6145
|
+
# of an Quick Sight account's subscription. A successful API call
|
5867
6146
|
# returns an `AccountInfo` object that includes an account's name,
|
5868
6147
|
# subscription status, authentication type, edition, and notification
|
5869
6148
|
# email address.
|
5870
6149
|
#
|
5871
6150
|
# @option params [required, String] :aws_account_id
|
5872
|
-
# The Amazon Web Services account ID associated with your
|
6151
|
+
# The Amazon Web Services account ID associated with your Quick Sight
|
5873
6152
|
# account.
|
5874
6153
|
#
|
5875
6154
|
# @return [Types::DescribeAccountSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -5904,6 +6183,120 @@ module Aws::QuickSight
|
|
5904
6183
|
req.send_request(options)
|
5905
6184
|
end
|
5906
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
|
+
|
5907
6300
|
# Provides a summary of the metadata for an analysis.
|
5908
6301
|
#
|
5909
6302
|
# @option params [required, String] :aws_account_id
|
@@ -6321,6 +6714,9 @@ module Aws::QuickSight
|
|
6321
6714
|
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
6322
6715
|
# resp.override_parameters.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
6323
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
|
6324
6720
|
# resp.override_parameters.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
|
6325
6721
|
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
|
6326
6722
|
# resp.override_parameters.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
|
@@ -6367,6 +6763,16 @@ module Aws::QuickSight
|
|
6367
6763
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.database #=> String
|
6368
6764
|
# resp.override_parameters.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
6369
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
|
6370
6776
|
# resp.override_parameters.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
6371
6777
|
# resp.override_parameters.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
6372
6778
|
# resp.override_parameters.data_sources[0].credentials.credential_pair.username #=> String
|
@@ -6574,6 +6980,14 @@ module Aws::QuickSight
|
|
6574
6980
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
6575
6981
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
6576
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
|
6577
6991
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
6578
6992
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
6579
6993
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
@@ -6696,6 +7110,14 @@ module Aws::QuickSight
|
|
6696
7110
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
6697
7111
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
6698
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
|
6699
7121
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
6700
7122
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
6701
7123
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
@@ -6767,6 +7189,18 @@ module Aws::QuickSight
|
|
6767
7189
|
# resp.custom_permissions.capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
|
6768
7190
|
# resp.custom_permissions.capabilities.dashboard #=> String, one of "DENY"
|
6769
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"
|
6770
7204
|
# resp.request_id #=> String
|
6771
7205
|
#
|
6772
7206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeCustomPermissions AWS API Documentation
|
@@ -7472,7 +7906,7 @@ module Aws::QuickSight
|
|
7472
7906
|
# resp.data_source.arn #=> String
|
7473
7907
|
# resp.data_source.data_source_id #=> String
|
7474
7908
|
# resp.data_source.name #=> String
|
7475
|
-
# 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"
|
7476
7910
|
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
7477
7911
|
# resp.data_source.created_time #=> Time
|
7478
7912
|
# resp.data_source.last_updated_time #=> Time
|
@@ -7519,6 +7953,9 @@ module Aws::QuickSight
|
|
7519
7953
|
# resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
7520
7954
|
# resp.data_source.data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
7521
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
|
7522
7959
|
# resp.data_source.data_source_parameters.service_now_parameters.site_base_url #=> String
|
7523
7960
|
# resp.data_source.data_source_parameters.snowflake_parameters.host #=> String
|
7524
7961
|
# resp.data_source.data_source_parameters.snowflake_parameters.database #=> String
|
@@ -7565,6 +8002,16 @@ module Aws::QuickSight
|
|
7565
8002
|
# resp.data_source.data_source_parameters.impala_parameters.database #=> String
|
7566
8003
|
# resp.data_source.data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
7567
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
|
7568
8015
|
# resp.data_source.alternate_data_source_parameters #=> Array
|
7569
8016
|
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
7570
8017
|
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -7609,6 +8056,9 @@ module Aws::QuickSight
|
|
7609
8056
|
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
7610
8057
|
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
7611
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
|
7612
8062
|
# resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
7613
8063
|
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
7614
8064
|
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
@@ -7655,6 +8105,16 @@ module Aws::QuickSight
|
|
7655
8105
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.database #=> String
|
7656
8106
|
# resp.data_source.alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
|
7657
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
|
7658
8118
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
7659
8119
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
7660
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"
|
@@ -7716,15 +8176,15 @@ module Aws::QuickSight
|
|
7716
8176
|
req.send_request(options)
|
7717
8177
|
end
|
7718
8178
|
|
7719
|
-
# Describes a Amazon Q Business application that is linked to an
|
7720
|
-
#
|
8179
|
+
# Describes a Amazon Q Business application that is linked to an Quick
|
8180
|
+
# Sight account.
|
7721
8181
|
#
|
7722
8182
|
# @option params [required, String] :aws_account_id
|
7723
|
-
# The ID of the
|
8183
|
+
# The ID of the Quick Sight account that is linked to the Amazon Q
|
7724
8184
|
# Business application that you want described.
|
7725
8185
|
#
|
7726
8186
|
# @option params [String] :namespace
|
7727
|
-
# The
|
8187
|
+
# The Quick Sight namespace that contains the linked Amazon Q Business
|
7728
8188
|
# application. If this field is left blank, the default namespace is
|
7729
8189
|
# used. Currently, the default namespace is the only valid value for
|
7730
8190
|
# this parameter.
|
@@ -7921,7 +8381,7 @@ module Aws::QuickSight
|
|
7921
8381
|
req.send_request(options)
|
7922
8382
|
end
|
7923
8383
|
|
7924
|
-
# Returns an Amazon
|
8384
|
+
# Returns an Amazon Quick Sight group's description and Amazon Resource
|
7925
8385
|
# Name (ARN).
|
7926
8386
|
#
|
7927
8387
|
# @option params [required, String] :group_name
|
@@ -7930,7 +8390,7 @@ module Aws::QuickSight
|
|
7930
8390
|
# @option params [required, String] :aws_account_id
|
7931
8391
|
# The ID for the Amazon Web Services account that the group is in.
|
7932
8392
|
# Currently, you use the ID for the Amazon Web Services account that
|
7933
|
-
# contains your Amazon
|
8393
|
+
# contains your Amazon Quick Sight account.
|
7934
8394
|
#
|
7935
8395
|
# @option params [required, String] :namespace
|
7936
8396
|
# The namespace of the group that you want described.
|
@@ -7980,7 +8440,7 @@ module Aws::QuickSight
|
|
7980
8440
|
# @option params [required, String] :aws_account_id
|
7981
8441
|
# The ID for the Amazon Web Services account that the group is in.
|
7982
8442
|
# Currently, you use the ID for the Amazon Web Services account that
|
7983
|
-
# contains your Amazon
|
8443
|
+
# contains your Amazon Quick Sight account.
|
7984
8444
|
#
|
7985
8445
|
# @option params [required, String] :namespace
|
7986
8446
|
# The namespace that includes the group you are searching within.
|
@@ -8162,7 +8622,7 @@ module Aws::QuickSight
|
|
8162
8622
|
req.send_request(options)
|
8163
8623
|
end
|
8164
8624
|
|
8165
|
-
# Describes all customer managed key registrations in a
|
8625
|
+
# Describes all customer managed key registrations in a Quick Sight
|
8166
8626
|
# account.
|
8167
8627
|
#
|
8168
8628
|
# @option params [required, String] :aws_account_id
|
@@ -8210,8 +8670,8 @@ module Aws::QuickSight
|
|
8210
8670
|
# Describes the current namespace.
|
8211
8671
|
#
|
8212
8672
|
# @option params [required, String] :aws_account_id
|
8213
|
-
# The ID for the Amazon Web Services account that contains the
|
8214
|
-
#
|
8673
|
+
# The ID for the Amazon Web Services account that contains the Quick
|
8674
|
+
# Sight namespace that you want to describe.
|
8215
8675
|
#
|
8216
8676
|
# @option params [required, String] :namespace
|
8217
8677
|
# The namespace that you want to describe.
|
@@ -8285,11 +8745,11 @@ module Aws::QuickSight
|
|
8285
8745
|
req.send_request(options)
|
8286
8746
|
end
|
8287
8747
|
|
8288
|
-
# Describes the state of a
|
8748
|
+
# Describes the state of a Quick Sight Q Search configuration.
|
8289
8749
|
#
|
8290
8750
|
# @option params [required, String] :aws_account_id
|
8291
|
-
# The ID of the Amazon Web Services account that contains the
|
8292
|
-
# 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.
|
8293
8753
|
#
|
8294
8754
|
# @return [Types::DescribeQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8295
8755
|
#
|
@@ -8376,8 +8836,8 @@ module Aws::QuickSight
|
|
8376
8836
|
# @option params [required, String] :aws_account_id
|
8377
8837
|
# The ID for the Amazon Web Services account that you want to create a
|
8378
8838
|
# group in. The Amazon Web Services account ID that you provide must be
|
8379
|
-
# the same Amazon Web Services account that contains your Amazon
|
8380
|
-
#
|
8839
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
8840
|
+
# Sight account.
|
8381
8841
|
#
|
8382
8842
|
# @option params [required, String] :namespace
|
8383
8843
|
# The namespace that contains the role.
|
@@ -9205,7 +9665,7 @@ module Aws::QuickSight
|
|
9205
9665
|
# @option params [required, String] :aws_account_id
|
9206
9666
|
# The ID for the Amazon Web Services account that the user is in.
|
9207
9667
|
# Currently, you use the ID for the Amazon Web Services account that
|
9208
|
-
# contains your Amazon
|
9668
|
+
# contains your Amazon Quick Sight account.
|
9209
9669
|
#
|
9210
9670
|
# @option params [required, String] :namespace
|
9211
9671
|
# The namespace. Currently, you should set this to `default`.
|
@@ -9347,9 +9807,9 @@ module Aws::QuickSight
|
|
9347
9807
|
# \[15-600\] minutes range.
|
9348
9808
|
#
|
9349
9809
|
# @option params [required, String] :namespace
|
9350
|
-
# The
|
9351
|
-
# If you are not using an Amazon QuickSight custom
|
9352
|
-
# 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`.
|
9353
9813
|
#
|
9354
9814
|
# @option params [Array<Types::SessionTag>] :session_tags
|
9355
9815
|
# The session tags used for row-level security. Before you use this
|
@@ -9359,15 +9819,15 @@ module Aws::QuickSight
|
|
9359
9819
|
#
|
9360
9820
|
# These are not the tags used for the Amazon Web Services resource
|
9361
9821
|
# tagging feature. For more information, see [Using Row-Level Security
|
9362
|
-
# (RLS) with Tags][1]in the *Amazon
|
9822
|
+
# (RLS) with Tags][1]in the *Amazon Quick Sight User Guide*.
|
9363
9823
|
#
|
9364
9824
|
#
|
9365
9825
|
#
|
9366
9826
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
|
9367
9827
|
#
|
9368
9828
|
# @option params [required, Array<String>] :authorized_resource_arns
|
9369
|
-
# The Amazon Resource Names (ARNs) for the
|
9370
|
-
# 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.
|
9371
9831
|
#
|
9372
9832
|
# If you choose `Dashboard` embedding experience, pass the list of
|
9373
9833
|
# dashboard ARNs in the account that you want the user to be able to
|
@@ -9384,10 +9844,10 @@ module Aws::QuickSight
|
|
9384
9844
|
# @option params [Array<String>] :allowed_domains
|
9385
9845
|
# The domains that you want to add to the allow list for access to the
|
9386
9846
|
# generated URL that is then embedded. This optional parameter overrides
|
9387
|
-
# the static domains that are configured in the Manage
|
9388
|
-
# in the
|
9389
|
-
# you include in this parameter. You can list up to three domains
|
9390
|
-
# 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.
|
9391
9851
|
#
|
9392
9852
|
# To include all subdomains under a specific domain to the allow list,
|
9393
9853
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
@@ -9504,17 +9964,17 @@ module Aws::QuickSight
|
|
9504
9964
|
#
|
9505
9965
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
9506
9966
|
# The experience that you want to embed. For registered users, you can
|
9507
|
-
# embed QuickSight dashboards,
|
9508
|
-
# search bar, the
|
9509
|
-
# 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.
|
9510
9970
|
#
|
9511
9971
|
# @option params [Array<String>] :allowed_domains
|
9512
9972
|
# The domains that you want to add to the allow list for access to the
|
9513
9973
|
# generated URL that is then embedded. This optional parameter overrides
|
9514
|
-
# the static domains that are configured in the Manage
|
9515
|
-
# in the
|
9516
|
-
# you include in this parameter. You can list up to three domains
|
9517
|
-
# 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.
|
9518
9978
|
#
|
9519
9979
|
# To include all subdomains under a specific domain to the allow list,
|
9520
9980
|
# use `*`. For example, `https://*.sapp.amazon.com` includes all
|
@@ -9627,9 +10087,9 @@ module Aws::QuickSight
|
|
9627
10087
|
req.send_request(options)
|
9628
10088
|
end
|
9629
10089
|
|
9630
|
-
# 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
|
9631
10091
|
# experience in your website. This action can be used for any type of
|
9632
|
-
# user that is registered in an
|
10092
|
+
# user that is registered in an Amazon Quick Sight account that uses IAM
|
9633
10093
|
# Identity Center for authentication. This API requires
|
9634
10094
|
# [identity-enhanced IAM Role sessions][1] for the authenticated user
|
9635
10095
|
# that the API call is being made for.
|
@@ -9638,9 +10098,9 @@ module Aws::QuickSight
|
|
9638
10098
|
# user is authenticated and receives the embed URL that is specific to
|
9639
10099
|
# that user. The IAM Identity Center application that the user has
|
9640
10100
|
# logged into needs to have [trusted Identity Propagation enabled for
|
9641
|
-
#
|
9642
|
-
# you use this action, make sure that you have configured the
|
9643
|
-
#
|
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.
|
9644
10104
|
#
|
9645
10105
|
#
|
9646
10106
|
#
|
@@ -9656,7 +10116,7 @@ module Aws::QuickSight
|
|
9656
10116
|
#
|
9657
10117
|
# @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
|
9658
10118
|
# The type of experience you want to embed. For registered users, you
|
9659
|
-
# can embed QuickSight dashboards or the
|
10119
|
+
# can embed QuickSight dashboards or the Amazon Quick Sight console.
|
9660
10120
|
#
|
9661
10121
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
9662
10122
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
@@ -9774,9 +10234,9 @@ module Aws::QuickSight
|
|
9774
10234
|
end
|
9775
10235
|
|
9776
10236
|
# Generates a temporary session URL and authorization code(bearer token)
|
9777
|
-
# that you can use to embed an
|
9778
|
-
# website or application. Before you use this command, make sure
|
9779
|
-
# 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.
|
9780
10240
|
#
|
9781
10241
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
9782
10242
|
# not from the user's browser. The following rules apply to the
|
@@ -9834,11 +10294,11 @@ module Aws::QuickSight
|
|
9834
10294
|
# Adds persistence of state for the user session in an embedded
|
9835
10295
|
# dashboard. Persistence applies to the sheet and the parameter
|
9836
10296
|
# settings. These are control settings that the dashboard subscriber
|
9837
|
-
# (
|
9838
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
9839
|
-
# the same dashboard URL. The state is stored in
|
9840
|
-
# browser cookie. If this is set to FALSE, the state of
|
9841
|
-
# 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`.
|
9842
10302
|
#
|
9843
10303
|
# @option params [String] :user_arn
|
9844
10304
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -9858,9 +10318,9 @@ module Aws::QuickSight
|
|
9858
10318
|
# role-based sessions.
|
9859
10319
|
#
|
9860
10320
|
# @option params [String] :namespace
|
9861
|
-
# The
|
9862
|
-
# request. If you're not using a custom namespace, set `Namespace
|
9863
|
-
# 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`.
|
9864
10324
|
#
|
9865
10325
|
# @option params [Array<String>] :additional_dashboard_ids
|
9866
10326
|
# A list of one or more dashboard IDs that you want anonymous users to
|
@@ -9906,15 +10366,113 @@ module Aws::QuickSight
|
|
9906
10366
|
req.send_request(options)
|
9907
10367
|
end
|
9908
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
|
+
|
9909
10467
|
# Generates a session URL and authorization code that you can use to
|
9910
|
-
# embed the Amazon
|
9911
|
-
# `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
|
9912
10470
|
# that allows users to create data sources, datasets, analyses, and
|
9913
|
-
# dashboards. The users who access an embedded
|
9914
|
-
# belong to the author or admin security cohort. If you
|
9915
|
-
# permissions to some of these features, add a custom
|
9916
|
-
# profile to the user with the ` UpdateUser ` API operation.
|
9917
|
-
# 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
|
9918
10476
|
# permission profile attached. For more information, see the following
|
9919
10477
|
# sections in the *Amazon QuickSight User Guide*:
|
9920
10478
|
#
|
@@ -9928,8 +10486,8 @@ module Aws::QuickSight
|
|
9928
10486
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
9929
10487
|
#
|
9930
10488
|
# @option params [required, String] :aws_account_id
|
9931
|
-
# The ID for the Amazon Web Services account associated with your
|
9932
|
-
#
|
10489
|
+
# The ID for the Amazon Web Services account associated with your Amazon
|
10490
|
+
# Quick Sight subscription.
|
9933
10491
|
#
|
9934
10492
|
# @option params [String] :entry_point
|
9935
10493
|
# The URL you use to access the embedded session. The entry point URL is
|
@@ -9944,10 +10502,10 @@ module Aws::QuickSight
|
|
9944
10502
|
# * `/start/favorites`
|
9945
10503
|
#
|
9946
10504
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
9947
|
-
# key from the
|
10505
|
+
# key from the Amazon Quick Sight console URL of the dashboard
|
9948
10506
|
#
|
9949
10507
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
9950
|
-
# from the
|
10508
|
+
# from the Amazon Quick Sight console URL of the analysis
|
9951
10509
|
#
|
9952
10510
|
# @option params [Integer] :session_lifetime_in_minutes
|
9953
10511
|
# How many minutes the session is valid. The session lifetime must be
|
@@ -10000,7 +10558,65 @@ module Aws::QuickSight
|
|
10000
10558
|
req.send_request(options)
|
10001
10559
|
end
|
10002
10560
|
|
10003
|
-
# 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
|
10004
10620
|
# Web Services account.
|
10005
10621
|
#
|
10006
10622
|
# @option params [required, String] :aws_account_id
|
@@ -10164,7 +10780,7 @@ module Aws::QuickSight
|
|
10164
10780
|
req.send_request(options)
|
10165
10781
|
end
|
10166
10782
|
|
10167
|
-
# Lists all brands in an
|
10783
|
+
# Lists all brands in an Quick Sight account.
|
10168
10784
|
#
|
10169
10785
|
# @option params [required, String] :aws_account_id
|
10170
10786
|
# The ID of the Amazon Web Services account that owns the brands that
|
@@ -10274,6 +10890,18 @@ module Aws::QuickSight
|
|
10274
10890
|
# resp.custom_permissions_list[0].capabilities.include_content_in_scheduled_reports_email #=> String, one of "DENY"
|
10275
10891
|
# resp.custom_permissions_list[0].capabilities.dashboard #=> String, one of "DENY"
|
10276
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"
|
10277
10905
|
# resp.next_token #=> String
|
10278
10906
|
# resp.request_id #=> String
|
10279
10907
|
#
|
@@ -10286,7 +10914,7 @@ module Aws::QuickSight
|
|
10286
10914
|
req.send_request(options)
|
10287
10915
|
end
|
10288
10916
|
|
10289
|
-
# Lists all the versions of the dashboards in the
|
10917
|
+
# Lists all the versions of the dashboards in the Amazon Quick Sight
|
10290
10918
|
# subscription.
|
10291
10919
|
#
|
10292
10920
|
# @option params [required, String] :aws_account_id
|
@@ -10495,7 +11123,7 @@ module Aws::QuickSight
|
|
10495
11123
|
# resp.data_sources[0].arn #=> String
|
10496
11124
|
# resp.data_sources[0].data_source_id #=> String
|
10497
11125
|
# resp.data_sources[0].name #=> String
|
10498
|
-
# 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"
|
10499
11127
|
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
10500
11128
|
# resp.data_sources[0].created_time #=> Time
|
10501
11129
|
# resp.data_sources[0].last_updated_time #=> Time
|
@@ -10542,6 +11170,9 @@ module Aws::QuickSight
|
|
10542
11170
|
# resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.bucket #=> String
|
10543
11171
|
# resp.data_sources[0].data_source_parameters.s3_parameters.manifest_file_location.key #=> String
|
10544
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
|
10545
11176
|
# resp.data_sources[0].data_source_parameters.service_now_parameters.site_base_url #=> String
|
10546
11177
|
# resp.data_sources[0].data_source_parameters.snowflake_parameters.host #=> String
|
10547
11178
|
# resp.data_sources[0].data_source_parameters.snowflake_parameters.database #=> String
|
@@ -10588,6 +11219,16 @@ module Aws::QuickSight
|
|
10588
11219
|
# resp.data_sources[0].data_source_parameters.impala_parameters.database #=> String
|
10589
11220
|
# resp.data_sources[0].data_source_parameters.impala_parameters.sql_endpoint_path #=> String
|
10590
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
|
10591
11232
|
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
10592
11233
|
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
10593
11234
|
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -10632,6 +11273,9 @@ module Aws::QuickSight
|
|
10632
11273
|
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
10633
11274
|
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
10634
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
|
10635
11279
|
# resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
10636
11280
|
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
10637
11281
|
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
@@ -10678,6 +11322,16 @@ module Aws::QuickSight
|
|
10678
11322
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.database #=> String
|
10679
11323
|
# resp.data_sources[0].alternate_data_source_parameters[0].impala_parameters.sql_endpoint_path #=> String
|
10680
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
|
10681
11335
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
10682
11336
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
10683
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"
|
@@ -10696,6 +11350,65 @@ module Aws::QuickSight
|
|
10696
11350
|
req.send_request(options)
|
10697
11351
|
end
|
10698
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
|
+
|
10699
11412
|
# List all assets (`DASHBOARD`, `ANALYSIS`, and `DATASET`) in a folder.
|
10700
11413
|
#
|
10701
11414
|
# @option params [required, String] :aws_account_id
|
@@ -10864,7 +11577,7 @@ module Aws::QuickSight
|
|
10864
11577
|
# @option params [required, String] :aws_account_id
|
10865
11578
|
# The ID for the Amazon Web Services account that the group is in.
|
10866
11579
|
# Currently, you use the ID for the Amazon Web Services account that
|
10867
|
-
# contains your Amazon
|
11580
|
+
# contains your Amazon Quick Sight account.
|
10868
11581
|
#
|
10869
11582
|
# @option params [required, String] :namespace
|
10870
11583
|
# The namespace of the group that you want a list of users from.
|
@@ -10906,12 +11619,12 @@ module Aws::QuickSight
|
|
10906
11619
|
req.send_request(options)
|
10907
11620
|
end
|
10908
11621
|
|
10909
|
-
# Lists all user groups in Amazon
|
11622
|
+
# Lists all user groups in Amazon Quick Sight.
|
10910
11623
|
#
|
10911
11624
|
# @option params [required, String] :aws_account_id
|
10912
11625
|
# The ID for the Amazon Web Services account that the group is in.
|
10913
11626
|
# Currently, you use the ID for the Amazon Web Services account that
|
10914
|
-
# contains your Amazon
|
11627
|
+
# contains your Amazon Quick Sight account.
|
10915
11628
|
#
|
10916
11629
|
# @option params [String] :next_token
|
10917
11630
|
# A pagination token that can be used in a subsequent request.
|
@@ -10960,7 +11673,7 @@ module Aws::QuickSight
|
|
10960
11673
|
req.send_request(options)
|
10961
11674
|
end
|
10962
11675
|
|
10963
|
-
# Lists the IAM policy assignments in the current Amazon
|
11676
|
+
# Lists the IAM policy assignments in the current Amazon Quick Sight
|
10964
11677
|
# account.
|
10965
11678
|
#
|
10966
11679
|
# @option params [required, String] :aws_account_id
|
@@ -11075,10 +11788,10 @@ module Aws::QuickSight
|
|
11075
11788
|
req.send_request(options)
|
11076
11789
|
end
|
11077
11790
|
|
11078
|
-
# Lists all services and authorized targets that the
|
11791
|
+
# Lists all services and authorized targets that the Quick Sight IAM
|
11079
11792
|
# Identity Center application can access.
|
11080
11793
|
#
|
11081
|
-
# This operation is only supported for
|
11794
|
+
# This operation is only supported for Quick Sight accounts that use IAM
|
11082
11795
|
# Identity Center.
|
11083
11796
|
#
|
11084
11797
|
# @option params [required, String] :aws_account_id
|
@@ -11195,8 +11908,8 @@ module Aws::QuickSight
|
|
11195
11908
|
# This operation doesn't list deleted namespaces.
|
11196
11909
|
#
|
11197
11910
|
# @option params [required, String] :aws_account_id
|
11198
|
-
# The ID for the Amazon Web Services account that contains the
|
11199
|
-
#
|
11911
|
+
# The ID for the Amazon Web Services account that contains the Quick
|
11912
|
+
# Sight namespaces that you want to list.
|
11200
11913
|
#
|
11201
11914
|
# @option params [String] :next_token
|
11202
11915
|
# A unique pagination token that can be used in a subsequent request.
|
@@ -11313,8 +12026,8 @@ module Aws::QuickSight
|
|
11313
12026
|
# @option params [required, String] :aws_account_id
|
11314
12027
|
# The ID for the Amazon Web Services account that you want to create a
|
11315
12028
|
# group in. The Amazon Web Services account ID that you provide must be
|
11316
|
-
# the same Amazon Web Services account that contains your Amazon
|
11317
|
-
#
|
12029
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
12030
|
+
# Sight account.
|
11318
12031
|
#
|
11319
12032
|
# @option params [required, String] :namespace
|
11320
12033
|
# The namespace that includes the role.
|
@@ -11443,8 +12156,8 @@ module Aws::QuickSight
|
|
11443
12156
|
req.send_request(options)
|
11444
12157
|
end
|
11445
12158
|
|
11446
|
-
# Lists all the versions of the templates in the current Amazon
|
11447
|
-
#
|
12159
|
+
# Lists all the versions of the templates in the current Amazon Quick
|
12160
|
+
# Sight account.
|
11448
12161
|
#
|
11449
12162
|
# @option params [required, String] :aws_account_id
|
11450
12163
|
# The ID of the Amazon Web Services account that contains the templates
|
@@ -11499,7 +12212,7 @@ module Aws::QuickSight
|
|
11499
12212
|
req.send_request(options)
|
11500
12213
|
end
|
11501
12214
|
|
11502
|
-
# Lists all the templates in the current Amazon
|
12215
|
+
# Lists all the templates in the current Amazon Quick Sight account.
|
11503
12216
|
#
|
11504
12217
|
# @option params [required, String] :aws_account_id
|
11505
12218
|
# The ID of the Amazon Web Services account that contains the templates
|
@@ -11678,10 +12391,10 @@ module Aws::QuickSight
|
|
11678
12391
|
# * `ALL (default)`- Display all existing themes.
|
11679
12392
|
#
|
11680
12393
|
# * `CUSTOM` - Display only the themes created by people using Amazon
|
11681
|
-
#
|
12394
|
+
# Quick Sight.
|
11682
12395
|
#
|
11683
|
-
# * `QUICKSIGHT` - Display only the starting themes defined by
|
11684
|
-
#
|
12396
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by Quick
|
12397
|
+
# Sight.
|
11685
12398
|
#
|
11686
12399
|
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11687
12400
|
#
|
@@ -12297,17 +13010,17 @@ module Aws::QuickSight
|
|
12297
13010
|
req.send_request(options)
|
12298
13011
|
end
|
12299
13012
|
|
12300
|
-
# Lists the Amazon
|
12301
|
-
# member of.
|
13013
|
+
# Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is
|
13014
|
+
# a member of.
|
12302
13015
|
#
|
12303
13016
|
# @option params [required, String] :user_name
|
12304
|
-
# The Amazon
|
13017
|
+
# The Amazon Quick Sight user name that you want to list group
|
12305
13018
|
# memberships for.
|
12306
13019
|
#
|
12307
13020
|
# @option params [required, String] :aws_account_id
|
12308
13021
|
# The Amazon Web Services account ID that the user is in. Currently, you
|
12309
13022
|
# use the ID for the Amazon Web Services account that contains your
|
12310
|
-
# Amazon
|
13023
|
+
# Amazon Quick Sight account.
|
12311
13024
|
#
|
12312
13025
|
# @option params [required, String] :namespace
|
12313
13026
|
# The namespace. Currently, you should set this to `default`.
|
@@ -12357,13 +13070,13 @@ module Aws::QuickSight
|
|
12357
13070
|
req.send_request(options)
|
12358
13071
|
end
|
12359
13072
|
|
12360
|
-
# Returns a list of all of the Amazon
|
12361
|
-
# account.
|
13073
|
+
# Returns a list of all of the Amazon Quick Sight users belonging to
|
13074
|
+
# this account.
|
12362
13075
|
#
|
12363
13076
|
# @option params [required, String] :aws_account_id
|
12364
13077
|
# The ID for the Amazon Web Services account that the user is in.
|
12365
13078
|
# Currently, you use the ID for the Amazon Web Services account that
|
12366
|
-
# contains your Amazon
|
13079
|
+
# contains your Amazon Quick Sight account.
|
12367
13080
|
#
|
12368
13081
|
# @option params [String] :next_token
|
12369
13082
|
# A pagination token that can be used in a subsequent request.
|
@@ -12644,30 +13357,30 @@ module Aws::QuickSight
|
|
12644
13357
|
req.send_request(options)
|
12645
13358
|
end
|
12646
13359
|
|
12647
|
-
# Creates an Amazon
|
13360
|
+
# Creates an Amazon Quick Sight user whose identity is associated with
|
12648
13361
|
# the Identity and Access Management (IAM) identity or role specified in
|
12649
|
-
# the request. When you register a new user from the
|
12650
|
-
#
|
12651
|
-
# registration URL to create their account.
|
12652
|
-
# 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
|
12653
13366
|
# API. If you want new users to receive a registration email, then add
|
12654
|
-
# those users in the
|
12655
|
-
# registering a new user in the
|
12656
|
-
# 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].
|
12657
13370
|
#
|
12658
13371
|
#
|
12659
13372
|
#
|
12660
13373
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users
|
12661
13374
|
#
|
12662
13375
|
# @option params [required, String] :identity_type
|
12663
|
-
# The identity type that your
|
13376
|
+
# The identity type that your Quick Sight account uses to manage the
|
12664
13377
|
# identity of users.
|
12665
13378
|
#
|
12666
13379
|
# @option params [required, String] :email
|
12667
13380
|
# The email address of the user that you want to register.
|
12668
13381
|
#
|
12669
13382
|
# @option params [required, String] :user_role
|
12670
|
-
# The Amazon
|
13383
|
+
# The Amazon Quick Sight role for the user. The user role can be one of
|
12671
13384
|
# the following:
|
12672
13385
|
#
|
12673
13386
|
# * `READER`: A user who has read-only access to dashboards.
|
@@ -12675,11 +13388,11 @@ module Aws::QuickSight
|
|
12675
13388
|
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
12676
13389
|
# and dashboards.
|
12677
13390
|
#
|
12678
|
-
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
12679
|
-
#
|
13391
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon Quick
|
13392
|
+
# Sight settings.
|
12680
13393
|
#
|
12681
13394
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
12682
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
13395
|
+
# Reader role. Reader Pros have access to Amazon Q in Quick Sight, can
|
12683
13396
|
# build stories with Amazon Q, and can generate executive summaries
|
12684
13397
|
# from dashboards.
|
12685
13398
|
#
|
@@ -12689,7 +13402,7 @@ module Aws::QuickSight
|
|
12689
13402
|
# Q&A, and generate executive summaries from dashboards.
|
12690
13403
|
#
|
12691
13404
|
# * `ADMIN_PRO`: Admin Pros are Author Pros who can also manage Amazon
|
12692
|
-
#
|
13405
|
+
# Quick Sight administrative settings. Admin Pro users are billed at
|
12693
13406
|
# Author Pro pricing.
|
12694
13407
|
#
|
12695
13408
|
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
@@ -12698,13 +13411,13 @@ module Aws::QuickSight
|
|
12698
13411
|
#
|
12699
13412
|
# @option params [String] :iam_arn
|
12700
13413
|
# The ARN of the IAM user or role that you are registering with Amazon
|
12701
|
-
#
|
13414
|
+
# Quick Sight.
|
12702
13415
|
#
|
12703
13416
|
# @option params [String] :session_name
|
12704
13417
|
# You need to use this parameter only when you register one or more
|
12705
13418
|
# users using an assumed IAM role. You don't need to provide the
|
12706
13419
|
# session name for other scenarios, for example when you are registering
|
12707
|
-
# an IAM user or an Amazon
|
13420
|
+
# an IAM user or an Amazon Quick Sight user. You can register multiple
|
12708
13421
|
# users using the same IAM role if each user has a different session
|
12709
13422
|
# name. For more information on assuming IAM roles, see [ `assume-role`
|
12710
13423
|
# ][1] in the *CLI Reference.*
|
@@ -12716,13 +13429,13 @@ module Aws::QuickSight
|
|
12716
13429
|
# @option params [required, String] :aws_account_id
|
12717
13430
|
# The ID for the Amazon Web Services account that the user is in.
|
12718
13431
|
# Currently, you use the ID for the Amazon Web Services account that
|
12719
|
-
# contains your Amazon
|
13432
|
+
# contains your Amazon Quick Sight account.
|
12720
13433
|
#
|
12721
13434
|
# @option params [required, String] :namespace
|
12722
13435
|
# The namespace. Currently, you should set this to `default`.
|
12723
13436
|
#
|
12724
13437
|
# @option params [String] :user_name
|
12725
|
-
# The Amazon
|
13438
|
+
# The Amazon Quick Sight user name that you want to create for the user
|
12726
13439
|
# you are registering.
|
12727
13440
|
#
|
12728
13441
|
# @option params [String] :custom_permissions_name
|
@@ -12744,21 +13457,22 @@ module Aws::QuickSight
|
|
12744
13457
|
#
|
12745
13458
|
# A set of custom permissions includes any combination of these
|
12746
13459
|
# restrictions. Currently, you need to create the profile names for
|
12747
|
-
# custom permission sets by using the
|
13460
|
+
# custom permission sets by using the Quick Sight console. Then, you use
|
12748
13461
|
# the `RegisterUser` API operation to assign the named set of
|
12749
|
-
# permissions to a
|
13462
|
+
# permissions to a Quick Sight user.
|
12750
13463
|
#
|
12751
|
-
#
|
13464
|
+
# Quick Sight custom permissions are applied through IAM policies.
|
12752
13465
|
# Therefore, they override the permissions typically granted by
|
12753
|
-
# assigning
|
12754
|
-
#
|
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).
|
12755
13469
|
#
|
12756
|
-
# This feature is available only to
|
13470
|
+
# This feature is available only to Quick Sight Enterprise edition
|
12757
13471
|
# subscriptions.
|
12758
13472
|
#
|
12759
13473
|
# @option params [String] :external_login_federation_provider_type
|
12760
13474
|
# The type of supported external login provider that provides identity
|
12761
|
-
# to let a user federate into Amazon
|
13475
|
+
# to let a user federate into Amazon Quick Sight with an associated
|
12762
13476
|
# Identity and Access Management(IAM) role. The type of supported
|
12763
13477
|
# external login provider can be one of the following.
|
12764
13478
|
#
|
@@ -12773,7 +13487,7 @@ module Aws::QuickSight
|
|
12773
13487
|
#
|
12774
13488
|
# @option params [String] :custom_federation_provider_url
|
12775
13489
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
12776
|
-
# identity to let a user federate into
|
13490
|
+
# identity to let a user federate into Quick Sight with an associated
|
12777
13491
|
# Identity and Access Management(IAM) role. This parameter should only
|
12778
13492
|
# be used when `ExternalLoginFederationProviderType` parameter is set to
|
12779
13493
|
# `CUSTOM_OIDC`.
|
@@ -12890,6 +13604,75 @@ module Aws::QuickSight
|
|
12890
13604
|
req.send_request(options)
|
12891
13605
|
end
|
12892
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
|
+
|
12893
13676
|
# Searches for analyses that belong to the user specified in the filter.
|
12894
13677
|
#
|
12895
13678
|
# <note markdown="1"> This operation is eventually consistent. The results are best effort
|
@@ -13142,7 +13925,7 @@ module Aws::QuickSight
|
|
13142
13925
|
# resp.data_source_summaries[0].arn #=> String
|
13143
13926
|
# resp.data_source_summaries[0].data_source_id #=> String
|
13144
13927
|
# resp.data_source_summaries[0].name #=> String
|
13145
|
-
# 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"
|
13146
13929
|
# resp.data_source_summaries[0].created_time #=> Time
|
13147
13930
|
# resp.data_source_summaries[0].last_updated_time #=> Time
|
13148
13931
|
# resp.next_token #=> String
|
@@ -13158,6 +13941,76 @@ module Aws::QuickSight
|
|
13158
13941
|
req.send_request(options)
|
13159
13942
|
end
|
13160
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
|
+
|
13161
14014
|
# Searches the subfolders in a folder.
|
13162
14015
|
#
|
13163
14016
|
# @option params [required, String] :aws_account_id
|
@@ -13223,13 +14076,13 @@ module Aws::QuickSight
|
|
13223
14076
|
req.send_request(options)
|
13224
14077
|
end
|
13225
14078
|
|
13226
|
-
# Use the `SearchGroups` operation to search groups in a specified
|
13227
|
-
#
|
14079
|
+
# Use the `SearchGroups` operation to search groups in a specified Quick
|
14080
|
+
# Sight namespace using the supplied filters.
|
13228
14081
|
#
|
13229
14082
|
# @option params [required, String] :aws_account_id
|
13230
14083
|
# The ID for the Amazon Web Services account that the group is in.
|
13231
14084
|
# Currently, you use the ID for the Amazon Web Services account that
|
13232
|
-
# contains your Amazon
|
14085
|
+
# contains your Amazon Quick Sight account.
|
13233
14086
|
#
|
13234
14087
|
# @option params [String] :next_token
|
13235
14088
|
# A pagination token that can be used in a subsequent request.
|
@@ -13351,14 +14204,14 @@ module Aws::QuickSight
|
|
13351
14204
|
|
13352
14205
|
# Starts an Asset Bundle export job.
|
13353
14206
|
#
|
13354
|
-
# An Asset Bundle export job exports specified
|
13355
|
-
# can also choose to export any asset dependencies in the
|
13356
|
-
# 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
|
13357
14210
|
# `DescribeAssetBundleExportJob` API call. When a job is successfully
|
13358
14211
|
# completed, a download URL that contains the exported assets is
|
13359
14212
|
# returned. The URL is valid for 5 minutes and can be refreshed with a
|
13360
|
-
# `DescribeAssetBundleExportJob` API call. Each
|
13361
|
-
# 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.
|
13362
14215
|
#
|
13363
14216
|
# The API caller must have the necessary permissions in their IAM role
|
13364
14217
|
# to access each resource before the resources can be exported.
|
@@ -13533,12 +14386,13 @@ module Aws::QuickSight
|
|
13533
14386
|
|
13534
14387
|
# Starts an Asset Bundle import job.
|
13535
14388
|
#
|
13536
|
-
# An Asset Bundle import job imports specified
|
13537
|
-
#
|
13538
|
-
# specified configuration overrides. The assets that
|
13539
|
-
# the bundle file that you provide are used to create
|
13540
|
-
# existing asset in your
|
13541
|
-
# 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.
|
13542
14396
|
#
|
13543
14397
|
# The API caller must have the necessary `"create"`, `"describe"`, and
|
13544
14398
|
# `"update"` permissions in their IAM role to access each resource type
|
@@ -13568,7 +14422,7 @@ module Aws::QuickSight
|
|
13568
14422
|
#
|
13569
14423
|
# If you choose `DO_NOTHING`, failed import jobs will not attempt to
|
13570
14424
|
# roll back any asset changes caused by the failed job, possibly keeping
|
13571
|
-
# the
|
14425
|
+
# the Amazon Quick Sight account in an inconsistent state.
|
13572
14426
|
#
|
13573
14427
|
# @option params [Types::AssetBundleImportJobOverridePermissions] :override_permissions
|
13574
14428
|
# Optional permission overrides that are applied to the resource
|
@@ -13703,6 +14557,11 @@ module Aws::QuickSight
|
|
13703
14557
|
# },
|
13704
14558
|
# role_arn: "RoleArn",
|
13705
14559
|
# },
|
14560
|
+
# s3_knowledge_base_parameters: {
|
14561
|
+
# role_arn: "RoleArn",
|
14562
|
+
# bucket_url: "S3Bucket", # required
|
14563
|
+
# metadata_files_location: "MetadataFilesLocation",
|
14564
|
+
# },
|
13706
14565
|
# service_now_parameters: {
|
13707
14566
|
# site_base_url: "SiteBaseUrl", # required
|
13708
14567
|
# },
|
@@ -13785,6 +14644,22 @@ module Aws::QuickSight
|
|
13785
14644
|
# custom_connection_parameters: {
|
13786
14645
|
# connection_type: "String",
|
13787
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
|
+
# },
|
13788
14663
|
# },
|
13789
14664
|
# vpc_connection_properties: {
|
13790
14665
|
# vpc_connection_arn: "Arn", # required
|
@@ -14033,14 +14908,14 @@ module Aws::QuickSight
|
|
14033
14908
|
#
|
14034
14909
|
# **StartDashboardSnapshotJob API throttling**
|
14035
14910
|
#
|
14036
|
-
#
|
14911
|
+
# Quick Sight utilizes API throttling to create a more consistent user
|
14037
14912
|
# experience within a time span for customers when they call the
|
14038
14913
|
# `StartDashboardSnapshotJob`. By default, 12 jobs can run
|
14039
14914
|
# simlutaneously in one Amazon Web Services account and users can submit
|
14040
14915
|
# up 10 API requests per second before an account is throttled. If an
|
14041
14916
|
# overwhelming number of API requests are made by the same user in a
|
14042
|
-
# short period of time,
|
14043
|
-
# 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.
|
14044
14919
|
#
|
14045
14920
|
# **Common throttling scenarios**
|
14046
14921
|
#
|
@@ -14056,7 +14931,7 @@ module Aws::QuickSight
|
|
14056
14931
|
#
|
14057
14932
|
# * **A large number of API requests are submitted on an Amazon Web
|
14058
14933
|
# Services account.** When a user makes more than 10 API calls to the
|
14059
|
-
#
|
14934
|
+
# Quick Sight API in one second, a `ThrottlingException` is returned.
|
14060
14935
|
#
|
14061
14936
|
# If your use case requires a higher throttling limit, contact your
|
14062
14937
|
# account admin or [Amazon Web ServicesSupport][1] to explore options to
|
@@ -14068,7 +14943,7 @@ module Aws::QuickSight
|
|
14068
14943
|
# the degree of frequency and parallelism of API calls as much as you
|
14069
14944
|
# can to avoid throttling. You can also perform a timing test to
|
14070
14945
|
# calculate an estimate for the total processing time of your projected
|
14071
|
-
# load that stays within the throttling limits of the
|
14946
|
+
# load that stays within the throttling limits of the Quick Sight APIs.
|
14072
14947
|
# For example, if your projected traffic is 100 snapshot jobs before
|
14073
14948
|
# 12:00 PM per day, start 12 jobs in parallel and measure the amount of
|
14074
14949
|
# time it takes to proccess all 12 jobs. Once you obtain the result,
|
@@ -14116,7 +14991,7 @@ module Aws::QuickSight
|
|
14116
14991
|
# @option params [required, Types::SnapshotUserConfiguration] :user_configuration
|
14117
14992
|
# A structure that contains information about the anonymous users that
|
14118
14993
|
# the generated snapshot is for. This API will not return information
|
14119
|
-
# about registered
|
14994
|
+
# about registered Amazon Quick Sight.
|
14120
14995
|
#
|
14121
14996
|
# @option params [required, Types::SnapshotConfiguration] :snapshot_configuration
|
14122
14997
|
# A structure that describes the configuration of the dashboard
|
@@ -14226,9 +15101,10 @@ module Aws::QuickSight
|
|
14226
15101
|
# Only one job can run simultaneously in a given schedule. Repeated
|
14227
15102
|
# requests are skipped with a `202` HTTP status code.
|
14228
15103
|
#
|
14229
|
-
# For more information, see [Scheduling and sending
|
14230
|
-
# by email][1] and [Configuring email report settings for a
|
14231
|
-
# 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*.
|
14232
15108
|
#
|
14233
15109
|
#
|
14234
15110
|
#
|
@@ -14245,9 +15121,9 @@ module Aws::QuickSight
|
|
14245
15121
|
#
|
14246
15122
|
# @option params [required, String] :schedule_id
|
14247
15123
|
# The ID of the schedule that you want to start a snapshot job schedule
|
14248
|
-
# for. The schedule ID can be found in the
|
14249
|
-
# **Schedules** pane of the dashboard that the schedule is
|
14250
|
-
# 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.
|
14251
15127
|
#
|
14252
15128
|
# @return [Types::StartDashboardSnapshotJobScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14253
15129
|
#
|
@@ -14276,8 +15152,8 @@ module Aws::QuickSight
|
|
14276
15152
|
req.send_request(options)
|
14277
15153
|
end
|
14278
15154
|
|
14279
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
14280
|
-
# resource.
|
15155
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
15156
|
+
# Quick Sight resource.
|
14281
15157
|
#
|
14282
15158
|
# Tags can help you organize and categorize your resources. You can also
|
14283
15159
|
# use them to scope user permissions, by granting a user permission to
|
@@ -14288,20 +15164,20 @@ module Aws::QuickSight
|
|
14288
15164
|
# key that is already associated with the resource, the new tag value
|
14289
15165
|
# that you specify replaces the previous value for that tag.
|
14290
15166
|
#
|
14291
|
-
# You can associate as many as 50 tags with a resource.
|
14292
|
-
# supports tagging on data set, data source, dashboard, template,
|
14293
|
-
# 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.
|
14294
15170
|
#
|
14295
|
-
# Tagging for
|
14296
|
-
# 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:
|
14297
15173
|
#
|
14298
|
-
# * Tags are used to track costs for users in
|
14299
|
-
# other resources that
|
14300
|
-
# capacoty (SPICE), session usage, alert
|
14301
|
-
# 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.
|
14302
15178
|
#
|
14303
|
-
# *
|
14304
|
-
# Groups.
|
15179
|
+
# * Amazon Quick Sight doesn't currently support the tag editor for
|
15180
|
+
# Resource Groups.
|
14305
15181
|
#
|
14306
15182
|
# @option params [required, String] :resource_arn
|
14307
15183
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
@@ -14412,11 +15288,11 @@ module Aws::QuickSight
|
|
14412
15288
|
req.send_request(options)
|
14413
15289
|
end
|
14414
15290
|
|
14415
|
-
# Updates Amazon
|
15291
|
+
# Updates Amazon Quick Sight customizations. Currently, the only
|
14416
15292
|
# customization that you can use is a theme.
|
14417
15293
|
#
|
14418
15294
|
# You can use customizations for your Amazon Web Services account or, if
|
14419
|
-
# you specify a namespace, for a
|
15295
|
+
# you specify a namespace, for a Quick Sight namespace instead.
|
14420
15296
|
# Customizations that apply to a namespace override customizations that
|
14421
15297
|
# apply to an Amazon Web Services account. To find out which
|
14422
15298
|
# customizations apply, use the `DescribeAccountCustomization` API
|
@@ -14424,13 +15300,13 @@ module Aws::QuickSight
|
|
14424
15300
|
#
|
14425
15301
|
# @option params [required, String] :aws_account_id
|
14426
15302
|
# The ID for the Amazon Web Services account that you want to update
|
14427
|
-
#
|
15303
|
+
# Quick Sight customizations for.
|
14428
15304
|
#
|
14429
15305
|
# @option params [String] :namespace
|
14430
|
-
# The namespace that you want to update
|
15306
|
+
# The namespace that you want to update Quick Sight customizations for.
|
14431
15307
|
#
|
14432
15308
|
# @option params [required, Types::AccountCustomization] :account_customization
|
14433
|
-
# The
|
15309
|
+
# The Quick Sight customizations you're updating.
|
14434
15310
|
#
|
14435
15311
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14436
15312
|
#
|
@@ -14471,25 +15347,26 @@ module Aws::QuickSight
|
|
14471
15347
|
req.send_request(options)
|
14472
15348
|
end
|
14473
15349
|
|
14474
|
-
# Updates the Amazon
|
15350
|
+
# Updates the Amazon Quick Sight settings in your Amazon Web Services
|
14475
15351
|
# account.
|
14476
15352
|
#
|
14477
15353
|
# @option params [required, String] :aws_account_id
|
14478
|
-
# The ID for the Amazon Web Services account that contains the
|
14479
|
-
#
|
15354
|
+
# The ID for the Amazon Web Services account that contains the Quick
|
15355
|
+
# Sight settings that you want to list.
|
14480
15356
|
#
|
14481
15357
|
# @option params [required, String] :default_namespace
|
14482
15358
|
# The default namespace for this Amazon Web Services account. Currently,
|
14483
15359
|
# the default is `default`. IAM users that register for the first time
|
14484
|
-
# with
|
14485
|
-
# the default namespace.
|
15360
|
+
# with Amazon Quick Sight provide an email address that becomes
|
15361
|
+
# associated with the default namespace.
|
14486
15362
|
#
|
14487
15363
|
# @option params [String] :notification_email
|
14488
|
-
# The email address that you want
|
14489
|
-
# 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.
|
14490
15367
|
#
|
14491
15368
|
# @option params [Boolean] :termination_protection_enabled
|
14492
|
-
# A boolean value that determines whether or not an
|
15369
|
+
# A boolean value that determines whether or not an Quick Sight account
|
14493
15370
|
# can be deleted. A `True` value doesn't allow the account to be
|
14494
15371
|
# deleted and results in an error message if a user tries to make a
|
14495
15372
|
# `DeleteAccountSubscription` request. A `False` value will allow the
|
@@ -14523,7 +15400,183 @@ module Aws::QuickSight
|
|
14523
15400
|
req.send_request(options)
|
14524
15401
|
end
|
14525
15402
|
|
14526
|
-
# 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
|
14527
15580
|
#
|
14528
15581
|
# @option params [required, String] :aws_account_id
|
14529
15582
|
# The ID of the Amazon Web Services account that contains the analysis
|
@@ -14535,7 +15588,7 @@ module Aws::QuickSight
|
|
14535
15588
|
#
|
14536
15589
|
# @option params [required, String] :name
|
14537
15590
|
# A descriptive name for the analysis that you're updating. This name
|
14538
|
-
# displays for the analysis in the
|
15591
|
+
# displays for the analysis in the Amazon Quick Sight console.
|
14539
15592
|
#
|
14540
15593
|
# @option params [Types::Parameters] :parameters
|
14541
15594
|
# The parameter names and override values that you want to use. An
|
@@ -14549,8 +15602,8 @@ module Aws::QuickSight
|
|
14549
15602
|
#
|
14550
15603
|
# @option params [String] :theme_arn
|
14551
15604
|
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
14552
|
-
# that you're creating. To see the theme in the
|
14553
|
-
# 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.
|
14554
15607
|
#
|
14555
15608
|
# @option params [Types::AnalysisDefinition] :definition
|
14556
15609
|
# The definition of an analysis.
|
@@ -14755,6 +15808,24 @@ module Aws::QuickSight
|
|
14755
15808
|
# background: "HexColor",
|
14756
15809
|
# },
|
14757
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
|
+
# },
|
14758
15829
|
# brand_element_style: {
|
14759
15830
|
# navbar_style: {
|
14760
15831
|
# global_navbar: {
|
@@ -14843,6 +15914,14 @@ module Aws::QuickSight
|
|
14843
15914
|
# resp.brand_definition.application_theme.brand_color_palette.warning.background #=> String
|
14844
15915
|
# resp.brand_definition.application_theme.brand_color_palette.danger.foreground #=> String
|
14845
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
|
14846
15925
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.foreground #=> String
|
14847
15926
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.global_navbar.background #=> String
|
14848
15927
|
# resp.brand_definition.application_theme.brand_element_style.navbar_style.contextual_navbar.foreground #=> String
|
@@ -14984,6 +16063,18 @@ module Aws::QuickSight
|
|
14984
16063
|
# include_content_in_scheduled_reports_email: "DENY", # accepts DENY
|
14985
16064
|
# dashboard: "DENY", # accepts DENY
|
14986
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
|
14987
16078
|
# },
|
14988
16079
|
# })
|
14989
16080
|
#
|
@@ -15030,7 +16121,7 @@ module Aws::QuickSight
|
|
15030
16121
|
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
15031
16122
|
# the Amazon Resource Name (ARN) of the source template. The
|
15032
16123
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
15033
|
-
# any
|
16124
|
+
# any Amazon Quick Sight-supported Amazon Web Services Region.
|
15034
16125
|
#
|
15035
16126
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
15036
16127
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -15049,9 +16140,9 @@ module Aws::QuickSight
|
|
15049
16140
|
#
|
15050
16141
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
15051
16142
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
15052
|
-
#
|
15053
|
-
# which can be used for ad hoc (one-time) filtering. This
|
15054
|
-
# `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.
|
15055
16146
|
#
|
15056
16147
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
15057
16148
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -15062,6 +16153,11 @@ module Aws::QuickSight
|
|
15062
16153
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
15063
16154
|
# by default.
|
15064
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
|
+
#
|
15065
16161
|
# * `AvailabilityStatus` for `ExecutiveSummaryOption` - This status can
|
15066
16162
|
# be either `ENABLED` or `DISABLED`. The option to build an executive
|
15067
16163
|
# summary is disabled when this is set to `DISABLED`. This option is
|
@@ -15353,7 +16449,7 @@ module Aws::QuickSight
|
|
15353
16449
|
# Indicates whether you want to import the data into SPICE.
|
15354
16450
|
#
|
15355
16451
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
15356
|
-
# Groupings of columns that work together in certain
|
16452
|
+
# Groupings of columns that work together in certain Amazon Quick Sight
|
15357
16453
|
# features. Currently, only geospatial hierarchy is supported.
|
15358
16454
|
#
|
15359
16455
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -15703,21 +16799,21 @@ module Aws::QuickSight
|
|
15703
16799
|
# A display name for the data source.
|
15704
16800
|
#
|
15705
16801
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
15706
|
-
# The parameters that
|
15707
|
-
# source.
|
16802
|
+
# The parameters that Amazon Quick Sight uses to connect to your
|
16803
|
+
# underlying source.
|
15708
16804
|
#
|
15709
16805
|
# @option params [Types::DataSourceCredentials] :credentials
|
15710
|
-
# The credentials that
|
16806
|
+
# The credentials that Amazon Quick Sight that uses to connect to your
|
15711
16807
|
# underlying source. Currently, only credentials based on user name and
|
15712
16808
|
# password are supported.
|
15713
16809
|
#
|
15714
16810
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
15715
|
-
# Use this parameter only when you want
|
16811
|
+
# Use this parameter only when you want Amazon Quick Sight to use a VPC
|
15716
16812
|
# connection when connecting to your underlying source.
|
15717
16813
|
#
|
15718
16814
|
# @option params [Types::SslProperties] :ssl_properties
|
15719
|
-
# Secure Socket Layer (SSL) properties that apply when
|
15720
|
-
# connects to your underlying source.
|
16815
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon Quick
|
16816
|
+
# Sight connects to your underlying source.
|
15721
16817
|
#
|
15722
16818
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
15723
16819
|
#
|
@@ -15812,6 +16908,11 @@ module Aws::QuickSight
|
|
15812
16908
|
# },
|
15813
16909
|
# role_arn: "RoleArn",
|
15814
16910
|
# },
|
16911
|
+
# s3_knowledge_base_parameters: {
|
16912
|
+
# role_arn: "RoleArn",
|
16913
|
+
# bucket_url: "S3Bucket", # required
|
16914
|
+
# metadata_files_location: "MetadataFilesLocation",
|
16915
|
+
# },
|
15815
16916
|
# service_now_parameters: {
|
15816
16917
|
# site_base_url: "SiteBaseUrl", # required
|
15817
16918
|
# },
|
@@ -15894,6 +16995,22 @@ module Aws::QuickSight
|
|
15894
16995
|
# custom_connection_parameters: {
|
15895
16996
|
# connection_type: "String",
|
15896
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
|
+
# },
|
15897
17014
|
# },
|
15898
17015
|
# credentials: {
|
15899
17016
|
# credential_pair: {
|
@@ -15979,6 +17096,11 @@ module Aws::QuickSight
|
|
15979
17096
|
# },
|
15980
17097
|
# role_arn: "RoleArn",
|
15981
17098
|
# },
|
17099
|
+
# s3_knowledge_base_parameters: {
|
17100
|
+
# role_arn: "RoleArn",
|
17101
|
+
# bucket_url: "S3Bucket", # required
|
17102
|
+
# metadata_files_location: "MetadataFilesLocation",
|
17103
|
+
# },
|
15982
17104
|
# service_now_parameters: {
|
15983
17105
|
# site_base_url: "SiteBaseUrl", # required
|
15984
17106
|
# },
|
@@ -16061,11 +17183,31 @@ module Aws::QuickSight
|
|
16061
17183
|
# custom_connection_parameters: {
|
16062
17184
|
# connection_type: "String",
|
16063
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
|
+
# },
|
16064
17202
|
# },
|
16065
17203
|
# ],
|
16066
17204
|
# },
|
16067
17205
|
# copy_source_arn: "CopySourceArn",
|
16068
17206
|
# secret_arn: "SecretArn",
|
17207
|
+
# web_proxy_credentials: {
|
17208
|
+
# web_proxy_username: "DbUsername", # required
|
17209
|
+
# web_proxy_password: "Password", # required
|
17210
|
+
# },
|
16069
17211
|
# },
|
16070
17212
|
# vpc_connection_properties: {
|
16071
17213
|
# vpc_connection_arn: "Arn", # required
|
@@ -16151,15 +17293,15 @@ module Aws::QuickSight
|
|
16151
17293
|
req.send_request(options)
|
16152
17294
|
end
|
16153
17295
|
|
16154
|
-
# Updates a Amazon Q Business application that is linked to a
|
16155
|
-
# account.
|
17296
|
+
# Updates a Amazon Q Business application that is linked to a Quick
|
17297
|
+
# Sight account.
|
16156
17298
|
#
|
16157
17299
|
# @option params [required, String] :aws_account_id
|
16158
|
-
# The ID of the
|
17300
|
+
# The ID of the Quick Sight account that is connected to the Amazon Q
|
16159
17301
|
# Business application that you want to update.
|
16160
17302
|
#
|
16161
17303
|
# @option params [String] :namespace
|
16162
|
-
# The
|
17304
|
+
# The Quick Sight namespace that contains the linked Amazon Q Business
|
16163
17305
|
# application. If this field is left blank, the default namespace is
|
16164
17306
|
# used. Currently, the default namespace is the only valid value for
|
16165
17307
|
# this parameter.
|
@@ -16194,6 +17336,68 @@ module Aws::QuickSight
|
|
16194
17336
|
req.send_request(options)
|
16195
17337
|
end
|
16196
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
|
+
|
16197
17401
|
# Updates the name of a folder.
|
16198
17402
|
#
|
16199
17403
|
# @option params [required, String] :aws_account_id
|
@@ -16312,7 +17516,7 @@ module Aws::QuickSight
|
|
16312
17516
|
# @option params [required, String] :aws_account_id
|
16313
17517
|
# The ID for the Amazon Web Services account that the group is in.
|
16314
17518
|
# Currently, you use the ID for the Amazon Web Services account that
|
16315
|
-
# contains your Amazon
|
17519
|
+
# contains your Amazon Quick Sight account.
|
16316
17520
|
#
|
16317
17521
|
# @option params [required, String] :namespace
|
16318
17522
|
# The namespace of the group that you want to update.
|
@@ -16378,12 +17582,12 @@ module Aws::QuickSight
|
|
16378
17582
|
# when creating the data source.
|
16379
17583
|
#
|
16380
17584
|
# @option params [String] :policy_arn
|
16381
|
-
# The ARN for the IAM policy to apply to the
|
16382
|
-
# 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.
|
16383
17587
|
#
|
16384
17588
|
# @option params [Hash<String,Array>] :identities
|
16385
|
-
# The
|
16386
|
-
# policy to.
|
17589
|
+
# The Amazon Quick Sight users, groups, or both that you want to assign
|
17590
|
+
# the policy to.
|
16387
17591
|
#
|
16388
17592
|
# @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16389
17593
|
#
|
@@ -16430,9 +17634,9 @@ module Aws::QuickSight
|
|
16430
17634
|
end
|
16431
17635
|
|
16432
17636
|
# Adds or updates services and authorized targets to configure what the
|
16433
|
-
#
|
17637
|
+
# Quick Sight IAM Identity Center application can access.
|
16434
17638
|
#
|
16435
|
-
# This operation is only supported for
|
17639
|
+
# This operation is only supported for Quick Sight accounts using IAM
|
16436
17640
|
# Identity Center
|
16437
17641
|
#
|
16438
17642
|
# @option params [required, String] :aws_account_id
|
@@ -16536,7 +17740,7 @@ module Aws::QuickSight
|
|
16536
17740
|
req.send_request(options)
|
16537
17741
|
end
|
16538
17742
|
|
16539
|
-
# Updates a customer managed key in a
|
17743
|
+
# Updates a customer managed key in a Quick Sight account.
|
16540
17744
|
#
|
16541
17745
|
# @option params [required, String] :aws_account_id
|
16542
17746
|
# The ID of the Amazon Web Services account that contains the customer
|
@@ -16544,7 +17748,7 @@ module Aws::QuickSight
|
|
16544
17748
|
#
|
16545
17749
|
# @option params [required, Array<Types::RegisteredCustomerManagedKey>] :key_registration
|
16546
17750
|
# A list of `RegisteredCustomerManagedKey` objects to be updated to the
|
16547
|
-
#
|
17751
|
+
# Quick Sight account.
|
16548
17752
|
#
|
16549
17753
|
# @return [Types::UpdateKeyRegistrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16550
17754
|
#
|
@@ -16585,38 +17789,38 @@ module Aws::QuickSight
|
|
16585
17789
|
req.send_request(options)
|
16586
17790
|
end
|
16587
17791
|
|
16588
|
-
# This API controls public sharing settings for your entire
|
17792
|
+
# This API controls public sharing settings for your entire Quick Sight
|
16589
17793
|
# account, affecting data security and access. When you enable public
|
16590
17794
|
# sharing:
|
16591
17795
|
#
|
16592
17796
|
# * Dashboards can be shared publicly
|
16593
17797
|
#
|
16594
17798
|
# * This setting affects your entire Amazon Web Services account and all
|
16595
|
-
#
|
17799
|
+
# Quick Sight users
|
16596
17800
|
#
|
16597
17801
|
# **Before proceeding:** Ensure you understand the security
|
16598
17802
|
# implications
|
16599
17803
|
# and have proper IAM permissions configured.
|
16600
17804
|
#
|
16601
17805
|
# Use the `UpdatePublicSharingSettings` operation to turn on or turn off
|
16602
|
-
# the public sharing settings of an
|
17806
|
+
# the public sharing settings of an Amazon Quick Sight dashboard.
|
16603
17807
|
#
|
16604
17808
|
# To use this operation, turn on session capacity pricing for your
|
16605
|
-
#
|
17809
|
+
# Amazon Quick Sight account.
|
16606
17810
|
#
|
16607
17811
|
# Before you can turn on public sharing on your account, make sure to
|
16608
17812
|
# give public sharing permissions to an administrative user in the
|
16609
17813
|
# Identity and Access Management (IAM) console. For more information on
|
16610
|
-
# using IAM with
|
16611
|
-
# *
|
17814
|
+
# using IAM with Amazon Quick Sight, see [Using QuickSight with IAM][1]
|
17815
|
+
# in the *Amazon Quick Sight User Guide*.
|
16612
17816
|
#
|
16613
17817
|
#
|
16614
17818
|
#
|
16615
17819
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html
|
16616
17820
|
#
|
16617
17821
|
# @option params [required, String] :aws_account_id
|
16618
|
-
# The Amazon Web Services account ID associated with your
|
16619
|
-
# subscription.
|
17822
|
+
# The Amazon Web Services account ID associated with your Amazon Quick
|
17823
|
+
# Sight subscription.
|
16620
17824
|
#
|
16621
17825
|
# @option params [Boolean] :public_sharing_enabled
|
16622
17826
|
# A Boolean value that indicates whether public sharing is turned on for
|
@@ -16655,9 +17859,9 @@ module Aws::QuickSight
|
|
16655
17859
|
# personalization configuration that the user wants to update.
|
16656
17860
|
#
|
16657
17861
|
# @option params [required, String] :personalization_mode
|
16658
|
-
# An option to allow
|
16659
|
-
# specific metadata, specifically location and job information, in
|
16660
|
-
# 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.
|
16661
17865
|
#
|
16662
17866
|
# @return [Types::UpdateQPersonalizationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16663
17867
|
#
|
@@ -16687,14 +17891,14 @@ module Aws::QuickSight
|
|
16687
17891
|
req.send_request(options)
|
16688
17892
|
end
|
16689
17893
|
|
16690
|
-
# Updates the state of a
|
17894
|
+
# Updates the state of a Quick Sight Q Search configuration.
|
16691
17895
|
#
|
16692
17896
|
# @option params [required, String] :aws_account_id
|
16693
|
-
# The ID of the Amazon Web Services account that contains the
|
16694
|
-
# 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.
|
16695
17899
|
#
|
16696
17900
|
# @option params [required, String] :q_search_status
|
16697
|
-
# The status of the
|
17901
|
+
# The status of the Quick Sight Q Search configuration that the user
|
16698
17902
|
# wants to update.
|
16699
17903
|
#
|
16700
17904
|
# @return [Types::UpdateQuickSightQSearchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -16793,8 +17997,8 @@ module Aws::QuickSight
|
|
16793
17997
|
# @option params [required, String] :aws_account_id
|
16794
17998
|
# The ID for the Amazon Web Services account that you want to create a
|
16795
17999
|
# group in. The Amazon Web Services account ID that you provide must be
|
16796
|
-
# the same Amazon Web Services account that contains your Amazon
|
16797
|
-
#
|
18000
|
+
# the same Amazon Web Services account that contains your Amazon Quick
|
18001
|
+
# Sight account.
|
16798
18002
|
#
|
16799
18003
|
# @option params [required, String] :namespace
|
16800
18004
|
# The namespace that contains the role that you want to update.
|
@@ -16827,7 +18031,7 @@ module Aws::QuickSight
|
|
16827
18031
|
req.send_request(options)
|
16828
18032
|
end
|
16829
18033
|
|
16830
|
-
# Updates the SPICE capacity configuration for a
|
18034
|
+
# Updates the SPICE capacity configuration for a Quick Sight account.
|
16831
18035
|
#
|
16832
18036
|
# @option params [required, String] :aws_account_id
|
16833
18037
|
# The ID of the Amazon Web Services account that contains the SPICE
|
@@ -16869,7 +18073,7 @@ module Aws::QuickSight
|
|
16869
18073
|
req.send_request(options)
|
16870
18074
|
end
|
16871
18075
|
|
16872
|
-
# Updates a template from an existing Amazon
|
18076
|
+
# Updates a template from an existing Amazon Quick Sight analysis or
|
16873
18077
|
# another template.
|
16874
18078
|
#
|
16875
18079
|
# @option params [required, String] :aws_account_id
|
@@ -16887,7 +18091,7 @@ module Aws::QuickSight
|
|
16887
18091
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
16888
18092
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
16889
18093
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
16890
|
-
# any
|
18094
|
+
# any Quick Sight-supported Amazon Web Services Region;.
|
16891
18095
|
#
|
16892
18096
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
16893
18097
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -17066,8 +18270,8 @@ module Aws::QuickSight
|
|
17066
18270
|
# The name for the theme.
|
17067
18271
|
#
|
17068
18272
|
# @option params [required, String] :base_theme_id
|
17069
|
-
# The theme ID, defined by Amazon
|
17070
|
-
# 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
|
17071
18275
|
# theme.
|
17072
18276
|
#
|
17073
18277
|
# @option params [String] :version_description
|
@@ -17713,15 +18917,15 @@ module Aws::QuickSight
|
|
17713
18917
|
req.send_request(options)
|
17714
18918
|
end
|
17715
18919
|
|
17716
|
-
# Updates an Amazon
|
18920
|
+
# Updates an Amazon Quick Sight user.
|
17717
18921
|
#
|
17718
18922
|
# @option params [required, String] :user_name
|
17719
|
-
# The Amazon
|
18923
|
+
# The Amazon Quick Sight user name that you want to update.
|
17720
18924
|
#
|
17721
18925
|
# @option params [required, String] :aws_account_id
|
17722
18926
|
# The ID for the Amazon Web Services account that the user is in.
|
17723
18927
|
# Currently, you use the ID for the Amazon Web Services account that
|
17724
|
-
# contains your Amazon
|
18928
|
+
# contains your Amazon Quick Sight account.
|
17725
18929
|
#
|
17726
18930
|
# @option params [required, String] :namespace
|
17727
18931
|
# The namespace. Currently, you should set this to `default`.
|
@@ -17730,7 +18934,7 @@ module Aws::QuickSight
|
|
17730
18934
|
# The email address of the user that you want to update.
|
17731
18935
|
#
|
17732
18936
|
# @option params [required, String] :role
|
17733
|
-
# The Amazon
|
18937
|
+
# The Amazon Quick Sight role of the user. The role can be one of the
|
17734
18938
|
# following default security cohorts:
|
17735
18939
|
#
|
17736
18940
|
# * `READER`: A user who has read-only access to dashboards.
|
@@ -17738,11 +18942,11 @@ module Aws::QuickSight
|
|
17738
18942
|
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
17739
18943
|
# and dashboards.
|
17740
18944
|
#
|
17741
|
-
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
17742
|
-
#
|
18945
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon Quick
|
18946
|
+
# Sight settings.
|
17743
18947
|
#
|
17744
18948
|
# * `READER_PRO`: Reader Pro adds Generative BI capabilities to the
|
17745
|
-
# Reader role. Reader Pros have access to Amazon Q in
|
18949
|
+
# Reader role. Reader Pros have access to Amazon Q in Quick Sight, can
|
17746
18950
|
# build stories with Amazon Q, and can generate executive summaries
|
17747
18951
|
# from dashboards.
|
17748
18952
|
#
|
@@ -17752,10 +18956,10 @@ module Aws::QuickSight
|
|
17752
18956
|
# Q&A, and generate executive summaries from dashboards.
|
17753
18957
|
#
|
17754
18958
|
# * `ADMIN_PRO`: Admin Pros are Author Pros who can also manage Amazon
|
17755
|
-
#
|
18959
|
+
# Quick Sight administrative settings. Admin Pro users are billed at
|
17756
18960
|
# Author Pro pricing.
|
17757
18961
|
#
|
17758
|
-
# The name of the
|
18962
|
+
# The name of the Quick Sight role is invisible to the user except for
|
17759
18963
|
# the console screens dealing with permissions.
|
17760
18964
|
#
|
17761
18965
|
# @option params [String] :custom_permissions_name
|
@@ -17774,16 +18978,16 @@ module Aws::QuickSight
|
|
17774
18978
|
#
|
17775
18979
|
# A set of custom permissions includes any combination of these
|
17776
18980
|
# restrictions. Currently, you need to create the profile names for
|
17777
|
-
# custom permission sets by using the
|
18981
|
+
# custom permission sets by using the Quick Sight console. Then, you use
|
17778
18982
|
# the `RegisterUser` API operation to assign the named set of
|
17779
|
-
# permissions to a
|
18983
|
+
# permissions to a Quick Sight user.
|
17780
18984
|
#
|
17781
|
-
#
|
18985
|
+
# Quick Sight custom permissions are applied through IAM policies.
|
17782
18986
|
# Therefore, they override the permissions typically granted by
|
17783
|
-
# assigning
|
17784
|
-
#
|
18987
|
+
# assigning Quick Sight users to one of the default security cohorts in
|
18988
|
+
# Quick Sight (admin, author, reader).
|
17785
18989
|
#
|
17786
|
-
# This feature is available only to
|
18990
|
+
# This feature is available only to Quick Sight Enterprise edition
|
17787
18991
|
# subscriptions.
|
17788
18992
|
#
|
17789
18993
|
# @option params [Boolean] :unapply_custom_permissions
|
@@ -17795,8 +18999,8 @@ module Aws::QuickSight
|
|
17795
18999
|
#
|
17796
19000
|
# @option params [String] :external_login_federation_provider_type
|
17797
19001
|
# The type of supported external login provider that provides identity
|
17798
|
-
# to let a user federate into
|
17799
|
-
# 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
|
17800
19004
|
# provider can be one of the following.
|
17801
19005
|
#
|
17802
19006
|
# * `COGNITO`: Amazon Cognito. The provider URL is
|
@@ -17814,7 +19018,7 @@ module Aws::QuickSight
|
|
17814
19018
|
#
|
17815
19019
|
# @option params [String] :custom_federation_provider_url
|
17816
19020
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
17817
|
-
# identity to let a user federate into
|
19021
|
+
# identity to let a user federate into Quick Sight with an associated
|
17818
19022
|
# Identity and Access Management(IAM) role. This parameter should only
|
17819
19023
|
# be used when `ExternalLoginFederationProviderType` parameter is set to
|
17820
19024
|
# `CUSTOM_OIDC`.
|
@@ -17996,7 +19200,7 @@ module Aws::QuickSight
|
|
17996
19200
|
tracer: tracer
|
17997
19201
|
)
|
17998
19202
|
context[:gem_name] = 'aws-sdk-quicksight'
|
17999
|
-
context[:gem_version] = '1.
|
19203
|
+
context[:gem_version] = '1.161.0'
|
18000
19204
|
Seahorse::Client::Request.new(handlers, context)
|
18001
19205
|
end
|
18002
19206
|
|