aws-sdk-quicksight 1.42.0 → 1.47.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.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.47.0
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -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.42.0'
51
+ GEM_VERSION = '1.47.0'
52
52
 
53
53
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -945,6 +945,7 @@ module Aws::QuickSight
945
945
  # namespace: "Namespace",
946
946
  # arn: "Arn", # required
947
947
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
948
+ # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
948
949
  # },
949
950
  # column_level_permission_rules: [
950
951
  # {
@@ -992,9 +993,12 @@ module Aws::QuickSight
992
993
  #
993
994
  # @option params [required, String] :type
994
995
  # The type of the data source. Currently, the supported types for this
995
- # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
996
- # POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER,
997
- # TERADATA`. Use `ListDataSources` to return a list of all data sources.
996
+ # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
997
+ # AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
998
+ # S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
999
+ # return a list of all data sources.
1000
+ #
1001
+ # `AMAZON_ELASTICSEARCH` is for Amazon managed Elasticsearch Service.
998
1002
  #
999
1003
  # @option params [Types::DataSourceParameters] :data_source_parameters
1000
1004
  # The parameters that QuickSight uses to connect to your underlying
@@ -1263,6 +1267,127 @@ module Aws::QuickSight
1263
1267
  req.send_request(options)
1264
1268
  end
1265
1269
 
1270
+ # Creates an empty shared folder.
1271
+ #
1272
+ # @option params [required, String] :aws_account_id
1273
+ # The AWS Account ID.
1274
+ #
1275
+ # @option params [required, String] :folder_id
1276
+ # The folder ID.
1277
+ #
1278
+ # @option params [String] :name
1279
+ # The name of the folder.
1280
+ #
1281
+ # @option params [String] :folder_type
1282
+ # The type of folder. By default, `folderType` is `SHARED`.
1283
+ #
1284
+ # @option params [String] :parent_folder_arn
1285
+ # The Amazon Resource Name (ARN) for the parent folder.
1286
+ #
1287
+ # `ParentFolderArn` can be null. An empty `parentFolderArn` creates a
1288
+ # root-level folder.
1289
+ #
1290
+ # @option params [Array<Types::ResourcePermission>] :permissions
1291
+ # A structure that describes the principals and the resource-level
1292
+ # permissions of a folder.
1293
+ #
1294
+ # To specify no permissions, omit `Permissions`.
1295
+ #
1296
+ # @option params [Array<Types::Tag>] :tags
1297
+ # Tags for the folder.
1298
+ #
1299
+ # @return [Types::CreateFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1300
+ #
1301
+ # * {Types::CreateFolderResponse#status #status} => Integer
1302
+ # * {Types::CreateFolderResponse#arn #arn} => String
1303
+ # * {Types::CreateFolderResponse#folder_id #folder_id} => String
1304
+ # * {Types::CreateFolderResponse#request_id #request_id} => String
1305
+ #
1306
+ # @example Request syntax with placeholder values
1307
+ #
1308
+ # resp = client.create_folder({
1309
+ # aws_account_id: "AwsAccountId", # required
1310
+ # folder_id: "RestrictiveResourceId", # required
1311
+ # name: "FolderName",
1312
+ # folder_type: "SHARED", # accepts SHARED
1313
+ # parent_folder_arn: "Arn",
1314
+ # permissions: [
1315
+ # {
1316
+ # principal: "Principal", # required
1317
+ # actions: ["String"], # required
1318
+ # },
1319
+ # ],
1320
+ # tags: [
1321
+ # {
1322
+ # key: "TagKey", # required
1323
+ # value: "TagValue", # required
1324
+ # },
1325
+ # ],
1326
+ # })
1327
+ #
1328
+ # @example Response structure
1329
+ #
1330
+ # resp.status #=> Integer
1331
+ # resp.arn #=> String
1332
+ # resp.folder_id #=> String
1333
+ # resp.request_id #=> String
1334
+ #
1335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolder AWS API Documentation
1336
+ #
1337
+ # @overload create_folder(params = {})
1338
+ # @param [Hash] params ({})
1339
+ def create_folder(params = {}, options = {})
1340
+ req = build_request(:create_folder, params)
1341
+ req.send_request(options)
1342
+ end
1343
+
1344
+ # Adds an asset, such as a dashboard, analysis, or dataset into a
1345
+ # folder.
1346
+ #
1347
+ # @option params [required, String] :aws_account_id
1348
+ # The AWS Account ID.
1349
+ #
1350
+ # @option params [required, String] :folder_id
1351
+ # The folder ID.
1352
+ #
1353
+ # @option params [required, String] :member_id
1354
+ # The ID of the asset (the dashboard, analysis, or dataset).
1355
+ #
1356
+ # @option params [required, String] :member_type
1357
+ # The type of the member, including `DASHBOARD`, `ANALYSIS`, and
1358
+ # `DATASET`.
1359
+ #
1360
+ # @return [Types::CreateFolderMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1361
+ #
1362
+ # * {Types::CreateFolderMembershipResponse#status #status} => Integer
1363
+ # * {Types::CreateFolderMembershipResponse#folder_member #folder_member} => Types::FolderMember
1364
+ # * {Types::CreateFolderMembershipResponse#request_id #request_id} => String
1365
+ #
1366
+ # @example Request syntax with placeholder values
1367
+ #
1368
+ # resp = client.create_folder_membership({
1369
+ # aws_account_id: "AwsAccountId", # required
1370
+ # folder_id: "RestrictiveResourceId", # required
1371
+ # member_id: "RestrictiveResourceId", # required
1372
+ # member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
1373
+ # })
1374
+ #
1375
+ # @example Response structure
1376
+ #
1377
+ # resp.status #=> Integer
1378
+ # resp.folder_member.member_id #=> String
1379
+ # resp.folder_member.member_type #=> String, one of "DASHBOARD", "ANALYSIS", "DATASET"
1380
+ # resp.request_id #=> String
1381
+ #
1382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembership AWS API Documentation
1383
+ #
1384
+ # @overload create_folder_membership(params = {})
1385
+ # @param [Hash] params ({})
1386
+ def create_folder_membership(params = {}, options = {})
1387
+ req = build_request(:create_folder_membership, params)
1388
+ req.send_request(options)
1389
+ end
1390
+
1266
1391
  # Creates an Amazon QuickSight group.
