aws-sdk-quicksight 1.45.0 → 1.49.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 31c924f1a8acdfefaa939af38a788ac6d8f7681ffd64aceea2dc6da45d3afc68
4
- data.tar.gz: f4bbe757b8d97ca4c4776adc9cc03aa48e8382324e3ef60bd2d078bcc0fef7bc
3
+ metadata.gz: 1f627081cda1221dfdd01a8d676793a9647493332a3f1a5982d86c999118ccdc
4
+ data.tar.gz: 887cbbe61c5819d34954d6d997868610298143fd68576edf1be1b0333ae1a068
5
5
  SHA512:
6
- metadata.gz: ab4442ca5d26a112813cb0633cb78ffa10f028be3fd36313667349a42a46713a6395805f1edc236f9f99f6b60d8bc20217ec86658d0b9a957da2757fd05dede9
7
- data.tar.gz: d6dd6294892907fcc5c87df77d51c0fba08f8dc0634625e7ceba39bf97d3578ab366e141613f390d8bb1e5763c52e45262a36f3208dc852a40b45edef25c8a79
6
+ metadata.gz: 9ea1b2d3f3c4d6f55f2410654bdba26943816d35d66fe225090cc2043bd8888bd1ed1d08d62aba38a89bafff00e44011dd8b66026d0ae7ac52d3c4dfadecbe8d
7
+ data.tar.gz: 43b774e731d74c003b447d0cab408e6ec136f6672ed5a8ba92271d61b37a8f07e2865d807d0992e428ee5b7d0f51a50a221ce2388e5be535c01daa7ad75fa4b0
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.49.0 (2021-07-28)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.48.0 (2021-07-27)
10
+ ------------------
11
+
12
+ * Feature - Add support to use row-level security with tags when embedding dashboards for users not provisioned in QuickSight
13
+
14
+ 1.47.0 (2021-06-23)
15
+ ------------------
16
+
17
+ * Feature - Releasing new APIs for AWS QuickSight Folders
18
+
19
+ 1.46.0 (2021-05-24)
20
+ ------------------
21
+
22
+ * Feature - Add new parameters on RegisterUser and UpdateUser APIs to assign or update external ID associated to QuickSight users federated through web identity.
23
+
4
24
  1.45.0 (2021-05-20)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.45.0
1
+ 1.49.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-quicksight/customizations'
48
48
  # @!group service
49
49
  module Aws::QuickSight
50
50
 
51
- GEM_VERSION = '1.45.0'
51
+ GEM_VERSION = '1.49.0'
52
52
 
53
53
  end
@@ -330,7 +330,7 @@ module Aws::QuickSight
330
330
  # Cancels an ongoing ingestion of data into SPICE.
331
331
  #
332
332
  # @option params [required, String] :aws_account_id
333
- # The AWS account ID.
333
+ # The Amazon Web Services account; ID.
334
334
  #
335
335
  # @option params [required, String] :data_set_id
336
336
  # The ID of the dataset used in the ingestion.
@@ -369,18 +369,19 @@ module Aws::QuickSight
369
369
  req.send_request(options)
370
370
  end
371
371
 
372
- # Creates Amazon QuickSight customizations the current AWS Region.
372
+ # Creates Amazon QuickSight customizations the current Region;.
373
373
  # Currently, you can add a custom default theme by using the
374
374
  # `CreateAccountCustomization` or `UpdateAccountCustomization` API
375
375
  # operation. To further customize QuickSight by removing QuickSight
376
376
  # sample assets and videos for all new users, see [Customizing
377
377
  # QuickSight][1] in the *Amazon QuickSight User Guide.*
378
378
  #
379
- # You can create customizations for your AWS account or, if you specify
380
- # a namespace, for a QuickSight namespace instead. Customizations that
381
- # apply to a namespace always override customizations that apply to an
382
- # AWS account. To find out which customizations apply, use the
383
- # `DescribeAccountCustomization` API operation.
379
+ # You can create customizations for your Amazon Web Services account;
380
+ # or, if you specify a namespace, for a QuickSight namespace instead.
381
+ # Customizations that apply to a namespace always override
382
+ # customizations that apply to an Amazon Web Services account;. To find
383
+ # out which customizations apply, use the `DescribeAccountCustomization`
384
+ # API operation.
384
385
  #
385
386
  # Before you use the `CreateAccountCustomization` API operation to add a
386
387
  # theme as the namespace default, make sure that you first share the
@@ -396,14 +397,15 @@ module Aws::QuickSight
396
397
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
397
398
  #
398
399
  # @option params [required, String] :aws_account_id
399
- # The ID for the AWS account that you want to customize QuickSight for.
400
+ # The ID for the Amazon Web Services account; that you want to customize
401
+ # QuickSight for.
400
402
  #
401
403
  # @option params [String] :namespace
402
404
  # The QuickSight namespace that you want to add customizations to.
403
405
  #
404
406
  # @option params [required, Types::AccountCustomization] :account_customization
405
- # The QuickSight customizations you're adding in the current AWS
406
- # Region. You can add these to an AWS account and a QuickSight
407
+ # The QuickSight customizations you're adding in the current Region;.
408
+ # You can add these to an Amazon Web Services account; and a QuickSight
407
409
  # namespace.
408
410
  #
409
411
  # For example, you can add a default theme by setting
@@ -463,7 +465,8 @@ module Aws::QuickSight
463
465
  # Creates an analysis in Amazon QuickSight.
464
466
  #
465
467
  # @option params [required, String] :aws_account_id
466
- # The ID of the AWS account where you are creating an analysis.
468
+ # The ID of the Amazon Web Services account; where you are creating an
469
+ # analysis.
467
470
  #
468
471
  # @option params [required, String] :analysis_id
469
472
  # The ID for the analysis that you're creating. This ID displays in the
@@ -481,7 +484,7 @@ module Aws::QuickSight
481
484
  # @option params [Array<Types::ResourcePermission>] :permissions
482
485
  # A structure that describes the principals and the resource-level
483
486
  # permissions on an analysis. You can use the `Permissions` structure to
484
- # grant permissions by providing a list of AWS Identity and Access
487
+ # grant permissions by providing a list of Identity and Access
485
488
  # Management (IAM) action information for each principal listed by
486
489
  # Amazon Resource Name (ARN).
487
490
  #
@@ -591,10 +594,12 @@ module Aws::QuickSight
591
594
  # reports, created from analyses. You can share QuickSight dashboards.
592
595
  # With the right permissions, you can create scheduled email reports
593
596
  # from them. If you have the correct permissions, you can create a
594
- # dashboard from a template that exists in a different AWS account.
597
+ # dashboard from a template that exists in a different Amazon Web
598
+ # Services account;.
595
599
  #
596
600
  # @option params [required, String] :aws_account_id
597
- # The ID of the AWS account where you want to create the dashboard.
601
+ # The ID of the Amazon Web Services account; where you want to create
602
+ # the dashboard.
598
603
  #
599
604
  # @option params [required, String] :dashboard_id
600
605
  # The ID for the dashboard, also added to the IAM policy.
@@ -622,8 +627,8 @@ module Aws::QuickSight
622
627
  # from an analysis, first convert the analysis to a template by using
623
628
  # the CreateTemplate API operation. For `SourceTemplate`, specify the
624
629
  # Amazon Resource Name (ARN) of the source template. The
625
- # `SourceTemplate`ARN can contain any AWS Account and any
626
- # QuickSight-supported AWS Region.
630
+ # `SourceTemplate`ARN can contain any Amazon Web Services account; and
631
+ # any QuickSight-supported Region;.
627
632
  #
628
633
  # Use the `DataSetReferences` entity within `SourceTemplate` to list the
629
634
  # replacement datasets for the placeholders listed in the original. The
@@ -658,7 +663,7 @@ module Aws::QuickSight
658
663
  # The Amazon Resource Name (ARN) of the theme that is being used for
659
664
  # this dashboard. If you add a value for this field, it overrides the
660
665
  # value that is used in the source entity. The theme ARN must exist in
661
- # the same AWS account where you create the dashboard.
666
+ # the same Amazon Web Services account; where you create the dashboard.
662
667
  #
663
668
  # @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
664
669
  #
@@ -760,11 +765,11 @@ module Aws::QuickSight
760
765
  # Creates a dataset.
761
766
  #
762
767
  # @option params [required, String] :aws_account_id
763
- # The AWS account ID.
768
+ # The Amazon Web Services account; ID.
764
769
  #
765
770
  # @option params [required, String] :data_set_id
766
771
  # An ID for the dataset that you want to create. This ID is unique per
767
- # AWS Region for each AWS account.
772
+ # Region; for each Amazon Web Services account;.
768
773
  #
769
774
  # @option params [required, String] :name
770
775
  # The display name for the dataset.
@@ -795,6 +800,11 @@ module Aws::QuickSight
795
800
  # The row-level security configuration for the data that you want to
796
801
  # create.
797
802
  #
803
+ # @option params [Types::RowLevelPermissionTagConfiguration] :row_level_permission_tag_configuration
804
+ # The configuration of tags on a dataset to set row-level security.
805
+ # Row-level security tags are currently supported for anonymous
806
+ # embedding only.
807
+ #
798
808
  # @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
799
809
  # A set of one or more definitions of a ` ColumnLevelPermissionRule `.
800
810
  #
@@ -946,6 +956,18 @@ module Aws::QuickSight
946
956
  # arn: "Arn", # required
947
957
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
948
958
  # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
959
+ # status: "ENABLED", # accepts ENABLED, DISABLED
960
+ # },
961
+ # row_level_permission_tag_configuration: {
962
+ # status: "ENABLED", # accepts ENABLED, DISABLED
963
+ # tag_rules: [ # required
964
+ # {
965
+ # tag_key: "SessionTagKey", # required
966
+ # column_name: "String", # required
967
+ # tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
968
+ # match_all_value: "SessionTagValue",
969
+ # },
970
+ # ],
949
971
  # },
950
972
  # column_level_permission_rules: [
951
973
  # {
@@ -982,11 +1004,11 @@ module Aws::QuickSight
982
1004
  # Creates a data source.
983
1005
  #
984
1006
  # @option params [required, String] :aws_account_id
985
- # The AWS account ID.
1007
+ # The Amazon Web Services account; ID.
986
1008
  #
987
1009
  # @option params [required, String] :data_source_id
988
- # An ID for the data source. This ID is unique per AWS Region for each
989
- # AWS account.
1010
+ # An ID for the data source. This ID is unique per Region; for each
1011
+ # Amazon Web Services account;.
990
1012
  #
991
1013
  # @option params [required, String] :name
992
1014
  # A display name for the data source.
@@ -1267,6 +1289,127 @@ module Aws::QuickSight
1267
1289
  req.send_request(options)
1268
1290
  end
1269
1291
 
1292
+ # Creates an empty shared folder.
1293
+ #
1294
+ # @option params [required, String] :aws_account_id
1295
+ # The AWS Account ID.
1296
+ #
1297
+ # @option params [required, String] :folder_id
1298
+ # The folder ID.
1299
+ #
1300
+ # @option params [String] :name
1301
+ # The name of the folder.
1302
+ #
1303
+ # @option params [String] :folder_type
1304
+ # The type of folder. By default, `folderType` is `SHARED`.
1305
+ #
1306
+ # @option params [String] :parent_folder_arn
1307
+ # The Amazon Resource Name (ARN) for the parent folder.
1308
+ #
1309
+ # `ParentFolderArn` can be null. An empty `parentFolderArn` creates a
1310
+ # root-level folder.
1311
+ #
1312
+ # @option params [Array<Types::ResourcePermission>] :permissions
1313
+ # A structure that describes the principals and the resource-level
1314
+ # permissions of a folder.
1315
+ #
1316
+ # To specify no permissions, omit `Permissions`.
1317
+ #
1318
+ # @option params [Array<Types::Tag>] :tags
1319
+ # Tags for the folder.
1320
+ #
1321
+ # @return [Types::CreateFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1322
+ #
1323
+ # * {Types::CreateFolderResponse#status #status} => Integer
1324
+ # * {Types::CreateFolderResponse#arn #arn} => String
1325
+ # * {Types::CreateFolderResponse#folder_id #folder_id} => String
1326
+ # * {Types::CreateFolderResponse#request_id #request_id} => String
1327
+ #
1328
+ # @example Request syntax with placeholder values
1329
+ #
1330
+ # resp = client.create_folder({
1331
+ # aws_account_id: "AwsAccountId", # required
1332
+ # folder_id: "RestrictiveResourceId", # required
1333
+ # name: "FolderName",
1334
+ # folder_type: "SHARED", # accepts SHARED
1335
+ # parent_folder_arn: "Arn",
1336
+ # permissions: [
1337
+ # {
1338
+ # principal: "Principal", # required
1339
+ # actions: ["String"], # required
1340
+ # },
1341
+ # ],
1342
+ # tags: [
1343
+ # {
1344
+ # key: "TagKey", # required
1345
+ # value: "TagValue", # required
1346
+ # },
1347
+ # ],
1348
+ # })
1349
+ #
1350
+ # @example Response structure
1351
+ #
1352
+ # resp.status #=> Integer
1353
+ # resp.arn #=> String
1354
+ # resp.folder_id #=> String
1355
+ # resp.request_id #=> String
1356
+ #
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolder AWS API Documentation
1358
+ #
1359
+ # @overload create_folder(params = {})
1360
+ # @param [Hash] params ({})
1361
+ def create_folder(params = {}, options = {})
1362
+ req = build_request(:create_folder, params)
1363
+ req.send_request(options)
1364
+ end
1365
+
1366
+ # Adds an asset, such as a dashboard, analysis, or dataset into a
1367
+ # folder.
1368
+ #
1369
+ # @option params [required, String] :aws_account_id
1370
+ # The AWS Account ID.
1371
+ #
1372
+ # @option params [required, String] :folder_id
1373
+ # The folder ID.
1374
+ #
1375
+ # @option params [required, String] :member_id
1376
+ # The ID of the asset (the dashboard, analysis, or dataset).
1377
+ #
1378
+ # @option params [required, String] :member_type
1379
+ # The type of the member, including `DASHBOARD`, `ANALYSIS`, and
1380
+ # `DATASET`.
1381
+ #
1382
+ # @return [Types::CreateFolderMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1383
+ #
1384
+ # * {Types::CreateFolderMembershipResponse#status #status} => Integer
1385
+ # * {Types::CreateFolderMembershipResponse#folder_member #folder_member} => Types::FolderMember
1386
+ # * {Types::CreateFolderMembershipResponse#request_id #request_id} => String
1387
+ #
1388
+ # @example Request syntax with placeholder values
1389
+ #
1390
+ # resp = client.create_folder_membership({
1391
+ # aws_account_id: "AwsAccountId", # required
1392
+ # folder_id: "RestrictiveResourceId", # required
1393
+ # member_id: "RestrictiveResourceId", # required
1394
+ # member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
1395
+ # })
1396
+ #
1397
+ # @example Response structure
1398
+ #
1399
+ # resp.status #=> Integer
1400
+ # resp.folder_member.member_id #=> String
1401
+ # resp.folder_member.member_type #=> String, one of "DASHBOARD", "ANALYSIS", "DATASET"
1402
+ # resp.request_id #=> String
1403
+ #
1404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembership AWS API Documentation
1405
+ #
1406
+ # @overload create_folder_membership(params = {})
1407
+ # @param [Hash] params ({})
1408
+ def create_folder_membership(params = {}, options = {})
1409
+ req = build_request(:create_folder_membership, params)
1410
+ req.send_request(options)
1411
+ end
1412
+
1270
1413
  # Creates an Amazon QuickSight group.
1271
1414
  #
1272
1415
  # The permissions resource is
@@ -1282,9 +1425,9 @@ module Aws::QuickSight
1282
1425
  # A description for the group that you want to create.
1283
1426
  #
1284
1427
  # @option params [required, String] :aws_account_id
