aws-sdk-quicksight 1.24.0 → 1.25.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/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +887 -3
- data/lib/aws-sdk-quicksight/client_api.rb +514 -0
- data/lib/aws-sdk-quicksight/types.rb +1736 -97
- 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: 73ec87a9d50b097049e6c8d8db9fe235405b7c155906e924d2d394d6dda9e599
|
4
|
+
data.tar.gz: e77307603a389ee14d809fef1d7390b6b8a083d2046f44709e9ab23e410cc846
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 70bff9cd8f5c2d7c3341694a868e2770894ba593aed271b9d9c1fd79a2f1d215107e4ad3173d9c6a28cf3a3c7b029a9d06cbee465b7a3bcdffce33d8486027fa
|
7
|
+
data.tar.gz: ddc03901ed4669c282032f949203a48c79b0307c79e7481083c9a4fb27cf4e2d310ccb1ec6fccc74ec96f2a3e55374e28645224377e4ad1af80ddb4b802203ea
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -375,8 +375,8 @@ module Aws::QuickSight
|
|
375
375
|
# The display name of the dashboard.
|
376
376
|
#
|
377
377
|
# @option params [Types::Parameters] :parameters
|
378
|
-
#
|
379
|
-
#
|
378
|
+
# The parameters for the creation of the dashboard, which you want to
|
379
|
+
# use to override the default settings. A dashboard can have any type of
|
380
380
|
# parameters, and some parameters might accept multiple values.
|
381
381
|
#
|
382
382
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
@@ -424,6 +424,12 @@ module Aws::QuickSight
|
|
424
424
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
425
425
|
# by default.
|
426
426
|
#
|
427
|
+
# @option params [String] :theme_arn
|
428
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
429
|
+
# this dashboard. If you add a value for this field, it overrides the
|
430
|
+
# value that is used in the source entity. The theme ARN must exist in
|
431
|
+
# the same AWS account where you create the dashboard.
|
432
|
+
#
|
427
433
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
434
|
#
|
429
435
|
# * {Types::CreateDashboardResponse#arn #arn} => String
|
@@ -500,6 +506,7 @@ module Aws::QuickSight
|
|
500
506
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
501
507
|
# },
|
502
508
|
# },
|
509
|
+
# theme_arn: "Arn",
|
503
510
|
# })
|
504
511
|
#
|
505
512
|
# @example Response structure
|
@@ -1384,6 +1391,186 @@ module Aws::QuickSight
|
|
1384
1391
|
req.send_request(options)
|
1385
1392
|
end
|
1386
1393
|
|
1394
|
+
# Creates a theme.
|
1395
|
+
#
|
1396
|
+
# A *theme* is set of configuration options for color and layout. Themes
|
1397
|
+
# apply to analyses and dashboards. For more information, see [Using
|
1398
|
+
# Themes in Amazon QuickSight][1] in the *Amazon QuickSight User Guide*.
|
1399
|
+
#
|
1400
|
+
#
|
1401
|
+
#
|
1402
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1403
|
+
#
|
1404
|
+
# @option params [required, String] :aws_account_id
|
1405
|
+
# The ID of the AWS account where you want to store the new theme.
|
1406
|
+
#
|
1407
|
+
# @option params [required, String] :theme_id
|
1408
|
+
# An ID for the theme that you want to create. The theme ID is unique
|
1409
|
+
# per AWS Region in each AWS account.
|
1410
|
+
#
|
1411
|
+
# @option params [required, String] :name
|
1412
|
+
# A display name for the theme.
|
1413
|
+
#
|
1414
|
+
# @option params [required, String] :base_theme_id
|
1415
|
+
# The ID of the theme that a custom theme will inherit from. All themes
|
1416
|
+
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1417
|
+
# For a list of the starting themes, use `ListThemes` or choose
|
1418
|
+
# **Themes** from within a QuickSight analysis.
|
1419
|
+
#
|
1420
|
+
# @option params [String] :version_description
|
1421
|
+
# A description of the first version of the theme that you're creating.
|
1422
|
+
# Every time `UpdateTheme` is called, a new version is created. Each
|
1423
|
+
# version of the theme has a description of the version in the
|
1424
|
+
# `VersionDescription` field.
|
1425
|
+
#
|
1426
|
+
# @option params [required, Types::ThemeConfiguration] :configuration
|
1427
|
+
# The theme configuration, which contains the theme display properties.
|
1428
|
+
#
|
1429
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
1430
|
+
# A valid grouping of resource permissions to apply to the new theme.
|
1431
|
+
#
|
1432
|
+
# @option params [Array<Types::Tag>] :tags
|
1433
|
+
# A map of the key-value pairs for the resource tag or tags that you
|
1434
|
+
# want to add to the resource.
|
1435
|
+
#
|
1436
|
+
# @return [Types::CreateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1437
|
+
#
|
1438
|
+
# * {Types::CreateThemeResponse#arn #arn} => String
|
1439
|
+
# * {Types::CreateThemeResponse#version_arn #version_arn} => String
|
1440
|
+
# * {Types::CreateThemeResponse#theme_id #theme_id} => String
|
1441
|
+
# * {Types::CreateThemeResponse#creation_status #creation_status} => String
|
1442
|
+
# * {Types::CreateThemeResponse#status #status} => Integer
|
1443
|
+
# * {Types::CreateThemeResponse#request_id #request_id} => String
|
1444
|
+
#
|
1445
|
+
# @example Request syntax with placeholder values
|
1446
|
+
#
|
1447
|
+
# resp = client.create_theme({
|
1448
|
+
# aws_account_id: "AwsAccountId", # required
|
1449
|
+
# theme_id: "RestrictiveResourceId", # required
|
1450
|
+
# name: "ThemeName", # required
|
1451
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
1452
|
+
# version_description: "VersionDescription",
|
1453
|
+
# configuration: { # required
|
1454
|
+
# data_color_palette: {
|
1455
|
+
# colors: ["HexColor"],
|
1456
|
+
# min_max_gradient: ["HexColor"],
|
1457
|
+
# empty_fill_color: "HexColor",
|
1458
|
+
# },
|
1459
|
+
# ui_color_palette: {
|
1460
|
+
# primary_foreground: "HexColor",
|
1461
|
+
# primary_background: "HexColor",
|
1462
|
+
# secondary_foreground: "HexColor",
|
1463
|
+
# secondary_background: "HexColor",
|
1464
|
+
# accent: "HexColor",
|
1465
|
+
# accent_foreground: "HexColor",
|
1466
|
+
# danger: "HexColor",
|
1467
|
+
# danger_foreground: "HexColor",
|
1468
|
+
# warning: "HexColor",
|
1469
|
+
# warning_foreground: "HexColor",
|
1470
|
+
# success: "HexColor",
|
1471
|
+
# success_foreground: "HexColor",
|
1472
|
+
# dimension: "HexColor",
|
1473
|
+
# dimension_foreground: "HexColor",
|
1474
|
+
# measure: "HexColor",
|
1475
|
+
# measure_foreground: "HexColor",
|
1476
|
+
# },
|
1477
|
+
# sheet: {
|
1478
|
+
# tile: {
|
1479
|
+
# border: {
|
1480
|
+
# show: false,
|
1481
|
+
# },
|
1482
|
+
# },
|
1483
|
+
# tile_layout: {
|
1484
|
+
# gutter: {
|
1485
|
+
# show: false,
|
1486
|
+
# },
|
1487
|
+
# margin: {
|
1488
|
+
# show: false,
|
1489
|
+
# },
|
1490
|
+
# },
|
1491
|
+
# },
|
1492
|
+
# },
|
1493
|
+
# permissions: [
|
1494
|
+
# {
|
1495
|
+
# principal: "Principal", # required
|
1496
|
+
# actions: ["String"], # required
|
1497
|
+
# },
|
1498
|
+
# ],
|
1499
|
+
# tags: [
|
1500
|
+
# {
|
1501
|
+
# key: "TagKey", # required
|
1502
|
+
# value: "TagValue", # required
|
1503
|
+
# },
|
1504
|
+
# ],
|
1505
|
+
# })
|
1506
|
+
#
|
1507
|
+
# @example Response structure
|
1508
|
+
#
|
1509
|
+
# resp.arn #=> String
|
1510
|
+
# resp.version_arn #=> String
|
1511
|
+
# resp.theme_id #=> String
|
1512
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1513
|
+
# resp.status #=> Integer
|
1514
|
+
# resp.request_id #=> String
|
1515
|
+
#
|
1516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTheme AWS API Documentation
|
1517
|
+
#
|
1518
|
+
# @overload create_theme(params = {})
|
1519
|
+
# @param [Hash] params ({})
|
1520
|
+
def create_theme(params = {}, options = {})
|
1521
|
+
req = build_request(:create_theme, params)
|
1522
|
+
req.send_request(options)
|
1523
|
+
end
|
1524
|
+
|
1525
|
+
# Creates a theme alias for a theme.
|
1526
|
+
#
|
1527
|
+
# @option params [required, String] :aws_account_id
|
1528
|
+
# The ID of the AWS account that contains the theme for the new theme
|
1529
|
+
# alias.
|
1530
|
+
#
|
1531
|
+
# @option params [required, String] :theme_id
|
1532
|
+
# An ID for the theme alias.
|
1533
|
+
#
|
1534
|
+
# @option params [required, String] :alias_name
|
1535
|
+
# The name that you want to give to the theme alias that you are
|
1536
|
+
# creating. The alias name can't begin with a `$`. Alias names that
|
1537
|
+
# start with `$` are reserved by Amazon QuickSight.
|
1538
|
+
#
|
1539
|
+
# @option params [required, Integer] :theme_version_number
|
1540
|
+
# The version number of the theme.
|
1541
|
+
#
|
1542
|
+
# @return [Types::CreateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1543
|
+
#
|
1544
|
+
# * {Types::CreateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
1545
|
+
# * {Types::CreateThemeAliasResponse#status #status} => Integer
|
1546
|
+
# * {Types::CreateThemeAliasResponse#request_id #request_id} => String
|
1547
|
+
#
|
1548
|
+
# @example Request syntax with placeholder values
|
1549
|
+
#
|
1550
|
+
# resp = client.create_theme_alias({
|
1551
|
+
# aws_account_id: "AwsAccountId", # required
|
1552
|
+
# theme_id: "RestrictiveResourceId", # required
|
1553
|
+
# alias_name: "AliasName", # required
|
1554
|
+
# theme_version_number: 1, # required
|
1555
|
+
# })
|
1556
|
+
#
|
1557
|
+
# @example Response structure
|
1558
|
+
#
|
1559
|
+
# resp.theme_alias.arn #=> String
|
1560
|
+
# resp.theme_alias.alias_name #=> String
|
1561
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
1562
|
+
# resp.status #=> Integer
|
1563
|
+
# resp.request_id #=> String
|
1564
|
+
#
|
1565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAlias AWS API Documentation
|
1566
|
+
#
|
1567
|
+
# @overload create_theme_alias(params = {})
|
1568
|
+
# @param [Hash] params ({})
|
1569
|
+
def create_theme_alias(params = {}, options = {})
|
1570
|
+
req = build_request(:create_theme_alias, params)
|
1571
|
+
req.send_request(options)
|
1572
|
+
end
|
1573
|
+
|
1387
1574
|
# Deletes a dashboard.
|
1388
1575
|
#
|
1389
1576
|
# @option params [required, String] :aws_account_id
|
@@ -1727,6 +1914,98 @@ module Aws::QuickSight
|
|
1727
1914
|
req.send_request(options)
|
1728
1915
|
end
|
1729
1916
|
|
1917
|
+
# Deletes a theme.
|
1918
|
+
#
|
1919
|
+
# @option params [required, String] :aws_account_id
|
1920
|
+
# The ID of the AWS account that contains the theme that you're
|
1921
|
+
# deleting.
|
1922
|
+
#
|
1923
|
+
# @option params [required, String] :theme_id
|
1924
|
+
# An ID for the theme that you want to delete.
|
1925
|
+
#
|
1926
|
+
# @option params [Integer] :version_number
|
1927
|
+
# The version of the theme that you want to delete.
|
1928
|
+
#
|
1929
|
+
# **Note:** If you don't provide a version number, you're using this
|
1930
|
+
# call to `DeleteTheme` to delete all versions of the theme.
|
1931
|
+
#
|
1932
|
+
# @return [Types::DeleteThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1933
|
+
#
|
1934
|
+
# * {Types::DeleteThemeResponse#arn #arn} => String
|
1935
|
+
# * {Types::DeleteThemeResponse#request_id #request_id} => String
|
1936
|
+
# * {Types::DeleteThemeResponse#status #status} => Integer
|
1937
|
+
# * {Types::DeleteThemeResponse#theme_id #theme_id} => String
|
1938
|
+
#
|
1939
|
+
# @example Request syntax with placeholder values
|
1940
|
+
#
|
1941
|
+
# resp = client.delete_theme({
|
1942
|
+
# aws_account_id: "AwsAccountId", # required
|
1943
|
+
# theme_id: "RestrictiveResourceId", # required
|
1944
|
+
# version_number: 1,
|
1945
|
+
# })
|
1946
|
+
#
|
1947
|
+
# @example Response structure
|
1948
|
+
#
|
1949
|
+
# resp.arn #=> String
|
1950
|
+
# resp.request_id #=> String
|
1951
|
+
# resp.status #=> Integer
|
1952
|
+
# resp.theme_id #=> String
|
1953
|
+
#
|
1954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTheme AWS API Documentation
|
1955
|
+
#
|
1956
|
+
# @overload delete_theme(params = {})
|
1957
|
+
# @param [Hash] params ({})
|
1958
|
+
def delete_theme(params = {}, options = {})
|
1959
|
+
req = build_request(:delete_theme, params)
|
1960
|
+
req.send_request(options)
|
1961
|
+
end
|
1962
|
+
|
1963
|
+
# Deletes the version of the theme that the specified theme alias points
|
1964
|
+
# to. If you provide a specific alias, you delete the version of the
|
1965
|
+
# theme that the alias points to.
|
1966
|
+
#
|
1967
|
+
# @option params [required, String] :aws_account_id
|
1968
|
+
# The ID of the AWS account that contains the theme alias to delete.
|
1969
|
+
#
|
1970
|
+
# @option params [required, String] :theme_id
|
1971
|
+
# The ID for the theme that the specified alias is for.
|
1972
|
+
#
|
1973
|
+
# @option params [required, String] :alias_name
|
1974
|
+
# The unique name for the theme alias to delete.
|
1975
|
+
#
|
1976
|
+
# @return [Types::DeleteThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1977
|
+
#
|
1978
|
+
# * {Types::DeleteThemeAliasResponse#alias_name #alias_name} => String
|
1979
|
+
# * {Types::DeleteThemeAliasResponse#arn #arn} => String
|
1980
|
+
# * {Types::DeleteThemeAliasResponse#request_id #request_id} => String
|
1981
|
+
# * {Types::DeleteThemeAliasResponse#status #status} => Integer
|
1982
|
+
# * {Types::DeleteThemeAliasResponse#theme_id #theme_id} => String
|
1983
|
+
#
|
1984
|
+
# @example Request syntax with placeholder values
|
1985
|
+
#
|
1986
|
+
# resp = client.delete_theme_alias({
|
1987
|
+
# aws_account_id: "AwsAccountId", # required
|
1988
|
+
# theme_id: "RestrictiveResourceId", # required
|
1989
|
+
# alias_name: "AliasName", # required
|
1990
|
+
# })
|
1991
|
+
#
|
1992
|
+
# @example Response structure
|
1993
|
+
#
|
1994
|
+
# resp.alias_name #=> String
|
1995
|
+
# resp.arn #=> String
|
1996
|
+
# resp.request_id #=> String
|
1997
|
+
# resp.status #=> Integer
|
1998
|
+
# resp.theme_id #=> String
|
1999
|
+
#
|
2000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAlias AWS API Documentation
|
2001
|
+
#
|
2002
|
+
# @overload delete_theme_alias(params = {})
|
2003
|
+
# @param [Hash] params ({})
|
2004
|
+
def delete_theme_alias(params = {}, options = {})
|
2005
|
+
req = build_request(:delete_theme_alias, params)
|
2006
|
+
req.send_request(options)
|
2007
|
+
end
|
2008
|
+
|
1730
2009
|
# Deletes the Amazon QuickSight user that is associated with the
|
1731
2010
|
# identity of the AWS Identity and Access Management (IAM) user or role
|
1732
2011
|
# that's making the call. The IAM user isn't deleted as a result of
|
@@ -2412,6 +2691,7 @@ module Aws::QuickSight
|
|
2412
2691
|
#
|
2413
2692
|
# * {Types::DescribeTemplateResponse#template #template} => Types::Template
|
2414
2693
|
# * {Types::DescribeTemplateResponse#status #status} => Integer
|
2694
|
+
# * {Types::DescribeTemplateResponse#request_id #request_id} => String
|
2415
2695
|
#
|
2416
2696
|
# @example Request syntax with placeholder values
|
2417
2697
|
#
|
@@ -2448,6 +2728,7 @@ module Aws::QuickSight
|
|
2448
2728
|
# resp.template.last_updated_time #=> Time
|
2449
2729
|
# resp.template.created_time #=> Time
|
2450
2730
|
# resp.status #=> Integer
|
2731
|
+
# resp.request_id #=> String
|
2451
2732
|
#
|
2452
2733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation
|
2453
2734
|
#
|
@@ -2549,6 +2830,182 @@ module Aws::QuickSight
|
|
2549
2830
|
req.send_request(options)
|
2550
2831
|
end
|
2551
2832
|
|
2833
|
+
# Describes a theme.
|
2834
|
+
#
|
2835
|
+
# @option params [required, String] :aws_account_id
|
2836
|
+
# The ID of the AWS account that contains the theme that you're
|
2837
|
+
# describing.
|
2838
|
+
#
|
2839
|
+
# @option params [required, String] :theme_id
|
2840
|
+
# The ID for the theme.
|
2841
|
+
#
|
2842
|
+
# @option params [Integer] :version_number
|
2843
|
+
# The version number for the version to describe. If a `VersionNumber`
|
2844
|
+
# parameter value isn't provided, the latest version of the theme is
|
2845
|
+
# described.
|
2846
|
+
#
|
2847
|
+
# @option params [String] :alias_name
|
2848
|
+
# The alias of the theme that you want to describe. If you name a
|
2849
|
+
# specific alias, you describe the version that the alias points to. You
|
2850
|
+
# can specify the latest version of the theme by providing the keyword
|
2851
|
+
# `$LATEST` in the `AliasName` parameter. The keyword `$PUBLISHED`
|
2852
|
+
# doesn't apply to themes.
|
2853
|
+
#
|
2854
|
+
# @return [Types::DescribeThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2855
|
+
#
|
2856
|
+
# * {Types::DescribeThemeResponse#theme #theme} => Types::Theme
|
2857
|
+
# * {Types::DescribeThemeResponse#status #status} => Integer
|
2858
|
+
# * {Types::DescribeThemeResponse#request_id #request_id} => String
|
2859
|
+
#
|
2860
|
+
# @example Request syntax with placeholder values
|
2861
|
+
#
|
2862
|
+
# resp = client.describe_theme({
|
2863
|
+
# aws_account_id: "AwsAndAccountId", # required
|
2864
|
+
# theme_id: "RestrictiveResourceId", # required
|
2865
|
+
# version_number: 1,
|
2866
|
+
# alias_name: "AliasName",
|
2867
|
+
# })
|
2868
|
+
#
|
2869
|
+
# @example Response structure
|
2870
|
+
#
|
2871
|
+
# resp.theme.arn #=> String
|
2872
|
+
# resp.theme.name #=> String
|
2873
|
+
# resp.theme.theme_id #=> String
|
2874
|
+
# resp.theme.version.version_number #=> Integer
|
2875
|
+
# resp.theme.version.arn #=> String
|
2876
|
+
# resp.theme.version.description #=> String
|
2877
|
+
# resp.theme.version.base_theme_id #=> String
|
2878
|
+
# resp.theme.version.created_time #=> Time
|
2879
|
+
# resp.theme.version.configuration.data_color_palette.colors #=> Array
|
2880
|
+
# resp.theme.version.configuration.data_color_palette.colors[0] #=> String
|
2881
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
|
2882
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
|
2883
|
+
# resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
|
2884
|
+
# resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
|
2885
|
+
# resp.theme.version.configuration.ui_color_palette.primary_background #=> String
|
2886
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
|
2887
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
|
2888
|
+
# resp.theme.version.configuration.ui_color_palette.accent #=> String
|
2889
|
+
# resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
|
2890
|
+
# resp.theme.version.configuration.ui_color_palette.danger #=> String
|
2891
|
+
# resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
|
2892
|
+
# resp.theme.version.configuration.ui_color_palette.warning #=> String
|
2893
|
+
# resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
|
2894
|
+
# resp.theme.version.configuration.ui_color_palette.success #=> String
|
2895
|
+
# resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
|
2896
|
+
# resp.theme.version.configuration.ui_color_palette.dimension #=> String
|
2897
|
+
# resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
|
2898
|
+
# resp.theme.version.configuration.ui_color_palette.measure #=> String
|
2899
|
+
# resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
|
2900
|
+
# resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
|
2901
|
+
# resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
|
2902
|
+
# resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
|
2903
|
+
# resp.theme.version.errors #=> Array
|
2904
|
+
# resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
|
2905
|
+
# resp.theme.version.errors[0].message #=> String
|
2906
|
+
# resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
2907
|
+
# resp.theme.created_time #=> Time
|
2908
|
+
# resp.theme.last_updated_time #=> Time
|
2909
|
+
# resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
|
2910
|
+
# resp.status #=> Integer
|
2911
|
+
# resp.request_id #=> String
|
2912
|
+
#
|
2913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTheme AWS API Documentation
|
2914
|
+
#
|
2915
|
+
# @overload describe_theme(params = {})
|
2916
|
+
# @param [Hash] params ({})
|
2917
|
+
def describe_theme(params = {}, options = {})
|
2918
|
+
req = build_request(:describe_theme, params)
|
2919
|
+
req.send_request(options)
|
2920
|
+
end
|
2921
|
+
|
2922
|
+
# Describes the alias for a theme.
|
2923
|
+
#
|
2924
|
+
# @option params [required, String] :aws_account_id
|
2925
|
+
# The ID of the AWS account that contains the theme alias that you're
|
2926
|
+
# describing.
|
2927
|
+
#
|
2928
|
+
# @option params [required, String] :theme_id
|
2929
|
+
# The ID for the theme.
|
2930
|
+
#
|
2931
|
+
# @option params [required, String] :alias_name
|
2932
|
+
# The name of the theme alias that you want to describe.
|
2933
|
+
#
|
2934
|
+
# @return [Types::DescribeThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2935
|
+
#
|
2936
|
+
# * {Types::DescribeThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
2937
|
+
# * {Types::DescribeThemeAliasResponse#status #status} => Integer
|
2938
|
+
# * {Types::DescribeThemeAliasResponse#request_id #request_id} => String
|
2939
|
+
#
|
2940
|
+
# @example Request syntax with placeholder values
|
2941
|
+
#
|
2942
|
+
# resp = client.describe_theme_alias({
|
2943
|
+
# aws_account_id: "AwsAccountId", # required
|
2944
|
+
# theme_id: "RestrictiveResourceId", # required
|
2945
|
+
# alias_name: "AliasName", # required
|
2946
|
+
# })
|
2947
|
+
#
|
2948
|
+
# @example Response structure
|
2949
|
+
#
|
2950
|
+
# resp.theme_alias.arn #=> String
|
2951
|
+
# resp.theme_alias.alias_name #=> String
|
2952
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
2953
|
+
# resp.status #=> Integer
|
2954
|
+
# resp.request_id #=> String
|
2955
|
+
#
|
2956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAlias AWS API Documentation
|
2957
|
+
#
|
2958
|
+
# @overload describe_theme_alias(params = {})
|
2959
|
+
# @param [Hash] params ({})
|
2960
|
+
def describe_theme_alias(params = {}, options = {})
|
2961
|
+
req = build_request(:describe_theme_alias, params)
|
2962
|
+
req.send_request(options)
|
2963
|
+
end
|
2964
|
+
|
2965
|
+
# Describes the read and write permissions for a theme.
|
2966
|
+
#
|
2967
|
+
# @option params [required, String] :aws_account_id
|
2968
|
+
# The ID of the AWS account that contains the theme that you're
|
2969
|
+
# describing.
|
2970
|
+
#
|
2971
|
+
# @option params [required, String] :theme_id
|
2972
|
+
# The ID for the theme that you want to describe permissions for.
|
2973
|
+
#
|
2974
|
+
# @return [Types::DescribeThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2975
|
+
#
|
2976
|
+
# * {Types::DescribeThemePermissionsResponse#theme_id #theme_id} => String
|
2977
|
+
# * {Types::DescribeThemePermissionsResponse#theme_arn #theme_arn} => String
|
2978
|
+
# * {Types::DescribeThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
2979
|
+
# * {Types::DescribeThemePermissionsResponse#request_id #request_id} => String
|
2980
|
+
# * {Types::DescribeThemePermissionsResponse#status #status} => Integer
|
2981
|
+
#
|
2982
|
+
# @example Request syntax with placeholder values
|
2983
|
+
#
|
2984
|
+
# resp = client.describe_theme_permissions({
|
2985
|
+
# aws_account_id: "AwsAccountId", # required
|
2986
|
+
# theme_id: "RestrictiveResourceId", # required
|
2987
|
+
# })
|
2988
|
+
#
|
2989
|
+
# @example Response structure
|
2990
|
+
#
|
2991
|
+
# resp.theme_id #=> String
|
2992
|
+
# resp.theme_arn #=> String
|
2993
|
+
# resp.permissions #=> Array
|
2994
|
+
# resp.permissions[0].principal #=> String
|
2995
|
+
# resp.permissions[0].actions #=> Array
|
2996
|
+
# resp.permissions[0].actions[0] #=> String
|
2997
|
+
# resp.request_id #=> String
|
2998
|
+
# resp.status #=> Integer
|
2999
|
+
#
|
3000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissions AWS API Documentation
|
3001
|
+
#
|
3002
|
+
# @overload describe_theme_permissions(params = {})
|
3003
|
+
# @param [Hash] params ({})
|
3004
|
+
def describe_theme_permissions(params = {}, options = {})
|
3005
|
+
req = build_request(:describe_theme_permissions, params)
|
3006
|
+
req.send_request(options)
|
3007
|
+
end
|
3008
|
+
|
2552
3009
|
# Returns information about a user, given the user name.
|
2553
3010
|
#
|
2554
3011
|
# @option params [required, String] :user_name
|
@@ -3476,6 +3933,173 @@ module Aws::QuickSight
|
|
3476
3933
|
req.send_request(options)
|
3477
3934
|
end
|
3478
3935
|
|
3936
|
+
# Lists all the aliases of a theme.
|
3937
|
+
#
|
3938
|
+
# @option params [required, String] :aws_account_id
|
3939
|
+
# The ID of the AWS account that contains the theme aliases that you're
|
3940
|
+
# listing.
|
3941
|
+
#
|
3942
|
+
# @option params [required, String] :theme_id
|
3943
|
+
# The ID for the theme.
|
3944
|
+
#
|
3945
|
+
# @option params [String] :next_token
|
3946
|
+
# The token for the next set of results, or null if there are no more
|
3947
|
+
# results.
|
3948
|
+
#
|
3949
|
+
# @option params [Integer] :max_results
|
3950
|
+
# The maximum number of results to be returned per request.
|
3951
|
+
#
|
3952
|
+
# @return [Types::ListThemeAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3953
|
+
#
|
3954
|
+
# * {Types::ListThemeAliasesResponse#theme_alias_list #theme_alias_list} => Array<Types::ThemeAlias>
|
3955
|
+
# * {Types::ListThemeAliasesResponse#status #status} => Integer
|
3956
|
+
# * {Types::ListThemeAliasesResponse#request_id #request_id} => String
|
3957
|
+
# * {Types::ListThemeAliasesResponse#next_token #next_token} => String
|
3958
|
+
#
|
3959
|
+
# @example Request syntax with placeholder values
|
3960
|
+
#
|
3961
|
+
# resp = client.list_theme_aliases({
|
3962
|
+
# aws_account_id: "AwsAccountId", # required
|
3963
|
+
# theme_id: "RestrictiveResourceId", # required
|
3964
|
+
# next_token: "String",
|
3965
|
+
# max_results: 1,
|
3966
|
+
# })
|
3967
|
+
#
|
3968
|
+
# @example Response structure
|
3969
|
+
#
|
3970
|
+
# resp.theme_alias_list #=> Array
|
3971
|
+
# resp.theme_alias_list[0].arn #=> String
|
3972
|
+
# resp.theme_alias_list[0].alias_name #=> String
|
3973
|
+
# resp.theme_alias_list[0].theme_version_number #=> Integer
|
3974
|
+
# resp.status #=> Integer
|
3975
|
+
# resp.request_id #=> String
|
3976
|
+
# resp.next_token #=> String
|
3977
|
+
#
|
3978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliases AWS API Documentation
|
3979
|
+
#
|
3980
|
+
# @overload list_theme_aliases(params = {})
|
3981
|
+
# @param [Hash] params ({})
|
3982
|
+
def list_theme_aliases(params = {}, options = {})
|
3983
|
+
req = build_request(:list_theme_aliases, params)
|
3984
|
+
req.send_request(options)
|
3985
|
+
end
|
3986
|
+
|
3987
|
+
# Lists all the versions of the themes in the current AWS account.
|
3988
|
+
#
|
3989
|
+
# @option params [required, String] :aws_account_id
|
3990
|
+
# The ID of the AWS account that contains the themes that you're
|
3991
|
+
# listing.
|
3992
|
+
#
|
3993
|
+
# @option params [required, String] :theme_id
|
3994
|
+
# The ID for the theme.
|
3995
|
+
#
|
3996
|
+
# @option params [String] :next_token
|
3997
|
+
# The token for the next set of results, or null if there are no more
|
3998
|
+
# results.
|
3999
|
+
#
|
4000
|
+
# @option params [Integer] :max_results
|
4001
|
+
# The maximum number of results to be returned per request.
|
4002
|
+
#
|
4003
|
+
# @return [Types::ListThemeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4004
|
+
#
|
4005
|
+
# * {Types::ListThemeVersionsResponse#theme_version_summary_list #theme_version_summary_list} => Array<Types::ThemeVersionSummary>
|
4006
|
+
# * {Types::ListThemeVersionsResponse#next_token #next_token} => String
|
4007
|
+
# * {Types::ListThemeVersionsResponse#status #status} => Integer
|
4008
|
+
# * {Types::ListThemeVersionsResponse#request_id #request_id} => String
|
4009
|
+
#
|
4010
|
+
# @example Request syntax with placeholder values
|
4011
|
+
#
|
4012
|
+
# resp = client.list_theme_versions({
|
4013
|
+
# aws_account_id: "AwsAccountId", # required
|
4014
|
+
# theme_id: "RestrictiveResourceId", # required
|
4015
|
+
# next_token: "String",
|
4016
|
+
# max_results: 1,
|
4017
|
+
# })
|
4018
|
+
#
|
4019
|
+
# @example Response structure
|
4020
|
+
#
|
4021
|
+
# resp.theme_version_summary_list #=> Array
|
4022
|
+
# resp.theme_version_summary_list[0].version_number #=> Integer
|
4023
|
+
# resp.theme_version_summary_list[0].arn #=> String
|
4024
|
+
# resp.theme_version_summary_list[0].description #=> String
|
4025
|
+
# resp.theme_version_summary_list[0].created_time #=> Time
|
4026
|
+
# resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4027
|
+
# resp.next_token #=> String
|
4028
|
+
# resp.status #=> Integer
|
4029
|
+
# resp.request_id #=> String
|
4030
|
+
#
|
4031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersions AWS API Documentation
|
4032
|
+
#
|
4033
|
+
# @overload list_theme_versions(params = {})
|
4034
|
+
# @param [Hash] params ({})
|
4035
|
+
def list_theme_versions(params = {}, options = {})
|
4036
|
+
req = build_request(:list_theme_versions, params)
|
4037
|
+
req.send_request(options)
|
4038
|
+
end
|
4039
|
+
|
4040
|
+
# Lists all the themes in the current AWS account.
|
4041
|
+
#
|
4042
|
+
# @option params [required, String] :aws_account_id
|
4043
|
+
# The ID of the AWS account that contains the themes that you're
|
4044
|
+
# listing.
|
4045
|
+
#
|
4046
|
+
# @option params [String] :next_token
|
4047
|
+
# The token for the next set of results, or null if there are no more
|
4048
|
+
# results.
|
4049
|
+
#
|
4050
|
+
# @option params [Integer] :max_results
|
4051
|
+
# The maximum number of results to be returned per request.
|
4052
|
+
#
|
4053
|
+
# @option params [String] :type
|
4054
|
+
# The type of themes that you want to list. Valid options include the
|
4055
|
+
# following:
|
4056
|
+
#
|
4057
|
+
# * `ALL (default)`- Display all existing themes.
|
4058
|
+
#
|
4059
|
+
# * `CUSTOM` - Display only the themes created by people using Amazon
|
4060
|
+
# QuickSight.
|
4061
|
+
#
|
4062
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
4063
|
+
# QuickSight.
|
4064
|
+
#
|
4065
|
+
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4066
|
+
#
|
4067
|
+
# * {Types::ListThemesResponse#theme_summary_list #theme_summary_list} => Array<Types::ThemeSummary>
|
4068
|
+
# * {Types::ListThemesResponse#next_token #next_token} => String
|
4069
|
+
# * {Types::ListThemesResponse#status #status} => Integer
|
4070
|
+
# * {Types::ListThemesResponse#request_id #request_id} => String
|
4071
|
+
#
|
4072
|
+
# @example Request syntax with placeholder values
|
4073
|
+
#
|
4074
|
+
# resp = client.list_themes({
|
4075
|
+
# aws_account_id: "AwsAccountId", # required
|
4076
|
+
# next_token: "String",
|
4077
|
+
# max_results: 1,
|
4078
|
+
# type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
|
4079
|
+
# })
|
4080
|
+
#
|
4081
|
+
# @example Response structure
|
4082
|
+
#
|
4083
|
+
# resp.theme_summary_list #=> Array
|
4084
|
+
# resp.theme_summary_list[0].arn #=> String
|
4085
|
+
# resp.theme_summary_list[0].name #=> String
|
4086
|
+
# resp.theme_summary_list[0].theme_id #=> String
|
4087
|
+
# resp.theme_summary_list[0].latest_version_number #=> Integer
|
4088
|
+
# resp.theme_summary_list[0].created_time #=> Time
|
4089
|
+
# resp.theme_summary_list[0].last_updated_time #=> Time
|
4090
|
+
# resp.next_token #=> String
|
4091
|
+
# resp.status #=> Integer
|
4092
|
+
# resp.request_id #=> String
|
4093
|
+
#
|
4094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemes AWS API Documentation
|
4095
|
+
#
|
4096
|
+
# @overload list_themes(params = {})
|
4097
|
+
# @param [Hash] params ({})
|
4098
|
+
def list_themes(params = {}, options = {})
|
4099
|
+
req = build_request(:list_themes, params)
|
4100
|
+
req.send_request(options)
|
4101
|
+
end
|
4102
|
+
|
3479
4103
|
# Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
|
3480
4104
|
# member of.
|
3481
4105
|
#
|
@@ -3907,6 +4531,12 @@ module Aws::QuickSight
|
|
3907
4531
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
3908
4532
|
# by default.
|
3909
4533
|
#
|
4534
|
+
# @option params [String] :theme_arn
|
4535
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
4536
|
+
# this dashboard. If you add a value for this field, it overrides the
|
4537
|
+
# value that was originally associated with the entity. The theme ARN
|
4538
|
+
# must exist in the same AWS account where you create the dashboard.
|
4539
|
+
#
|
3910
4540
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3911
4541
|
#
|
3912
4542
|
# * {Types::UpdateDashboardResponse#arn #arn} => String
|
@@ -3971,6 +4601,7 @@ module Aws::QuickSight
|
|
3971
4601
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
3972
4602
|
# },
|
3973
4603
|
# },
|
4604
|
+
# theme_arn: "Arn",
|
3974
4605
|
# })
|
3975
4606
|
#
|
3976
4607
|
# @example Response structure
|
@@ -4958,6 +5589,259 @@ module Aws::QuickSight
|
|
4958
5589
|
req.send_request(options)
|
4959
5590
|
end
|
4960
5591
|
|
5592
|
+
# Updates a theme.
|
5593
|
+
#
|
5594
|
+
# @option params [required, String] :aws_account_id
|
5595
|
+
# The ID of the AWS account that contains the theme that you're
|
5596
|
+
# updating.
|
5597
|
+
#
|
5598
|
+
# @option params [required, String] :theme_id
|
5599
|
+
# The ID for the theme.
|
5600
|
+
#
|
5601
|
+
# @option params [String] :name
|
5602
|
+
# The name for the theme.
|
5603
|
+
#
|
5604
|
+
# @option params [required, String] :base_theme_id
|
5605
|
+
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
5606
|
+
# inherits from. All themes initially inherit from a default QuickSight
|
5607
|
+
# theme.
|
5608
|
+
#
|
5609
|
+
# @option params [String] :version_description
|
5610
|
+
# A description of the theme version that you're updating Every time
|
5611
|
+
# that you call `UpdateTheme`, you create a new version of the theme.
|
5612
|
+
# Each version of the theme maintains a description of the version in
|
5613
|
+
# `VersionDescription`.
|
5614
|
+
#
|
5615
|
+
# @option params [Types::ThemeConfiguration] :configuration
|
5616
|
+
# The theme configuration, which contains the theme display properties.
|
5617
|
+
#
|
5618
|
+
# @return [Types::UpdateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5619
|
+
#
|
5620
|
+
# * {Types::UpdateThemeResponse#theme_id #theme_id} => String
|
5621
|
+
# * {Types::UpdateThemeResponse#arn #arn} => String
|
5622
|
+
# * {Types::UpdateThemeResponse#version_arn #version_arn} => String
|
5623
|
+
# * {Types::UpdateThemeResponse#creation_status #creation_status} => String
|
5624
|
+
# * {Types::UpdateThemeResponse#status #status} => Integer
|
5625
|
+
# * {Types::UpdateThemeResponse#request_id #request_id} => String
|
5626
|
+
#
|
5627
|
+
# @example Request syntax with placeholder values
|
5628
|
+
#
|
5629
|
+
# resp = client.update_theme({
|
5630
|
+
# aws_account_id: "AwsAccountId", # required
|
5631
|
+
# theme_id: "RestrictiveResourceId", # required
|
5632
|
+
# name: "ThemeName",
|
5633
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
5634
|
+
# version_description: "VersionDescription",
|
5635
|
+
# configuration: {
|
5636
|
+
# data_color_palette: {
|
5637
|
+
# colors: ["HexColor"],
|
5638
|
+
# min_max_gradient: ["HexColor"],
|
5639
|
+
# empty_fill_color: "HexColor",
|
5640
|
+
# },
|
5641
|
+
# ui_color_palette: {
|
5642
|
+
# primary_foreground: "HexColor",
|
5643
|
+
# primary_background: "HexColor",
|
5644
|
+
# secondary_foreground: "HexColor",
|
5645
|
+
# secondary_background: "HexColor",
|
5646
|
+
# accent: "HexColor",
|
5647
|
+
# accent_foreground: "HexColor",
|
5648
|
+
# danger: "HexColor",
|
5649
|
+
# danger_foreground: "HexColor",
|
5650
|
+
# warning: "HexColor",
|
5651
|
+
# warning_foreground: "HexColor",
|
5652
|
+
# success: "HexColor",
|
5653
|
+
# success_foreground: "HexColor",
|
5654
|
+
# dimension: "HexColor",
|
5655
|
+
# dimension_foreground: "HexColor",
|
5656
|
+
# measure: "HexColor",
|
5657
|
+
# measure_foreground: "HexColor",
|
5658
|
+
# },
|
5659
|
+
# sheet: {
|
5660
|
+
# tile: {
|
5661
|
+
# border: {
|
5662
|
+
# show: false,
|
5663
|
+
# },
|
5664
|
+
# },
|
5665
|
+
# tile_layout: {
|
5666
|
+
# gutter: {
|
5667
|
+
# show: false,
|
5668
|
+
# },
|
5669
|
+
# margin: {
|
5670
|
+
# show: false,
|
5671
|
+
# },
|
5672
|
+
# },
|
5673
|
+
# },
|
5674
|
+
# },
|
5675
|
+
# })
|
5676
|
+
#
|
5677
|
+
# @example Response structure
|
5678
|
+
#
|
5679
|
+
# resp.theme_id #=> String
|
5680
|
+
# resp.arn #=> String
|
5681
|
+
# resp.version_arn #=> String
|
5682
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
5683
|
+
# resp.status #=> Integer
|
5684
|
+
# resp.request_id #=> String
|
5685
|
+
#
|
5686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTheme AWS API Documentation
|
5687
|
+
#
|
5688
|
+
# @overload update_theme(params = {})
|
5689
|
+
# @param [Hash] params ({})
|
5690
|
+
def update_theme(params = {}, options = {})
|
5691
|
+
req = build_request(:update_theme, params)
|
5692
|
+
req.send_request(options)
|
5693
|
+
end
|
5694
|
+
|
5695
|
+
# Updates an alias of a theme.
|
5696
|
+
#
|
5697
|
+
# @option params [required, String] :aws_account_id
|
5698
|
+
# The ID of the AWS account that contains the theme alias that you're
|
5699
|
+
# updating.
|
5700
|
+
#
|
5701
|
+
# @option params [required, String] :theme_id
|
5702
|
+
# The ID for the theme.
|
5703
|
+
#
|
5704
|
+
# @option params [required, String] :alias_name
|
5705
|
+
# The name of the theme alias that you want to update.
|
5706
|
+
#
|
5707
|
+
# @option params [required, Integer] :theme_version_number
|
5708
|
+
# The version number of the theme that the alias should reference.
|
5709
|
+
#
|
5710
|
+
# @return [Types::UpdateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5711
|
+
#
|
5712
|
+
# * {Types::UpdateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
5713
|
+
# * {Types::UpdateThemeAliasResponse#status #status} => Integer
|
5714
|
+
# * {Types::UpdateThemeAliasResponse#request_id #request_id} => String
|
5715
|
+
#
|
5716
|
+
# @example Request syntax with placeholder values
|
5717
|
+
#
|
5718
|
+
# resp = client.update_theme_alias({
|
5719
|
+
# aws_account_id: "AwsAccountId", # required
|
5720
|
+
# theme_id: "RestrictiveResourceId", # required
|
5721
|
+
# alias_name: "AliasName", # required
|
5722
|
+
# theme_version_number: 1, # required
|
5723
|
+
# })
|
5724
|
+
#
|
5725
|
+
# @example Response structure
|
5726
|
+
#
|
5727
|
+
# resp.theme_alias.arn #=> String
|
5728
|
+
# resp.theme_alias.alias_name #=> String
|
5729
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
5730
|
+
# resp.status #=> Integer
|
5731
|
+
# resp.request_id #=> String
|
5732
|
+
#
|
5733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAlias AWS API Documentation
|
5734
|
+
#
|
5735
|
+
# @overload update_theme_alias(params = {})
|
5736
|
+
# @param [Hash] params ({})
|
5737
|
+
def update_theme_alias(params = {}, options = {})
|
5738
|
+
req = build_request(:update_theme_alias, params)
|
5739
|
+
req.send_request(options)
|
5740
|
+
end
|
5741
|
+
|
5742
|
+
# Updates the resource permissions for a theme. Permissions apply to the
|
5743
|
+
# action to grant or revoke permissions on, for example
|
5744
|
+
# `"quicksight:DescribeTheme"`.
|
5745
|
+
#
|
5746
|
+
# Theme permissions apply in groupings. Valid groupings include the
|
5747
|
+
# following for the three levels of permissions, which are user, owner,
|
5748
|
+
# or no permissions:
|
5749
|
+
#
|
5750
|
+
# * User
|
5751
|
+
#
|
5752
|
+
# * `"quicksight:DescribeTheme"`
|
5753
|
+
#
|
5754
|
+
# * `"quicksight:DescribeThemeAlias"`
|
5755
|
+
#
|
5756
|
+
# * `"quicksight:ListThemeAliases"`
|
5757
|
+
#
|
5758
|
+
# * `"quicksight:ListThemeVersions"`
|
5759
|
+
#
|
5760
|
+
# * Owner
|
5761
|
+
#
|
5762
|
+
# * `"quicksight:DescribeTheme"`
|
5763
|
+
#
|
5764
|
+
# * `"quicksight:DescribeThemeAlias"`
|
5765
|
+
#
|
5766
|
+
# * `"quicksight:ListThemeAliases"`
|
5767
|
+
#
|
5768
|
+
# * `"quicksight:ListThemeVersions"`
|
5769
|
+
#
|
5770
|
+
# * `"quicksight:DeleteTheme"`
|
5771
|
+
#
|
5772
|
+
# * `"quicksight:UpdateTheme"`
|
5773
|
+
#
|
5774
|
+
# * `"quicksight:CreateThemeAlias"`
|
5775
|
+
#
|
5776
|
+
# * `"quicksight:DeleteThemeAlias"`
|
5777
|
+
#
|
5778
|
+
# * `"quicksight:UpdateThemeAlias"`
|
5779
|
+
#
|
5780
|
+
# * `"quicksight:UpdateThemePermissions"`
|
5781
|
+
#
|
5782
|
+
# * `"quicksight:DescribeThemePermissions"`
|
5783
|
+
#
|
5784
|
+
# * To specify no permissions, omit the permissions list.
|
5785
|
+
#
|
5786
|
+
# @option params [required, String] :aws_account_id
|
5787
|
+
# The ID of the AWS account that contains the theme.
|
5788
|
+
#
|
5789
|
+
# @option params [required, String] :theme_id
|
5790
|
+
# The ID for the theme.
|
5791
|
+
#
|
5792
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
5793
|
+
# A list of resource permissions to be granted for the theme.
|
5794
|
+
#
|
5795
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
5796
|
+
# A list of resource permissions to be revoked from the theme.
|
5797
|
+
#
|
5798
|
+
# @return [Types::UpdateThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5799
|
+
#
|
5800
|
+
# * {Types::UpdateThemePermissionsResponse#theme_id #theme_id} => String
|
5801
|
+
# * {Types::UpdateThemePermissionsResponse#theme_arn #theme_arn} => String
|
5802
|
+
# * {Types::UpdateThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
5803
|
+
# * {Types::UpdateThemePermissionsResponse#request_id #request_id} => String
|
5804
|
+
# * {Types::UpdateThemePermissionsResponse#status #status} => Integer
|
5805
|
+
#
|
5806
|
+
# @example Request syntax with placeholder values
|
5807
|
+
#
|
5808
|
+
# resp = client.update_theme_permissions({
|
5809
|
+
# aws_account_id: "AwsAccountId", # required
|
5810
|
+
# theme_id: "RestrictiveResourceId", # required
|
5811
|
+
# grant_permissions: [
|
5812
|
+
# {
|
5813
|
+
# principal: "Principal", # required
|
5814
|
+
# actions: ["String"], # required
|
5815
|
+
# },
|
5816
|
+
# ],
|
5817
|
+
# revoke_permissions: [
|
5818
|
+
# {
|
5819
|
+
# principal: "Principal", # required
|
5820
|
+
# actions: ["String"], # required
|
5821
|
+
# },
|
5822
|
+
# ],
|
5823
|
+
# })
|
5824
|
+
#
|
5825
|
+
# @example Response structure
|
5826
|
+
#
|
5827
|
+
# resp.theme_id #=> String
|
5828
|
+
# resp.theme_arn #=> String
|
5829
|
+
# resp.permissions #=> Array
|
5830
|
+
# resp.permissions[0].principal #=> String
|
5831
|
+
# resp.permissions[0].actions #=> Array
|
5832
|
+
# resp.permissions[0].actions[0] #=> String
|
5833
|
+
# resp.request_id #=> String
|
5834
|
+
# resp.status #=> Integer
|
5835
|
+
#
|
5836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissions AWS API Documentation
|
5837
|
+
#
|
5838
|
+
# @overload update_theme_permissions(params = {})
|
5839
|
+
# @param [Hash] params ({})
|
5840
|
+
def update_theme_permissions(params = {}, options = {})
|
5841
|
+
req = build_request(:update_theme_permissions, params)
|
5842
|
+
req.send_request(options)
|
5843
|
+
end
|
5844
|
+
|
4961
5845
|
# Updates an Amazon QuickSight user.
|
4962
5846
|
#
|
4963
5847
|
# @option params [required, String] :user_name
|
@@ -5035,7 +5919,7 @@ module Aws::QuickSight
|
|
5035
5919
|
params: params,
|
5036
5920
|
config: config)
|
5037
5921
|
context[:gem_name] = 'aws-sdk-quicksight'
|
5038
|
-
context[:gem_version] = '1.
|
5922
|
+
context[:gem_version] = '1.25.0'
|
5039
5923
|
Seahorse::Client::Request.new(handlers, context)
|
5040
5924
|
end
|
5041
5925
|
|