1267
1392
  #
1268
1393
  # The permissions resource is
@@ -2141,6 +2266,89 @@ module Aws::QuickSight
2141
2266
  req.send_request(options)
2142
2267
  end
2143
2268
 
2269
+ # Deletes an empty folder.
2270
+ #
2271
+ # @option params [required, String] :aws_account_id
2272
+ # The AWS Account ID for the folder.
2273
+ #
2274
+ # @option params [required, String] :folder_id
2275
+ # The folder ID.
2276
+ #
2277
+ # @return [Types::DeleteFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2278
+ #
2279
+ # * {Types::DeleteFolderResponse#status #status} => Integer
2280
+ # * {Types::DeleteFolderResponse#arn #arn} => String
2281
+ # * {Types::DeleteFolderResponse#folder_id #folder_id} => String
2282
+ # * {Types::DeleteFolderResponse#request_id #request_id} => String
2283
+ #
2284
+ # @example Request syntax with placeholder values
2285
+ #
2286
+ # resp = client.delete_folder({
2287
+ # aws_account_id: "AwsAccountId", # required
2288
+ # folder_id: "RestrictiveResourceId", # required
2289
+ # })
2290
+ #
2291
+ # @example Response structure
2292
+ #
2293
+ # resp.status #=> Integer
2294
+ # resp.arn #=> String
2295
+ # resp.folder_id #=> String
2296
+ # resp.request_id #=> String
2297
+ #
2298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolder AWS API Documentation
2299
+ #
2300
+ # @overload delete_folder(params = {})
2301
+ # @param [Hash] params ({})
2302
+ def delete_folder(params = {}, options = {})
2303
+ req = build_request(:delete_folder, params)
2304
+ req.send_request(options)
2305
+ end
2306
+
2307
+ # Removes an asset, such as a dashboard, analysis, or dataset, from a
2308
+ # folder.
2309
+ #
2310
+ # @option params [required, String] :aws_account_id
2311
+ # The AWS Account ID.
2312
+ #
2313
+ # @option params [required, String] :folder_id
2314
+ # The Folder ID.
2315
+ #
2316
+ # @option params [required, String] :member_id
2317
+ # The ID of the asset (the dashboard, analysis, or dataset) that you
2318
+ # want to delete.
2319
+ #
2320
+ # @option params [required, String] :member_type
2321
+ # The type of the member, including `DASHBOARD`, `ANALYSIS`, and
2322
+ # `DATASET`
2323
+ #
2324
+ # @return [Types::DeleteFolderMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2325
+ #
2326
+ # * {Types::DeleteFolderMembershipResponse#status #status} => Integer
2327
+ # * {Types::DeleteFolderMembershipResponse#request_id #request_id} => String
2328
+ #
2329
+ # @example Request syntax with placeholder values
2330
+ #
2331
+ # resp = client.delete_folder_membership({
2332
+ # aws_account_id: "AwsAccountId", # required
2333
+ # folder_id: "RestrictiveResourceId", # required
2334
+ # member_id: "RestrictiveResourceId", # required
2335
+ # member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
2336
+ # })
2337
+ #
2338
+ # @example Response structure
2339
+ #
2340
+ # resp.status #=> Integer
2341
+ # resp.request_id #=> String
2342
+ #
2343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembership AWS API Documentation
2344
+ #
2345
+ # @overload delete_folder_membership(params = {})
2346
+ # @param [Hash] params ({})
2347
+ def delete_folder_membership(params = {}, options = {})
2348
+ req = build_request(:delete_folder_membership, params)
2349
+ req.send_request(options)
2350
+ end
2351
+
2144
2352
  # Removes a user group from Amazon QuickSight.