1285
- # The ID for the AWS account that the group is in. Currently, you use
1286
- # the ID for the AWS account that contains your Amazon QuickSight
1287
- # account.
1428
+ # The ID for the Amazon Web Services account; that the group is in.
1429
+ # Currently, you use the ID for the Amazon Web Services account; that
1430
+ # contains your Amazon QuickSight account.
1288
1431
  #
1289
1432
  # @option params [required, String] :namespace
1290
1433
  # The namespace. Currently, you should set this to `default`.
@@ -1331,9 +1474,9 @@ module Aws::QuickSight
1331
1474
  # The name of the group that you want to add the user to.
1332
1475
  #
1333
1476
  # @option params [required, String] :aws_account_id
1334
- # The ID for the AWS account that the group is in. Currently, you use
1335
- # the ID for the AWS account that contains your Amazon QuickSight
1336
- # account.
1477
+ # The ID for the Amazon Web Services account; that the group is in.
1478
+ # Currently, you use the ID for the Amazon Web Services account; that
1479
+ # contains your Amazon QuickSight account.
1337
1480
  #
1338
1481
  # @option params [required, String] :namespace
1339
1482
  # The namespace. Currently, you should set this to `default`.
@@ -1372,16 +1515,16 @@ module Aws::QuickSight
1372
1515
  # Creates an assignment with one specified IAM policy, identified by its
1373
1516
  # Amazon Resource Name (ARN). This policy assignment is attached to the
1374
1517
  # specified groups or users of Amazon QuickSight. Assignment names are
1375
- # unique per AWS account. To avoid overwriting rules in other
1376
- # namespaces, use assignment names that are unique.
1518
+ # unique per Amazon Web Services account;. To avoid overwriting rules in
1519
+ # other namespaces, use assignment names that are unique.
1377
1520
  #
1378
1521
  # @option params [required, String] :aws_account_id
1379
- # The ID of the AWS account where you want to assign an IAM policy to
1380
- # QuickSight users or groups.
1522
+ # The ID of the Amazon Web Services account; where you want to assign an
1523
+ # IAM policy to QuickSight users or groups.
1381
1524
  #
1382
1525
  # @option params [required, String] :assignment_name
1383
1526
  # The name of the assignment, also called a rule. It must be unique
1384
- # within an AWS account.
1527
+ # within an Amazon Web Services account;.
1385
1528
  #
1386
1529
  # @option params [required, String] :assignment_status
1387
1530
  # The status of the assignment. Possible values are as follows:
@@ -1455,8 +1598,8 @@ module Aws::QuickSight
1455
1598
  # Any ingestions operating on tagged datasets inherit the same tags
1456
1599
  # automatically for use in access control. For an example, see [How do I
1457
1600
  # create an IAM policy to control access to Amazon EC2 resources using
1458
- # tags?][1] in the AWS Knowledge Center. Tags are visible on the tagged
1459
- # dataset, but not on the ingestion resource.
1601
+ # tags?][1] in the Amazon Web Services Knowledge Center. Tags are
1602
+ # visible on the tagged dataset, but not on the ingestion resource.
1460
1603
  #
1461
1604
  #
1462
1605
  #
@@ -1469,7 +1612,7 @@ module Aws::QuickSight
1469
1612
  # An ID for the ingestion.
1470
1613
  #
1471
1614
  # @option params [required, String] :aws_account_id
1472
- # The AWS account ID.
1615
+ # The Amazon Web Services account; ID.
1473
1616
  #
1474
1617
  # @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1475
1618
  #
@@ -1511,14 +1654,15 @@ module Aws::QuickSight
1511
1654
  # are registered for that namespace. Users that access the namespace can
1512
1655
  # share assets only with other users or groups in the same namespace.
1513
1656
  # They can't see users and groups in other namespaces. You can create a
1514
- # namespace after your AWS account is subscribed to QuickSight. The
1515
- # namespace must be unique within the AWS account. By default, there is
1516
- # a limit of 100 namespaces per AWS account. To increase your limit,
1517
- # create a ticket with AWS Support.
1657
+ # namespace after your Amazon Web Services account; is subscribed to
1658
+ # QuickSight. The namespace must be unique within the Amazon Web
1659
+ # Services account;. By default, there is a limit of 100 namespaces per
1660
+ # Amazon Web Services account;. To increase your limit, create a ticket
1661
+ # with Amazon Web Services Support.
1518
1662
  #
1519
1663
  # @option params [required, String] :aws_account_id
1520
- # The ID for the AWS account that you want to create the QuickSight
1521
- # namespace in.
1664
+ # The ID for the Amazon Web Services account; that you want to create
1665
+ # the QuickSight namespace in.
1522
1666
  #
1523
1667
  # @option params [required, String] :namespace
1524
1668
  # The name that you want to use to describe the new namespace.
@@ -1574,8 +1718,8 @@ module Aws::QuickSight
1574
1718
  req.send_request(options)
1575
1719
  end
1576
1720
 
1577
- # Creates a template from an existing QuickSight analysis or template.
1578
- # You can use the resulting template to create a dashboard.
1721
+ # Creates a template from an existing Amazon QuickSight analysis or
1722
+ # template. You can use the resulting template to create a dashboard.
1579
1723
  #
1580
1724
  # A *template* is an entity in QuickSight that encapsulates the metadata
1581
1725
  # required to create an analysis and that you can use to create s
@@ -1586,13 +1730,13 @@ module Aws::QuickSight
1586
1730
  # to create the source analysis and template.
1587
1731
  #
1588
1732
  # @option params [required, String] :aws_account_id
1589
- # The ID for the AWS account that the group is in. Currently, you use
1590
- # the ID for the AWS account that contains your Amazon QuickSight
1591
- # account.
1733
+ # The ID for the Amazon Web Services account; that the group is in.
1734
+ # Currently, you use the ID for the Amazon Web Services account; that
1735
+ # contains your Amazon QuickSight account.
1592
1736
  #
1593
1737
  # @option params [required, String] :template_id
1594
1738
  # An ID for the template that you want to create. This template is
1595
- # unique per AWS Region in each AWS account.
1739
+ # unique per Region; in each Amazon Web Services account;.
1596
1740
  #
1597
1741
  # @option params [String] :name
1598
1742
  # A display name for the template.
@@ -1607,8 +1751,8 @@ module Aws::QuickSight
1607
1751
  # for an analysis. Both of these require an Amazon Resource Name (ARN).
1608
1752
  # For `SourceTemplate`, specify the ARN of the source template. For
1609
1753
  # `SourceAnalysis`, specify the ARN of the source analysis. The
1610
- # `SourceTemplate` ARN can contain any AWS Account and any
1611
- # QuickSight-supported AWS Region.
1754
+ # `SourceTemplate` ARN can contain any Amazon Web Services account; and
1755
+ # any QuickSight-supported Region;.
1612
1756
  #
1613
1757
  # Use the `DataSetReferences` entity within `SourceTemplate` or
1614
1758
  # `SourceAnalysis` to list the replacement datasets for the placeholders
@@ -1691,8 +1835,8 @@ module Aws::QuickSight
1691
1835
  # Creates a template alias for a template.
1692
1836
  #
1693
1837
  # @option params [required, String] :aws_account_id
1694
- # The ID of the AWS account that contains the template that you creating
1695
- # an alias for.
1838
+ # The ID of the Amazon Web Services account; that contains the template
1839
+ # that you creating an alias for.
1696
1840
  #
1697
1841
  # @option params [required, String] :template_id
1698
1842
  # An ID for the template.
@@ -1700,7 +1844,7 @@ module Aws::QuickSight
1700
1844
  # @option params [required, String] :alias_name
1701
1845
  # The name that you want to give to the template alias that you're
1702
1846
  # creating. Don't start the alias name with the `$` character. Alias
1703
- # names that start with `$` are reserved by QuickSight.
1847
+ # names that start with `$` are reserved by Amazon QuickSight.
1704
1848
  #
1705
1849
  # @option params [required, Integer] :template_version_number
1706
1850
  # The version number of the template.
@@ -1748,11 +1892,12 @@ module Aws::QuickSight
1748
1892
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
1749
1893
  #
1750
1894
  # @option params [required, String] :aws_account_id
1751
- # The ID of the AWS account where you want to store the new theme.
1895
+ # The ID of the Amazon Web Services account; where you want to store the
1896
+ # new theme.
1752
1897
  #
1753
1898
  # @option params [required, String] :theme_id
1754
1899
  # An ID for the theme that you want to create. The theme ID is unique
1755
- # per AWS Region in each AWS account.
1900
+ # per Region; in each Amazon Web Services account;.
1756
1901
  #
1757
1902
  # @option params [required, String] :name
1758
1903
  # A display name for the theme.
@@ -1871,8 +2016,8 @@ module Aws::QuickSight
1871
2016
  # Creates a theme alias for a theme.
1872
2017
  #
1873
2018
  # @option params [required, String] :aws_account_id
1874
- # The ID of the AWS account that contains the theme for the new theme
1875
- # alias.
2019
+ # The ID of the Amazon Web Services account; that contains the theme for
2020
+ # the new theme alias.
1876
2021
  #
1877
2022
  # @option params [required, String] :theme_id
1878
2023
  # An ID for the theme alias.
@@ -1917,12 +2062,12 @@ module Aws::QuickSight
1917
2062
  req.send_request(options)
1918
2063
  end
1919
2064
 
1920
- # Deletes all Amazon QuickSight customizations in this AWS Region for
1921
- # the specified AWS account and QuickSight namespace.
2065
+ # Deletes all Amazon QuickSight customizations in this Region; for the
2066
+ # specified Amazon Web Services account; and QuickSight namespace.
1922
2067
  #
1923
2068
  # @option params [required, String] :aws_account_id
1924
- # The ID for the AWS account that you want to delete QuickSight
1925
- # customizations from in this AWS Region.
2069
+ # The ID for the Amazon Web Services account; that you want to delete
2070
+ # QuickSight customizations from in this Region;.
1926
2071
  #
1927
2072
  # @option params [String] :namespace
1928
2073
  # The QuickSight namespace that you're deleting the customizations
@@ -1972,7 +2117,8 @@ module Aws::QuickSight
1972
2117
  # an analysis doesn't delete the dashboards that you publish from it.
1973
2118
  #
1974
2119
  # @option params [required, String] :aws_account_id
1975
- # The ID of the AWS account where you want to delete an analysis.
2120
+ # The ID of the Amazon Web Services account; where you want to delete an
2121
+ # analysis.
1976
2122
  #
1977
2123
  # @option params [required, String] :analysis_id
1978
2124
  # The ID of the analysis that you're deleting.
@@ -2025,8 +2171,8 @@ module Aws::QuickSight
2025
2171
  # Deletes a dashboard.
2026
2172
  #
2027
2173
  # @option params [required, String] :aws_account_id
2028
- # The ID of the AWS account that contains the dashboard that you're
2029
- # deleting.
2174
+ # The ID of the Amazon Web Services account; that contains the dashboard
2175
+ # that you're deleting.
2030
2176
  #
2031
2177
  # @option params [required, String] :dashboard_id
2032
2178
  # The ID for the dashboard.
@@ -2069,11 +2215,11 @@ module Aws::QuickSight
2069
2215
  # Deletes a dataset.
2070
2216
  #
2071
2217
  # @option params [required, String] :aws_account_id
2072
- # The AWS account ID.
2218
+ # The Amazon Web Services account; ID.
2073
2219
  #
2074
2220
  # @option params [required, String] :data_set_id
2075
2221
  # The ID for the dataset that you want to create. This ID is unique per
2076
- # AWS Region for each AWS account.
2222
+ # Region; for each Amazon Web Services account;.
2077
2223
  #
2078
2224
  # @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2079
2225
  #
@@ -2109,11 +2255,11 @@ module Aws::QuickSight
2109
2255
  # datasets that reference the deleted data source.
2110
2256
  #
2111
2257
  # @option params [required, String] :aws_account_id
2112
- # The AWS account ID.
2258
+ # The Amazon Web Services account; ID.
2113
2259
  #
2114
2260
  # @option params [required, String] :data_source_id
2115
- # The ID of the data source. This ID is unique per AWS Region for each
2116
- # AWS account.
2261
+ # The ID of the data source. This ID is unique per Region; for each
2262
+ # Amazon Web Services account;.
2117
2263
  #
2118
2264
  # @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2119
2265
  #
@@ -2145,15 +2291,98 @@ module Aws::QuickSight
2145
2291
  req.send_request(options)
2146
2292
  end
2147
2293
 
2294
+ # Deletes an empty folder.
2295
+ #
2296
+ # @option params [required, String] :aws_account_id
2297
+ # The AWS Account ID for the folder.
2298
+ #
2299
+ # @option params [required, String] :folder_id
2300
+ # The folder ID.
2301
+ #
2302
+ # @return [Types::DeleteFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2303
+ #
2304
+ # * {Types::DeleteFolderResponse#status #status} => Integer
2305
+ # * {Types::DeleteFolderResponse#arn #arn} => String
2306
+ # * {Types::DeleteFolderResponse#folder_id #folder_id} => String
2307
+ # * {Types::DeleteFolderResponse#request_id #request_id} => String
2308
+ #
2309
+ # @example Request syntax with placeholder values
2310
+ #
2311
+ # resp = client.delete_folder({
2312
+ # aws_account_id: "AwsAccountId", # required
2313
+ # folder_id: "RestrictiveResourceId", # required
2314
+ # })
2315
+ #
2316
+ # @example Response structure
2317
+ #
2318
+ # resp.status #=> Integer
2319
+ # resp.arn #=> String
2320
+ # resp.folder_id #=> String
2321
+ # resp.request_id #=> String
2322
+ #
2323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolder AWS API Documentation
2324
+ #
2325
+ # @overload delete_folder(params = {})
2326
+ # @param [Hash] params ({})
2327
+ def delete_folder(params = {}, options = {})
2328
+ req = build_request(:delete_folder, params)
2329
+ req.send_request(options)
2330
+ end
2331
+
2332
+ # Removes an asset, such as a dashboard, analysis, or dataset, from a
2333
+ # folder.
2334
+ #
2335
+ # @option params [required, String] :aws_account_id
2336
+ # The AWS Account ID.
2337
+ #
2338
+ # @option params [required, String] :folder_id
2339
+ # The Folder ID.
2340
+ #
2341
+ # @option params [required, String] :member_id
2342
+ # The ID of the asset (the dashboard, analysis, or dataset) that you
2343
+ # want to delete.
2344
+ #
2345
+ # @option params [required, String] :member_type
2346
+ # The type of the member, including `DASHBOARD`, `ANALYSIS`, and
2347
+ # `DATASET`
2348
+ #
2349
+ # @return [Types::DeleteFolderMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2350
+ #
2351
+ # * {Types::DeleteFolderMembershipResponse#status #status} => Integer
2352
+ # * {Types::DeleteFolderMembershipResponse#request_id #request_id} => String
2353
+ #
2354
+ # @example Request syntax with placeholder values
2355
+ #
2356
+ # resp = client.delete_folder_membership({
2357
+ # aws_account_id: "AwsAccountId", # required
2358
+ # folder_id: "RestrictiveResourceId", # required
2359
+ # member_id: "RestrictiveResourceId", # required
2360
+ # member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
2361
+ # })
2362
+ #
2363
+ # @example Response structure
2364
+ #
2365
+ # resp.status #=> Integer
2366
+ # resp.request_id #=> String
2367
+ #
2368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembership AWS API Documentation
2369
+ #
2370
+ # @overload delete_folder_membership(params = {})
2371
+ # @param [Hash] params ({})
2372
+ def delete_folder_membership(params = {}, options = {})
2373
+ req = build_request(:delete_folder_membership, params)
2374
+ req.send_request(options)
2375
+ end
2376
+
2148
2377
  # Removes a user group from Amazon QuickSight.
2149
2378
  #
2150
2379
  # @option params [required, String] :group_name
2151
2380
  # The name of the group that you want to delete.
2152
2381
  #
2153
2382
  # @option params [required, String] :aws_account_id
