aws-sdk-quicksight 1.25.0 → 1.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +574 -1
- data/lib/aws-sdk-quicksight/client_api.rb +353 -0
- data/lib/aws-sdk-quicksight/types.rb +860 -6
- 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: 8d80520b575a81b846237750af2db53859dc3efebfcbeb2afe45feab6ca3fe24
|
4
|
+
data.tar.gz: 8983ea37cef08fbfd984c22fb9609a7864efd741f3c8631691d2d79fcd798e7b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bf2786ff837b06a794e9184432a0849cd2b1c9158af22f566d05f4d519007b460e90e2db86853b6c0ecad67f170aba44cbfc04ab85c39491630e5e99ca783cf0
|
7
|
+
data.tar.gz: afd4503c43cdb35401ea4e996d8ca8240f5c0dd69eb03891996686fffea308ecd17fd6284dcf99c3145d1ac4f52e7251c411642f0ff3b36f078f0722e7f2c924
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -354,6 +354,58 @@ module Aws::QuickSight
|
|
354
354
|
req.send_request(options)
|
355
355
|
end
|
356
356
|
|
357
|
+
# Creates a customization for the Amazon QuickSight subscription
|
358
|
+
# associated with your AWS account.
|
359
|
+
#
|
360
|
+
# @option params [required, String] :aws_account_id
|
361
|
+
# The ID for the AWS account that you want to customize QuickSight for.
|
362
|
+
#
|
363
|
+
# @option params [String] :namespace
|
364
|
+
# The namespace associated with the customization that you're creating.
|
365
|
+
#
|
366
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
367
|
+
# The customizations you're adding to the QuickSight subscription for
|
368
|
+
# the AWS account. For example, you could add a default theme by setting
|
369
|
+
# `AccountCustomization` to the midnight theme
|
370
|
+
# (`DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT"`) or to a
|
371
|
+
# custom theme
|
372
|
+
# (`DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"`).
|
373
|
+
#
|
374
|
+
# @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
375
|
+
#
|
376
|
+
# * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
377
|
+
# * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
|
378
|
+
# * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
379
|
+
# * {Types::CreateAccountCustomizationResponse#request_id #request_id} => String
|
380
|
+
# * {Types::CreateAccountCustomizationResponse#status #status} => Integer
|
381
|
+
#
|
382
|
+
# @example Request syntax with placeholder values
|
383
|
+
#
|
384
|
+
# resp = client.create_account_customization({
|
385
|
+
# aws_account_id: "AwsAccountId", # required
|
386
|
+
# namespace: "Namespace",
|
387
|
+
# account_customization: { # required
|
388
|
+
# default_theme: "Arn",
|
389
|
+
# },
|
390
|
+
# })
|
391
|
+
#
|
392
|
+
# @example Response structure
|
393
|
+
#
|
394
|
+
# resp.aws_account_id #=> String
|
395
|
+
# resp.namespace #=> String
|
396
|
+
# resp.account_customization.default_theme #=> String
|
397
|
+
# resp.request_id #=> String
|
398
|
+
# resp.status #=> Integer
|
399
|
+
#
|
400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomization AWS API Documentation
|
401
|
+
#
|
402
|
+
# @overload create_account_customization(params = {})
|
403
|
+
# @param [Hash] params ({})
|
404
|
+
def create_account_customization(params = {}, options = {})
|
405
|
+
req = build_request(:create_account_customization, params)
|
406
|
+
req.send_request(options)
|
407
|
+
end
|
408
|
+
|
357
409
|
# Creates a dashboard from a template. To first create a template, see
|
358
410
|
# the CreateTemplate API operation.
|
359
411
|
#
|
@@ -689,6 +741,7 @@ module Aws::QuickSight
|
|
689
741
|
# },
|
690
742
|
# ],
|
691
743
|
# row_level_permission_data_set: {
|
744
|
+
# namespace: "Namespace",
|
692
745
|
# arn: "Arn", # required
|
693
746
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
694
747
|
# },
|
@@ -1228,6 +1281,76 @@ module Aws::QuickSight
|
|
1228
1281
|
req.send_request(options)
|
1229
1282
|
end
|
1230
1283
|
|
1284
|
+
# (Enterprise edition only) Creates a new namespace for you to use with
|
1285
|
+
# Amazon QuickSight.
|
1286
|
+
#
|
1287
|
+
# A namespace allows you to isolate the QuickSight users and groups that
|
1288
|
+
# are registered for that namespace. Users that access the namespace can
|
1289
|
+
# share assets only with other users or groups in the same namespace.
|
1290
|
+
# They can't see users and groups in other namespaces. You can create a
|
1291
|
+
# namespace after your AWS account is subscribed to QuickSight. The
|
1292
|
+
# namespace must be unique within the AWS account. By default, there is
|
1293
|
+
# a limit of 100 namespaces per AWS account. To increase your limit,
|
1294
|
+
# create a ticket with AWS Support.
|
1295
|
+
#
|
1296
|
+
# @option params [required, String] :aws_account_id
|
1297
|
+
# The ID for the AWS account that you want to create the QuickSight
|
1298
|
+
# namespace in.
|
1299
|
+
#
|
1300
|
+
# @option params [required, String] :namespace
|
1301
|
+
# The name that you want to use to describe the new namespace.
|
1302
|
+
#
|
1303
|
+
# @option params [required, String] :identity_store
|
1304
|
+
# Specifies the type of your user identity directory. Currently, this
|
1305
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
1306
|
+
#
|
1307
|
+
# @option params [Array<Types::Tag>] :tags
|
1308
|
+
# The tags that you want to associate with the namespace that you're
|
1309
|
+
# creating.
|
1310
|
+
#
|
1311
|
+
# @return [Types::CreateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
|
+
#
|
1313
|
+
# * {Types::CreateNamespaceResponse#arn #arn} => String
|
1314
|
+
# * {Types::CreateNamespaceResponse#name #name} => String
|
1315
|
+
# * {Types::CreateNamespaceResponse#capacity_region #capacity_region} => String
|
1316
|
+
# * {Types::CreateNamespaceResponse#creation_status #creation_status} => String
|
1317
|
+
# * {Types::CreateNamespaceResponse#identity_store #identity_store} => String
|
1318
|
+
# * {Types::CreateNamespaceResponse#request_id #request_id} => String
|
1319
|
+
# * {Types::CreateNamespaceResponse#status #status} => Integer
|
1320
|
+
#
|
1321
|
+
# @example Request syntax with placeholder values
|
1322
|
+
#
|
1323
|
+
# resp = client.create_namespace({
|
1324
|
+
# aws_account_id: "AwsAccountId", # required
|
1325
|
+
# namespace: "Namespace", # required
|
1326
|
+
# identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
|
1327
|
+
# tags: [
|
1328
|
+
# {
|
1329
|
+
# key: "TagKey", # required
|
1330
|
+
# value: "TagValue", # required
|
1331
|
+
# },
|
1332
|
+
# ],
|
1333
|
+
# })
|
1334
|
+
#
|
1335
|
+
# @example Response structure
|
1336
|
+
#
|
1337
|
+
# resp.arn #=> String
|
1338
|
+
# resp.name #=> String
|
1339
|
+
# resp.capacity_region #=> String
|
1340
|
+
# resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
1341
|
+
# resp.identity_store #=> String, one of "QUICKSIGHT"
|
1342
|
+
# resp.request_id #=> String
|
1343
|
+
# resp.status #=> Integer
|
1344
|
+
#
|
1345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespace AWS API Documentation
|
1346
|
+
#
|
1347
|
+
# @overload create_namespace(params = {})
|
1348
|
+
# @param [Hash] params ({})
|
1349
|
+
def create_namespace(params = {}, options = {})
|
1350
|
+
req = build_request(:create_namespace, params)
|
1351
|
+
req.send_request(options)
|
1352
|
+
end
|
1353
|
+
|
1231
1354
|
# Creates a template from an existing QuickSight analysis or template.
|
1232
1355
|
# You can use the resulting template to create a dashboard.
|
1233
1356
|
#
|
@@ -1571,6 +1694,42 @@ module Aws::QuickSight
|
|
1571
1694
|
req.send_request(options)
|
1572
1695
|
end
|
1573
1696
|
|
1697
|
+
# Deletes customizations for the QuickSight subscription on your AWS
|
1698
|
+
# account.
|
1699
|
+
#
|
1700
|
+
# @option params [required, String] :aws_account_id
|
1701
|
+
# The ID for the AWS account that you want to delete QuickSight
|
1702
|
+
# customizations from.
|
1703
|
+
#
|
1704
|
+
# @option params [String] :namespace
|
1705
|
+
# The namespace associated with the customization that you're deleting.
|
1706
|
+
#
|
1707
|
+
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1708
|
+
#
|
1709
|
+
# * {Types::DeleteAccountCustomizationResponse#request_id #request_id} => String
|
1710
|
+
# * {Types::DeleteAccountCustomizationResponse#status #status} => Integer
|
1711
|
+
#
|
1712
|
+
# @example Request syntax with placeholder values
|
1713
|
+
#
|
1714
|
+
# resp = client.delete_account_customization({
|
1715
|
+
# aws_account_id: "AwsAccountId", # required
|
1716
|
+
# namespace: "Namespace",
|
1717
|
+
# })
|
1718
|
+
#
|
1719
|
+
# @example Response structure
|
1720
|
+
#
|
1721
|
+
# resp.request_id #=> String
|
1722
|
+
# resp.status #=> Integer
|
1723
|
+
#
|
1724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomization AWS API Documentation
|
1725
|
+
#
|
1726
|
+
# @overload delete_account_customization(params = {})
|
1727
|
+
# @param [Hash] params ({})
|
1728
|
+
def delete_account_customization(params = {}, options = {})
|
1729
|
+
req = build_request(:delete_account_customization, params)
|
1730
|
+
req.send_request(options)
|
1731
|
+
end
|
1732
|
+
|
1574
1733
|
# Deletes a dashboard.
|
1575
1734
|
#
|
1576
1735
|
# @option params [required, String] :aws_account_id
|
@@ -1820,6 +1979,44 @@ module Aws::QuickSight
|
|
1820
1979
|
req.send_request(options)
|
1821
1980
|
end
|
1822
1981
|
|
1982
|
+
# Deletes a namespace and the users and groups that are associated with
|
1983
|
+
# the namespace. This is an asynchronous process. Assets including
|
1984
|
+
# dashboards, analyses, datasets and data sources are not deleted. To
|
1985
|
+
# delete these assets, you use the APIs for the relevant asset.
|
1986
|
+
#
|
1987
|
+
# @option params [required, String] :aws_account_id
|
1988
|
+
# The ID for the AWS account that you want to delete the QuickSight
|
1989
|
+
# namespace from.
|
1990
|
+
#
|
1991
|
+
# @option params [required, String] :namespace
|
1992
|
+
# The namespace that you want to delete.
|
1993
|
+
#
|
1994
|
+
# @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1995
|
+
#
|
1996
|
+
# * {Types::DeleteNamespaceResponse#request_id #request_id} => String
|
1997
|
+
# * {Types::DeleteNamespaceResponse#status #status} => Integer
|
1998
|
+
#
|
1999
|
+
# @example Request syntax with placeholder values
|
2000
|
+
#
|
2001
|
+
# resp = client.delete_namespace({
|
2002
|
+
# aws_account_id: "AwsAccountId", # required
|
2003
|
+
# namespace: "Namespace", # required
|
2004
|
+
# })
|
2005
|
+
#
|
2006
|
+
# @example Response structure
|
2007
|
+
#
|
2008
|
+
# resp.request_id #=> String
|
2009
|
+
# resp.status #=> Integer
|
2010
|
+
#
|
2011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespace AWS API Documentation
|
2012
|
+
#
|
2013
|
+
# @overload delete_namespace(params = {})
|
2014
|
+
# @param [Hash] params ({})
|
2015
|
+
def delete_namespace(params = {}, options = {})
|
2016
|
+
req = build_request(:delete_namespace, params)
|
2017
|
+
req.send_request(options)
|
2018
|
+
end
|
2019
|
+
|
1823
2020
|
# Deletes a template.
|
1824
2021
|
#
|
1825
2022
|
# @option params [required, String] :aws_account_id
|
@@ -2087,6 +2284,91 @@ module Aws::QuickSight
|
|
2087
2284
|
req.send_request(options)
|
2088
2285
|
end
|
2089
2286
|
|
2287
|
+
# Describes the customizations associated with your AWS account.
|
2288
|
+
#
|
2289
|
+
# @option params [required, String] :aws_account_id
|
2290
|
+
# The ID for the AWS account that you want to describe QuickSight
|
2291
|
+
# customizations for.
|
2292
|
+
#
|
2293
|
+
# @option params [String] :namespace
|
2294
|
+
# The namespace associated with the customization that you're
|
2295
|
+
# describing.
|
2296
|
+
#
|
2297
|
+
# @option params [Boolean] :resolved
|
2298
|
+
# The status of the creation of the customization. This is an
|
2299
|
+
# asynchronous process. A status of `CREATED` means that your
|
2300
|
+
# customization is ready to use.
|
2301
|
+
#
|
2302
|
+
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2303
|
+
#
|
2304
|
+
# * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
2305
|
+
# * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
|
2306
|
+
# * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
2307
|
+
# * {Types::DescribeAccountCustomizationResponse#request_id #request_id} => String
|
2308
|
+
# * {Types::DescribeAccountCustomizationResponse#status #status} => Integer
|
2309
|
+
#
|
2310
|
+
# @example Request syntax with placeholder values
|
2311
|
+
#
|
2312
|
+
# resp = client.describe_account_customization({
|
2313
|
+
# aws_account_id: "AwsAccountId", # required
|
2314
|
+
# namespace: "Namespace",
|
2315
|
+
# resolved: false,
|
2316
|
+
# })
|
2317
|
+
#
|
2318
|
+
# @example Response structure
|
2319
|
+
#
|
2320
|
+
# resp.aws_account_id #=> String
|
2321
|
+
# resp.namespace #=> String
|
2322
|
+
# resp.account_customization.default_theme #=> String
|
2323
|
+
# resp.request_id #=> String
|
2324
|
+
# resp.status #=> Integer
|
2325
|
+
#
|
2326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomization AWS API Documentation
|
2327
|
+
#
|
2328
|
+
# @overload describe_account_customization(params = {})
|
2329
|
+
# @param [Hash] params ({})
|
2330
|
+
def describe_account_customization(params = {}, options = {})
|
2331
|
+
req = build_request(:describe_account_customization, params)
|
2332
|
+
req.send_request(options)
|
2333
|
+
end
|
2334
|
+
|
2335
|
+
# Describes the settings that were used when your QuickSight
|
2336
|
+
# subscription was first created in this AWS Account.
|
2337
|
+
#
|
2338
|
+
# @option params [required, String] :aws_account_id
|
2339
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
2340
|
+
# that you want to list.
|
2341
|
+
#
|
2342
|
+
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2343
|
+
#
|
2344
|
+
# * {Types::DescribeAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
|
2345
|
+
# * {Types::DescribeAccountSettingsResponse#request_id #request_id} => String
|
2346
|
+
# * {Types::DescribeAccountSettingsResponse#status #status} => Integer
|
2347
|
+
#
|
2348
|
+
# @example Request syntax with placeholder values
|
2349
|
+
#
|
2350
|
+
# resp = client.describe_account_settings({
|
2351
|
+
# aws_account_id: "AwsAccountId", # required
|
2352
|
+
# })
|
2353
|
+
#
|
2354
|
+
# @example Response structure
|
2355
|
+
#
|
2356
|
+
# resp.account_settings.account_name #=> String
|
2357
|
+
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
|
2358
|
+
# resp.account_settings.default_namespace #=> String
|
2359
|
+
# resp.account_settings.notification_email #=> String
|
2360
|
+
# resp.request_id #=> String
|
2361
|
+
# resp.status #=> Integer
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettings AWS API Documentation
|
2364
|
+
#
|
2365
|
+
# @overload describe_account_settings(params = {})
|
2366
|
+
# @param [Hash] params ({})
|
2367
|
+
def describe_account_settings(params = {}, options = {})
|
2368
|
+
req = build_request(:describe_account_settings, params)
|
2369
|
+
req.send_request(options)
|
2370
|
+
end
|
2371
|
+
|
2090
2372
|
# Provides a summary for a dashboard.
|
2091
2373
|
#
|
2092
2374
|
# @option params [required, String] :aws_account_id
|
@@ -2277,6 +2559,7 @@ module Aws::QuickSight
|
|
2277
2559
|
# resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
|
2278
2560
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
|
2279
2561
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
|
2562
|
+
# resp.data_set.row_level_permission_data_set.namespace #=> String
|
2280
2563
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
2281
2564
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
2282
2565
|
# resp.request_id #=> String
|
@@ -2666,6 +2949,49 @@ module Aws::QuickSight
|
|
2666
2949
|
req.send_request(options)
|
2667
2950
|
end
|
2668
2951
|
|
2952
|
+
# Describes the current namespace.
|
2953
|
+
#
|
2954
|
+
# @option params [required, String] :aws_account_id
|
2955
|
+
# The ID for the AWS account that contains the QuickSight namespace that
|
2956
|
+
# you want to describe.
|
2957
|
+
#
|
2958
|
+
# @option params [required, String] :namespace
|
2959
|
+
# The namespace that you want to describe.
|
2960
|
+
#
|
2961
|
+
# @return [Types::DescribeNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2962
|
+
#
|
2963
|
+
# * {Types::DescribeNamespaceResponse#namespace #namespace} => Types::NamespaceInfoV2
|
2964
|
+
# * {Types::DescribeNamespaceResponse#request_id #request_id} => String
|
2965
|
+
# * {Types::DescribeNamespaceResponse#status #status} => Integer
|
2966
|
+
#
|
2967
|
+
# @example Request syntax with placeholder values
|
2968
|
+
#
|
2969
|
+
# resp = client.describe_namespace({
|
2970
|
+
# aws_account_id: "AwsAccountId", # required
|
2971
|
+
# namespace: "Namespace", # required
|
2972
|
+
# })
|
2973
|
+
#
|
2974
|
+
# @example Response structure
|
2975
|
+
#
|
2976
|
+
# resp.namespace.name #=> String
|
2977
|
+
# resp.namespace.arn #=> String
|
2978
|
+
# resp.namespace.capacity_region #=> String
|
2979
|
+
# resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
2980
|
+
# resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
|
2981
|
+
# resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
2982
|
+
# resp.namespace.namespace_error.message #=> String
|
2983
|
+
# resp.request_id #=> String
|
2984
|
+
# resp.status #=> Integer
|
2985
|
+
#
|
2986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespace AWS API Documentation
|
2987
|
+
#
|
2988
|
+
# @overload describe_namespace(params = {})
|
2989
|
+
# @param [Hash] params ({})
|
2990
|
+
def describe_namespace(params = {}, options = {})
|
2991
|
+
req = build_request(:describe_namespace, params)
|
2992
|
+
req.send_request(options)
|
2993
|
+
end
|
2994
|
+
|
2669
2995
|
# Describes a template's metadata.
|
2670
2996
|
#
|
2671
2997
|
# @option params [required, String] :aws_account_id
|
@@ -3041,6 +3367,7 @@ module Aws::QuickSight
|
|
3041
3367
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3042
3368
|
# resp.user.active #=> Boolean
|
3043
3369
|
# resp.user.principal_id #=> String
|
3370
|
+
# resp.user.custom_permissions_name #=> String
|
3044
3371
|
# resp.request_id #=> String
|
3045
3372
|
# resp.status #=> Integer
|
3046
3373
|
#
|
@@ -3147,6 +3474,64 @@ module Aws::QuickSight
|
|
3147
3474
|
req.send_request(options)
|
3148
3475
|
end
|
3149
3476
|
|
3477
|
+
# Generates a session URL and authorization code that you can embed in
|
3478
|
+
# your web server code.
|
3479
|
+
#
|
3480
|
+
# @option params [required, String] :aws_account_id
|
3481
|
+
# The ID for the AWS account that contains the QuickSight session that
|
3482
|
+
# you're embedding.
|
3483
|
+
#
|
3484
|
+
# @option params [String] :entry_point
|
3485
|
+
# The entry point for the embedded session.
|
3486
|
+
#
|
3487
|
+
# @option params [Integer] :session_lifetime_in_minutes
|
3488
|
+
# How many minutes the session is valid. The session lifetime must be
|
3489
|
+
# 15-600 minutes.
|
3490
|
+
#
|
3491
|
+
# @option params [String] :user_arn
|
3492
|
+
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
3493
|
+
# `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
|
3494
|
+
# users in your account (readers, authors, or admins) authenticated as
|
3495
|
+
# one of the following:
|
3496
|
+
#
|
3497
|
+
# * Active Directory (AD) users or group members
|
3498
|
+
#
|
3499
|
+
# * Invited nonfederated users
|
3500
|
+
#
|
3501
|
+
# * IAM users and IAM role-based sessions authenticated through
|
3502
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3503
|
+
# federation.
|
3504
|
+
#
|
3505
|
+
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3506
|
+
#
|
3507
|
+
# * {Types::GetSessionEmbedUrlResponse#embed_url #embed_url} => String
|
3508
|
+
# * {Types::GetSessionEmbedUrlResponse#status #status} => Integer
|
3509
|
+
# * {Types::GetSessionEmbedUrlResponse#request_id #request_id} => String
|
3510
|
+
#
|
3511
|
+
# @example Request syntax with placeholder values
|
3512
|
+
#
|
3513
|
+
# resp = client.get_session_embed_url({
|
3514
|
+
# aws_account_id: "AwsAccountId", # required
|
3515
|
+
# entry_point: "EntryPoint",
|
3516
|
+
# session_lifetime_in_minutes: 1,
|
3517
|
+
# user_arn: "Arn",
|
3518
|
+
# })
|
3519
|
+
#
|
3520
|
+
# @example Response structure
|
3521
|
+
#
|
3522
|
+
# resp.embed_url #=> String
|
3523
|
+
# resp.status #=> Integer
|
3524
|
+
# resp.request_id #=> String
|
3525
|
+
#
|
3526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrl AWS API Documentation
|
3527
|
+
#
|
3528
|
+
# @overload get_session_embed_url(params = {})
|
3529
|
+
# @param [Hash] params ({})
|
3530
|
+
def get_session_embed_url(params = {}, options = {})
|
3531
|
+
req = build_request(:get_session_embed_url, params)
|
3532
|
+
req.send_request(options)
|
3533
|
+
end
|
3534
|
+
|
3150
3535
|
# Lists all the versions of the dashboards in the QuickSight
|
3151
3536
|
# subscription.
|
3152
3537
|
#
|
@@ -3299,6 +3684,7 @@ module Aws::QuickSight
|
|
3299
3684
|
# resp.data_set_summaries[0].created_time #=> Time
|
3300
3685
|
# resp.data_set_summaries[0].last_updated_time #=> Time
|
3301
3686
|
# resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
|
3687
|
+
# resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
|
3302
3688
|
# resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
|
3303
3689
|
# resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
3304
3690
|
# resp.next_token #=> String
|
@@ -3737,6 +4123,58 @@ module Aws::QuickSight
|
|
3737
4123
|
req.send_request(options)
|
3738
4124
|
end
|
3739
4125
|
|
4126
|
+
# Lists the namespaces for the specified AWS account.
|
4127
|
+
#
|
4128
|
+
# @option params [required, String] :aws_account_id
|
4129
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4130
|
+
# that you want to list.
|
4131
|
+
#
|
4132
|
+
# @option params [String] :next_token
|
4133
|
+
# A pagination token that can be used in a subsequent request.
|
4134
|
+
#
|
4135
|
+
# @option params [Integer] :max_results
|
4136
|
+
# The maximum number of results to return.
|
4137
|
+
#
|
4138
|
+
# @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4139
|
+
#
|
4140
|
+
# * {Types::ListNamespacesResponse#namespaces #namespaces} => Array<Types::NamespaceInfoV2>
|
4141
|
+
# * {Types::ListNamespacesResponse#next_token #next_token} => String
|
4142
|
+
# * {Types::ListNamespacesResponse#request_id #request_id} => String
|
4143
|
+
# * {Types::ListNamespacesResponse#status #status} => Integer
|
4144
|
+
#
|
4145
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4146
|
+
#
|
4147
|
+
# @example Request syntax with placeholder values
|
4148
|
+
#
|
4149
|
+
# resp = client.list_namespaces({
|
4150
|
+
# aws_account_id: "AwsAccountId", # required
|
4151
|
+
# next_token: "String",
|
4152
|
+
# max_results: 1,
|
4153
|
+
# })
|
4154
|
+
#
|
4155
|
+
# @example Response structure
|
4156
|
+
#
|
4157
|
+
# resp.namespaces #=> Array
|
4158
|
+
# resp.namespaces[0].name #=> String
|
4159
|
+
# resp.namespaces[0].arn #=> String
|
4160
|
+
# resp.namespaces[0].capacity_region #=> String
|
4161
|
+
# resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
4162
|
+
# resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
|
4163
|
+
# resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
4164
|
+
# resp.namespaces[0].namespace_error.message #=> String
|
4165
|
+
# resp.next_token #=> String
|
4166
|
+
# resp.request_id #=> String
|
4167
|
+
# resp.status #=> Integer
|
4168
|
+
#
|
4169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespaces AWS API Documentation
|
4170
|
+
#
|
4171
|
+
# @overload list_namespaces(params = {})
|
4172
|
+
# @param [Hash] params ({})
|
4173
|
+
def list_namespaces(params = {}, options = {})
|
4174
|
+
req = build_request(:list_namespaces, params)
|
4175
|
+
req.send_request(options)
|
4176
|
+
end
|
4177
|
+
|
3740
4178
|
# Lists the tags assigned to a resource.
|
3741
4179
|
#
|
3742
4180
|
# @option params [required, String] :resource_arn
|
@@ -4199,6 +4637,7 @@ module Aws::QuickSight
|
|
4199
4637
|
# resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
4200
4638
|
# resp.user_list[0].active #=> Boolean
|
4201
4639
|
# resp.user_list[0].principal_id #=> String
|
4640
|
+
# resp.user_list[0].custom_permissions_name #=> String
|
4202
4641
|
# resp.next_token #=> String
|
4203
4642
|
# resp.request_id #=> String
|
4204
4643
|
# resp.status #=> Integer
|
@@ -4272,6 +4711,30 @@ module Aws::QuickSight
|
|
4272
4711
|
# The Amazon QuickSight user name that you want to create for the user
|
4273
4712
|
# you are registering.
|
4274
4713
|
#
|
4714
|
+
# @option params [String] :custom_permissions_name
|
4715
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
4716
|
+
# that you want to assign to this user. Currently, custom permissions
|
4717
|
+
# profile names are assigned to permissions profiles in the QuickSight
|
4718
|
+
# console. You use this API to assign the named set of permissions to a
|
4719
|
+
# QuickSight user.
|
4720
|
+
#
|
4721
|
+
# Customizing permissions in the QuickSight UI allows you to control a
|
4722
|
+
# user's access to the following operations:
|
4723
|
+
#
|
4724
|
+
# *
|
4725
|
+
# *
|
4726
|
+
# *
|
4727
|
+
# *
|
4728
|
+
#
|
4729
|
+
# QuickSight custom permissions are applied through IAM policies.
|
4730
|
+
# Therefore, they override the permissions typically granted by
|
4731
|
+
# assigning QuickSight users to one of the default security cohorts
|
4732
|
+
# (admin, author, reader) in QuickSight.
|
4733
|
+
#
|
4734
|
+
# This feature is available only to QuickSight Enterprise edition
|
4735
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
4736
|
+
# (SSO).
|
4737
|
+
#
|
4275
4738
|
# @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4276
4739
|
#
|
4277
4740
|
# * {Types::RegisterUserResponse#user #user} => Types::User
|
@@ -4290,6 +4753,7 @@ module Aws::QuickSight
|
|
4290
4753
|
# aws_account_id: "AwsAccountId", # required
|
4291
4754
|
# namespace: "Namespace", # required
|
4292
4755
|
# user_name: "UserName",
|
4756
|
+
# custom_permissions_name: "RoleName",
|
4293
4757
|
# })
|
4294
4758
|
#
|
4295
4759
|
# @example Response structure
|
@@ -4301,6 +4765,7 @@ module Aws::QuickSight
|
|
4301
4765
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
4302
4766
|
# resp.user.active #=> Boolean
|
4303
4767
|
# resp.user.principal_id #=> String
|
4768
|
+
# resp.user.custom_permissions_name #=> String
|
4304
4769
|
# resp.user_invitation_url #=> String
|
4305
4770
|
# resp.request_id #=> String
|
4306
4771
|
# resp.status #=> Integer
|
@@ -4478,6 +4943,97 @@ module Aws::QuickSight
|
|
4478
4943
|
req.send_request(options)
|
4479
4944
|
end
|
4480
4945
|
|
4946
|
+
# Updates customizations associated with the QuickSight subscription on
|
4947
|
+
# your AWS account.
|
4948
|
+
#
|
4949
|
+
# @option params [required, String] :aws_account_id
|
4950
|
+
# The ID for the AWS account that you want to update QuickSight
|
4951
|
+
# customizations for.
|
4952
|
+
#
|
4953
|
+
# @option params [String] :namespace
|
4954
|
+
# The namespace associated with the customization that you're updating.
|
4955
|
+
#
|
4956
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
4957
|
+
# The customizations you want to update in QuickSight.
|
4958
|
+
#
|
4959
|
+
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4960
|
+
#
|
4961
|
+
# * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
4962
|
+
# * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
|
4963
|
+
# * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
4964
|
+
# * {Types::UpdateAccountCustomizationResponse#request_id #request_id} => String
|
4965
|
+
# * {Types::UpdateAccountCustomizationResponse#status #status} => Integer
|
4966
|
+
#
|
4967
|
+
# @example Request syntax with placeholder values
|
4968
|
+
#
|
4969
|
+
# resp = client.update_account_customization({
|
4970
|
+
# aws_account_id: "AwsAccountId", # required
|
4971
|
+
# namespace: "Namespace",
|
4972
|
+
# account_customization: { # required
|
4973
|
+
# default_theme: "Arn",
|
4974
|
+
# },
|
4975
|
+
# })
|
4976
|
+
#
|
4977
|
+
# @example Response structure
|
4978
|
+
#
|
4979
|
+
# resp.aws_account_id #=> String
|
4980
|
+
# resp.namespace #=> String
|
4981
|
+
# resp.account_customization.default_theme #=> String
|
4982
|
+
# resp.request_id #=> String
|
4983
|
+
# resp.status #=> Integer
|
4984
|
+
#
|
4985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization AWS API Documentation
|
4986
|
+
#
|
4987
|
+
# @overload update_account_customization(params = {})
|
4988
|
+
# @param [Hash] params ({})
|
4989
|
+
def update_account_customization(params = {}, options = {})
|
4990
|
+
req = build_request(:update_account_customization, params)
|
4991
|
+
req.send_request(options)
|
4992
|
+
end
|
4993
|
+
|
4994
|
+
# Updates the settings for the Amazon QuickSight subscription in your
|
4995
|
+
# AWS Account.
|
4996
|
+
#
|
4997
|
+
# @option params [required, String] :aws_account_id
|
4998
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4999
|
+
# that you want to list.
|
5000
|
+
#
|
5001
|
+
# @option params [required, String] :default_namespace
|
5002
|
+
# The default namespace for this AWS Account. Currently, the default is
|
5003
|
+
# `default`. IAM users who register for the first time with QuickSight
|
5004
|
+
# provide an email that becomes associated with the default namespace.
|
5005
|
+
#
|
5006
|
+
# @option params [String] :notification_email
|
5007
|
+
# Email address used to send notifications regarding administration of
|
5008
|
+
# QuickSight.
|
5009
|
+
#
|
5010
|
+
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5011
|
+
#
|
5012
|
+
# * {Types::UpdateAccountSettingsResponse#request_id #request_id} => String
|
5013
|
+
# * {Types::UpdateAccountSettingsResponse#status #status} => Integer
|
5014
|
+
#
|
5015
|
+
# @example Request syntax with placeholder values
|
5016
|
+
#
|
5017
|
+
# resp = client.update_account_settings({
|
5018
|
+
# aws_account_id: "AwsAccountId", # required
|
5019
|
+
# default_namespace: "Namespace", # required
|
5020
|
+
# notification_email: "String",
|
5021
|
+
# })
|
5022
|
+
#
|
5023
|
+
# @example Response structure
|
5024
|
+
#
|
5025
|
+
# resp.request_id #=> String
|
5026
|
+
# resp.status #=> Integer
|
5027
|
+
#
|
5028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings AWS API Documentation
|
5029
|
+
#
|
5030
|
+
# @overload update_account_settings(params = {})
|
5031
|
+
# @param [Hash] params ({})
|
5032
|
+
def update_account_settings(params = {}, options = {})
|
5033
|
+
req = build_request(:update_account_settings, params)
|
5034
|
+
req.send_request(options)
|
5035
|
+
end
|
5036
|
+
|
4481
5037
|
# Updates a dashboard in an AWS account.
|
4482
5038
|
#
|
4483
5039
|
# @option params [required, String] :aws_account_id
|
@@ -4875,6 +5431,7 @@ module Aws::QuickSight
|
|
4875
5431
|
# },
|
4876
5432
|
# ],
|
4877
5433
|
# row_level_permission_data_set: {
|
5434
|
+
# namespace: "Namespace",
|
4878
5435
|
# arn: "Arn", # required
|
4879
5436
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
4880
5437
|
# },
|
@@ -5869,6 +6426,19 @@ module Aws::QuickSight
|
|
5869
6426
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
5870
6427
|
# QuickSight settings.
|
5871
6428
|
#
|
6429
|
+
# @option params [String] :custom_permissions_name
|
6430
|
+
# The name of the custom permissions profile that you want to assign to
|
6431
|
+
# this user. Currently, custom permissions profile names are assigned to
|
6432
|
+
# permissions profiles in the QuickSight console. You use this API to
|
6433
|
+
# assign the named set of permissions to a QuickSight user.
|
6434
|
+
#
|
6435
|
+
# @option params [Boolean] :unapply_custom_permissions
|
6436
|
+
# A flag that you use to indicate that you want to remove all custom
|
6437
|
+
# permissions from this user. Using this parameter resets the user to
|
6438
|
+
# the state it was in before a custom permissions profile was applied.
|
6439
|
+
# This parameter defaults to NULL and it doesn't accept any other
|
6440
|
+
# value.
|
6441
|
+
#
|
5872
6442
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5873
6443
|
#
|
5874
6444
|
# * {Types::UpdateUserResponse#user #user} => Types::User
|
@@ -5883,6 +6453,8 @@ module Aws::QuickSight
|
|
5883
6453
|
# namespace: "Namespace", # required
|
5884
6454
|
# email: "String", # required
|
5885
6455
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
6456
|
+
# custom_permissions_name: "RoleName",
|
6457
|
+
# unapply_custom_permissions: false,
|
5886
6458
|
# })
|
5887
6459
|
#
|
5888
6460
|
# @example Response structure
|
@@ -5894,6 +6466,7 @@ module Aws::QuickSight
|
|
5894
6466
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
5895
6467
|
# resp.user.active #=> Boolean
|
5896
6468
|
# resp.user.principal_id #=> String
|
6469
|
+
# resp.user.custom_permissions_name #=> String
|
5897
6470
|
# resp.request_id #=> String
|
5898
6471
|
# resp.status #=> Integer
|
5899
6472
|
#
|
@@ -5919,7 +6492,7 @@ module Aws::QuickSight
|
|
5919
6492
|
params: params,
|
5920
6493
|
config: config)
|
5921
6494
|
context[:gem_name] = 'aws-sdk-quicksight'
|
5922
|
-
context[:gem_version] = '1.
|
6495
|
+
context[:gem_version] = '1.26.0'
|
5923
6496
|
Seahorse::Client::Request.new(handlers, context)
|
5924
6497
|
end
|
5925
6498
|
|