2145
2353
  #
2146
2354
  # @option params [required, String] :group_name
@@ -3019,6 +3227,7 @@ module Aws::QuickSight
3019
3227
  # resp.data_set.row_level_permission_data_set.namespace #=> String
3020
3228
  # resp.data_set.row_level_permission_data_set.arn #=> String
3021
3229
  # resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
3230
+ # resp.data_set.row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
3022
3231
  # resp.data_set.column_level_permission_rules #=> Array
3023
3232
  # resp.data_set.column_level_permission_rules[0].principals #=> Array
3024
3233
  # resp.data_set.column_level_permission_rules[0].principals[0] #=> String
@@ -3269,6 +3478,137 @@ module Aws::QuickSight
3269
3478
  req.send_request(options)
3270
3479
  end
3271
3480
 
3481
+ # Describes a folder.
3482
+ #
3483
+ # @option params [required, String] :aws_account_id
3484
+ # The AWS account ID.
3485
+ #
3486
+ # @option params [required, String] :folder_id
3487
+ # The folder ID.
3488
+ #
3489
+ # @return [Types::DescribeFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3490
+ #
3491
+ # * {Types::DescribeFolderResponse#status #status} => Integer
3492
+ # * {Types::DescribeFolderResponse#folder #folder} => Types::Folder
3493
+ # * {Types::DescribeFolderResponse#request_id #request_id} => String
3494
+ #
3495
+ # @example Request syntax with placeholder values
3496
+ #
3497
+ # resp = client.describe_folder({
3498
+ # aws_account_id: "AwsAccountId", # required
3499
+ # folder_id: "RestrictiveResourceId", # required
3500
+ # })
3501
+ #
3502
+ # @example Response structure
3503
+ #
3504
+ # resp.status #=> Integer
3505
+ # resp.folder.folder_id #=> String
3506
+ # resp.folder.arn #=> String
3507
+ # resp.folder.name #=> String
3508
+ # resp.folder.folder_type #=> String, one of "SHARED"
3509
+ # resp.folder.folder_path #=> Array
3510
+ # resp.folder.folder_path[0] #=> String
3511
+ # resp.folder.created_time #=> Time
3512
+ # resp.folder.last_updated_time #=> Time
3513
+ # resp.request_id #=> String
3514
+ #
3515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolder AWS API Documentation
3516
+ #
3517
+ # @overload describe_folder(params = {})
3518
+ # @param [Hash] params ({})
3519
+ def describe_folder(params = {}, options = {})
3520
+ req = build_request(:describe_folder, params)
3521
+ req.send_request(options)
3522
+ end
3523
+
3524
+ # Describes permissions for a folder.
3525
+ #
3526
+ # @option params [required, String] :aws_account_id
3527
+ # The AWS Account ID.
3528
+ #
3529
+ # @option params [required, String] :folder_id
3530
+ # The folder ID.
3531
+ #
3532
+ # @return [Types::DescribeFolderPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3533
+ #
3534
+ # * {Types::DescribeFolderPermissionsResponse#status #status} => Integer
3535
+ # * {Types::DescribeFolderPermissionsResponse#folder_id #folder_id} => String
3536
+ # * {Types::DescribeFolderPermissionsResponse#arn #arn} => String
3537
+ # * {Types::DescribeFolderPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3538
+ # * {Types::DescribeFolderPermissionsResponse#request_id #request_id} => String
3539
+ #
3540
+ # @example Request syntax with placeholder values
3541
+ #
3542
+ # resp = client.describe_folder_permissions({
3543
+ # aws_account_id: "AwsAccountId", # required
3544
+ # folder_id: "RestrictiveResourceId", # required
3545
+ # })
3546
+ #
3547
+ # @example Response structure
3548
+ #
3549
+ # resp.status #=> Integer
3550
+ # resp.folder_id #=> String
3551
+ # resp.arn #=> String
3552
+ # resp.permissions #=> Array
3553
+ # resp.permissions[0].principal #=> String
3554
+ # resp.permissions[0].actions #=> Array
3555
+ # resp.permissions[0].actions[0] #=> String
3556
+ # resp.request_id #=> String
3557
+ #
3558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissions AWS API Documentation
3559
+ #
3560
+ # @overload describe_folder_permissions(params = {})
3561
+ # @param [Hash] params ({})
3562
+ def describe_folder_permissions(params = {}, options = {})
3563
+ req = build_request(:describe_folder_permissions, params)
3564
+ req.send_request(options)
3565
+ end
3566
+
3567
+ # Describes the folder resolved permissions. Permissions consists of
3568
+ # both folder direct permissions and the inherited permissions from the
3569
+ # ancestor folders.
3570
+ #
3571
+ # @option params [required, String] :aws_account_id
3572
+ # The AWS account ID.
3573
+ #
3574
+ # @option params [required, String] :folder_id
3575
+ # The folder ID.
3576
+ #
3577
+ # @return [Types::DescribeFolderResolvedPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3578
+ #
3579
+ # * {Types::DescribeFolderResolvedPermissionsResponse#status #status} => Integer
3580
+ # * {Types::DescribeFolderResolvedPermissionsResponse#folder_id #folder_id} => String
3581
+ # * {Types::DescribeFolderResolvedPermissionsResponse#arn #arn} => String
3582
+ # * {Types::DescribeFolderResolvedPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3583
+ # * {Types::DescribeFolderResolvedPermissionsResponse#request_id #request_id} => String
3584
+ #
3585
+ # @example Request syntax with placeholder values
3586
+ #
3587
+ # resp = client.describe_folder_resolved_permissions({
3588
+ # aws_account_id: "AwsAccountId", # required
3589
+ # folder_id: "RestrictiveResourceId", # required
3590
+ # })
3591
+ #
3592
+ # @example Response structure
3593
+ #
3594
+ # resp.status #=> Integer
3595
+ # resp.folder_id #=> String
3596
+ # resp.arn #=> String
3597
+ # resp.permissions #=> Array
3598
+ # resp.permissions[0].principal #=> String
3599
+ # resp.permissions[0].actions #=> Array
3600
+ # resp.permissions[0].actions[0] #=> String
3601
+ # resp.request_id #=> String
3602
+ #
3603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissions AWS API Documentation
3604
+ #
3605
+ # @overload describe_folder_resolved_permissions(params = {})
3606
+ # @param [Hash] params ({})
3607
+ def describe_folder_resolved_permissions(params = {}, options = {})
3608
+ req = build_request(:describe_folder_resolved_permissions, params)
3609
+ req.send_request(options)
3610
+ end
3611
+
3272
3612
  # Returns an Amazon QuickSight group's description and Amazon Resource