2154
- # The ID for the AWS account that the group is in. Currently, you use
2155
- # the ID for the AWS account that contains your Amazon QuickSight
2156
- # account.
2383
+ # The ID for the Amazon Web Services account; that the group is in.
2384
+ # Currently, you use the ID for the Amazon Web Services account; that
2385
+ # contains your Amazon QuickSight account.
2157
2386
  #
2158
2387
  # @option params [required, String] :namespace
2159
2388
  # The namespace. Currently, you should set this to `default`.
@@ -2196,9 +2425,9 @@ module Aws::QuickSight
2196
2425
  # The name of the group that you want to delete the user from.
2197
2426
  #
2198
2427
  # @option params [required, String] :aws_account_id
2199
- # The ID for the AWS account that the group is in. Currently, you use
2200
- # the ID for the AWS account that contains your Amazon QuickSight
2201
- # account.
2428
+ # The ID for the Amazon Web Services account; that the group is in.
2429
+ # Currently, you use the ID for the Amazon Web Services account; that
2430
+ # contains your Amazon QuickSight account.
2202
2431
  #
2203
2432
  # @option params [required, String] :namespace
2204
2433
  # The namespace. Currently, you should set this to `default`.
@@ -2234,7 +2463,8 @@ module Aws::QuickSight
2234
2463
  # Deletes an existing IAM policy assignment.
2235
2464
  #
2236
2465
  # @option params [required, String] :aws_account_id
2237
- # The AWS account ID where you want to delete the IAM policy assignment.
2466
+ # The Amazon Web Services account; ID where you want to delete the IAM
2467
+ # policy assignment.
2238
2468
  #
2239
2469
  # @option params [required, String] :assignment_name
2240
2470
  # The name of the assignment.
@@ -2278,8 +2508,8 @@ module Aws::QuickSight
2278
2508
  # asset.
2279
2509
  #
2280
2510
  # @option params [required, String] :aws_account_id
2281
- # The ID for the AWS account that you want to delete the QuickSight
2282
- # namespace from.
2511
+ # The ID for the Amazon Web Services account; that you want to delete
2512
+ # the QuickSight namespace from.
2283
2513
  #
2284
2514
  # @option params [required, String] :namespace
2285
2515
  # The namespace that you want to delete.
@@ -2313,8 +2543,8 @@ module Aws::QuickSight
2313
2543
  # Deletes a template.
2314
2544
  #
2315
2545
  # @option params [required, String] :aws_account_id
2316
- # The ID of the AWS account that contains the template that you're
2317
- # deleting.
2546
+ # The ID of the Amazon Web Services account; that contains the template
2547
+ # that you're deleting.
2318
2548
  #
2319
2549
  # @option params [required, String] :template_id
2320
2550
  # An ID for the template you want to delete.
@@ -2360,7 +2590,8 @@ module Aws::QuickSight
2360
2590
  # the alias points to.
2361
2591
  #
2362
2592
  # @option params [required, String] :aws_account_id
2363
- # The ID of the AWS account that contains the item to delete.
2593
+ # The ID of the Amazon Web Services account; that contains the item to
2594
+ # delete.
2364
2595
  #
2365
2596
  # @option params [required, String] :template_id
2366
2597
  # The ID for the template that the specified alias is for.
@@ -2407,8 +2638,8 @@ module Aws::QuickSight
2407
2638
  # Deletes a theme.
2408
2639
  #
2409
2640
  # @option params [required, String] :aws_account_id
2410
- # The ID of the AWS account that contains the theme that you're
2411
- # deleting.
2641
+ # The ID of the Amazon Web Services account; that contains the theme
2642
+ # that you're deleting.
2412
2643
  #
2413
2644
  # @option params [required, String] :theme_id
2414
2645
  # An ID for the theme that you want to delete.
@@ -2455,7 +2686,8 @@ module Aws::QuickSight
2455
2686
  # theme that the alias points to.
2456
2687
  #
2457
2688
  # @option params [required, String] :aws_account_id
2458
- # The ID of the AWS account that contains the theme alias to delete.
2689
+ # The ID of the Amazon Web Services account; that contains the theme
2690
+ # alias to delete.
2459
2691
  #
2460
2692
  # @option params [required, String] :theme_id
2461
2693
  # The ID for the theme that the specified alias is for.
@@ -2497,7 +2729,7 @@ module Aws::QuickSight
2497
2729
  end
2498
2730
 
2499
2731
  # Deletes the Amazon QuickSight user that is associated with the
2500
- # identity of the AWS Identity and Access Management (IAM) user or role
2732
+ # identity of the Identity and Access Management (IAM) user or role
2501
2733
  # that's making the call. The IAM user isn't deleted as a result of
2502
2734
  # this call.
2503
2735
  #
@@ -2505,8 +2737,9 @@ module Aws::QuickSight
2505
2737
  # The name of the user that you want to delete.
2506
2738
  #
2507
2739
  # @option params [required, String] :aws_account_id
2508
- # The ID for the AWS account that the user is in. Currently, you use the
2509
- # ID for the AWS account that contains your Amazon QuickSight account.
2740
+ # The ID for the Amazon Web Services account; that the user is in.
2741
+ # Currently, you use the ID for the Amazon Web Services account; that
2742
+ # contains your Amazon QuickSight account.
2510
2743
  #
2511
2744
  # @option params [required, String] :namespace
2512
2745
  # The namespace. Currently, you should set this to `default`.
@@ -2544,8 +2777,9 @@ module Aws::QuickSight
2544
2777
  # The principal ID of the user.
2545
2778
  #
2546
2779
  # @option params [required, String] :aws_account_id
2547
- # The ID for the AWS account that the user is in. Currently, you use the
2548
- # ID for the AWS account that contains your Amazon QuickSight account.
2780
+ # The ID for the Amazon Web Services account; that the user is in.
2781
+ # Currently, you use the ID for the Amazon Web Services account; that
2782
+ # contains your Amazon QuickSight account.
2549
2783
  #
2550
2784
  # @option params [required, String] :namespace
2551
2785
  # The namespace. Currently, you should set this to `default`.
@@ -2577,28 +2811,29 @@ module Aws::QuickSight
2577
2811
  req.send_request(options)
2578
2812
  end
2579
2813
 
2580
- # Describes the customizations associated with the provided AWS account
2581
- # and Amazon QuickSight namespace in an AWS Region. The QuickSight
2582
- # console evaluates which customizations to apply by running this API
2583
- # operation with the `Resolved` flag included.
2814
+ # Describes the customizations associated with the provided Amazon Web
2815
+ # Services account; and Amazon QuickSight namespace in an Region;. The
2816
+ # QuickSight console evaluates which customizations to apply by running
2817
+ # this API operation with the `Resolved` flag included.
2584
2818
  #
2585
2819
  # To determine what customizations display when you run this command, it
2586
2820
  # can help to visualize the relationship of the entities involved.
2587
2821
  #
2588
- # * `AWS Account` - The AWS account exists at the top of the hierarchy.
2589
- # It has the potential to use all of the AWS Regions and AWS Services.
2590
- # When you subscribe to QuickSight, you choose one AWS Region to use
2591
- # as your home Region. That's where your free SPICE capacity is
2592
- # located. You can use QuickSight in any supported AWS Region.
2593
- #
2594
- # * `AWS Region` - In each AWS Region where you sign in to QuickSight at
2595
- # least once, QuickSight acts as a separate instance of the same
2596
- # service. If you have a user directory, it resides in us-east-1,
2597
- # which is the US East (N. Virginia). Generally speaking, these users
2598
- # have access to QuickSight in any AWS Region, unless they are
2599
- # constrained to a namespace.
2822
+ # * `Amazon Web Services account;` - The Amazon Web Services account;
2823
+ # exists at the top of the hierarchy. It has the potential to use all
2824
+ # of the Regions; and AWS Services. When you subscribe to QuickSight,
2825
+ # you choose one Region; to use as your home Region. That's where
2826
+ # your free SPICE capacity is located. You can use QuickSight in any
2827
+ # supported Region;.
2828
+ #
2829
+ # * `Region;` - In each Region; where you sign in to QuickSight at least
2830
+ # once, QuickSight acts as a separate instance of the same service. If
2831
+ # you have a user directory, it resides in us-east-1, which is the US
2832
+ # East (N. Virginia). Generally speaking, these users have access to
2833
+ # QuickSight in any Region;, unless they are constrained to a
2834
+ # namespace.
2600
2835
  #
2601
- # To run the command in a different AWS Region, you change your Region
2836
+ # To run the command in a different Region;, you change your Region
2602
2837
  # settings. If you're using the AWS CLI, you can use one of the
2603
2838
  # following options:
2604
2839
  #
@@ -2606,8 +2841,8 @@ module Aws::QuickSight
2606
2841
  #
2607
2842
  # * Use [named profiles][2].
2608
2843
  #
2609
- # * Run `aws configure` to change your default AWS Region. Use Enter
2610
- # to key the same settings for your keys. For more information, see
2844
+ # * Run `aws configure` to change your default Region;. Use Enter to
2845
+ # key the same settings for your keys. For more information, see
2611
2846
  # [Configuring the AWS CLI][3].
2612
2847
  #
2613
2848
  # * `Namespace` - A QuickSight namespace is a partition that contains
@@ -2615,14 +2850,15 @@ module Aws::QuickSight
2615
2850
  # access assets that are in a specific namespace, users and groups
2616
2851
  # must also be part of the same namespace. People who share a
2617
2852
  # namespace are completely isolated from users and assets in other
2618
- # namespaces, even if they are in the same AWS account and AWS Region.
2619
- #
2620
- # * `Applied customizations` - Within an AWS Region, a set of QuickSight
2621
- # customizations can apply to an AWS account or to a namespace.
2622
- # Settings that you apply to a namespace override settings that you
2623
- # apply to an AWS account. All settings are isolated to a single AWS
2624
- # Region. To apply them in other AWS Regions, run the
2625
- # `CreateAccountCustomization` command in each AWS Region where you
2853
+ # namespaces, even if they are in the same Amazon Web Services
2854
+ # account; and Region;.
2855
+ #
2856
+ # * `Applied customizations` - Within an Region;, a set of QuickSight
2857
+ # customizations can apply to an Amazon Web Services account; or to a
2858
+ # namespace. Settings that you apply to a namespace override settings
2859
+ # that you apply to an Amazon Web Services account;. All settings are
2860
+ # isolated to a single Region;. To apply them in other Regions;, run
2861
+ # the `CreateAccountCustomization` command in each Region; where you
2626
2862
  # want to apply the same customizations.
2627
2863
  #
2628
2864
  #
@@ -2632,8 +2868,8 @@ module Aws::QuickSight
2632
2868
  # [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
2633
2869
  #
2634
2870
  # @option params [required, String] :aws_account_id
2635
- # The ID for the AWS account that you want to describe QuickSight
2636
- # customizations for.
2871
+ # The ID for the Amazon Web Services account; that you want to describe
2872
+ # QuickSight customizations for.
2637
2873
  #
2638
2874
  # @option params [String] :namespace
2639
2875
  # The QuickSight namespace that you want to describe QuickSight
@@ -2683,11 +2919,11 @@ module Aws::QuickSight
2683
2919
  end
2684
2920
 
2685
2921
  # Describes the settings that were used when your QuickSight
2686
- # subscription was first created in this AWS account.
2922
+ # subscription was first created in this Amazon Web Services account;.
2687
2923
  #
2688
2924
  # @option params [required, String] :aws_account_id
2689
- # The ID for the AWS account that contains the settings that you want to
2690
- # list.
2925
+ # The ID for the Amazon Web Services account; that contains the settings
2926
+ # that you want to list.
2691
2927
  #
2692
2928
  # @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2693
2929
  #
@@ -2722,8 +2958,9 @@ module Aws::QuickSight
2722
2958
  # Provides a summary of the metadata for an analysis.
2723
2959
  #
2724
2960
  # @option params [required, String] :aws_account_id
2725
- # The ID of the AWS account that contains the analysis. You must be
2726
- # using the AWS account that the analysis is in.
2961
+ # The ID of the Amazon Web Services account; that contains the analysis.
2962
+ # You must be using the Amazon Web Services account; that the analysis
2963
+ # is in.
2727
2964
  #
2728
2965
  # @option params [required, String] :analysis_id
2729
2966
  # The ID of the analysis that you're describing. The ID is part of the
@@ -2774,9 +3011,9 @@ module Aws::QuickSight
2774
3011
  # Provides the read and write permissions for an analysis.
2775
3012
  #
2776
3013
  # @option params [required, String] :aws_account_id
2777
- # The ID of the AWS account that contains the analysis whose permissions
2778
- # you're describing. You must be using the AWS account that the
2779
- # analysis is in.
3014
+ # The ID of the Amazon Web Services account; that contains the analysis
3015
+ # whose permissions you're describing. You must be using the Amazon Web
3016
+ # Services account; that the analysis is in.
2780
3017
  #
2781
3018
  # @option params [required, String] :analysis_id
2782
3019
  # The ID of the analysis whose permissions you're describing. The ID is
@@ -2820,8 +3057,8 @@ module Aws::QuickSight
2820
3057
  # Provides a summary for a dashboard.
2821
3058
  #
2822
3059
  # @option params [required, String] :aws_account_id
2823
- # The ID of the AWS account that contains the dashboard that you're
2824
- # describing.
3060
+ # The ID of the Amazon Web Services account; that contains the dashboard
3061
+ # that you're describing.
2825
3062
  #
2826
3063
  # @option params [required, String] :dashboard_id
2827
3064
  # The ID for the dashboard.
@@ -2886,8 +3123,8 @@ module Aws::QuickSight
2886
3123
  # Describes read and write permissions for a dashboard.
2887
3124
  #
2888
3125
  # @option params [required, String] :aws_account_id
2889
- # The ID of the AWS account that contains the dashboard that you're
2890
- # describing permissions for.
3126
+ # The ID of the Amazon Web Services account; that contains the dashboard
3127
+ # that you're describing permissions for.
2891
3128
  #
2892
3129
  # @option params [required, String] :dashboard_id
2893
3130
  # The ID for the dashboard, also added to the IAM policy.
@@ -2930,11 +3167,11 @@ module Aws::QuickSight
2930
3167
  # Describes a dataset.
2931
3168
  #
2932
3169
  # @option params [required, String] :aws_account_id
2933
- # The AWS account ID.
3170
+ # The Amazon Web Services account; ID.
2934
3171
  #
2935
3172
  # @option params [required, String] :data_set_id
2936
3173
  # The ID for the dataset that you want to create. This ID is unique per
2937
- # AWS Region for each AWS account.
3174
+ # Region; for each Amazon Web Services account;.
2938
3175
  #
2939
3176
  # @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2940
3177
  #
@@ -3024,6 +3261,13 @@ module Aws::QuickSight
3024
3261
  # resp.data_set.row_level_permission_data_set.arn #=> String
3025
3262
  # resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
3026
3263
  # resp.data_set.row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
3264
+ # resp.data_set.row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
3265
+ # resp.data_set.row_level_permission_tag_configuration.status #=> String, one of "ENABLED", "DISABLED"
3266
+ # resp.data_set.row_level_permission_tag_configuration.tag_rules #=> Array
3267
+ # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_key #=> String
3268
+ # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].column_name #=> String
3269
+ # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].tag_multi_value_delimiter #=> String
3270
+ # resp.data_set.row_level_permission_tag_configuration.tag_rules[0].match_all_value #=> String
3027
3271
  # resp.data_set.column_level_permission_rules #=> Array
3028
3272
  # resp.data_set.column_level_permission_rules[0].principals #=> Array
3029
3273
  # resp.data_set.column_level_permission_rules[0].principals[0] #=> String
@@ -3047,11 +3291,11 @@ module Aws::QuickSight
3047
3291
  # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
3048
3292
  #
3049
3293
  # @option params [required, String] :aws_account_id
3050
- # The AWS account ID.
3294
+ # The Amazon Web Services account; ID.
3051
3295
  #
3052
3296
  # @option params [required, String] :data_set_id
3053
3297
  # The ID for the dataset that you want to create. This ID is unique per
