aws-sdk-quicksight 1.46.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +599 -1
- data/lib/aws-sdk-quicksight/client_api.rb +392 -0
- data/lib/aws-sdk-quicksight/types.rb +988 -52
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9a40b3ba471baa487a7b2920d9b072ae38123b4b32c5809a6e2b6ad076e85d98
|
4
|
+
data.tar.gz: 49ba5ef4cfad487ff4acbb752ff076f80640e7b0de0226080e1c5a4396aa85e6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f291feaf7fa62ce3fdcf7c0b6c4ac0afd036f1121ffe5fdfada10300dc68c1e98607c9661cf9600d023cab8776f33be4046dc9344d742dc487452c0d214c2445
|
7
|
+
data.tar.gz: 167bac951684e90df4b5ee9b05e5d03d83ecee3ea43a09d3ccec0e9438c3c1ddec26117f96a6dea7ad4165c0f785fef2098da86d712974b35d873a13f76bb00d
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.47.0
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -1267,6 +1267,127 @@ module Aws::QuickSight
|
|
1267
1267
|
req.send_request(options)
|
1268
1268
|
end
|
1269
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
|
+
|
1270
1391
|
# Creates an Amazon QuickSight group.
|
1271
1392
|
#
|
1272
1393
|
# The permissions resource is
|
@@ -2145,6 +2266,89 @@ module Aws::QuickSight
|
|
2145
2266
|
req.send_request(options)
|
2146
2267
|
end
|
2147
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
|
+
|
2148
2352
|
# Removes a user group from Amazon QuickSight.
|
2149
2353
|
#
|
2150
2354
|
# @option params [required, String] :group_name
|
@@ -3274,6 +3478,137 @@ module Aws::QuickSight
|
|
3274
3478
|
req.send_request(options)
|
3275
3479
|
end
|
3276
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<Types::ResourcePermission>
|
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<Types::ResourcePermission>
|
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
|
+
|
3277
3612
|
# Returns an Amazon QuickSight group's description and Amazon Resource
|
3278
3613
|
# Name (ARN).
|
3279
3614
|
#
|
@@ -4451,6 +4786,104 @@ module Aws::QuickSight
|
|
4451
4786
|
req.send_request(options)
|
4452
4787
|
end
|
4453
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<Types::MemberIdArnPair>
|
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<Types::FolderSummary>
|
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
|
+
|
4454
4887
|
# Lists member users in a group.
|
4455
4888
|
#
|
4456
4889
|
# @option params [required, String] :group_name
|
@@ -5596,6 +6029,68 @@ module Aws::QuickSight
|
|
5596
6029
|
req.send_request(options)
|
5597
6030
|
end
|
5598
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<Types::FolderSummary>
|
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
|
+
|
5599
6094
|
# Assigns one or more tags (key-value pairs) to the specified QuickSight
|
5600
6095
|
# resource.
|
5601
6096
|
#
|
@@ -6789,6 +7284,109 @@ module Aws::QuickSight
|
|
6789
7284
|
req.send_request(options)
|
6790
7285
|
end
|
6791
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<Types::ResourcePermission>
|
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
|
+
|
6792
7390
|
# Changes a group description.
|
6793
7391
|
#
|
6794
7392
|
# @option params [required, String] :group_name
|
@@ -7519,7 +8117,7 @@ module Aws::QuickSight
|
|
7519
8117
|
params: params,
|
7520
8118
|
config: config)
|
7521
8119
|
context[:gem_name] = 'aws-sdk-quicksight'
|
7522
|
-
context[:gem_version] = '1.
|
8120
|
+
context[:gem_version] = '1.47.0'
|
7523
8121
|
Seahorse::Client::Request.new(handlers, context)
|
7524
8122
|
end
|
7525
8123
|
|