3273
3613
  # Name (ARN).
3274
3614
  #
@@ -3840,6 +4180,9 @@ module Aws::QuickSight
3840
4180
  # resp.user.active #=> Boolean
3841
4181
  # resp.user.principal_id #=> String
3842
4182
  # resp.user.custom_permissions_name #=> String
4183
+ # resp.user.external_login_federation_provider_type #=> String
4184
+ # resp.user.external_login_federation_provider_url #=> String
4185
+ # resp.user.external_login_id #=> String
3843
4186
  # resp.request_id #=> String
3844
4187
  # resp.status #=> Integer
3845
4188
  #
@@ -4276,6 +4619,7 @@ module Aws::QuickSight
4276
4619
  # resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
4277
4620
  # resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
4278
4621
  # resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
4622
+ # resp.data_set_summaries[0].row_level_permission_data_set.format_version #=> String, one of "VERSION_1", "VERSION_2"
4279
4623
  # resp.data_set_summaries[0].column_level_permission_rules_applied #=> Boolean
4280
4624
  # resp.next_token #=> String
4281
4625
  # resp.request_id #=> String
@@ -4442,6 +4786,104 @@ module Aws::QuickSight
4442
4786
  req.send_request(options)
4443
4787
  end
4444
4788
 
4789
+ # List all assets (`DASHBOARD`, `ANALYSIS`, and `DATASET`) in a folder.
4790
+ #
4791
+ # @option params [required, String] :aws_account_id
4792
+ # The AWS account ID.
4793
+ #
4794
+ # @option params [required, String] :folder_id
4795
+ # The folder ID.
4796
+ #
4797
+ # @option params [String] :next_token
4798
+ # The token for the next set of results, or null if there are no more
4799
+ # results.
4800
+ #
4801
+ # @option params [Integer] :max_results
4802
+ # The maximum number of results to be returned per request.
4803
+ #
4804
+ # @return [Types::ListFolderMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4805
+ #
4806
+ # * {Types::ListFolderMembersResponse#status #status} => Integer
4807
+ # * {Types::ListFolderMembersResponse#folder_member_list #folder_member_list} => Array&lt;Types::MemberIdArnPair&gt;
4808
+ # * {Types::ListFolderMembersResponse#next_token #next_token} => String
4809
+ # * {Types::ListFolderMembersResponse#request_id #request_id} => String
4810
+ #
4811
+ # @example Request syntax with placeholder values
4812
+ #
4813
+ # resp = client.list_folder_members({
4814
+ # aws_account_id: "AwsAccountId", # required
4815
+ # folder_id: "RestrictiveResourceId", # required
4816
+ # next_token: "String",
4817
+ # max_results: 1,
4818
+ # })
4819
+ #
4820
+ # @example Response structure
4821
+ #
4822
+ # resp.status #=> Integer
4823
+ # resp.folder_member_list #=> Array
4824
+ # resp.folder_member_list[0].member_id #=> String
4825
+ # resp.folder_member_list[0].member_arn #=> String
4826
+ # resp.next_token #=> String
4827
+ # resp.request_id #=> String
4828
+ #
4829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembers AWS API Documentation
4830
+ #
4831
+ # @overload list_folder_members(params = {})
4832
+ # @param [Hash] params ({})
4833
+ def list_folder_members(params = {}, options = {})
4834
+ req = build_request(:list_folder_members, params)
4835
+ req.send_request(options)
4836
+ end
4837
+
4838
+ # Lists all folders in an account.
4839
+ #
4840
+ # @option params [required, String] :aws_account_id
4841
+ # The AWS account ID.
4842
+ #
4843
+ # @option params [String] :next_token
4844
+ # The token for the next set of results, or null if there are no more
4845
+ # results.
4846
+ #
4847
+ # @option params [Integer] :max_results
4848
+ # The maximum number of results to be returned per request.
4849
+ #
4850
+ # @return [Types::ListFoldersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4851
+ #
4852
+ # * {Types::ListFoldersResponse#status #status} => Integer
4853
+ # * {Types::ListFoldersResponse#folder_summary_list #folder_summary_list} => Array&lt;Types::FolderSummary&gt;
4854
+ # * {Types::ListFoldersResponse#next_token #next_token} => String
4855
+ # * {Types::ListFoldersResponse#request_id #request_id} => String
4856
+ #
4857
+ # @example Request syntax with placeholder values
4858
+ #
4859
+ # resp = client.list_folders({
4860
+ # aws_account_id: "AwsAccountId", # required
4861
+ # next_token: "String",
4862
+ # max_results: 1,
4863
+ # })
4864
+ #
4865
+ # @example Response structure
4866
+ #
4867
+ # resp.status #=> Integer
4868
+ # resp.folder_summary_list #=> Array
4869
+ # resp.folder_summary_list[0].arn #=> String
4870
+ # resp.folder_summary_list[0].folder_id #=> String
4871
+ # resp.folder_summary_list[0].name #=> String
4872
+ # resp.folder_summary_list[0].folder_type #=> String, one of "SHARED"
4873
+ # resp.folder_summary_list[0].created_time #=> Time
4874
+ # resp.folder_summary_list[0].last_updated_time #=> Time
4875
+ # resp.next_token #=> String
4876
+ # resp.request_id #=> String
4877
+ #
4878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolders AWS API Documentation
4879
+ #
4880
+ # @overload list_folders(params = {})
4881
+ # @param [Hash] params ({})
4882
+ def list_folders(params = {}, options = {})
4883
+ req = build_request(:list_folders, params)
4884
+ req.send_request(options)
4885
+ end
4886
+
4445
4887
  # Lists member users in a group.