3054
- # AWS Region for each AWS account.
3298
+ # Region; for each Amazon Web Services account;.
3055
3299
  #
3056
3300
  # @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3057
3301
  #
@@ -3091,11 +3335,11 @@ module Aws::QuickSight
3091
3335
  # Describes a data source.
3092
3336
  #
3093
3337
  # @option params [required, String] :aws_account_id
3094
- # The AWS account ID.
3338
+ # The Amazon Web Services account; ID.
3095
3339
  #
3096
3340
  # @option params [required, String] :data_source_id
3097
- # The ID of the data source. This ID is unique per AWS Region for each
3098
- # AWS account.
3341
+ # The ID of the data source. This ID is unique per Region; for each
3342
+ # Amazon Web Services account;.
3099
3343
  #
3100
3344
  # @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3101
3345
  #
@@ -3233,11 +3477,11 @@ module Aws::QuickSight
3233
3477
  # Describes the resource permissions for a data source.
3234
3478
  #
3235
3479
  # @option params [required, String] :aws_account_id
3236
- # The AWS account ID.
3480
+ # The Amazon Web Services account; ID.
3237
3481
  #
3238
3482
  # @option params [required, String] :data_source_id
3239
- # The ID of the data source. This ID is unique per AWS Region for each
3240
- # AWS account.
3483
+ # The ID of the data source. This ID is unique per Region; for each
3484
+ # Amazon Web Services account;.
3241
3485
  #
3242
3486
  # @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3243
3487
  #
@@ -3274,6 +3518,137 @@ module Aws::QuickSight
3274
3518
  req.send_request(options)
3275
3519
  end
3276
3520
 
3521
+ # Describes a folder.
3522
+ #
3523
+ # @option params [required, String] :aws_account_id
3524
+ # The AWS account ID.
3525
+ #
3526
+ # @option params [required, String] :folder_id
3527
+ # The folder ID.
3528
+ #
3529
+ # @return [Types::DescribeFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3530
+ #
3531
+ # * {Types::DescribeFolderResponse#status #status} => Integer
3532
+ # * {Types::DescribeFolderResponse#folder #folder} => Types::Folder
3533
+ # * {Types::DescribeFolderResponse#request_id #request_id} => String
3534
+ #
3535
+ # @example Request syntax with placeholder values
3536
+ #
3537
+ # resp = client.describe_folder({
3538
+ # aws_account_id: "AwsAccountId", # required
3539
+ # folder_id: "RestrictiveResourceId", # required
3540
+ # })
3541
+ #
3542
+ # @example Response structure
3543
+ #
3544
+ # resp.status #=> Integer
3545
+ # resp.folder.folder_id #=> String
3546
+ # resp.folder.arn #=> String
3547
+ # resp.folder.name #=> String
3548
+ # resp.folder.folder_type #=> String, one of "SHARED"
3549
+ # resp.folder.folder_path #=> Array
3550
+ # resp.folder.folder_path[0] #=> String
3551
+ # resp.folder.created_time #=> Time
3552
+ # resp.folder.last_updated_time #=> Time
3553
+ # resp.request_id #=> String
3554
+ #
3555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolder AWS API Documentation
3556
+ #
3557
+ # @overload describe_folder(params = {})
3558
+ # @param [Hash] params ({})
3559
+ def describe_folder(params = {}, options = {})
3560
+ req = build_request(:describe_folder, params)
3561
+ req.send_request(options)
3562
+ end
3563
+
3564
+ # Describes permissions for a folder.
3565
+ #
3566
+ # @option params [required, String] :aws_account_id
3567
+ # The AWS Account ID.
3568
+ #
3569
+ # @option params [required, String] :folder_id
3570
+ # The folder ID.
3571
+ #
3572
+ # @return [Types::DescribeFolderPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3573
+ #
3574
+ # * {Types::DescribeFolderPermissionsResponse#status #status} => Integer
3575
+ # * {Types::DescribeFolderPermissionsResponse#folder_id #folder_id} => String
3576
+ # * {Types::DescribeFolderPermissionsResponse#arn #arn} => String
3577
+ # * {Types::DescribeFolderPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3578
+ # * {Types::DescribeFolderPermissionsResponse#request_id #request_id} => String
3579
+ #
3580
+ # @example Request syntax with placeholder values
3581
+ #
3582
+ # resp = client.describe_folder_permissions({
3583
+ # aws_account_id: "AwsAccountId", # required
3584
+ # folder_id: "RestrictiveResourceId", # required
3585
+ # })
3586
+ #
3587
+ # @example Response structure
3588
+ #
3589
+ # resp.status #=> Integer
3590
+ # resp.folder_id #=> String
3591
+ # resp.arn #=> String
3592
+ # resp.permissions #=> Array
3593
+ # resp.permissions[0].principal #=> String
3594
+ # resp.permissions[0].actions #=> Array
3595
+ # resp.permissions[0].actions[0] #=> String
3596
+ # resp.request_id #=> String
3597
+ #
3598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissions AWS API Documentation
3599
+ #
3600
+ # @overload describe_folder_permissions(params = {})
3601
+ # @param [Hash] params ({})
3602
+ def describe_folder_permissions(params = {}, options = {})
3603
+ req = build_request(:describe_folder_permissions, params)
3604
+ req.send_request(options)
3605
+ end
3606
+
3607
+ # Describes the folder resolved permissions. Permissions consists of
3608
+ # both folder direct permissions and the inherited permissions from the
3609
+ # ancestor folders.
3610
+ #
3611
+ # @option params [required, String] :aws_account_id
3612
+ # The AWS account ID.
3613
+ #
3614
+ # @option params [required, String] :folder_id
3615
+ # The folder ID.
3616
+ #
3617
+ # @return [Types::DescribeFolderResolvedPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3618
+ #
3619
+ # * {Types::DescribeFolderResolvedPermissionsResponse#status #status} => Integer
3620
+ # * {Types::DescribeFolderResolvedPermissionsResponse#folder_id #folder_id} => String
3621
+ # * {Types::DescribeFolderResolvedPermissionsResponse#arn #arn} => String
3622
+ # * {Types::DescribeFolderResolvedPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3623
+ # * {Types::DescribeFolderResolvedPermissionsResponse#request_id #request_id} => String
3624
+ #
3625
+ # @example Request syntax with placeholder values
3626
+ #
3627
+ # resp = client.describe_folder_resolved_permissions({
3628
+ # aws_account_id: "AwsAccountId", # required
3629
+ # folder_id: "RestrictiveResourceId", # required
3630
+ # })
3631
+ #
3632
+ # @example Response structure
3633
+ #
3634
+ # resp.status #=> Integer
3635
+ # resp.folder_id #=> String
3636
+ # resp.arn #=> String
3637
+ # resp.permissions #=> Array
3638
+ # resp.permissions[0].principal #=> String
3639
+ # resp.permissions[0].actions #=> Array
3640
+ # resp.permissions[0].actions[0] #=> String
3641
+ # resp.request_id #=> String
3642
+ #
3643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissions AWS API Documentation
3644
+ #
3645
+ # @overload describe_folder_resolved_permissions(params = {})
3646
+ # @param [Hash] params ({})
3647
+ def describe_folder_resolved_permissions(params = {}, options = {})
3648
+ req = build_request(:describe_folder_resolved_permissions, params)
3649
+ req.send_request(options)
3650
+ end
3651
+
3277
3652
  # Returns an Amazon QuickSight group's description and Amazon Resource
3278
3653
  # Name (ARN).
3279
3654
  #
@@ -3281,9 +3656,9 @@ module Aws::QuickSight
3281
3656
  # The name of the group that you want to describe.
3282
3657
  #
3283
3658
  # @option params [required, String] :aws_account_id
3284
- # The ID for the AWS account that the group is in. Currently, you use
3285
- # the ID for the AWS account that contains your Amazon QuickSight
3286
- # account.
3659
+ # The ID for the Amazon Web Services account; that the group is in.
3660
+ # Currently, you use the ID for the Amazon Web Services account; that
3661
+ # contains your Amazon QuickSight account.
3287
3662
  #
3288
3663
  # @option params [required, String] :namespace
3289
3664
  # The namespace. Currently, you should set this to `default`.
@@ -3324,8 +3699,8 @@ module Aws::QuickSight
3324
3699
  # assignment name.
3325
3700
  #
3326
3701
  # @option params [required, String] :aws_account_id
3327
- # The ID of the AWS account that contains the assignment that you want
3328
- # to describe.
3702
+ # The ID of the Amazon Web Services account; that contains the
3703
+ # assignment that you want to describe.
3329
3704
  #
3330
3705
  # @option params [required, String] :assignment_name
3331
3706
  # The name of the assignment, also called a rule.
@@ -3372,7 +3747,7 @@ module Aws::QuickSight
3372
3747
  # Describes a SPICE ingestion.
3373
3748
  #
3374
3749
  # @option params [required, String] :aws_account_id
3375
- # The AWS account ID.
3750
+ # The Amazon Web Services account; ID.
3376
3751
  #
3377
3752
  # @option params [required, String] :data_set_id
3378
3753
  # The ID of the dataset used in the ingestion.
@@ -3425,8 +3800,8 @@ module Aws::QuickSight
3425
3800
  # Describes the current namespace.
3426
3801
  #
3427
3802
  # @option params [required, String] :aws_account_id
3428
- # The ID for the AWS account that contains the QuickSight namespace that
3429
- # you want to describe.
3803
+ # The ID for the Amazon Web Services account; that contains the
3804
+ # QuickSight namespace that you want to describe.
3430
3805
  #
3431
3806
  # @option params [required, String] :namespace
3432
3807
  # The namespace that you want to describe.
@@ -3468,8 +3843,8 @@ module Aws::QuickSight
3468
3843
  # Describes a template's metadata.
3469
3844
  #
3470
3845
  # @option params [required, String] :aws_account_id
3471
- # The ID of the AWS account that contains the template that you're
3472
- # describing.
3846
+ # The ID of the Amazon Web Services account; that contains the template
3847
+ # that you're describing.
3473
3848
  #
3474
3849
  # @option params [required, String] :template_id
3475
3850
  # The ID for the template.
@@ -3545,8 +3920,8 @@ module Aws::QuickSight
3545
3920
  # Describes the template alias for a template.
3546
3921
  #
3547
3922
  # @option params [required, String] :aws_account_id
3548
- # The ID of the AWS account that contains the template alias that
3549
- # you're describing.
3923
+ # The ID of the Amazon Web Services account; that contains the template
3924
+ # alias that you're describing.
3550
3925
  #
3551
3926
  # @option params [required, String] :template_id
3552
3927
  # The ID for the template.
@@ -3592,8 +3967,8 @@ module Aws::QuickSight
3592
3967
  # Describes read and write permissions on a template.
3593
3968
  #
3594
3969
  # @option params [required, String] :aws_account_id
3595
- # The ID of the AWS account that contains the template that you're
3596
- # describing.
3970
+ # The ID of the Amazon Web Services account; that contains the template
3971
+ # that you're describing.
3597
3972
  #
3598
3973
  # @option params [required, String] :template_id
3599
3974
  # The ID for the template.
@@ -3636,8 +4011,8 @@ module Aws::QuickSight
3636
4011
  # Describes a theme.
3637
4012
  #
3638
4013
  # @option params [required, String] :aws_account_id
3639
- # The ID of the AWS account that contains the theme that you're
3640
- # describing.
4014
+ # The ID of the Amazon Web Services account; that contains the theme
4015
+ # that you're describing.
3641
4016
  #
3642
4017
  # @option params [required, String] :theme_id
3643
4018
  # The ID for the theme.
@@ -3725,8 +4100,8 @@ module Aws::QuickSight
3725
4100
  # Describes the alias for a theme.
3726
4101
  #
3727
4102
  # @option params [required, String] :aws_account_id
3728
- # The ID of the AWS account that contains the theme alias that you're
3729
- # describing.
4103
+ # The ID of the Amazon Web Services account; that contains the theme
4104
+ # alias that you're describing.
3730
4105
  #
3731
4106
  # @option params [required, String] :theme_id
3732
4107
  # The ID for the theme.
@@ -3768,8 +4143,8 @@ module Aws::QuickSight
3768
4143
  # Describes the read and write permissions for a theme.
3769
4144
  #
3770
4145
  # @option params [required, String] :aws_account_id
3771
- # The ID of the AWS account that contains the theme that you're
3772
- # describing.
4146
+ # The ID of the Amazon Web Services account; that contains the theme
4147
+ # that you're describing.
3773
4148
  #
3774
4149
  # @option params [required, String] :theme_id
3775
4150
  # The ID for the theme that you want to describe permissions for.
@@ -3804,56 +4179,257 @@ module Aws::QuickSight
3804
4179
  #
3805
4180
  # @overload describe_theme_permissions(params = {})
3806
4181
  # @param [Hash] params ({})