4446
4888
  #
4447
4889
  # @option params [required, String] :group_name
@@ -5238,6 +5680,9 @@ module Aws::QuickSight
5238
5680
  # resp.user_list[0].active #=> Boolean
5239
5681
  # resp.user_list[0].principal_id #=> String
5240
5682
  # resp.user_list[0].custom_permissions_name #=> String
5683
+ # resp.user_list[0].external_login_federation_provider_type #=> String
5684
+ # resp.user_list[0].external_login_federation_provider_url #=> String
5685
+ # resp.user_list[0].external_login_id #=> String
5241
5686
  # resp.next_token #=> String
5242
5687
  # resp.request_id #=> String
5243
5688
  # resp.status #=> Integer
@@ -5343,6 +5788,31 @@ module Aws::QuickSight
5343
5788
  # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
5344
5789
  # (SSO).
5345
5790
  #
5791
+ # @option params [String] :external_login_federation_provider_type
5792
+ # The type of supported external login provider that provides identity
5793
+ # to let a user federate into Amazon QuickSight with an associated AWS
5794
+ # Identity and Access Management (IAM) role. The type of supported
5795
+ # external login provider can be one of the following.
5796
+ #
5797
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
5798
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
5799
+ # type, don’t use the "CustomFederationProviderUrl" parameter which
5800
+ # is only needed when the external provider is custom.
5801
+ #
5802
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
5803
+ # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
5804
+ # to provide the custom OIDC provider URL.
5805
+ #
5806
+ # @option params [String] :custom_federation_provider_url
5807
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
5808
+ # identity to let a user federate into QuickSight with an associated AWS
5809
+ # Identity and Access Management (IAM) role. This parameter should only
5810
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
5811
+ # `CUSTOM_OIDC`.
5812
+ #
5813
+ # @option params [String] :external_login_id
5814
+ # The identity ID for a user in the external login provider.
5815
+ #
5346
5816
  # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5347
5817
  #
5348
5818
  # * {Types::RegisterUserResponse#user #user} => Types::User
@@ -5362,6 +5832,9 @@ module Aws::QuickSight
5362
5832
  # namespace: "Namespace", # required
5363
5833
  # user_name: "UserName",
5364
5834
  # custom_permissions_name: "RoleName",
5835
+ # external_login_federation_provider_type: "String",
5836
+ # custom_federation_provider_url: "String",
5837
+ # external_login_id: "String",
5365
5838
  # })
5366
5839
  #
5367
5840
  # @example Response structure
@@ -5374,6 +5847,9 @@ module Aws::QuickSight
5374
5847
  # resp.user.active #=> Boolean
5375
5848
  # resp.user.principal_id #=> String
5376
5849
  # resp.user.custom_permissions_name #=> String
5850
+ # resp.user.external_login_federation_provider_type #=> String
5851
+ # resp.user.external_login_federation_provider_url #=> String
5852
+ # resp.user.external_login_id #=> String
5377
5853
  # resp.user_invitation_url #=> String
5378
5854
  # resp.request_id #=> String
5379
5855
  # resp.status #=> Integer
@@ -5553,6 +6029,68 @@ module Aws::QuickSight
5553
6029
  req.send_request(options)
5554
6030
  end
5555
6031
 
6032
+ # Searches the subfolders in a folder.
6033
+ #
6034
+ # @option params [required, String] :aws_account_id
6035
+ # The AWS account ID.
6036
+ #
6037
+ # @option params [required, Array<Types::FolderSearchFilter>] :filters
6038
+ # The filters to apply to the search. Currently, you can search only by
6039
+ # the parent folder ARN. For example, `"Filters": [ \{ "Name":
6040
+ # "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value":
6041
+ # "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ]`.
6042
+ #
6043
+ # @option params [String] :next_token
6044
+ # The token for the next set of results, or null if there are no more
6045
+ # results.
6046
+ #
6047
+ # @option params [Integer] :max_results
6048
+ # The maximum number of results to be returned per request.
6049
+ #
6050
+ # @return [Types::SearchFoldersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6051
+ #
6052
+ # * {Types::SearchFoldersResponse#status #status} => Integer
6053
+ # * {Types::SearchFoldersResponse#folder_summary_list #folder_summary_list} => Array&lt;Types::FolderSummary&gt;
6054
+ # * {Types::SearchFoldersResponse#next_token #next_token} => String
6055
+ # * {Types::SearchFoldersResponse#request_id #request_id} => String
6056
+ #
6057
+ # @example Request syntax with placeholder values
6058
+ #
6059
+ # resp = client.search_folders({
6060
+ # aws_account_id: "AwsAccountId", # required
6061
+ # filters: [ # required
6062
+ # {
6063
+ # operator: "StringEquals", # accepts StringEquals
6064
+ # name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
6065
+ # value: "String",
6066
+ # },
6067
+ # ],
6068
+ # next_token: "String",
6069
+ # max_results: 1,
6070
+ # })
6071
+ #
6072
+ # @example Response structure
6073
+ #
6074
+ # resp.status #=> Integer
6075
+ # resp.folder_summary_list #=> Array
6076
+ # resp.folder_summary_list[0].arn #=> String
6077
+ # resp.folder_summary_list[0].folder_id #=> String
6078
+ # resp.folder_summary_list[0].name #=> String
6079
+ # resp.folder_summary_list[0].folder_type #=> String, one of "SHARED"
6080
+ # resp.folder_summary_list[0].created_time #=> Time
6081
+ # resp.folder_summary_list[0].last_updated_time #=> Time
6082
+ # resp.next_token #=> String
6083
+ # resp.request_id #=> String
6084
+ #
6085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFolders AWS API Documentation
6086
+ #
6087
+ # @overload search_folders(params = {})
6088
+ # @param [Hash] params ({})
6089
+ def search_folders(params = {}, options = {})
6090
+ req = build_request(:search_folders, params)
6091
+ req.send_request(options)
6092
+ end
6093
+
5556
6094
  # Assigns one or more tags (key-value pairs) to the specified QuickSight