3807
- def describe_theme_permissions(params = {}, options = {})
3808
- req = build_request(:describe_theme_permissions, params)
4182
+ def describe_theme_permissions(params = {}, options = {})
4183
+ req = build_request(:describe_theme_permissions, params)
4184
+ req.send_request(options)
4185
+ end
4186
+
4187
+ # Returns information about a user, given the user name.
4188
+ #
4189
+ # @option params [required, String] :user_name
4190
+ # The name of the user that you want to describe.
4191
+ #
4192
+ # @option params [required, String] :aws_account_id
4193
+ # The ID for the Amazon Web Services account; that the user is in.
4194
+ # Currently, you use the ID for the Amazon Web Services account; that
4195
+ # contains your Amazon QuickSight account.
4196
+ #
4197
+ # @option params [required, String] :namespace
4198
+ # The namespace. Currently, you should set this to `default`.
4199
+ #
4200
+ # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4201
+ #
4202
+ # * {Types::DescribeUserResponse#user #user} => Types::User
4203
+ # * {Types::DescribeUserResponse#request_id #request_id} => String
4204
+ # * {Types::DescribeUserResponse#status #status} => Integer
4205
+ #
4206
+ # @example Request syntax with placeholder values
4207
+ #
4208
+ # resp = client.describe_user({
4209
+ # user_name: "UserName", # required
4210
+ # aws_account_id: "AwsAccountId", # required
4211
+ # namespace: "Namespace", # required
4212
+ # })
4213
+ #
4214
+ # @example Response structure
4215
+ #
4216
+ # resp.user.arn #=> String
4217
+ # resp.user.user_name #=> String
4218
+ # resp.user.email #=> String
4219
+ # resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
4220
+ # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
4221
+ # resp.user.active #=> Boolean
4222
+ # resp.user.principal_id #=> String
4223
+ # resp.user.custom_permissions_name #=> String
4224
+ # resp.user.external_login_federation_provider_type #=> String
4225
+ # resp.user.external_login_federation_provider_url #=> String
4226
+ # resp.user.external_login_id #=> String
4227
+ # resp.request_id #=> String
4228
+ # resp.status #=> Integer
4229
+ #
4230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser AWS API Documentation
4231
+ #
4232
+ # @overload describe_user(params = {})
4233
+ # @param [Hash] params ({})
4234
+ def describe_user(params = {}, options = {})
4235
+ req = build_request(:describe_user, params)
4236
+ req.send_request(options)
4237
+ end
4238
+
4239
+ # Generates an embed URL that you can use to embed an Amazon QuickSight
4240
+ # dashboard in your website, without having to register any reader
4241
+ # users. Before you use this action, make sure that you have configured
4242
+ # the dashboards and permissions.
4243
+ #
4244
+ # The following rules apply to the generated URL:
4245
+ #
4246
+ # * It contains a temporary bearer token. It is valid for 5 minutes
4247
+ # after it is generated. Once redeemed within this period, it cannot
4248
+ # be re-used again.
4249
+ #
4250
+ # * The URL validity period should not be confused with the actual
4251
+ # session lifetime that can be customized using the `
4252
+ # SessionLifetimeInMinutes ` parameter.
4253
+ #
4254
+ # The resulting user session is valid for 15 minutes (default) to 10
4255
+ # hours (maximum).
4256
+ #
4257
+ # * You are charged only when the URL is used or there is interaction
4258
+ # with Amazon QuickSight.
4259
+ #
4260
+ # For more information, see [Embedded Analytics][1] in the *Amazon
4261
+ # QuickSight User Guide*.
4262
+ #
4263
+ # For more information about the high-level steps for embedding and for
4264
+ # an interactive demo of the ways you can customize embedding, visit the
4265
+ # [Amazon QuickSight Developer Portal][2].
4266
+ #
4267
+ #
4268
+ #
4269
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
4270
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
4271
+ #
4272
+ # @option params [required, String] :aws_account_id
4273
+ # The ID for the Amazon Web Services account that contains the dashboard
4274
+ # that you're embedding.
4275
+ #
4276
+ # @option params [Integer] :session_lifetime_in_minutes
4277
+ # How many minutes the session is valid. The session lifetime must be in
4278
+ # \[15-600\] minutes range.
4279
+ #
4280
+ # @option params [required, String] :namespace
4281
+ # The Amazon QuickSight namespace that the anonymous user virtually
4282
+ # belongs to. If you are not using an Amazon QuickSight custom
4283
+ # namespace, set this to `default`.
4284
+ #
4285
+ # @option params [Array<Types::SessionTag>] :session_tags
4286
+ # The session tags used for row-level security. Before you use this
4287
+ # parameter, make sure that you have configured the relevant datasets
4288
+ # using the `DataSet$RowLevelPermissionTagConfiguration` parameter so
4289
+ # that session tags can be used to provide row-level security.
4290
+ #
4291
+ # These are not the tags used for the Amazon Web Services resource
4292
+ # tagging feature. For more information, see [Using Row-Level Security
4293
+ # (RLS) with Tags][1].
4294
+ #
4295
+ #
4296
+ #
4297
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
4298
+ #
4299
+ # @option params [required, Array<String>] :authorized_resource_arns
4300
+ # The Amazon Resource Names for the Amazon QuickSight resources that the
4301
+ # user is authorized to access during the lifetime of the session. If
4302
+ # you choose `Dashboard` embedding experience, pass the list of
4303
+ # dashboard ARNs in the account that you want the user to be able to
4304
+ # view.
4305
+ #
4306
+ # @option params [required, Types::AnonymousUserEmbeddingExperienceConfiguration] :experience_configuration
4307
+ # The configuration of the experience you are embedding.
4308
+ #
4309
+ # @return [Types::GenerateEmbedUrlForAnonymousUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4310
+ #
4311
+ # * {Types::GenerateEmbedUrlForAnonymousUserResponse#embed_url #embed_url} => String
4312
+ # * {Types::GenerateEmbedUrlForAnonymousUserResponse#status #status} => Integer
4313
+ # * {Types::GenerateEmbedUrlForAnonymousUserResponse#request_id #request_id} => String
4314
+ #
4315
+ # @example Request syntax with placeholder values
4316
+ #
4317
+ # resp = client.generate_embed_url_for_anonymous_user({
4318
+ # aws_account_id: "AwsAccountId", # required
4319
+ # session_lifetime_in_minutes: 1,
4320
+ # namespace: "Namespace", # required
4321
+ # session_tags: [
4322
+ # {
4323
+ # key: "SessionTagKey", # required
4324
+ # value: "SessionTagValue", # required
4325
+ # },
4326
+ # ],
4327
+ # authorized_resource_arns: ["Arn"], # required
4328
+ # experience_configuration: { # required
4329
+ # dashboard: {
4330
+ # initial_dashboard_id: "RestrictiveResourceId", # required
4331
+ # },
4332
+ # },
4333
+ # })
4334
+ #
4335
+ # @example Response structure
4336
+ #
4337
+ # resp.embed_url #=> String
4338
+ # resp.status #=> Integer
4339
+ # resp.request_id #=> String
4340
+ #
4341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUser AWS API Documentation
4342
+ #
4343
+ # @overload generate_embed_url_for_anonymous_user(params = {})
4344
+ # @param [Hash] params ({})
4345
+ def generate_embed_url_for_anonymous_user(params = {}, options = {})
4346
+ req = build_request(:generate_embed_url_for_anonymous_user, params)
3809
4347
  req.send_request(options)
3810
4348
  end
3811
4349
 
3812
- # Returns information about a user, given the user name.
4350
+ # Generates an embed URL that you can use to embed an Amazon QuickSight
4351
+ # experience in your website. This action can be used for any type of
4352
+ # user registered in an Amazon QuickSight account. Before you use this
4353
+ # action, make sure that you have configured the relevant Amazon
4354
+ # QuickSight resource and permissions.
3813
4355
  #
3814
- # @option params [required, String] :user_name
3815
- # The name of the user that you want to describe.
4356
+ # The following rules apply to the generated URL:
4357
+ #
4358
+ # * It contains a temporary bearer token. It is valid for 5 minutes
4359
+ # after it is generated. Once redeemed within this period, it cannot
4360
+ # be re-used again.
4361
+ #
4362
+ # * The URL validity period should not be confused with the actual
4363
+ # session lifetime that can be customized using the `
4364
+ # SessionLifetimeInMinutes ` parameter.
4365
+ #
4366
+ # The resulting user session is valid for 15 minutes (default) to 10
4367
+ # hours (maximum).
4368
+ #
4369
+ # * You are charged only when the URL is used or there is interaction
4370
+ # with Amazon QuickSight.
4371
+ #
4372
+ # For more information, see [Embedded Analytics][1] in the *Amazon
4373
+ # QuickSight User Guide*.
4374
+ #
4375
+ # For more information about the high-level steps for embedding and for
4376
+ # an interactive demo of the ways you can customize embedding, visit the
4377
+ # [Amazon QuickSight Developer Portal][2].
4378
+ #
4379
+ #
4380
+ #
4381
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
4382
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
3816
4383
  #
3817
4384
  # @option params [required, String] :aws_account_id
3818
- # The ID for the AWS account that the user is in. Currently, you use the
3819
- # ID for the AWS account that contains your Amazon QuickSight account.
4385
+ # The ID for the Amazon Web Services account that contains the dashboard
4386
+ # that you're embedding.
3820
4387
  #
3821
- # @option params [required, String] :namespace
3822
- # The namespace. Currently, you should set this to `default`.
4388
+ # @option params [Integer] :session_lifetime_in_minutes
4389
+ # How many minutes the session is valid. The session lifetime must be in
4390
+ # \[15-600\] minutes range.
3823
4391
  #
3824
- # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4392
+ # @option params [required, String] :user_arn
4393
+ # The Amazon Resource Name for the registered user.
3825
4394
  #
3826
- # * {Types::DescribeUserResponse#user #user} => Types::User
3827
- # * {Types::DescribeUserResponse#request_id #request_id} => String
3828
- # * {Types::DescribeUserResponse#status #status} => Integer
4395
+ # @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
4396
+ # The experience you are embedding. For registered users, you can embed
4397
+ # Amazon QuickSight dashboards or the entire Amazon QuickSight console.
4398
+ #
4399
+ # @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4400
+ #
4401
+ # * {Types::GenerateEmbedUrlForRegisteredUserResponse#embed_url #embed_url} => String
4402
+ # * {Types::GenerateEmbedUrlForRegisteredUserResponse#status #status} => Integer
4403
+ # * {Types::GenerateEmbedUrlForRegisteredUserResponse#request_id #request_id} => String
3829
4404
  #
3830
4405
  # @example Request syntax with placeholder values
3831
4406
  #
3832
- # resp = client.describe_user({
3833
- # user_name: "UserName", # required
4407
+ # resp = client.generate_embed_url_for_registered_user({
3834
4408
  # aws_account_id: "AwsAccountId", # required
3835
- # namespace: "Namespace", # required
4409
+ # session_lifetime_in_minutes: 1,
4410
+ # user_arn: "Arn", # required
4411
+ # experience_configuration: { # required
4412
+ # dashboard: {
4413
+ # initial_dashboard_id: "RestrictiveResourceId", # required
4414
+ # },
4415
+ # quick_sight_console: {
4416
+ # initial_path: "EntryPath",
4417
+ # },
4418
+ # },
3836
4419
  # })
3837
4420
  #
3838
4421
  # @example Response structure
3839
4422
  #
3840
- # resp.user.arn #=> String
3841
- # resp.user.user_name #=> String
3842
- # resp.user.email #=> String
3843
- # resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
3844
- # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
3845
- # resp.user.active #=> Boolean
3846
- # resp.user.principal_id #=> String
3847
- # resp.user.custom_permissions_name #=> String
3848
- # resp.request_id #=> String
4423
+ # resp.embed_url #=> String
3849
4424
  # resp.status #=> Integer
4425
+ # resp.request_id #=> String
3850
4426
  #
3851
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser AWS API Documentation
4427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser AWS API Documentation
3852
4428
  #
3853
- # @overload describe_user(params = {})
4429
+ # @overload generate_embed_url_for_registered_user(params = {})
3854
4430
  # @param [Hash] params ({})
3855
- def describe_user(params = {}, options = {})
3856
- req = build_request(:describe_user, params)
4431
+ def generate_embed_url_for_registered_user(params = {}, options = {})
4432
+ req = build_request(:generate_embed_url_for_registered_user, params)
3857
4433
  req.send_request(options)
3858
4434
  end
3859
4435
 
@@ -3877,16 +4453,21 @@ module Aws::QuickSight
3877
4453
  # For more information, see [Embedded Analytics][1] in the *Amazon
3878
4454
  # QuickSight User Guide*.
3879
4455
  #
4456
+ # For more information about the high-level steps for embedding and for
4457
+ # an interactive demo of the ways you can customize embedding, visit the
4458
+ # [Amazon QuickSight Developer Portal][2].
4459
+ #
3880
4460
  #
3881
4461
  #
3882
4462
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
4463
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
3883
4464
  #
3884
4465
  # @option params [required, String] :aws_account_id
3885
- # The ID for the AWS account that contains the dashboard that you're
3886
- # embedding.
4466
+ # The ID for the Amazon Web Services account; that contains the
4467
+ # dashboard that you're embedding.
3887
4468
  #
3888
4469
  # @option params [required, String] :dashboard_id
3889
- # The ID for the dashboard, also added to the AWS Identity and Access
4470
+ # The ID for the dashboard, also added to the Identity and Access
3890
4471
  # Management (IAM) policy.
3891
4472
  #
3892
4473
  # @option params [required, String] :identity_type
@@ -3932,9 +4513,9 @@ module Aws::QuickSight
3932
4513
  # role-based sessions.
3933
4514
  #
3934
4515
  # @option params [String] :namespace
3935
- # The QuickSight namespace that contains the dashboard IDs in this
3936
- # request. If you're not using a custom namespace, set this to
3937
- # "`default`".
4516
+ # The Amazon QuickSight namespace that the user virtually belongs to. If
4517
+ # you are not using an Amazon QuickSight custom namespace, set this to
4518
+ # `default`.
3938
4519
  #
3939
4520
  # @option params [Array<String>] :additional_dashboard_ids
3940
4521
  # A list of one or more dashboard IDs that you want to add to a session
@@ -4003,8 +4584,8 @@ module Aws::QuickSight
4003
4584
  # [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
4004
4585
  #
4005
4586
  # @option params [required, String] :aws_account_id
4006
- # The ID for the AWS account associated with your QuickSight
4007
- # subscription.
4587
+ # The ID for the Amazon Web Services account; associated with your
4588
+ # QuickSight subscription.
4008
4589
  #
4009
4590
  # @option params [String] :entry_point
4010
4591
  # The URL you use to access the embedded session. The entry point URL is
@@ -4038,7 +4619,7 @@ module Aws::QuickSight
4038
4619
  #
4039
4620
  # 2. Invited nonfederated users
4040
4621
  #
4041
- # 3. AWS Identity and Access Management (IAM) users and IAM role-based
4622
+ # 3. Identity and Access Management (IAM) users and IAM role-based
4042
4623
  # sessions authenticated through Federated Single Sign-On using
4043
4624
  # SAML, OpenID Connect, or IAM federation
4044
4625
  #
@@ -4075,11 +4656,11 @@ module Aws::QuickSight
4075
4656
  req.send_request(options)
4076
4657
  end
4077
4658
 
4078
- # Lists Amazon QuickSight analyses that exist in the specified AWS
4079
- # account.
4659
+ # Lists Amazon QuickSight analyses that exist in the specified Amazon
4660
+ # Web Services account;.
4080
4661
  #
4081
4662
  # @option params [required, String] :aws_account_id
4082
- # The ID of the AWS account that contains the analyses.
4663
+ # The ID of the Amazon Web Services account; that contains the analyses.
4083
4664
  #
4084
4665
  # @option params [String] :next_token
4085
4666
  # A pagination token that can be used in a subsequent request.
@@ -4130,8 +4711,8 @@ module Aws::QuickSight
4130
4711
  # subscription.
4131
4712
  #
4132
4713
  # @option params [required, String] :aws_account_id
4133
- # The ID of the AWS account that contains the dashboard that you're
4134
- # listing versions for.
4714
+ # The ID of the Amazon Web Services account; that contains the dashboard
4715
+ # that you're listing versions for.
4135
4716
  #
4136
4717
  # @option params [required, String] :dashboard_id
4137
4718
  # The ID for the dashboard.
@@ -4183,11 +4764,11 @@ module Aws::QuickSight
4183
4764
  req.send_request(options)
4184
4765
  end
4185
4766
 
4186
- # Lists dashboards in an AWS account.
4767
+ # Lists dashboards in an Amazon Web Services account;.
4187
4768
  #
4188
4769
  # @option params [required, String] :aws_account_id
4189
- # The ID of the AWS account that contains the dashboards that you're
4190
- # listing.
4770
+ # The ID of the Amazon Web Services account; that contains the
4771
+ # dashboards that you're listing.
4191
4772
  #
4192
4773
  # @option params [String] :next_token
4193
4774
  # The token for the next set of results, or null if there are no more
@@ -4236,14 +4817,14 @@ module Aws::QuickSight
4236
4817
  req.send_request(options)
4237
4818
  end
4238
4819
 
4239
- # Lists all of the datasets belonging to the current AWS account in an
4240
- # AWS Region.
4820
+ # Lists all of the datasets belonging to the current Amazon Web Services
4821
+ # account; in an Region;.
4241
4822
  #
4242
4823
  # The permissions resource is
4243
4824
  # `arn:aws:quicksight:region:aws-account-id:dataset/*`.
4244
4825
  #
4245
4826
  # @option params [required, String] :aws_account_id
4246
- # The AWS account ID.
4827
+ # The Amazon Web Services account; ID.
4247
4828
  #
4248
4829
  # @option params [String] :next_token
4249
4830
  # The token for the next set of results, or null if there are no more
@@ -4282,6 +4863,8 @@ module Aws::QuickSight
4282
4863
  # resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
4283
4864
  # resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
4284
4865
  # resp.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
4866
+ # resp.data_set_summaries[0].row_level_permission_data_set.status #=> String, one of "ENABLED", "DISABLED"
4867
+ # resp.data_set_summaries[0].row_level_permission_tag_configuration_applied #=> Boolean
4285
4868
  # resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
4286
4869
  # resp.next_token #=> String
4287
4870
  # resp.request_id #=> String
@@ -4296,11 +4879,11 @@ module Aws::QuickSight
4296
4879
  req.send_request(options)
4297
4880
  end
4298
4881
 
4299
- # Lists data sources in current AWS Region that belong to this AWS
4300
- # account.
4882
+ # Lists data sources in current Region; that belong to this Amazon Web
4883
+ # Services account;.
4301
4884
  #
4302
4885
  # @option params [required, String] :aws_account_id
4303
- # The AWS account ID.
4886
+ # The Amazon Web Services account; ID.
4304
4887
  #
4305
4888
  # @option params [String] :next_token
4306
4889
  # The token for the next set of results, or null if there are no more
@@ -4448,6 +5031,104 @@ module Aws::QuickSight
4448
5031
  req.send_request(options)
4449
5032
  end
4450
5033
 
5034
+ # List all assets (`DASHBOARD`, `ANALYSIS`, and `DATASET`) in a folder.
5035
+ #
5036
+ # @option params [required, String] :aws_account_id
5037
+ # The AWS account ID.
5038
+ #
5039
+ # @option params [required, String] :folder_id
5040
+ # The folder ID.
5041
+ #
5042
+ # @option params [String] :next_token
5043
+ # The token for the next set of results, or null if there are no more
5044
+ # results.
5045
+ #
5046
+ # @option params [Integer] :max_results
5047
+ # The maximum number of results to be returned per request.
5048
+ #
5049
+ # @return [Types::ListFolderMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5050
+ #
5051
+ # * {Types::ListFolderMembersResponse#status #status} => Integer
5052
+ # * {Types::ListFolderMembersResponse#folder_member_list #folder_member_list} => Array&lt;Types::MemberIdArnPair&gt;
5053
+ # * {Types::ListFolderMembersResponse#next_token #next_token} => String
5054
+ # * {Types::ListFolderMembersResponse#request_id #request_id} => String
5055
+ #
5056
+ # @example Request syntax with placeholder values
5057
+ #
5058
+ # resp = client.list_folder_members({
5059
+ # aws_account_id: "AwsAccountId", # required
5060
+ # folder_id: "RestrictiveResourceId", # required
5061
+ # next_token: "String",
5062
+ # max_results: 1,
5063
+ # })
5064
+ #
5065
+ # @example Response structure
5066
+ #
5067
+ # resp.status #=> Integer
5068
+ # resp.folder_member_list #=> Array
5069
+ # resp.folder_member_list[0].member_id #=> String
5070
+ # resp.folder_member_list[0].member_arn #=> String
5071
+ # resp.next_token #=> String
5072
+ # resp.request_id #=> String
5073
+ #
5074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembers AWS API Documentation
5075
+ #
5076
+ # @overload list_folder_members(params = {})
5077
+ # @param [Hash] params ({})
5078
+ def list_folder_members(params = {}, options = {})
5079
+ req = build_request(:list_folder_members, params)
5080
+ req.send_request(options)
5081
+ end
5082
+
5083
+ # Lists all folders in an account.
5084
+ #
5085
+ # @option params [required, String] :aws_account_id
5086
+ # The AWS account ID.
5087
+ #
5088
+ # @option params [String] :next_token
5089
+ # The token for the next set of results, or null if there are no more
5090
+ # results.
5091
+ #
5092
+ # @option params [Integer] :max_results
5093
+ # The maximum number of results to be returned per request.
5094
+ #
5095
+ # @return [Types::ListFoldersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5096
+ #
5097
+ # * {Types::ListFoldersResponse#status #status} => Integer
5098
+ # * {Types::ListFoldersResponse#folder_summary_list #folder_summary_list} => Array&lt;Types::FolderSummary&gt;
5099
+ # * {Types::ListFoldersResponse#next_token #next_token} => String
5100
+ # * {Types::ListFoldersResponse#request_id #request_id} => String
5101
+ #
5102
+ # @example Request syntax with placeholder values
5103
+ #
5104
+ # resp = client.list_folders({
5105
+ # aws_account_id: "AwsAccountId", # required
5106
+ # next_token: "String",
5107
+ # max_results: 1,
5108
+ # })
5109
+ #
5110
+ # @example Response structure
5111
+ #
5112
+ # resp.status #=> Integer
5113
+ # resp.folder_summary_list #=> Array
5114
+ # resp.folder_summary_list[0].arn #=> String
5115
+ # resp.folder_summary_list[0].folder_id #=> String
5116
+ # resp.folder_summary_list[0].name #=> String
5117
+ # resp.folder_summary_list[0].folder_type #=> String, one of "SHARED"
5118
+ # resp.folder_summary_list[0].created_time #=> Time
5119
+ # resp.folder_summary_list[0].last_updated_time #=> Time
5120
+ # resp.next_token #=> String
5121
+ # resp.request_id #=> String
5122
+ #
5123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolders AWS API Documentation
5124
+ #
5125
+ # @overload list_folders(params = {})
5126
+ # @param [Hash] params ({})
5127
+ def list_folders(params = {}, options = {})
5128
+ req = build_request(:list_folders, params)
5129
+ req.send_request(options)
5130
+ end
5131
+
4451
5132
  # Lists member users in a group.
4452
5133
  #
4453
5134
  # @option params [required, String] :group_name
@@ -4460,9 +5141,9 @@ module Aws::QuickSight
4460
5141
  # The maximum number of results to return from this request.
4461
5142
  #
4462
5143
  # @option params [required, String] :aws_account_id
4463
- # The ID for the AWS account that the group is in. Currently, you use
4464
- # the ID for the AWS account that contains your Amazon QuickSight
4465
- # account.
5144
+ # The ID for the Amazon Web Services account; that the group is in.
5145
+ # Currently, you use the ID for the Amazon Web Services account; that
5146
+ # contains your Amazon QuickSight account.
4466
5147
  #
4467
5148
  # @option params [required, String] :namespace
4468
5149
  # The namespace. Currently, you should set this to `default`.
@@ -4505,9 +5186,9 @@ module Aws::QuickSight
4505
5186
  # Lists all user groups in Amazon QuickSight.
4506
5187
  #
4507
5188
  # @option params [required, String] :aws_account_id
4508
- # The ID for the AWS account that the group is in. Currently, you use
4509
- # the ID for the AWS account that contains your Amazon QuickSight
4510
- # account.
5189
+ # The ID for the Amazon Web Services account; that the group is in.
5190
+ # Currently, you use the ID for the Amazon Web Services account; that
5191
+ # contains your Amazon QuickSight account.
4511
5192
  #
4512
5193
  # @option params [String] :next_token
4513
5194
  # A pagination token that can be used in a subsequent request.
@@ -4557,7 +5238,8 @@ module Aws::QuickSight
4557
5238
  # Lists IAM policy assignments in the current Amazon QuickSight account.
4558
5239
  #
4559
5240
  # @option params [required, String] :aws_account_id
4560
- # The ID of the AWS account that contains these IAM policy assignments.
5241
+ # The ID of the Amazon Web Services account; that contains these IAM
5242
+ # policy assignments.
4561
5243
  #
4562
5244
  # @option params [String] :assignment_status
4563
5245
  # The status of the assignments.
@@ -4612,7 +5294,8 @@ module Aws::QuickSight
4612
5294
  # group or groups that the user belongs to.
4613
5295
  #
4614
5296
  # @option params [required, String] :aws_account_id
4615
- # The ID of the AWS account that contains the assignments.
5297
+ # The ID of the Amazon Web Services account; that contains the
5298
+ # assignments.
4616
5299
  #
4617
5300
  # @option params [required, String] :user_name
4618
5301
  # The name of the user.
@@ -4672,7 +5355,7 @@ module Aws::QuickSight
4672
5355
  # results.
4673
5356
  #
4674
5357
  # @option params [required, String] :aws_account_id
4675
- # The AWS account ID.
5358
+ # The Amazon Web Services account; ID.
4676
5359
  #
4677
5360
  # @option params [Integer] :max_results
4678
5361
  # The maximum number of results to be returned per request.
@@ -4725,11 +5408,11 @@ module Aws::QuickSight
4725
5408
  req.send_request(options)
4726
5409
  end
4727
5410
 
4728
- # Lists the namespaces for the specified AWS account.
5411
+ # Lists the namespaces for the specified Amazon Web Services account;.
4729
5412
  #
4730
5413
  # @option params [required, String] :aws_account_id
4731
- # The ID for the AWS account that contains the QuickSight namespaces
4732
- # that you want to list.
5414
+ # The ID for the Amazon Web Services account; that contains the
5415
+ # QuickSight namespaces that you want to list.
4733
5416
  #
4734
5417
  # @option params [String] :next_token
4735
5418
  # A pagination token that can be used in a subsequent request.
@@ -4815,8 +5498,8 @@ module Aws::QuickSight
4815
5498
  # Lists all the aliases of a template.
4816
5499
  #
4817
5500
  # @option params [required, String] :aws_account_id
4818
- # The ID of the AWS account that contains the template aliases that
4819
- # you're listing.
5501
+ # The ID of the Amazon Web Services account; that contains the template
5502
+ # aliases that you're listing.
4820
5503
  #
4821
5504
  # @option params [required, String] :template_id
4822
5505
  # The ID for the template.
@@ -4869,8 +5552,8 @@ module Aws::QuickSight
4869
5552
  # QuickSight account.
4870
5553
  #
4871
5554
  # @option params [required, String] :aws_account_id
4872
- # The ID of the AWS account that contains the templates that you're
4873
- # listing.
5555
+ # The ID of the Amazon Web Services account; that contains the templates
5556
+ # that you're listing.
4874
5557
  #
4875
5558
  # @option params [required, String] :template_id
4876
5559
  # The ID for the template.
@@ -4924,8 +5607,8 @@ module Aws::QuickSight
4924
5607
  # Lists all the templates in the current Amazon QuickSight account.
4925
5608
  #
4926
5609
  # @option params [required, String] :aws_account_id
4927
- # The ID of the AWS account that contains the templates that you're
4928
- # listing.
5610
+ # The ID of the Amazon Web Services account; that contains the templates
5611
+ # that you're listing.
4929
5612
  #
4930
5613
  # @option params [String] :next_token
4931
5614
  # The token for the next set of results, or null if there are no more
@@ -4976,8 +5659,8 @@ module Aws::QuickSight
4976
5659
  # Lists all the aliases of a theme.
4977
5660
  #
4978
5661
  # @option params [required, String] :aws_account_id
4979
- # The ID of the AWS account that contains the theme aliases that you're
4980
- # listing.
5662
+ # The ID of the Amazon Web Services account; that contains the theme
5663
+ # aliases that you're listing.
4981
5664
  #
4982
5665
  # @option params [required, String] :theme_id
4983
5666
  # The ID for the theme.
@@ -5024,11 +5707,12 @@ module Aws::QuickSight
5024
5707
  req.send_request(options)
5025
5708
  end
5026
5709
 
5027
- # Lists all the versions of the themes in the current AWS account.
5710
+ # Lists all the versions of the themes in the current Amazon Web
5711
+ # Services account;.
5028
5712
  #
5029
5713
  # @option params [required, String] :aws_account_id
5030
- # The ID of the AWS account that contains the themes that you're
5031
- # listing.
5714
+ # The ID of the Amazon Web Services account; that contains the themes
5715
+ # that you're listing.
5032
5716
  #
5033
5717
  # @option params [required, String] :theme_id
5034
5718
  # The ID for the theme.
@@ -5079,11 +5763,11 @@ module Aws::QuickSight
5079
5763
  req.send_request(options)
5080
5764
  end
5081
5765
 
5082
- # Lists all the themes in the current AWS account.
5766
+ # Lists all the themes in the current Amazon Web Services account;.
5083
5767
  #
5084
5768
  # @option params [required, String] :aws_account_id
5085
- # The ID of the AWS account that contains the themes that you're
5086
- # listing.
5769
+ # The ID of the Amazon Web Services account; that contains the themes
5770
+ # that you're listing.
5087
5771
  #
5088
5772
  # @option params [String] :next_token
5089
5773
  # The token for the next set of results, or null if there are no more
@@ -5101,7 +5785,7 @@ module Aws::QuickSight
5101
5785
  # * `CUSTOM` - Display only the themes created by people using Amazon
5102
5786
  # QuickSight.
5103
5787
  #
5104
- # * `QUICKSIGHT` - Display only the starting themes defined by
5788
+ # * `QUICKSIGHT` - Display only the starting themes defined by Amazon
5105
5789
  # QuickSight.
5106
5790
  #
5107
5791
  # @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -5152,8 +5836,9 @@ module Aws::QuickSight
5152
5836
  # memberships for.
5153
5837
  #
5154
5838
  # @option params [required, String] :aws_account_id
5155
- # The AWS account ID that the user is in. Currently, you use the ID for
5156
- # the AWS account that contains your Amazon QuickSight account.
5839
+ # The Amazon Web Services account; ID that the user is in. Currently,
5840
+ # you use the ID for the Amazon Web Services account; that contains your
5841
+ # Amazon QuickSight account.
5157
5842
  #
5158
5843
  # @option params [required, String] :namespace
5159
5844
  # The namespace. Currently, you should set this to `default`.
@@ -5205,8 +5890,9 @@ module Aws::QuickSight
5205
5890
  # account.
5206
5891
  #
5207
5892
  # @option params [required, String] :aws_account_id
5208
- # The ID for the AWS account that the user is in. Currently, you use the
5209
- # ID for the AWS account that contains your Amazon QuickSight account.
5893
+ # The ID for the Amazon Web Services account; that the user is in.
5894
+ # Currently, you use the ID for the Amazon Web Services account; that
5895
+ # contains your Amazon QuickSight account.
5210
5896
  #
5211
5897
  # @option params [String] :next_token
5212
5898
  # A pagination token that can be used in a subsequent request.
@@ -5244,6 +5930,9 @@ module Aws::QuickSight
5244
5930
  # resp.user_list[0].active #=> Boolean
5245
5931
  # resp.user_list[0].principal_id #=> String
5246
5932
  # resp.user_list[0].custom_permissions_name #=> String
5933
+ # resp.user_list[0].external_login_federation_provider_type #=> String
5934
+ # resp.user_list[0].external_login_federation_provider_url #=> String
5935
+ # resp.user_list[0].external_login_id #=> String
5247
5936
  # resp.next_token #=> String
5248
5937
  # resp.request_id #=> String
5249
5938
  # resp.status #=> Integer
@@ -5307,8 +5996,9 @@ module Aws::QuickSight
5307
5996
  # [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
5308
5997
  #
5309
5998
  # @option params [required, String] :aws_account_id
5310
- # The ID for the AWS account that the user is in. Currently, you use the
5311
- # ID for the AWS account that contains your Amazon QuickSight account.
5999
+ # The ID for the Amazon Web Services account; that the user is in.
6000
+ # Currently, you use the ID for the Amazon Web Services account; that
6001
+ # contains your Amazon QuickSight account.
5312
6002
  #
5313
6003
  # @option params [required, String] :namespace
5314
6004
  # The namespace. Currently, you should set this to `default`.
@@ -5346,8 +6036,32 @@ module Aws::QuickSight
5346
6036
  # QuickSight (admin, author, reader).
5347
6037
  #
5348
6038
  # This feature is available only to QuickSight Enterprise edition
5349
- # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
5350
- # (SSO).
6039
+ # subscriptions.
6040
+ #
6041
+ # @option params [String] :external_login_federation_provider_type
6042
+ # The type of supported external login provider that provides identity
6043
+ # to let a user federate into Amazon QuickSight with an associated AWS
6044
+ # Identity and Access Management (IAM) role. The type of supported
6045
+ # external login provider can be one of the following.
6046
+ #
6047
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
6048
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
6049
+ # type, don’t use the "CustomFederationProviderUrl" parameter which
6050
+ # is only needed when the external provider is custom.
6051
+ #
6052
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
6053
+ # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
6054
+ # to provide the custom OIDC provider URL.
6055
+ #
6056
+ # @option params [String] :custom_federation_provider_url
6057
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
6058
+ # identity to let a user federate into QuickSight with an associated AWS
6059
+ # Identity and Access Management (IAM) role. This parameter should only
6060
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
6061
+ # `CUSTOM_OIDC`.
6062
+ #
6063
+ # @option params [String] :external_login_id
6064
+ # The identity ID for a user in the external login provider.
5351
6065
  #
5352
6066
  # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5353
6067
  #
@@ -5368,6 +6082,9 @@ module Aws::QuickSight
5368
6082
  # namespace: "Namespace", # required
5369
6083
  # user_name: "UserName",
5370
6084
  # custom_permissions_name: "RoleName",