5557
6095
  # resource.
5558
6096
  #
@@ -6340,6 +6878,7 @@ module Aws::QuickSight
6340
6878
  # namespace: "Namespace",
6341
6879
  # arn: "Arn", # required
6342
6880
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
6881
+ # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
6343
6882
  # },
6344
6883
  # column_level_permission_rules: [
6345
6884
  # {
@@ -6745,6 +7284,109 @@ module Aws::QuickSight
6745
7284
  req.send_request(options)
6746
7285
  end
6747
7286
 
7287
+ # Updates the name of a folder.
7288
+ #
7289
+ # @option params [required, String] :aws_account_id
7290
+ # The AWS account ID.
7291
+ #
7292
+ # @option params [required, String] :folder_id
7293
+ # The folder ID.
7294
+ #
7295
+ # @option params [required, String] :name
7296
+ # The name of the folder.
7297
+ #
7298
+ # @return [Types::UpdateFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7299
+ #
7300
+ # * {Types::UpdateFolderResponse#status #status} => Integer
7301
+ # * {Types::UpdateFolderResponse#arn #arn} => String
7302
+ # * {Types::UpdateFolderResponse#folder_id #folder_id} => String
7303
+ # * {Types::UpdateFolderResponse#request_id #request_id} => String
7304
+ #
7305
+ # @example Request syntax with placeholder values
7306
+ #
7307
+ # resp = client.update_folder({
7308
+ # aws_account_id: "AwsAccountId", # required
7309
+ # folder_id: "RestrictiveResourceId", # required
7310
+ # name: "FolderName", # required
7311
+ # })
7312
+ #
7313
+ # @example Response structure
7314
+ #
7315
+ # resp.status #=> Integer
7316
+ # resp.arn #=> String
7317
+ # resp.folder_id #=> String
7318
+ # resp.request_id #=> String
7319
+ #
7320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolder AWS API Documentation
7321
+ #
7322
+ # @overload update_folder(params = {})
7323
+ # @param [Hash] params ({})
7324
+ def update_folder(params = {}, options = {})
7325
+ req = build_request(:update_folder, params)
7326
+ req.send_request(options)
7327
+ end
7328
+
7329
+ # Updates permissions of a folder.
7330
+ #
7331
+ # @option params [required, String] :aws_account_id
7332
+ # The AWS account ID.
7333
+ #
7334
+ # @option params [required, String] :folder_id
7335
+ # The folder ID.
7336
+ #
7337
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
7338
+ # The permissions that you want to grant on a resource.
7339
+ #
7340
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
7341
+ # The permissions that you want to revoke from a resource.
7342
+ #
7343
+ # @return [Types::UpdateFolderPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7344
+ #
7345
+ # * {Types::UpdateFolderPermissionsResponse#status #status} => Integer
7346
+ # * {Types::UpdateFolderPermissionsResponse#arn #arn} => String
7347
+ # * {Types::UpdateFolderPermissionsResponse#folder_id #folder_id} => String
7348
+ # * {Types::UpdateFolderPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
7349
+ # * {Types::UpdateFolderPermissionsResponse#request_id #request_id} => String
7350
+ #
7351
+ # @example Request syntax with placeholder values
7352
+ #
7353
+ # resp = client.update_folder_permissions({
7354
+ # aws_account_id: "AwsAccountId", # required
7355
+ # folder_id: "RestrictiveResourceId", # required
7356
+ # grant_permissions: [
7357
+ # {
7358
+ # principal: "Principal", # required
7359
+ # actions: ["String"], # required
7360
+ # },
7361
+ # ],
7362
+ # revoke_permissions: [
7363
+ # {
7364
+ # principal: "Principal", # required
7365
+ # actions: ["String"], # required
7366
+ # },
7367
+ # ],
7368
+ # })
7369
+ #
7370
+ # @example Response structure
7371
+ #
7372
+ # resp.status #=> Integer
7373
+ # resp.arn #=> String
7374
+ # resp.folder_id #=> String
7375
+ # resp.permissions #=> Array
7376
+ # resp.permissions[0].principal #=> String
7377
+ # resp.permissions[0].actions #=> Array
7378
+ # resp.permissions[0].actions[0] #=> String
7379
+ # resp.request_id #=> String
7380
+ #
7381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissions AWS API Documentation
7382
+ #
7383
+ # @overload update_folder_permissions(params = {})
7384
+ # @param [Hash] params ({})
7385
+ def update_folder_permissions(params = {}, options = {})
7386
+ req = build_request(:update_folder_permissions, params)
7387
+ req.send_request(options)
7388
+ end
7389
+
6748
7390
  # Changes a group description.