6085
+ # external_login_federation_provider_type: "String",
6086
+ # custom_federation_provider_url: "String",
6087
+ # external_login_id: "String",
5371
6088
  # })
5372
6089
  #
5373
6090
  # @example Response structure
@@ -5380,6 +6097,9 @@ module Aws::QuickSight
5380
6097
  # resp.user.active #=> Boolean
5381
6098
  # resp.user.principal_id #=> String
5382
6099
  # resp.user.custom_permissions_name #=> String
6100
+ # resp.user.external_login_federation_provider_type #=> String
6101
+ # resp.user.external_login_federation_provider_url #=> String
6102
+ # resp.user.external_login_id #=> String
5383
6103
  # resp.user_invitation_url #=> String
5384
6104
  # resp.request_id #=> String
5385
6105
  # resp.status #=> Integer
@@ -5396,7 +6116,7 @@ module Aws::QuickSight
5396
6116
  # Restores an analysis.
5397
6117
  #
5398
6118
  # @option params [required, String] :aws_account_id
5399
- # The ID of the AWS account that contains the analysis.
6119
+ # The ID of the Amazon Web Services account; that contains the analysis.
5400
6120
  #
5401
6121
  # @option params [required, String] :analysis_id
5402
6122
  # The ID of the analysis that you're restoring.
@@ -5433,9 +6153,14 @@ module Aws::QuickSight
5433
6153
 
5434
6154
  # Searches for analyses that belong to the user specified in the filter.
5435
6155
  #
6156
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
6157
+ # and may not reflect very recent updates and changes.
6158
+ #
6159
+ # </note>
6160
+ #
5436
6161
  # @option params [required, String] :aws_account_id
5437
- # The ID of the AWS account that contains the analyses that you're
5438
- # searching for.
6162
+ # The ID of the Amazon Web Services account; that contains the analyses
6163
+ # that you're searching for.
5439
6164
  #
5440
6165
  # @option params [required, Array<Types::AnalysisSearchFilter>] :filters
5441
6166
  # The structure for the search filters that you want to apply to your
@@ -5495,9 +6220,14 @@ module Aws::QuickSight
5495
6220
 
5496
6221
  # Searches for dashboards that belong to a user.
5497
6222
  #
6223
+ # <note markdown="1"> This operation is eventually consistent. The results are best effort
6224
+ # and may not reflect very recent updates and changes.
6225
+ #
6226
+ # </note>
6227
+ #
5498
6228
  # @option params [required, String] :aws_account_id
5499
- # The ID of the AWS account that contains the user whose dashboards
5500
- # you're searching for.
6229
+ # The ID of the Amazon Web Services account; that contains the user
6230
+ # whose dashboards you're searching for.
5501
6231
  #
5502
6232
  # @option params [required, Array<Types::DashboardSearchFilter>] :filters
5503
6233
  # The filters to apply to the search. Currently, you can search only by
@@ -5559,6 +6289,68 @@ module Aws::QuickSight
5559
6289
  req.send_request(options)
5560
6290
  end
5561
6291
 
6292
+ # Searches the subfolders in a folder.
6293
+ #
6294
+ # @option params [required, String] :aws_account_id
6295
+ # The AWS account ID.
6296
+ #
6297
+ # @option params [required, Array<Types::FolderSearchFilter>] :filters
6298
+ # The filters to apply to the search. Currently, you can search only by
6299
+ # the parent folder ARN. For example, `"Filters": [ \{ "Name":
6300
+ # "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value":
6301
+ # "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ]`.
6302
+ #
6303
+ # @option params [String] :next_token
6304
+ # The token for the next set of results, or null if there are no more
6305
+ # results.
6306
+ #
6307
+ # @option params [Integer] :max_results
6308
+ # The maximum number of results to be returned per request.
6309
+ #
6310
+ # @return [Types::SearchFoldersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6311
+ #
6312
+ # * {Types::SearchFoldersResponse#status #status} => Integer
6313
+ # * {Types::SearchFoldersResponse#folder_summary_list #folder_summary_list} => Array&lt;Types::FolderSummary&gt;
6314
+ # * {Types::SearchFoldersResponse#next_token #next_token} => String
6315
+ # * {Types::SearchFoldersResponse#request_id #request_id} => String
6316
+ #
6317
+ # @example Request syntax with placeholder values
6318
+ #
6319
+ # resp = client.search_folders({
6320
+ # aws_account_id: "AwsAccountId", # required
6321
+ # filters: [ # required
6322
+ # {
6323
+ # operator: "StringEquals", # accepts StringEquals
6324
+ # name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
6325
+ # value: "String",
6326
+ # },
6327
+ # ],
6328
+ # next_token: "String",
6329
+ # max_results: 1,
6330
+ # })
6331
+ #
6332
+ # @example Response structure
6333
+ #
6334
+ # resp.status #=> Integer
6335
+ # resp.folder_summary_list #=> Array
6336
+ # resp.folder_summary_list[0].arn #=> String
6337
+ # resp.folder_summary_list[0].folder_id #=> String
6338
+ # resp.folder_summary_list[0].name #=> String
6339
+ # resp.folder_summary_list[0].folder_type #=> String, one of "SHARED"
6340
+ # resp.folder_summary_list[0].created_time #=> Time
6341
+ # resp.folder_summary_list[0].last_updated_time #=> Time
6342
+ # resp.next_token #=> String
6343
+ # resp.request_id #=> String
6344
+ #
6345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFolders AWS API Documentation
6346
+ #
6347
+ # @overload search_folders(params = {})
6348
+ # @param [Hash] params ({})
6349
+ def search_folders(params = {}, options = {})
6350
+ req = build_request(:search_folders, params)
6351
+ req.send_request(options)
6352
+ end
6353
+
5562
6354
  # Assigns one or more tags (key-value pairs) to the specified QuickSight
5563
6355
  # resource.
5564
6356
  #
@@ -5581,8 +6373,8 @@ module Aws::QuickSight
5581
6373
  # restriction is because QuickSight costs are based on users and SPICE
5582
6374
  # capacity, which aren't taggable resources.
5583
6375
  #
5584
- # * QuickSight doesn't currently support the Tag Editor for AWS
5585
- # Resource Groups.
6376
+ # * QuickSight doesn't currently support the Tag Editor for Resource
6377
+ # Groups.
5586
6378
  #
5587
6379
  # @option params [required, String] :resource_arn
5588
6380
  # The Amazon Resource Name (ARN) of the resource that you want to tag.
@@ -5657,25 +6449,25 @@ module Aws::QuickSight
5657
6449
  req.send_request(options)
5658
6450
  end
5659
6451
 
5660
- # Updates Amazon QuickSight customizations the current AWS Region.
6452
+ # Updates Amazon QuickSight customizations the current Region;.
5661
6453
  # Currently, the only customization you can use is a theme.
5662
6454
  #
5663
- # You can use customizations for your AWS account or, if you specify a
5664
- # namespace, for a QuickSight namespace instead. Customizations that
5665
- # apply to a namespace override customizations that apply to an AWS
5666
- # account. To find out which customizations apply, use the
5667
- # `DescribeAccountCustomization` API operation.
6455
+ # You can use customizations for your Amazon Web Services account; or,
6456
+ # if you specify a namespace, for a QuickSight namespace instead.
6457
+ # Customizations that apply to a namespace override customizations that
6458
+ # apply to an Amazon Web Services account;. To find out which
6459
+ # customizations apply, use the `DescribeAccountCustomization` API
6460
+ # operation.
5668
6461
  #
5669
6462
  # @option params [required, String] :aws_account_id
5670
- # The ID for the AWS account that you want to update QuickSight
5671
- # customizations for.
6463
+ # The ID for the Amazon Web Services account; that you want to update
6464
+ # QuickSight customizations for.
5672
6465
  #
5673
6466
  # @option params [String] :namespace
5674
6467
  # The namespace that you want to update QuickSight customizations for.
5675
6468
  #
5676
6469
  # @option params [required, Types::AccountCustomization] :account_customization
5677
- # The QuickSight customizations you're updating in the current AWS
5678
- # Region.
6470
+ # The QuickSight customizations you're updating in the current Region;.
5679
6471
  #
5680
6472
  # @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5681
6473
  #
@@ -5714,21 +6506,23 @@ module Aws::QuickSight
5714
6506
  req.send_request(options)
5715
6507
  end
5716
6508
 
5717
- # Updates the Amazon QuickSight settings in your AWS account.
6509
+ # Updates the Amazon QuickSight settings in your Amazon Web Services
6510
+ # account;.
5718
6511
  #
5719
6512
  # @option params [required, String] :aws_account_id
5720
- # The ID for the AWS account that contains the QuickSight settings that
5721
- # you want to list.
6513
+ # The ID for the Amazon Web Services account; that contains the
6514
+ # QuickSight settings that you want to list.
5722
6515
  #
5723
6516
  # @option params [required, String] :default_namespace
5724
- # The default namespace for this AWS account. Currently, the default is
5725
- # `default`. AWS Identity and Access Management (IAM) users that
5726
- # register for the first time with QuickSight provide an email that
5727
- # becomes associated with the default namespace.
6517
+ # The default namespace for this Amazon Web Services account;.
6518
+ # Currently, the default is `default`. Identity and Access Management
6519
+ # (IAM) users that register for the first time with QuickSight provide
6520
+ # an email that becomes associated with the default namespace.
5728
6521
  #
5729
6522
  # @option params [String] :notification_email
5730
6523
  # The email address that you want QuickSight to send notifications to
5731
- # regarding your AWS account or QuickSight subscription.
6524
+ # regarding your Amazon Web Services account; or QuickSight
6525
+ # subscription.
5732
6526
  #
5733
6527
  # @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5734
6528
  #
@@ -5760,8 +6554,8 @@ module Aws::QuickSight
5760
6554
  # Updates an analysis in Amazon QuickSight
5761
6555
  #
5762
6556
  # @option params [required, String] :aws_account_id
5763
- # The ID of the AWS account that contains the analysis that you're
5764
- # updating.
6557
+ # The ID of the Amazon Web Services account; that contains the analysis
6558
+ # that you're updating.
5765
6559
  #
5766
6560
  # @option params [required, String] :analysis_id
5767
6561
  # The ID for the analysis that you're updating. This ID displays in the
@@ -5860,9 +6654,9 @@ module Aws::QuickSight
5860
6654
  # Updates the read and write permissions for an analysis.
5861
6655
  #
5862
6656
  # @option params [required, String] :aws_account_id
5863
- # The ID of the AWS account that contains the analysis whose permissions
5864
- # you're updating. You must be using the AWS account that the analysis
5865
- # is in.
6657
+ # The ID of the Amazon Web Services account; that contains the analysis
6658
+ # whose permissions you're updating. You must be using the Amazon Web
6659
+ # Services account; that the analysis is in.
5866
6660
  #
5867
6661
  # @option params [required, String] :analysis_id
5868
6662
  # The ID of the analysis whose permissions you're updating. The ID is
@@ -5923,11 +6717,18 @@ module Aws::QuickSight
5923
6717
  req.send_request(options)
5924
6718
  end
5925
6719
 
5926
- # Updates a dashboard in an AWS account.
6720
+ # Updates a dashboard in an Amazon Web Services account;.
6721
+ #
6722
+ # <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
6723
+ # immediately publish the new version. You can update the published
6724
+ # version of a dashboard by using the UpdateDashboardPublishedVersion
6725
+ # API operation.
6726
+ #
6727
+ # </note>
5927
6728
  #
5928
6729
  # @option params [required, String] :aws_account_id
5929
- # The ID of the AWS account that contains the dashboard that you're
5930
- # updating.
6730
+ # The ID of the Amazon Web Services account; that contains the dashboard
6731
+ # that you're updating.
5931
6732
  #
5932
6733
  # @option params [required, String] :dashboard_id
5933
6734
  # The ID for the dashboard.
@@ -5943,8 +6744,8 @@ module Aws::QuickSight
5943
6744
  # from an analysis, first convert the analysis to a template by using
5944
6745
  # the CreateTemplate API operation. For `SourceTemplate`, specify the
5945
6746
  # Amazon Resource Name (ARN) of the source template. The
5946
- # `SourceTemplate` ARN can contain any AWS Account and any
5947
- # QuickSight-supported AWS Region.
6747
+ # `SourceTemplate` ARN can contain any Amazon Web Services account; and
6748
+ # any QuickSight-supported Region;.
5948
6749
  #
5949
6750
  # Use the `DataSetReferences` entity within `SourceTemplate` to list the
5950
6751
  # replacement datasets for the placeholders listed in the original. The
@@ -5980,7 +6781,8 @@ module Aws::QuickSight
5980
6781
  # The Amazon Resource Name (ARN) of the theme that is being used for
5981
6782
  # this dashboard. If you add a value for this field, it overrides the
5982
6783
  # value that was originally associated with the entity. The theme ARN
5983
- # must exist in the same AWS account where you create the dashboard.
6784
+ # must exist in the same Amazon Web Services account; where you create
6785
+ # the dashboard.
5984
6786
  #
5985
6787
  # @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5986
6788
  #
@@ -6070,8 +6872,8 @@ module Aws::QuickSight
6070
6872
  # Updates read and write permissions on a dashboard.
6071
6873
  #
6072
6874
  # @option params [required, String] :aws_account_id
6073
- # The ID of the AWS account that contains the dashboard whose
6074
- # permissions you're updating.
6875
+ # The ID of the Amazon Web Services account; that contains the dashboard
6876
+ # whose permissions you're updating.
6075
6877
  #
6076
6878
  # @option params [required, String] :dashboard_id
6077
6879
  # The ID for the dashboard.
@@ -6132,8 +6934,8 @@ module Aws::QuickSight
6132
6934
  # Updates the published version of a dashboard.
6133
6935
  #
6134
6936
  # @option params [required, String] :aws_account_id
6135
- # The ID of the AWS account that contains the dashboard that you're
6136
- # updating.
6937
+ # The ID of the Amazon Web Services account; that contains the dashboard
6938
+ # that you're updating.
6137
6939
  #
6138
6940
  # @option params [required, String] :dashboard_id
6139
6941
  # The ID for the dashboard.
@@ -6175,11 +6977,11 @@ module Aws::QuickSight
6175
6977
  # Updates a dataset.
6176
6978
  #
6177
6979
  # @option params [required, String] :aws_account_id
6178
- # The AWS account ID.
6980
+ # The Amazon Web Services account; ID.
6179
6981
  #
6180
6982
  # @option params [required, String] :data_set_id
6181
6983
  # The ID for the dataset that you want to update. This ID is unique per
6182
- # AWS Region for each AWS account.
6984
+ # Region; for each Amazon Web Services account;.
6183
6985
  #
6184
6986
  # @option params [required, String] :name
6185
6987
  # The display name for the dataset.
@@ -6206,6 +7008,11 @@ module Aws::QuickSight
6206
7008
  # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
6207
7009
  # The row-level security configuration for the data you want to create.
6208
7010
  #
7011
+ # @option params [Types::RowLevelPermissionTagConfiguration] :row_level_permission_tag_configuration
7012
+ # The configuration of tags on a dataset to set row-level security.
7013
+ # Row-level security tags are currently supported for anonymous
7014
+ # embedding only.
7015
+ #
6209
7016
  # @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
6210
7017
  # A set of one or more definitions of a ` ColumnLevelPermissionRule `.
6211
7018
  #
@@ -6347,6 +7154,18 @@ module Aws::QuickSight
6347
7154
  # arn: "Arn", # required
6348
7155
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
6349
7156
  # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
7157
+ # status: "ENABLED", # accepts ENABLED, DISABLED
7158
+ # },
7159
+ # row_level_permission_tag_configuration: {
7160
+ # status: "ENABLED", # accepts ENABLED, DISABLED
7161
+ # tag_rules: [ # required
7162
+ # {
7163
+ # tag_key: "SessionTagKey", # required
7164
+ # column_name: "String", # required
7165
+ # tag_multi_value_delimiter: "RowLevelPermissionTagDelimiter",
7166
+ # match_all_value: "SessionTagValue",
7167
+ # },
7168
+ # ],
6350
7169
  # },
6351
7170
  # column_level_permission_rules: [
6352
7171
  # {
@@ -6380,11 +7199,11 @@ module Aws::QuickSight
6380
7199
  # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
6381
7200
  #
6382
7201
  # @option params [required, String] :aws_account_id
6383
- # The AWS account ID.
7202
+ # The Amazon Web Services account; ID.
6384
7203
  #
6385
7204
  # @option params [required, String] :data_set_id
6386
7205
  # The ID for the dataset whose permissions you want to update. This ID
6387
- # is unique per AWS Region for each AWS account.
7206
+ # is unique per Region; for each Amazon Web Services account;.
6388
7207
  #
6389
7208
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
6390
7209
  # The resource permissions that you want to grant to the dataset.
@@ -6437,11 +7256,11 @@ module Aws::QuickSight
6437
7256
  # Updates a data source.
6438
7257
  #
6439
7258
  # @option params [required, String] :aws_account_id
6440
- # The AWS account ID.
7259
+ # The Amazon Web Services account; ID.
6441
7260
  #
6442
7261
  # @option params [required, String] :data_source_id
6443
- # The ID of the data source. This ID is unique per AWS Region for each
6444
- # AWS account.
7262
+ # The ID of the data source. This ID is unique per Region; for each
7263
+ # Amazon Web Services account;.
6445
7264
  #
6446
7265
  # @option params [required, String] :name
6447
7266
  # A display name for the data source.
@@ -6696,11 +7515,11 @@ module Aws::QuickSight
6696
7515
  # Updates the permissions to a data source.
6697
7516
  #
6698
7517
  # @option params [required, String] :aws_account_id
6699
- # The AWS account ID.
7518
+ # The Amazon Web Services account; ID.
6700
7519
  #
6701
7520
  # @option params [required, String] :data_source_id
6702
- # The ID of the data source. This ID is unique per AWS Region for each
6703
- # AWS account.
7521
+ # The ID of the data source. This ID is unique per Region; for each
7522
+ # Amazon Web Services account;.
6704
7523
  #
6705
7524
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
6706
7525
  # A list of resource permissions that you want to grant on the data
@@ -6752,6 +7571,109 @@ module Aws::QuickSight
6752
7571
  req.send_request(options)
6753
7572
  end
6754
7573
 
7574
+ # Updates the name of a folder.
7575
+ #
7576
+ # @option params [required, String] :aws_account_id
7577
+ # The AWS account ID.
7578
+ #
7579
+ # @option params [required, String] :folder_id
7580
+ # The folder ID.
7581
+ #
7582
+ # @option params [required, String] :name
7583
+ # The name of the folder.
7584
+ #
7585
+ # @return [Types::UpdateFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7586
+ #
7587
+ # * {Types::UpdateFolderResponse#status #status} => Integer
7588
+ # * {Types::UpdateFolderResponse#arn #arn} => String
7589
+ # * {Types::UpdateFolderResponse#folder_id #folder_id} => String
7590
+ # * {Types::UpdateFolderResponse#request_id #request_id} => String
7591
+ #
7592
+ # @example Request syntax with placeholder values
7593
+ #
7594
+ # resp = client.update_folder({
7595
+ # aws_account_id: "AwsAccountId", # required
7596
+ # folder_id: "RestrictiveResourceId", # required
7597
+ # name: "FolderName", # required
7598
+ # })
7599
+ #
7600
+ # @example Response structure
7601
+ #
7602
+ # resp.status #=> Integer
7603
+ # resp.arn #=> String
7604
+ # resp.folder_id #=> String
7605
+ # resp.request_id #=> String
7606
+ #
7607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolder AWS API Documentation
7608
+ #
7609
+ # @overload update_folder(params = {})
7610
+ # @param [Hash] params ({})
7611
+ def update_folder(params = {}, options = {})
7612
+ req = build_request(:update_folder, params)
7613
+ req.send_request(options)
7614
+ end
7615
+
7616
+ # Updates permissions of a folder.
7617
+ #
7618
+ # @option params [required, String] :aws_account_id
7619
+ # The AWS account ID.
7620
+ #
7621
+ # @option params [required, String] :folder_id
7622
+ # The folder ID.
7623
+ #
7624
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
7625
+ # The permissions that you want to grant on a resource.
7626
+ #
7627
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
7628
+ # The permissions that you want to revoke from a resource.
7629
+ #
7630
+ # @return [Types::UpdateFolderPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7631
+ #
7632
+ # * {Types::UpdateFolderPermissionsResponse#status #status} => Integer
7633
+ # * {Types::UpdateFolderPermissionsResponse#arn #arn} => String
7634
+ # * {Types::UpdateFolderPermissionsResponse#folder_id #folder_id} => String
7635
+ # * {Types::UpdateFolderPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
7636
+ # * {Types::UpdateFolderPermissionsResponse#request_id #request_id} => String
7637
+ #
7638
+ # @example Request syntax with placeholder values
7639
+ #
7640
+ # resp = client.update_folder_permissions({
7641
+ # aws_account_id: "AwsAccountId", # required
7642
+ # folder_id: "RestrictiveResourceId", # required
7643
+ # grant_permissions: [
7644
+ # {
7645
+ # principal: "Principal", # required
7646
+ # actions: ["String"], # required
7647
+ # },
7648
+ # ],
7649
+ # revoke_permissions: [
7650
+ # {
7651
+ # principal: "Principal", # required
7652
+ # actions: ["String"], # required
7653
+ # },
7654
+ # ],
7655
+ # })
7656
+ #
7657
+ # @example Response structure
7658
+ #
7659
+ # resp.status #=> Integer
7660
+ # resp.arn #=> String
7661
+ # resp.folder_id #=> String
7662
+ # resp.permissions #=> Array
7663
+ # resp.permissions[0].principal #=> String
7664
+ # resp.permissions[0].actions #=> Array
7665
+ # resp.permissions[0].actions[0] #=> String
7666
+ # resp.request_id #=> String
7667
+ #
7668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissions AWS API Documentation
7669
+ #
7670
+ # @overload update_folder_permissions(params = {})
7671
+ # @param [Hash] params ({})
7672
+ def update_folder_permissions(params = {}, options = {})
7673
+ req = build_request(:update_folder_permissions, params)
7674
+ req.send_request(options)
7675
+ end
7676
+
6755
7677
  # Changes a group description.
6756
7678
  #
6757
7679
  # @option params [required, String] :group_name
@@ -6761,9 +7683,9 @@ module Aws::QuickSight
6761
7683
  # The description for the group that you want to update.
6762
7684
  #
6763
7685
  # @option params [required, String] :aws_account_id
6764
- # The ID for the AWS account that the group is in. Currently, you use
6765
- # the ID for the AWS account that contains your Amazon QuickSight
6766
- # account.
7686
+ # The ID for the Amazon Web Services account; that the group is in.
7687
+ # Currently, you use the ID for the Amazon Web Services account; that
7688
+ # contains your Amazon QuickSight account.
6767
7689
  #
6768
7690
  # @option params [required, String] :namespace
6769
7691
  # The namespace. Currently, you should set this to `default`.
@@ -6806,11 +7728,12 @@ module Aws::QuickSight
6806
7728
  # request. This overwrites all of the users included in `Identities`.
6807
7729
  #
6808
7730
  # @option params [required, String] :aws_account_id
6809
- # The ID of the AWS account that contains the IAM policy assignment.
7731
+ # The ID of the Amazon Web Services account; that contains the IAM
7732
+ # policy assignment.
6810
7733
  #
6811
7734
  # @option params [required, String] :assignment_name
6812
7735
  # The name of the assignment, also called a rule. This name must be
6813
- # unique within an AWS account.
7736
+ # unique within an Amazon Web Services account;.
6814
7737
  #
6815
7738
  # @option params [required, String] :namespace
6816
7739
  # The namespace of the assignment.
@@ -6883,8 +7806,8 @@ module Aws::QuickSight
6883
7806
  # another template.
6884
7807
  #
6885
7808
  # @option params [required, String] :aws_account_id
6886
- # The ID of the AWS account that contains the template that you're
6887
- # updating.
7809
+ # The ID of the Amazon Web Services account; that contains the template
7810
+ # that you're updating.
6888
7811
  #
6889
7812
  # @option params [required, String] :template_id
6890
7813
  # The ID for the template.
@@ -6896,8 +7819,8 @@ module Aws::QuickSight
6896
7819
  # for an analysis. Both of these require an Amazon Resource Name (ARN).
6897
7820
  # For `SourceTemplate`, specify the ARN of the source template. For
6898
7821
  # `SourceAnalysis`, specify the ARN of the source analysis. The
6899
- # `SourceTemplate` ARN can contain any AWS Account and any
6900
- # QuickSight-supported AWS Region.
7822
+ # `SourceTemplate` ARN can contain any Amazon Web Services account; and
7823
+ # any QuickSight-supported Region;.
6901
7824
  #
6902
7825
  # Use the `DataSetReferences` entity within `SourceTemplate` or
6903
7826
  # `SourceAnalysis` to list the replacement datasets for the placeholders
@@ -6966,8 +7889,8 @@ module Aws::QuickSight
6966
7889
  # Updates the template alias of a template.
6967
7890
  #
6968
7891
  # @option params [required, String] :aws_account_id
6969
- # The ID of the AWS account that contains the template alias that
6970
- # you're updating.
7892
+ # The ID of the Amazon Web Services account; that contains the template
7893
+ # alias that you're updating.
6971
7894
  #
6972
7895
  # @option params [required, String] :template_id
6973
7896
  # The ID for the template.
@@ -7017,7 +7940,7 @@ module Aws::QuickSight
7017
7940
  # Updates the resource permissions for a template.
7018
7941
  #
7019
7942
  # @option params [required, String] :aws_account_id
7020
- # The ID of the AWS account that contains the template.
7943
+ # The ID of the Amazon Web Services account; that contains the template.
7021
7944
  #
7022
7945
  # @option params [required, String] :template_id
7023
7946
  # The ID for the template.
@@ -7078,8 +8001,8 @@ module Aws::QuickSight
7078
8001
  # Updates a theme.
7079
8002
  #
7080
8003
  # @option params [required, String] :aws_account_id
7081
- # The ID of the AWS account that contains the theme that you're
7082
- # updating.
8004
+ # The ID of the Amazon Web Services account; that contains the theme
8005
+ # that you're updating.
7083
8006
  #
7084
8007
  # @option params [required, String] :theme_id
7085
8008
  # The ID for the theme.
@@ -7089,8 +8012,8 @@ module Aws::QuickSight
7089
8012
  #
7090
8013
  # @option params [required, String] :base_theme_id
7091
8014
  # The theme ID, defined by Amazon QuickSight, that a custom theme
7092
- # inherits from. All themes initially inherit from a default QuickSight
7093
- # theme.
8015
+ # inherits from. All themes initially inherit from a default Amazon
8016
+ # QuickSight theme.
7094
8017
  #
7095
8018
  # @option params [String] :version_description
7096
8019
  # A description of the theme version that you're updating Every time
@@ -7181,8 +8104,8 @@ module Aws::QuickSight
7181
8104
  # Updates an alias of a theme.
7182
8105
  #
7183
8106
  # @option params [required, String] :aws_account_id
7184
- # The ID of the AWS account that contains the theme alias that you're
7185
- # updating.
8107
+ # The ID of the Amazon Web Services account; that contains the theme
8108
+ # alias that you're updating.
7186
8109
  #
7187
8110
  # @option params [required, String] :theme_id
7188
8111
  # The ID for the theme.
@@ -7270,7 +8193,7 @@ module Aws::QuickSight
7270
8193
  # * To specify no permissions, omit the permissions list.
7271
8194
  #
7272
8195
  # @option params [required, String] :aws_account_id
7273
- # The ID of the AWS account that contains the theme.
8196
+ # The ID of the Amazon Web Services account; that contains the theme.
7274
8197
  #
7275
8198
  # @option params [required, String] :theme_id
7276
8199
  # The ID for the theme.
@@ -7334,8 +8257,9 @@ module Aws::QuickSight
7334
8257
  # The Amazon QuickSight user name that you want to update.
7335
8258
  #
7336
8259
  # @option params [required, String] :aws_account_id
7337
- # The ID for the AWS account that the user is in. Currently, you use the
7338
- # ID for the AWS account that contains your Amazon QuickSight account.
8260
+ # The ID for the Amazon Web Services account; that the user is in.
8261
+ # Currently, you use the ID for the Amazon Web Services account; that
8262
+ # contains your Amazon QuickSight account.
7339
8263
  #
7340
8264
  # @option params [required, String] :namespace
7341
8265
  # The namespace. Currently, you should set this to `default`.
@@ -7384,8 +8308,7 @@ module Aws::QuickSight
7384
8308
  # QuickSight (admin, author, reader).
7385
8309
  #
7386
8310
  # This feature is available only to QuickSight Enterprise edition
7387
- # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
7388
- # (SSO).
8311
+ # subscriptions.
7389
8312
  #
7390
8313
  # @option params [Boolean] :unapply_custom_permissions
7391
8314
  # A flag that you use to indicate that you want to remove all custom
@@ -7394,6 +8317,35 @@ module Aws::QuickSight
7394
8317
  # This parameter defaults to NULL and it doesn't accept any other
7395
8318
  # value.
7396
8319
  #
8320
+ # @option params [String] :external_login_federation_provider_type
8321
+ # The type of supported external login provider that provides identity
8322
+ # to let a user federate into QuickSight with an associated AWS Identity
8323
+ # and Access Management (IAM) role. The type of supported external login
8324
+ # provider can be one of the following.
8325
+ #
8326
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
8327
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
8328
+ # type, don’t use the "CustomFederationProviderUrl" parameter which
8329
+ # is only needed when the external provider is custom.
8330
+ #
8331
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
8332
+ # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
8333
+ # to provide the custom OIDC provider URL.
8334
+ #
8335
+ # * `NONE`\: This clears all the previously saved external login
8336
+ # information for a user. Use ` DescribeUser ` API to check the
8337
+ # external login information.
8338
+ #
8339
+ # @option params [String] :custom_federation_provider_url
8340
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
8341
+ # identity to let a user federate into QuickSight with an associated AWS
8342
+ # Identity and Access Management (IAM) role. This parameter should only
8343
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
8344
+ # `CUSTOM_OIDC`.
8345
+ #
8346
+ # @option params [String] :external_login_id
8347
+ # The identity ID for a user in the external login provider.
8348
+ #
7397
8349
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7398
8350
  #
7399
8351
  # * {Types::UpdateUserResponse#user #user} => Types::User
@@ -7410,6 +8362,9 @@ module Aws::QuickSight
7410
8362
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
7411
8363
  # custom_permissions_name: "RoleName",
7412
8364
  # unapply_custom_permissions: false,
8365
+ # external_login_federation_provider_type: "String",
8366
+ # custom_federation_provider_url: "String",
8367
+ # external_login_id: "String",
7413
8368
  # })
7414
8369
  #
7415
8370
  # @example Response structure
@@ -7422,6 +8377,9 @@ module Aws::QuickSight
7422
8377
  # resp.user.active #=> Boolean
7423
8378
  # resp.user.principal_id #=> String
7424
8379
  # resp.user.custom_permissions_name #=> String
8380
+ # resp.user.external_login_federation_provider_type #=> String
8381
+ # resp.user.external_login_federation_provider_url #=> String
8382
+ # resp.user.external_login_id #=> String
7425
8383
  # resp.request_id #=> String
7426
8384
  # resp.status #=> Integer
7427
8385
  #
@@ -7447,7 +8405,7 @@ module Aws::QuickSight
7447
8405
  params: params,
7448
8406
  config: config)
7449
8407
  context[:gem_name] = 'aws-sdk-quicksight'
7450
- context[:gem_version] = '1.45.0'
8408
+ context[:gem_version] = '1.49.0'
7451
8409
  Seahorse::Client::Request.new(handlers, context)
7452
8410
  end
7453
8411