6749
7391
  #
6750
7392
  # @option params [required, String] :group_name
@@ -7387,6 +8029,35 @@ module Aws::QuickSight
7387
8029
  # This parameter defaults to NULL and it doesn't accept any other
7388
8030
  # value.
7389
8031
  #
8032
+ # @option params [String] :external_login_federation_provider_type
8033
+ # The type of supported external login provider that provides identity
8034
+ # to let a user federate into QuickSight with an associated AWS Identity
8035
+ # and Access Management (IAM) role. The type of supported external login
8036
+ # provider can be one of the following.
8037
+ #
8038
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
8039
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
8040
+ # type, don’t use the "CustomFederationProviderUrl" parameter which
8041
+ # is only needed when the external provider is custom.
8042
+ #
8043
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When choosing
8044
+ # `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl` parameter
8045
+ # to provide the custom OIDC provider URL.
8046
+ #
8047
+ # * `NONE`\: This clears all the previously saved external login
8048
+ # information for a user. Use ` DescribeUser ` API to check the
8049
+ # external login information.
8050
+ #
8051
+ # @option params [String] :custom_federation_provider_url
8052
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
8053
+ # identity to let a user federate into QuickSight with an associated AWS
8054
+ # Identity and Access Management (IAM) role. This parameter should only
8055
+ # be used when `ExternalLoginFederationProviderType` parameter is set to
8056
+ # `CUSTOM_OIDC`.
8057
+ #
8058
+ # @option params [String] :external_login_id
8059
+ # The identity ID for a user in the external login provider.
8060
+ #
7390
8061
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7391
8062
  #
7392
8063
  # * {Types::UpdateUserResponse#user #user} => Types::User
@@ -7403,6 +8074,9 @@ module Aws::QuickSight
7403
8074
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
7404
8075
  # custom_permissions_name: "RoleName",
7405
8076
  # unapply_custom_permissions: false,
8077
+ # external_login_federation_provider_type: "String",
8078
+ # custom_federation_provider_url: "String",
8079
+ # external_login_id: "String",
7406
8080
  # })
7407
8081
  #
7408
8082
  # @example Response structure
@@ -7415,6 +8089,9 @@ module Aws::QuickSight
7415
8089
  # resp.user.active #=> Boolean
7416
8090
  # resp.user.principal_id #=> String
7417
8091
  # resp.user.custom_permissions_name #=> String
8092
+ # resp.user.external_login_federation_provider_type #=> String
8093
+ # resp.user.external_login_federation_provider_url #=> String
8094
+ # resp.user.external_login_id #=> String
7418
8095
  # resp.request_id #=> String
7419
8096
  # resp.status #=> Integer
7420
8097
  #
@@ -7440,7 +8117,7 @@ module Aws::QuickSight
7440
8117
  params: params,
7441
8118
  config: config)
7442
8119
  context[:gem_name] = 'aws-sdk-quicksight'
7443
- context[:gem_version] = '1.42.0'
8120
+ context[:gem_version] = '1.47.0'
7444
8121
  Seahorse::Client::Request.new(handlers, context)
7445
8122
  end
7446
8123